Merge pull request #196 from mglaman/gh-191-defaulttheme-browsertestbase

Detect undefined defaultTheme property

Author: mglaman

extension.neon

@@ -61,3 +61,7 @@ services:
 	-
 		class: PHPStan\Rules\Deprecations\ConfigEntityConfigExportRule
 		tags: [phpstan.rules.rule]
+
+	-
+		class: PHPStan\Rules\Drupal\Tests\BrowserTestBaseDefaultThemeRule
+		tags: [phpstan.rules.rule]

src/Rules/Drupal/Tests/BrowserTestBaseDefaultThemeRule.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types=1);
+
+namespace PHPStan\Rules\Drupal\Tests;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Type\ObjectType;
+
+final class BrowserTestBaseDefaultThemeRule implements Rule
+{
+
+    public function getNodeType(): string
+    {
+        return Node\Stmt\Class_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        assert($node instanceof Node\Stmt\Class_);
+        if ($node->extends === null) {
+            return [];
+        }
+        if ($node->namespacedName === null) {
+            return [];
+        }
+
+        $classType = $scope->resolveTypeByName($node->namespacedName);
+        assert($classType instanceof ObjectType);
+        $browserTestBaseAncestor = $classType->getAncestorWithClassName('Drupal\\Tests\\BrowserTestBase');
+        if ($browserTestBaseAncestor === null) {
+            return [];
+        }
+
+        $reflection = $classType->getClassReflection();
+        assert($reflection !== null);
+        $defaultProperties = $reflection->getNativeReflection()->getDefaultProperties();
+        $defaultTheme = $defaultProperties['defaultTheme'] ?? null;
+
+        if ($defaultTheme === null || $defaultTheme === '') {
+            return [
+                'Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.',
+            ];
+        }
+        return [];
+    }
+}

tests/fixtures/drupal/modules/module_with_tests/tests/src/Functional/DefaultThemeTest.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Drupal\Tests\module_with_tests\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+
+class DefaultThemeTest extends BrowserTestBase {
+
+    protected $defaultTheme = 'stark';
+
+    public function testFoo() {
+        $this->drupalGet('/');
+    }
+
+}

tests/fixtures/drupal/modules/module_with_tests/tests/src/Functional/ExtendsDefaultThemeTest.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Drupal\Tests\module_with_tests\Functional;
+
+class ExtendsDefaultThemeTest extends DefaultThemeTest {
+
+    public function testBar() {
+        $this->drupalGet('/');
+    }
+
+}

tests/fixtures/drupal/modules/module_with_tests/tests/src/Functional/MissingDefaultThemeTest.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Drupal\Tests\module_with_tests\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+
+class MissingDefaultThemeTest extends BrowserTestBase {
+
+    public function testFoo() {
+        $this->drupalGet('/');
+    }
+
+}

tests/src/Rules/BrowserTestBaseDefaultThemeRuleTest.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types=1);
+
+namespace PHPStan\Drupal\Rules;
+
+use PHPStan\Drupal\AnalyzerTestBase;
+
+final class BrowserTestBaseDefaultThemeRuleTest extends AnalyzerTestBase {
+
+    /**
+     * @dataProvider fileData
+     */
+    public function testRule(string $path, int $count, array $errorMessages): void
+    {
+        $errors = $this->runAnalyze($path);
+        self::assertCount($count, $errors->getErrors(), var_export($errors, true));
+        foreach ($errors->getErrors() as $key => $error) {
+            self::assertEquals($errorMessages[$key], $error->getMessage());
+        }
+    }
+
+    public function fileData(): \Generator
+    {
+        yield [
+            __DIR__ . '/../../fixtures/drupal/modules/module_with_tests/tests/src/Functional/MissingDefaultThemeTest.php',
+            1,
+            [
+                'Drupal\Tests\BrowserTestBase::$defaultTheme is required. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.',
+            ]
+        ];
+        yield [
+            __DIR__ . '/../../fixtures/drupal/modules/module_with_tests/tests/src/Functional/DefaultThemeTest.php',
+            0,
+            []
+        ];
+        yield [
+            __DIR__ . '/../../fixtures/drupal/modules/module_with_tests/tests/src/Functional/ExtendsDefaultThemeTest.php',
+            0,
+            []
+        ];
+    }
+
+
+}