Fix: Module Manager test

CHANGELOG-DEV.md

@@ -3,6 +3,7 @@ HumHub Changelog
 
 1.16.0 (Unreleased)
 -------------------
+- Fix #6636: Module Manager test
 - Enh #6530: Small performance improvements
 - Fix #6511: Only test compatible modules in `onMarketplaceAfterFilterModules()`
 - Enh #6511: Backup folder path is now return from `removeModule()`

protected/humhub/components/ModuleManager.php

@@ -377,7 +377,7 @@ public function getModules($options = [])
     public function filterModules(?array $modules, $filters = []): array
     {
         if (!$filters instanceof ArrayAccess && !is_array($filters)) {
-            throw new InvalidArgumentTypeException(__METHOD__, [2 => '$filters'], ['array', ArrayAccess::class], $filters);
+            throw new InvalidArgumentTypeException('$filters', ['array', ArrayAccess::class], $filters);
         }
 
         $modules = $this->filterModulesByKeyword($modules, $filters['keyword'] ?? null);

protected/humhub/tests/codeception/_support/HumHubHelperTrait.php

@@ -34,6 +34,7 @@
 use yii\db\Command;
 use yii\db\ExpressionInterface;
 use yii\db\Query;
+use yii\helpers\ArrayHelper;
 use yii\helpers\FileHelper;
 use yii\log\Dispatcher;
 
@@ -619,15 +620,15 @@ public function expectExceptionTypeError(string $calledClass, string $method, in
      * @since 1.15
      * @see static::assertEvents()
      */
-    public function handleEvent(Event $event)
+    public function handleEvent(Event $event, array $eventData = [])
     {
-        $eventData = [
+        $eventData = ArrayHelper::merge([
             'class' => get_class($event),
             'event' => $event->name,
             'sender' => $event->sender,
             'data' => $event->data,
             'handled' => $event->handled,
-        ];
+        ], $eventData);
 
         $this->firedEvents[] = $eventData;
     }

protected/humhub/tests/codeception/unit/components/ModuleManagerTest.php

@@ -11,6 +11,7 @@
 namespace humhub\tests\codeception\unit\components;
 
 use humhub\components\bootstrap\ModuleAutoLoader;
+use humhub\components\ModuleEvent;
 use humhub\components\ModuleManager;
 use humhub\exceptions\InvalidArgumentTypeException;
 use humhub\models\ModuleEnabled;
@@ -27,7 +28,6 @@
 use yii\caching\ArrayCache;
 use yii\db\StaleObjectException;
 use yii\helpers\FileHelper;
-use humhub\components\ModuleEvent;
 
 require_once __DIR__ . '/bootstrap/ModuleAutoLoaderTest.php';
 
@@ -37,7 +37,8 @@
 class ModuleManagerTest extends HumHubDbTestCase
 {
     private static int $moduleDirCount;
-
+    private static array $moduleDirList;
+    private static ?array $moduleEnabledList = null;
     private static string $appModuleRoot;
     private static string $coreModuleRoot;
     private static string $testModuleRoot;
@@ -47,7 +48,6 @@ class ModuleManagerTest extends HumHubDbTestCase
     private ?string $moduleClass = null;
     private ?string $moduleNS = null;
     private static array $aliases;
-
     private static ModuleManager $originalModuleManager;
 
     public static function setUpBeforeClass(): void
@@ -59,12 +59,28 @@ public static function setUpBeforeClass(): void
         static::$appModuleRoot = dirname(__DIR__, 5) . '/modules';
 
         static::$moduleDirCount = 0;
+        static::$moduleDirList = [];
 
-        $dh  = opendir($appModuleRoot = static::$appModuleRoot);
+        $dh = opendir($appModuleRoot = static::$appModuleRoot);
 
         while (false !== ($filename = readdir($dh))) {
             if ($filename !== '.' && $filename !== '..' && is_dir("$appModuleRoot/$filename")) {
                 static::$moduleDirCount++;
+
+                $config_file = new \SplFileInfo("$appModuleRoot/$filename/config.php");
+                $config_file = new \SplFileInfo($config_file->getRealPath());
+
+                if (!$config_file->isFile() || !$config_file->isReadable()) {
+                    continue;
+                }
+
+                $config = include $config_file->getPathname();
+
+                if (!is_array($config)) {
+                    continue;
+                }
+
+                static::$moduleDirList[$config['id']] = $config['class'];
             }
         }
     }
@@ -102,9 +118,21 @@ protected function setUp(): void
 
     public function testBasics()
     {
-        static::assertEquals([], $this->moduleManager->myModules());
-        static::assertEquals([], $this->moduleManager->myCoreModules());
-        static::assertEquals([], $this->moduleManager->myEnabledModules());
+        static::assertEquals(
+            [],
+            $this->moduleManager->myModules(),
+            __FUNCTION__ . '.' . 'myModules()'
+        );
+        static::assertEquals(
+            [],
+            $this->moduleManager->myCoreModules(),
+            __FUNCTION__ . '.' . 'myCoreModules()'
+        );
+        static::assertEquals(
+            static::$moduleEnabledList,
+            $this->moduleManager->myEnabledModules(),
+            __FUNCTION__ . '.' . 'myEnabledModules()'
+        );
     }
 
     /**
@@ -183,11 +211,15 @@ public function testRegisterValidModuleConfig()
 
         $this->registerModule($basePath, $config);
 
-        static::assertEquals([], $this->moduleManager->getModules([
-            'includeCoreModules' => true,
-            'enabled' => true,
-            'returnClass' => true,
-        ]));
+        static::assertEquals(
+            [],
+            $this->moduleManager->getModules([
+                'includeCoreModules' => true,
+                'enabled' => true,
+                'returnClass' => true,
+            ]),
+            __FUNCTION__ . '.' . 'getModules()'
+        );
     }
 
     /**
@@ -287,7 +319,7 @@ public function testInvalidEventConfigAsString()
     public function testInvalidEventConfigNotArrayAccess()
     {
         $this->runEventExceptionTest([
-                'invalid1',
+            'invalid1',
         ], "event configuration must be an array or implement \\ArrayAccess");
     }
 
@@ -355,13 +387,16 @@ public function testInvalidEventConfigInvalidCallbackWithNonExistingClass()
 
     public function testInvalidEventConfigInvalidCallbackWithNonExistingMethod()
     {
-        $this->runEventExceptionTest([
+        $this->runEventExceptionTest(
             [
-                'class' => __CLASS__,
-                'event' => 'invalid1',
-                'callback' => [__CLASS__, 'someMethod'],
+                [
+                    'class' => __CLASS__,
+                    'event' => 'invalid1',
+                    'callback' => [__CLASS__, 'someMethod'],
+                ],
             ],
-        ], "class 'humhub\\tests\\codeception\\unit\\components\\ModuleManagerTest' does not have a method called 'someMethod");
+            "class 'humhub\\tests\\codeception\\unit\\components\\ModuleManagerTest' does not have a method called 'someMethod"
+        );
     }
 
     /**
@@ -392,13 +427,18 @@ public function testGetEnabledModules()
             'enabled' => false,
             'returnClass' => true,
         ]));
-        static::assertEquals(array_flip(ModuleAutoLoaderTest::EXPECTED_CORE_MODULES), $modules);
+        $expected = array_merge(
+            [],
+            array_flip(ModuleAutoLoaderTest::EXPECTED_CORE_MODULES),
+            static::$moduleDirList
+        );
+        static::assertEquals($expected, $modules);
 
         static::assertIsArray($modules = $moduleManager->getEnabledModules([
             'enabled' => false,
             'returnClass' => true,
         ]));
-        static::assertEquals([], $modules);
+        static::assertEquals(static::$moduleDirList, $modules);
     }
 
     /**
@@ -511,7 +551,7 @@ public function testEnableAndDisableModules()
 
         $this->moduleManager->disable($module);
 
-        static::assertCount(0, $this->moduleManager->myEnabledModules());
+        static::assertCount(count(static::$moduleEnabledList), $this->moduleManager->myEnabledModules());
         static::assertRecordCount(0, ModuleEnabled::tableName(), ['module_id' => $this->moduleId]);
         static::assertNull(Yii::$app->getModule($this->moduleId));
 
@@ -600,35 +640,77 @@ public function testFilterModules()
     {
         Yii::$app->set('moduleManager', $this->moduleManager);
 
-        $this->moduleManager->enableModules([static::$testModuleRoot . '/module1', static::$testModuleRoot . '/module2']);
+        $this->moduleManager->enableModules([
+            static::$testModuleRoot . '/module1',
+            static::$testModuleRoot . '/module2'
+        ]);
 
-        static::assertEquals(['module1' => Module1::class, 'module2' => Module2::class], $this->moduleManager->myModules());
-        static::assertEquals([], $this->moduleManager->myCoreModules());
-        static::assertEquals(['module1', 'module2'], $this->moduleManager->myEnabledModules());
+        static::assertEquals(
+            ['module1' => Module1::class, 'module2' => Module2::class],
+            $this->moduleManager->myModules()
+        );
+        static::assertEquals(
+            [],
+            $this->moduleManager->myCoreModules()
+        );
+        static::assertEquals(
+            [...static::$moduleEnabledList, 'module1', 'module2'],
+            $this->moduleManager->myEnabledModules()
+        );
 
         $module1 = $this->moduleManager->getModule('module1');
         $module2 = $this->moduleManager->getModule('module2');
 
         static::assertEquals([], $this->moduleManager->filterModulesByKeyword(null, 'foo'));
 
         // match keyword
-        static::assertEquals(['module1' => $module1], $this->moduleManager->filterModulesByKeyword(null, 'one'));
-        static::assertEquals(['module2' => $module2], $this->moduleManager->filterModulesByKeyword(null, 'two'));
-        static::assertEquals(['module1' => $module1, 'module2' => $module2], $this->moduleManager->filterModulesByKeyword(null, 'cool'));
+        static::assertEquals(
+            ['module1' => $module1],
+            $this->moduleManager->filterModulesByKeyword(null, 'one')
+        );
+        static::assertEquals(
+            ['module2' => $module2],
+            $this->moduleManager->filterModulesByKeyword(null, 'two')
+        );
+        static::assertEquals(
+            ['module1' => $module1, 'module2' => $module2],
+            $this->moduleManager->filterModulesByKeyword(null, 'cool')
+        );
 
         // match name
-        static::assertEquals(['module1' => $module1], $this->moduleManager->filterModulesByKeyword(null, 'Module 1'));
-        static::assertEquals(['module2' => $module2], $this->moduleManager->filterModulesByKeyword(null, 'Module 2'));
-        static::assertEquals(['module1' => $module1, 'module2' => $module2], $this->moduleManager->filterModulesByKeyword(null, 'Example'));
+        static::assertEquals(
+            ['module1' => $module1],
+            $this->moduleManager->filterModulesByKeyword(null, 'Module 1')
+        );
+        static::assertEquals(
+            ['module2' => $module2],
+            $this->moduleManager->filterModulesByKeyword(null, 'Module 2')
+        );
+        static::assertEquals(
+            ['module1' => $module1, 'module2' => $module2],
+            $this->moduleManager->filterModulesByKeyword(null, 'Example')
+        );
 
         // match description
-        static::assertEquals(['module1' => $module1], $this->moduleManager->filterModulesByKeyword(null, 'module 1.'));
-        static::assertEquals(['module2' => $module2], $this->moduleManager->filterModulesByKeyword(null, 'module 2.'));
-        static::assertEquals(['module1' => $module1, 'module2' => $module2], $this->moduleManager->filterModulesByKeyword(null, 'testing'));
+        static::assertEquals(
+            ['module1' => $module1],
+            $this->moduleManager->filterModulesByKeyword(null, 'module 1.')
+        );
+        static::assertEquals(
+            ['module2' => $module2],
+            $this->moduleManager->filterModulesByKeyword(null, 'module 2.')
+        );
+        static::assertEquals(
+            ['module1' => $module1, 'module2' => $module2],
+            $this->moduleManager->filterModulesByKeyword(null, 'testing')
+        );
 
         $this->moduleManager->on(ModuleManager::EVENT_AFTER_FILTER_MODULES, [$this, 'handleEvent']);
 
-        static::assertEquals(['module1' => $module1, 'module2' => $module2], $this->moduleManager->filterModules(null, ['foo']));
+        static::assertEquals(
+            ['module1' => $module1, 'module2' => $module2],
+            $this->moduleManager->filterModules(null, ['foo'])
+        );
 
         /** @noinspection MissedFieldInspection */
         $this->assertEvents([
@@ -656,7 +738,10 @@ public function testFilterModules()
             ]
         ]);
 
-        static::assertEquals(['module2' => $module2], $this->moduleManager->filterModules(null, ['keyword' => 'Example Module 2']));
+        static::assertEquals(
+            ['module2' => $module2],
+            $this->moduleManager->filterModules(null, ['keyword' => 'Example Module 2'])
+        );
 
         /** @noinspection MissedFieldInspection */
         $this->assertEvents([
@@ -672,7 +757,7 @@ public function testFilterModules()
 
         $this->expectException(InvalidArgumentTypeException::class);
         $this->expectExceptionMessage(
-            'Argument #2 $filters passed to humhub\components\ModuleManager::filterModules must be of type array, ArrayAccess, string given.'
+            'Argument $filters passed to humhub\components\ModuleManager::filterModules must be one of the following types: array, ArrayAccess - string given.'
         );
         static::assertEquals([], $this->moduleManager->filterModules(null, 'foo'));
     }
@@ -746,9 +831,27 @@ public function registerModule(string $basePath, $config, ?bool $isEnabled = nul
 
         $this->moduleManager->register($basePath, $config);
 
-        static::assertEquals([$this->moduleId => $this->moduleClass], $this->moduleManager->myModules());
-        static::assertEquals($isCore ? [$this->moduleClass] : [], $this->moduleManager->myCoreModules());
-        static::assertEquals($isEnabled && !$isCore ? [$this->moduleId] : [], $this->moduleManager->myEnabledModules());
+        static::assertEquals(
+            [$this->moduleId => $this->moduleClass],
+            $this->moduleManager->myModules(),
+            __FUNCTION__ . '.' . 'myModules()'
+        );
+
+        static::assertEquals(
+            $isCore ? [$this->moduleClass] : [],
+            $this->moduleManager->myCoreModules(),
+            __FUNCTION__ . '.' . 'myCoreModules()'
+        );
+
+        $expected = static::$moduleEnabledList;
+        if ($isEnabled && !$isCore) {
+            $expected[] = $this->moduleId;
+        }
+        static::assertEquals(
+            $expected,
+            $this->moduleManager->myEnabledModules(),
+            __FUNCTION__ . '.' . 'myEnabledModules()'
+        );
 
         static::assertTrue($this->moduleManager->hasModule($this->moduleId));
 
@@ -795,7 +898,12 @@ public function registerModule(string $basePath, $config, ?bool $isEnabled = nul
             $eventName = $event['event'] ?? $event[1] ?? null;
             $eventHandler = $event['callback'] ?? $event[2] ?? null;
 
-            if ($isEnabled && $eventClass && $eventName && is_array($eventHandler) && method_exists($eventHandler[0], $eventHandler[1])) {
+            if (
+                $isEnabled && $eventClass && $eventName && is_array($eventHandler) && method_exists(
+                    $eventHandler[0],
+                    $eventHandler[1]
+                )
+            ) {
                 static::assertTrue(Event::off($eventClass, $eventName, $eventHandler));
             } else {
                 static::assertFalse(Event::off($eventClass, $eventName, $eventHandler));
@@ -902,7 +1010,21 @@ public function reset(): void
 
         $this->firedEvents = [];
 
-        static::dbDelete(ModuleEnabled::tableName(), ['module_id' => ['module1', 'module2', 'coreModule', 'installerModule', 'invalidModule1', 'invalidModule2']]);
+        static::dbDelete(ModuleEnabled::tableName(), [
+            'module_id' => [
+                'module1',
+                'module2',
+                'coreModule',
+                'installerModule',
+                'invalidModule1',
+                'invalidModule2'
+            ]
+        ]);
+
+        static::$moduleEnabledList ??= array_column(
+            static::dbSelect('module_enabled', 'module_id'),
+            'module_id'
+        );
 
         $this->moduleManager = new ModuleManagerMock();
     }