Ignore LoadIncludes rule if module and file name unknown (#524)

mglaman · Apr 7, 2023 · 21b6249 · 21b6249
1 parent 46786f8
commit 21b6249
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 14 deletions.
diff --git a/src/Rules/Drupal/LoadIncludeBase.php b/src/Rules/Drupal/LoadIncludeBase.php
@@ -34,11 +34,11 @@ protected function parseLoadIncludeArgs(Node\Arg $module, Node\Arg $type, ?Node\
     {
         $moduleName = $this->getStringArgValue($module->value, $scope);
         if ($moduleName === null) {
-            return [];
+            return [false, false];
         }
         $fileType = $this->getStringArgValue($type->value, $scope);
         if ($fileType === null) {
-            return [];
+            return [false, false];
         }
         $baseName = null;
         if ($name !== null) {

diff --git a/src/Rules/Drupal/LoadIncludes.php b/src/Rules/Drupal/LoadIncludes.php
@@ -48,6 +48,11 @@ public function processNode(Node $node, Scope $scope): array
         try {
             // Try to invoke it similarly as the module handler itself.
             [$moduleName, $filename] = $this->parseLoadIncludeArgs($args[0], $args[1], $args[2] ?? null, $scope);
+            if (!$moduleName && !$filename) {
+                // Couldn't determine module- nor file-name, most probably
+                // because it's a variable. Nothing to load, bail now.
+                return [];
+            }
             $module = $this->extensionMap->getModule($moduleName);
             if ($module === null) {
                 return [

diff --git a/tests/src/Rules/LoadIncludesRuleTest.php b/tests/src/Rules/LoadIncludesRuleTest.php
@@ -12,26 +12,39 @@ protected function getRule(): \PHPStan\Rules\Rule
         return self::getContainer()->getByType(LoadIncludes::class);
     }
 
-    public function testRule(): void
+    /**
+     * @dataProvider cases
+     */
+    public function test(array $files, array $errors): void
     {
-        $this->analyse([
-            __DIR__ . '/../../fixtures/drupal/modules/phpstan_fixtures/phpstan_fixtures.module'
-        ],
+        $this->analyse($files, $errors);
+    }
+
+    public function cases(): \Generator
+    {
+        yield [
+            [
+                __DIR__ . '/../../fixtures/drupal/modules/phpstan_fixtures/phpstan_fixtures.module'
+            ],
             [
                 [
                     'File modules/phpstan_fixtures/phpstan_fixtures.fetch.inc could not be loaded from Drupal\Core\Extension\ModuleHandlerInterface::loadInclude',
                     30
                 ]
-            ]);
-    }
+            ],
+        ];
 
-    public function testFormStateLoadInclude(): void
-    {
-        $this->analyse([
-            __DIR__ . '/../../fixtures/drupal/core/tests/Drupal/Tests/Core/Form/FormStateTest.php'
-        ],
+        yield [
             [
-            ]);
+                __DIR__ . '/../../fixtures/drupal/core/tests/Drupal/Tests/Core/Form/FormStateTest.php'
+            ],
+            [],
+        ];
+
+        yield 'bug-516.php' => [
+            [__DIR__.'/data/bug-516.php'],
+            []
+        ];
     }
 
 }
diff --git a/tests/src/Rules/data/bug-516.php b/tests/src/Rules/data/bug-516.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Bug516;
+
+use Drupal\Core\Extension\ModuleHandlerInterface;
+
+/**
+ * Tests moduleHandler::loadInclude where first argument is a variable.
+ */
+class TestClass {
+
+    /**
+     * Code snippet from \Drupal\TestTools\Extension\SchemaInspector.
+     *
+     * @param \Drupal\Core\Extension\ModuleHandlerInterface $handler
+     * @param string $module
+     */
+    function bug516(ModuleHandlerInterface $handler, string $module): void
+    {
+        $handler->loadInclude($module, 'install');
+    }
+
+    /**
+     * Code snippet from \_update_fix_missing_schema.
+     */
+    function bug516_2(): void
+    {
+        $module_handler = \Drupal::moduleHandler();
+        $enabled_modules = $module_handler->getModuleList();
+
+        foreach (array_keys($enabled_modules) as $module) {
+            $module_handler->loadInclude($module, 'install');
+        }
+    }
+
+}