Merge pull request #84 from visto9259/fix-25

Fix #25 assertModulesLoaded not matching all loaded Modules
laminas · Sep 12, 2024 · a8de7f8 · a8de7f8
2 parents 607c55c + a16757f
commit a8de7f8
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 450 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/psalm.xml b/psalm.xml
@@ -29,7 +29,15 @@
             <errorLevel type="suppress">
                 <referencedMethod name="PHPUnit\Framework\MockObject\Builder\InvocationMocker::with"/>
             </errorLevel>
+            <errorLevel type="suppress">
+                <referencedMethod name="PHPUnit\Framework\ExpectationFailedException::__construct"/>
+            </errorLevel>
         </InternalMethod>
+        <InternalClass>
+            <errorLevel type="suppress">
+                <referencedClass name="PHPUnit\Framework\ExpectationFailedException" />
+            </errorLevel>
+        </InternalClass>
     </issueHandlers>
     <plugins>
         <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>

diff --git a/src/PHPUnit/Controller/AbstractControllerTestCase.php b/src/PHPUnit/Controller/AbstractControllerTestCase.php
@@ -9,6 +9,7 @@
 use Laminas\EventManager\StaticEventManager;
 use Laminas\Http\Request as HttpRequest;
 use Laminas\Http\Response;
+use Laminas\ModuleManager\ModuleManager;
 use Laminas\Mvc\Application;
 use Laminas\Mvc\ApplicationInterface;
 use Laminas\Mvc\Controller\ControllerManager;
@@ -30,6 +31,7 @@
 use function array_diff;
 use function array_intersect;
 use function array_key_exists;
+use function array_keys;
 use function array_merge;
 use function assert;
 use function class_exists;
@@ -381,7 +383,8 @@ public function triggerApplicationEvent($eventName)
     public function assertModulesLoaded(array $modules)
     {
         $moduleManager = $this->getApplicationServiceLocator()->get('ModuleManager');
-        $modulesLoaded = $moduleManager->getModules();
+        assert($moduleManager instanceof ModuleManager);
+        $modulesLoaded = array_keys($moduleManager->getLoadedModules());
         $list          = array_diff($modules, $modulesLoaded);
         if ($list) {
             throw new ExpectationFailedException($this->createFailureMessage(

diff --git a/test/PHPUnit/ModuleDependenciesTest.php b/test/PHPUnit/ModuleDependenciesTest.php
@@ -21,12 +21,12 @@ public function testDependenciesModules(): void
             include __DIR__ . '/../_files/application.config.with.dependencies.php'
         );
         $sm = $this->getApplicationServiceLocator();
-        $this->assertEquals(true, $sm->has('FooObject'));
-        $this->assertEquals(true, $sm->has('BarObject'));
+        $this->assertTrue($sm->has('FooObject'));
+        $this->assertTrue($sm->has('BarObject'));
 
         $this->assertModulesLoaded(['Foo', 'Bar']);
         $this->expectedException(ExpectationFailedException::class);
-        $this->assertModulesLoaded(['Foo', 'Bar', 'Unknow']);
+        $this->assertModulesLoaded(['Foo', 'Bar', 'Unknown']);
     }
 
     public function testBadDependenciesModules(): void
@@ -35,11 +35,29 @@ public function testBadDependenciesModules(): void
             include __DIR__ . '/../_files/application.config.with.dependencies.disabled.php'
         );
         $sm = $this->getApplicationServiceLocator();
-        $this->assertEquals(false, $sm->has('FooObject'));
-        $this->assertEquals(true, $sm->has('BarObject'));
+        $this->assertFalse($sm->has('FooObject'));
+        $this->assertTrue($sm->has('BarObject'));
 
         $this->assertNotModulesLoaded(['Foo']);
         $this->expectedException(ExpectationFailedException::class);
         $this->assertNotModulesLoaded(['Foo', 'Bar']);
     }
+
+    /**
+     * Test that 'assertModulesLoaded()' can detect modules that are loaded in a module's init() method
+     */
+    public function testLoadedModulesUsingModuleInit(): void
+    {
+        $this->setApplicationConfig(
+            include __DIR__ . '/../_files/application.config.with.modules.init.php'
+        );
+        $sm = $this->getApplicationServiceLocator();
+
+        // Check that modules loaded and created the below services
+        $this->assertTrue($sm->has('FooObject'));
+        $this->assertTrue($sm->has('QuxObject'));
+
+        // Assert for the module loaded via Module init() method
+        $this->assertModulesLoaded(['Foo']);
+    }
 }
diff --git a/test/_files/application.config.with.modules.init.php b/test/_files/application.config.with.modules.init.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'modules'                 => [
+        'Laminas\Router',
+        'Qux', // Qux will load Foo during module init event
+    ],
+    'module_listener_options' => [
+        'config_static_paths' => [],
+        'module_paths'        => [
+            'Qux' => __DIR__ . '/modules-path/with-subdir/Qux',
+            'Foo' => __DIR__ . '/modules-path/with-subdir/Foo',
+        ],
+    ],
+];
diff --git a/test/_files/modules-path/with-subdir/Bar/Module.php b/test/_files/modules-path/with-subdir/Bar/Module.php
@@ -5,6 +5,7 @@
 namespace Bar;
 
 use Laminas\Loader\StandardAutoloader;
+use stdClass;
 
 class Module
 {
@@ -33,12 +34,7 @@ public function getServiceConfig()
             // Legacy Zend Framework aliases
             'aliases'   => [],
             'factories' => [
-                'BarObject' => static function ($sm) {
-                    $foo      = $sm->get('FooObject');
-                    $foo->bar = 'baz';
-
-                    return $foo;
-                },
+                'BarObject' => static fn(): stdClass => new stdClass(),
             ],
         ];
     }

diff --git a/test/_files/modules-path/with-subdir/Foo/Module.php b/test/_files/modules-path/with-subdir/Foo/Module.php
@@ -34,7 +34,7 @@ public function getServiceConfig()
             // Legacy Zend Framework aliases
             'aliases'   => [],
             'factories' => [
-                'FooObject' => static fn($sm): stdClass => new stdClass(),
+                'FooObject' => static fn(): stdClass => new stdClass(),
             ],
         ];
     }

diff --git a/test/_files/modules-path/with-subdir/Qux/Module.php b/test/_files/modules-path/with-subdir/Qux/Module.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Qux;
+
+use Laminas\ModuleManager\Feature\InitProviderInterface;
+use Laminas\ModuleManager\ModuleManagerInterface;
+use stdClass;
+
+/** @psalm-suppress UnusedClass */
+class Module implements InitProviderInterface
+{
+    public function getConfig(): array
+    {
+        return [
+            'service_manager' => [
+                'factories' => [
+                    'QuxObject' => static fn(): stdClass => new stdClass(),
+                ],
+            ],
+        ];
+    }
+
+    public function init(ModuleManagerInterface $manager): void
+    {
+        $manager->loadModule('Foo');
+    }
+}