Skip to content

Commit 303acb0

Browse files
stronk7kabalin
stronk7
authored and
kabalin
committed
New tests towards better cov in some classes with low metrics
Note that initially I was planning to add this to v4 series but, as far as it requires changes to Psalm config, I've moved it to v5. - MoodlePluginCI\Bridge\Moodle : 21% => 100% - MoodlePluginCI\Bridge\MessDetectorRenderer : 31% => 100%
1 parent 5bb4847 commit 303acb0

File tree

6 files changed

+222
-3
lines changed

6 files changed

+222
-3
lines changed

‎psalm.xml

+8
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@
3030
<RedundantPropertyInitializationCheck errorLevel="suppress"/>
3131
<MissingConstructor errorLevel="info"/>
3232

33+
<!-- There are some include statements in tests that psalm cannot resolve,
34+
but they are correct, part of the mocked Moodle environment. -->
35+
<UnresolvableInclude>
36+
<errorLevel type="suppress">
37+
<directory name="tests"/>
38+
</errorLevel>
39+
</UnresolvableInclude>
40+
3341
<!-- Test classes are, apparently, not used but, for sure, they are used by PHPUnit. -->
3442
<UnusedClass>
3543
<errorLevel type="suppress">

‎tests/Bridge/MoodleTest.php

+107-3
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,116 @@
1313
namespace MoodlePluginCI\Tests\Bridge;
1414

1515
use MoodlePluginCI\Bridge\Moodle;
16+
use MoodlePluginCI\Tests\FilesystemTestCase;
1617

17-
class MoodleTest extends \PHPUnit\Framework\TestCase
18+
/**
19+
* Test the \MoodlePluginCI\Bridge\Moodle class.
20+
*
21+
* Note that various unit tests are run in a separate process to avoid
22+
* conflicts with global state when including Moodle's config.php or
23+
* core_component (mocked) class.
24+
*
25+
* @covers \MoodlePluginCI\Bridge\Moodle
26+
*/
27+
class MoodleTest extends FilesystemTestCase
1828
{
19-
public function testGetBranch(): void
29+
/**
30+
* @runInSeparateProcess
31+
*/
32+
public function testGetConfigExists(): void
33+
{
34+
$this->fs->mirror(__DIR__ . '/../Fixture/moodle', $this->tempDir);
35+
$this->fs->copy(__DIR__ . '/../Fixture/tiny-config.php', $this->tempDir . '/config.php');
36+
$moodle = new Moodle($this->tempDir);
37+
38+
$this->assertSame('exists', $moodle->getConfig('exists'));
39+
}
40+
41+
/**
42+
* @runInSeparateProcess
43+
*/
44+
public function testGetConfigNotExists(): void
45+
{
46+
$this->fs->mirror(__DIR__ . '/../Fixture/moodle', $this->tempDir);
47+
$this->fs->copy(__DIR__ . '/../Fixture/tiny-config.php', $this->tempDir . '/config.php');
48+
$moodle = new Moodle($this->tempDir);
49+
50+
$this->expectException(\RuntimeException::class);
51+
$this->expectExceptionMessage('Failed to find $CFG->notexists in Moodle config file');
52+
$moodle->getConfig('notexists');
53+
}
54+
55+
/**
56+
* @runInSeparateProcess
57+
*/
58+
public function testGetConfigNoConfigFile(): void
59+
{
60+
$this->fs->mirror(__DIR__ . '/../Fixture/moodle', $this->tempDir);
61+
$moodle = new Moodle($this->tempDir);
62+
63+
$this->expectException(\RuntimeException::class);
64+
$this->expectExceptionMessage('Failed to find Moodle config file');
65+
$moodle->getConfig('wwwroot');
66+
}
67+
68+
/**
69+
* @runInSeparateProcess
70+
*/
71+
public function testComponentInstallDirectoryExists(): void
2072
{
21-
$moodle = new Moodle(__DIR__ . '/../Fixture/moodle');
73+
$this->fs->mirror(__DIR__ . '/../Fixture/moodle', $this->tempDir);
74+
$this->fs->copy(__DIR__ . '/../Fixture/tiny-config.php', $this->tempDir . '/config.php');
75+
$moodle = new Moodle($this->tempDir);
76+
77+
// Initially we tried to mock the core_component class with Mockery, and everything
78+
// worked fine, but the use of Reflection that we have in the code to be tested.
79+
// Hence, we have changed to load a minimal core_component (Fixture/moodle/lib/classes/component.php)
80+
// class that will be used instead of the (core) original.
81+
require_once $this->tempDir . '/lib/classes/component.php';
82+
83+
$this->assertSame('/path/to/mod/test', $moodle->getComponentInstallDirectory('mod_test'));
84+
}
85+
86+
/**
87+
* @runInSeparateProcess
88+
*/
89+
public function testComponentInstallDirectoryNotExists(): void
90+
{
91+
$this->fs->mirror(__DIR__ . '/../Fixture/moodle', $this->tempDir);
92+
$this->fs->copy(__DIR__ . '/../Fixture/tiny-config.php', $this->tempDir . '/config.php');
93+
$moodle = new Moodle($this->tempDir);
94+
95+
// Initially we tried to mock the core_component class with Mockery, and everything
96+
// worked fine, but the use of Reflection that we have in the code to be tested.
97+
// Hence, we have changed to load a minimal core_component (Fixture/moodle/lib/classes/component.php)
98+
// class that will be used instead of the (core) original.
99+
require_once $this->tempDir . '/lib/classes/component.php';
100+
101+
$this->expectException(\InvalidArgumentException::class);
102+
$this->expectExceptionMessage('The component unknown_test has an unknown plugin type of unknown');
103+
$moodle->getComponentInstallDirectory('unknown_test');
104+
}
105+
106+
public function testGetBranchCorrect(): void
107+
{
108+
$this->fs->mirror(__DIR__ . '/../Fixture/moodle', $this->tempDir);
109+
$moodle = new Moodle($this->tempDir);
110+
22111
$this->assertSame(39, $moodle->getBranch());
23112
}
113+
114+
public function testGetBranchIncorrect(): void
115+
{
116+
$this->fs->mirror(__DIR__ . '/../Fixture/moodle', $this->tempDir);
117+
118+
// Let's edit the version.php file to convert the correct (string) branch into incorrect (integer) branch.
119+
$contents = file_get_contents($this->tempDir . '/version.php');
120+
$contents = preg_replace("/'39'/", '39', $contents);
121+
file_put_contents($this->tempDir . '/version.php', $contents);
122+
123+
$moodle = new Moodle($this->tempDir);
124+
$this->expectException(\RuntimeException::class);
125+
$this->expectExceptionMessage('Failed to find Moodle branch version');
126+
$moodle->getBranch();
127+
}
24128
}

‎tests/Command/MessDetectorCommandTest.php

+10
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,16 @@ public function testExecute(): void
5252
$this->assertSame(0, $commandTester->getStatusCode());
5353
}
5454

55+
public function testExecuteWithProblems(): void
56+
{
57+
$commandTester = $this->executeCommand(__DIR__ . '/../Fixture/phpmd');
58+
59+
$this->assertSame(0, $commandTester->getStatusCode()); // PHPMD always return 0, no matter the violations/errors.
60+
$this->assertStringContainsString('Constant testConst should be defined in uppercase', $commandTester->getDisplay());
61+
$this->assertStringContainsString('long variable names like $reallyVeryLongVariableName', $commandTester->getDisplay());
62+
$this->assertStringContainsString('Unexpected end of token stream in file', $commandTester->getDisplay());
63+
}
64+
5565
public function testExecuteNoFiles(): void
5666
{
5767
// Just random directory with no PHP files.

‎tests/Fixture/moodle/lib/classes/component.php

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Moodle Plugin CI package.
5+
*
6+
* For the full copyright and license information, please view the LICENSE
7+
* file that was distributed with this source code.
8+
*
9+
* @copyright 2024 onwards Eloy Lafuente (stronk7) {@link https://stronk7.com}
10+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11+
*/
12+
13+
/**
14+
* Minimal core_component core class.
15+
*
16+
* This is a minimal fixture of the Moodle core_component class, just to be able
17+
* to use it in the tests, only including the methods that we are going to need to
18+
* invoke.
19+
*
20+
* Note that we haven't been able to use Mockery for this, because the code to be
21+
* tested is using Reflection on this class, so we cannot aliases/overload or
22+
* use similar strategies to mock it.
23+
*/
24+
class core_component {
25+
26+
public static function get_component_directory($component) {
27+
return '/path/to/' . str_replace('_', '/', $component);
28+
}
29+
30+
public static function normalize_component($component) {
31+
return explode('_', $component, 2);
32+
}
33+
34+
protected static function fetch_plugintypes() {
35+
return [
36+
['mod' => '/path/to/mod', 'local' => '/path/to/local'],
37+
[], // We don't need this.
38+
[], // We don't need this.
39+
];
40+
}
41+
}

‎tests/Fixture/phpmd/Problems.php

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Moodle Plugin CI package.
5+
*
6+
* For the full copyright and license information, please view the LICENSE
7+
* file that was distributed with this source code.
8+
*
9+
* @copyright 2024 onwards Eloy Lafuente (stronk7) {@link https://stronk7.com}
10+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
11+
*/
12+
13+
/**
14+
* This fixture class is used to test the PHPMD command.
15+
*
16+
* It contains 2 PHPMD naming violations and 1 parsing error.
17+
*/
18+
class Problems {
19+
const testConst = 1;
20+
protected $reallyVeryLongVariableName = true;
21+
}
22+
23+
class unfinishedFixtureClass {

‎tests/Fixture/tiny-config.php

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php // Moodle configuration file
2+
3+
unset($CFG);
4+
global $CFG;
5+
$CFG = new stdClass();
6+
7+
$CFG->dbtype = 'mysqli';
8+
$CFG->dblibrary = 'native';
9+
$CFG->dbhost = 'localhost';
10+
$CFG->dbname = 'moodle';
11+
$CFG->dbuser = 'root';
12+
$CFG->dbpass = '';
13+
$CFG->prefix = 'mdl_';
14+
$CFG->dboptions = [
15+
'dbport' => '',
16+
];
17+
18+
$CFG->wwwroot = 'http://localhost/moodle';
19+
$CFG->dataroot = '/path/to/moodledata';
20+
$CFG->admin = 'admin';
21+
22+
$CFG->directorypermissions = 02777;
23+
24+
// Show debugging messages.
25+
$CFG->debug = (E_ALL | E_STRICT);
26+
$CFG->debugdisplay = 1;
27+
28+
// Extra config.
29+
$CFG->exists = 'exists';
30+
31+
// require_once(__DIR__.'/lib/setup.php');
32+
// There is no php closing tag in this file,
33+
// it is intentional because it prevents trailing whitespace problems!

0 commit comments

Comments
 (0)