Reuse ShipMonk generic RuleTestCase (#243)

Author: janedbal

composer.json

@@ -32,6 +32,7 @@
         "shipmonk/coding-standard": "^0.1.3",
         "shipmonk/composer-dependency-analyser": "^1.8.2",
         "shipmonk/name-collision-detector": "^2.1.1",
+        "shipmonk/phpstan-dev": "^0.1.0",
         "shipmonk/phpstan-rules": "^4.1.0",
         "symfony/contracts": "^2.5 || ^3.0",
         "symfony/dependency-injection": "^5.4 || ^6.0 || ^7.0",

composer.lock

@@ -40,7 +40,7 @@ parameters:
             superclassToSuffixMapping:
                 PHPStan\Rules\Rule: Rule
                 PHPStan\Collectors\Collector: Collector
-                ShipMonk\PHPStan\DeadCode\Rule\RuleTestCase: RuleTest
+                ShipMonk\PHPStanDev\RuleTestCase: RuleTest
                 ShipMonk\PHPStan\DeadCode\Graph\ClassMemberRef: Ref
                 ShipMonk\PHPStan\DeadCode\Graph\ClassMemberUsage: Usage
                 ShipMonk\PHPStan\DeadCode\Provider\MemberUsageProvider: UsageProvider

phpstan.neon.dist

@@ -51,6 +51,7 @@
 use ShipMonk\PHPStan\DeadCode\Provider\VendorUsageProvider;
 use ShipMonk\PHPStan\DeadCode\Provider\VirtualUsageData;
 use ShipMonk\PHPStan\DeadCode\Transformer\FileSystem;
+use ShipMonk\PHPStanDev\RuleTestCase as ShipMonkRuleTestCase;
 use Throwable;
 use Traversable;
 use function array_filter;
@@ -73,9 +74,9 @@
 use const PHP_VERSION_ID;
 
 /**
- * @extends RuleTestCase<DeadCodeRule>
+ * @extends ShipMonkRuleTestCase<DeadCodeRule>
  */
-class DeadCodeRuleTest extends RuleTestCase
+class DeadCodeRuleTest extends ShipMonkRuleTestCase
 {
 
     /**
@@ -225,25 +226,25 @@ private function doTestDead(
             self::markTestSkipped('Requirements not met');
         }
 
-        $this->analyseFiles(is_array($files) ? $files : [$files]);
+        $this->analyzeFiles(is_array($files) ? $files : [$files]);
     }
 
     public function testMixedCallsTracked(): void
     {
-        $this->analyseFiles([__DIR__ . '/data/methods/mixed/tracked.php']);
-        $this->analyseFiles([__DIR__ . '/data/constants/mixed/tracked.php']);
+        $this->analyzeFiles([__DIR__ . '/data/methods/mixed/tracked.php']);
+        $this->analyzeFiles([__DIR__ . '/data/constants/mixed/tracked.php']);
     }
 
     public function testMixedCallsNotTracked(): void
     {
         $this->trackMixedAccess = false;
-        $this->analyseFiles([__DIR__ . '/data/methods/mixed/untracked.php']);
-        $this->analyseFiles([__DIR__ . '/data/constants/mixed/untracked.php']);
+        $this->analyzeFiles([__DIR__ . '/data/methods/mixed/untracked.php']);
+        $this->analyzeFiles([__DIR__ . '/data/constants/mixed/untracked.php']);
     }
 
     public function testDiagnoseMixedCalls(): void
     {
-        $this->analyseFiles([__DIR__ . '/data/methods/mixed/tracked.php']);
+        $this->analyzeFiles([__DIR__ . '/data/methods/mixed/tracked.php']);
         $rule = $this->getRule();
 
         $actualOutput = '';
@@ -267,7 +268,7 @@ public function testDiagnoseMixedCalls(): void
 
     public function testDiagnoseFullyMixedCalls(): void
     {
-        $this->analyseFiles([__DIR__ . '/data/mixed-member/full-mixed-method.php']);
+        $this->analyzeFiles([__DIR__ . '/data/mixed-member/full-mixed-method.php']);
         $rule = $this->getRule();
 
         $actualOutput = '';
@@ -289,7 +290,7 @@ public function testDiagnoseFullyMixedCalls(): void
 
     public function testDiagnoseFullyMixedFetches(): void
     {
-        $this->analyseFiles([__DIR__ . '/data/mixed-member/full-mixed-const.php']);
+        $this->analyzeFiles([__DIR__ . '/data/mixed-member/full-mixed-const.php']);
         $rule = $this->getRule();
 
         $actualOutput = '';
@@ -333,7 +334,7 @@ public function testDebugUsage(): void
             'DebugUnsupported\Foo::notDead',
             'DebugZero\Foo::__construct',
         ];
-        $this->analyseFiles([
+        $this->analyzeFiles([
             __DIR__ . '/data/debug/alternative.php',
             __DIR__ . '/data/debug/builtin.php',
             __DIR__ . '/data/debug/ctor.php',
@@ -433,7 +434,7 @@ public function testDebugUsageInvalidArgs(
         $this->expectExceptionMessage($error);
 
         $this->debugMembers = [$member];
-        $this->analyseFiles([__DIR__ . '/data/debug/alternative.php']);
+        $this->analyzeFiles([__DIR__ . '/data/debug/alternative.php']);
         $this->getRule();
     }
 
@@ -1188,6 +1189,20 @@ private function trimFgColors(string $output): string
         return $replaced;
     }
 
+    /**
+     * @param list<Error> $actualErrors
+     * @return list<string>
+     */
+    protected function processActualErrors(array $actualErrors): array
+    {
+        foreach ($actualErrors as $error) {
+            self::assertNotNull($error->getIdentifier(), "Missing error identifier for error: {$error->getMessage()}");
+            self::assertStringStartsWith('shipmonk.', $error->getIdentifier(), "Unexpected error identifier for: {$error->getMessage()}");
+        }
+
+        return parent::processActualErrors($actualErrors);
+    }
+
     /**
      * Allows secondary analysis within same testcase with different setup
      */