Add tests, fix PHPStan errors

Author: mglaman

src/Rules/Drupal/LoadIncludes.php

@@ -11,6 +11,7 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\ObjectType;
 
 class LoadIncludes implements Rule
 {
@@ -24,8 +25,9 @@ class LoadIncludes implements Rule
 
     /**
      * LoadIncludes constructor.
+     * @param string $project_root
      */
-    public function __construct($project_root)
+    public function __construct(string $project_root)
     {
         $this->projectRoot = $project_root;
     }
@@ -38,26 +40,30 @@ public function getNodeType(): string
     public function processNode(Node $node, Scope $scope): array
     {
         assert($node instanceof Node\Expr\MethodCall);
+        if (!$node->name instanceof Node\Identifier) {
+            return [];
+        }
+        $method_name = $node->name->toString();
+        if ($method_name !== 'loadInclude') {
+            return [];
+        }
+        $variable = $node->var;
+        if (!$variable instanceof Node\Expr\Variable) {
+            return [];
+        }
+        $var_name = $variable->name;
+        if (!is_string($var_name)) {
+            throw new ShouldNotHappenException(sprintf('Expected string for variable in %s, please open an issue on GitHub https://github.com/mglaman/phpstan-drupal/issues', get_called_class()));
+        }
+        $type = $scope->getVariableType($var_name);
+        assert($type instanceof ObjectType);
+        if (!class_exists($type->getClassName()) && !interface_exists($type->getClassName())) {
+            throw new ShouldNotHappenException(sprintf('Could not find class for %s from reflection.', get_called_class()));
+        }
 
         try {
-            $method_name = $node->name;
-            if ($method_name instanceof Node\Identifier) {
-                $method_name = $method_name->name;
-            }
-            if ($method_name !== 'loadInclude') {
-                return [];
-            }
-            $var_name = $node->var->name;
-            if ($var_name instanceof Node\Identifier) {
-                $var_name = $var_name->name;
-            }
-            if (!$var_name) {
-                return [];
-            }
-            $type = $scope->getVariableType($var_name);
             $reflected = new \ReflectionClass($type->getClassName());
-            $implements = $reflected->implementsInterface(ModuleHandlerInterface::class);
-            if (!$implements) {
+            if (!$reflected->implementsInterface(ModuleHandlerInterface::class)) {
                 return [];
             }
             // Try to invoke it similarily as the module handler itself.
@@ -66,26 +72,32 @@ public function processNode(Node $node, Scope $scope): array
             $drupal_root = $finder->getDrupalRoot();
             $extensionDiscovery = new ExtensionDiscovery($drupal_root);
             $modules = $extensionDiscovery->scan('module');
-            $module_arg = $node->args[0]->value->value;
-            $type_arg = $node->args[1]->value->value;
-            $name_arg = !empty($node->args[2]) ? $node->args[2] : null;
-            if (!$name_arg) {
+            $module_arg = $node->args[0];
+            assert($module_arg->value instanceof Node\Scalar\String_);
+            $type_arg = $node->args[1];
+            assert($type_arg->value instanceof Node\Scalar\String_);
+            $name_arg = $node->args[2] ?? null;
+
+            if ($name_arg === null) {
                 $name_arg = $module_arg;
-            } else {
-                $name_arg = $name_arg->value->value;
             }
-            if (empty($modules[$module_arg])) {
+            assert($name_arg->value instanceof Node\Scalar\String_);
+
+            $module_name = $module_arg->value->value;
+            if (!isset($modules[$module_name])) {
                 return [];
             }
-            /** @var \PHPStan\Drupal\Extension $module */
-            $module = $modules[$module_arg];
-            $file = $drupal_root . '/' . $module->getPath() . "/$name_arg.$type_arg";
+            $type_prefix = $name_arg->value->value;
+            $type_filename = $type_arg->value->value;
+            $module = $modules[$module_name];
+            $file = $drupal_root . '/' . $module->getPath() . "/$type_prefix.$type_filename";
             if (is_file($file)) {
                 require_once $file;
                 return [];
             }
-            return ['File could not be loaded from ModuleHandler::loadInclude'];
+            return [sprintf('File %s could not be loaded from %s::loadInclude', $file, $type->getClassName())];
         } catch (\Throwable $e) {
+            return [sprintf('A file could not be loaded from %s::loadInclude', $type->getClassName())];
         }
 
         return [];

tests/fixtures/drupal/modules/phpstan_fixtures/phpstan_fixtures.module

@@ -16,3 +16,14 @@ function phpstan_fixtures_get_app_root(): string {
     $app_root = \Drupal::getContainer()->get('app.root');
     return $app_root . '/core/includes/install.inc';
 }
+
+function phpstan_fixtures_module_load_includes_test(): array {
+    $module_handler = \Drupal::moduleHandler();
+    $module_handler->loadInclude('locale', 'fetch.inc');
+    return _locale_translation_default_update_options();
+}
+
+function phpstan_fixtures_module_load_includes_negative_test(): void {
+    $module_handler = \Drupal::moduleHandler();
+    $module_handler->loadInclude('phpstan_fixtures', 'fetch.inc');
+}

tests/src/DrupalIntegrationTest.php

@@ -38,14 +38,16 @@ public function testDrupalTestInChildSiteContant() {
 
     public function testExtensionReportsError() {
         $errors = $this->runAnalyze(__DIR__ . '/../fixtures/drupal/modules/phpstan_fixtures/phpstan_fixtures.module');
-        $this->assertCount(2, $errors->getErrors(), var_export($errors, true));
+        $this->assertCount(3, $errors->getErrors(), var_export($errors, true));
         $this->assertCount(0, $errors->getInternalErrors(), var_export($errors, true));
 
         $errors = $errors->getErrors();
         $error = array_shift($errors);
         $this->assertEquals('If condition is always false.', $error->getMessage());
         $error = array_shift($errors);
         $this->assertEquals('Function phpstan_fixtures_MissingReturnRule() should return string but return statement is missing.', $error->getMessage());
+        $error = array_shift($errors);
+        $this->assertStringContainsString('phpstan_fixtures/phpstan_fixtures.fetch.inc could not be loaded from Drupal\\Core\\Extension\\ModuleHandlerInterface::loadInclude', $error->getMessage());
     }
 
     public function testExtensionTestSuiteAutoloading() {