test: centralize tooling excluded directories and cleanup fixture handling

Author: coisa

.agents/skills/phpunit-tests/SKILL.md

@@ -83,4 +83,57 @@ Choose the smallest command that proves the change.
 - Re-run after fixes until the targeted tests pass.
 - If failures come from unrelated pre-existing breakage, call that out separately and do not silently claim success.
 
+### Composer plugin validation flow
+
+Some repository test scenarios are only valid when DevTools is executed as a Composer plugin.
+Create a temporary fixture under `backup/` before running plugin-based verification.
+
+```bash
+PROJECT_ROOT="$(pwd)"
+PLUGIN_FIXTURE="$PROJECT_ROOT/backup/composer-plugin-consumer"
+mkdir -p "$PROJECT_ROOT/backup"
+rm -rf "$PLUGIN_FIXTURE"
+mkdir -p "$PLUGIN_FIXTURE"
+
+cat > "$PLUGIN_FIXTURE/composer.json" <<'JSON'
+{
+    "name": "fast-forward/dev-tools-composer-plugin-consumer-fixture",
+    "description": "Fixture project used to validate DevTools plugin behavior.",
+    "license": "MIT",
+    "type": "project",
+    "require": {
+        "fast-forward/dev-tools": "*@dev"
+    },
+    "repositories": [
+        {
+            "type": "path",
+            "url": "../..",
+            "options": {
+                "symlink": true
+            }
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "config": {
+        "allow-plugins": {
+            "ergebnis/composer-normalize": true,
+            "fast-forward/dev-tools": true,
+            "phpdocumentor/shim": true,
+            "phpro/grumphp-shim": true,
+            "pyrech/composer-changelogs": true
+        }
+    },
+    "scripts": {
+        "dev-tools": "dev-tools",
+        "dev-tools:fix": "@dev-tools --fix"
+    }
+}
+JSON
+
+cd "$PLUGIN_FIXTURE"
+composer install
+composer tests
+```
+
 Read [references/generation-checklist.md](references/generation-checklist.md) before writing or repairing tests in an unfamiliar repository.

.php-cs-fixer.dist.php

@@ -2,6 +2,10 @@
 
 declare(strict_types=1);
 
+require __DIR__ . '/vendor/autoload.php';
+
+use FastForward\DevTools\Path\WorkingProjectPathResolver;
+
 $rules = [
     'phpdoc_indent' => true,
     'phpdoc_order' => [
@@ -39,11 +43,7 @@
 
 $finder = PhpCsFixer\Finder::create()
     ->in([getcwd()])
-    ->exclude('public')
-    ->exclude('resources')
-    ->exclude('vendor')
-    ->exclude('tmp')
-;
+    ->exclude(WorkingProjectPathResolver::TOOLING_EXCLUDED_DIRECTORIES);
 
 return (new PhpCsFixer\Config())
     ->setRiskyAllowed(false)

docs/commands/metrics.rst

@@ -33,7 +33,7 @@ Options
    Comma-separated directories that should be excluded from analysis.
 
    Default:
-   ``vendor,tmp,cache,spec,build,.dev-tools,backup,resources,tests/Fixtures``.
+   ``vendor,tmp,cache,spec,build,.dev-tools,backup,resources``.
 
 ``--target=<directory>``
    Output directory for the generated metrics reports.

src/Console/Command/MetricsCommand.php

@@ -89,7 +89,7 @@ protected function configure(): void
                 name: 'exclude',
                 mode: InputOption::VALUE_OPTIONAL,
                 description: 'Comma-separated directories that SHOULD be excluded from analysis.',
-                default: 'vendor,tmp,cache,spec,build,.dev-tools,backup,resources,tests/Fixtures',
+                default: 'vendor,tmp,cache,spec,build,.dev-tools,backup,resources',
             )
             ->addOption(
                 name: 'target',

src/Path/WorkingProjectPathResolver.php

@@ -29,6 +29,23 @@
  */
 final class WorkingProjectPathResolver
 {
+    /**
+     * @var list<string> repository-local directories ignored by tooling
+     */
+    public const array TOOLING_EXCLUDED_DIRECTORIES = [
+        '.dev-tools',
+        'backup',
+        'cache',
+        'public',
+        'resources',
+        'tmp',
+        'vendor',
+        '*/vendor',
+        '*/vendor/*',
+        '**/vendor',
+        '**/vendor/*',
+    ];
+
     /**
      * Returns the current working project directory or a path under it.
      *
@@ -52,19 +69,27 @@ public static function getProjectPath(string $path = ''): string
      */
     public static function getToolingExcludedDirectories(string $baseDir = ''): array
     {
-        return [
-            ManagedWorkspace::getOutputDirectory(baseDir: $baseDir),
-            Path::join($baseDir, 'backup'),
-            Path::join($baseDir, 'cache'),
-            Path::join($baseDir, 'public'),
-            Path::join($baseDir, 'resources'),
-            Path::join($baseDir, 'tmp'),
-            Path::join($baseDir, 'vendor'),
-            Path::join($baseDir, '*/vendor'),
-            Path::join($baseDir, '*/vendor/*'),
-            Path::join($baseDir, '**/vendor'),
-            Path::join($baseDir, '**/vendor/*'),
+        $excludeFromBaseDir = [
+            '.dev-tools' => ManagedWorkspace::getOutputDirectory(baseDir: $baseDir),
+            'backup' => Path::join($baseDir, 'backup'),
+            'cache' => Path::join($baseDir, 'cache'),
+            'public' => Path::join($baseDir, 'public'),
+            'resources' => Path::join($baseDir, 'resources'),
+            'tmp' => Path::join($baseDir, 'tmp'),
+            'vendor' => Path::join($baseDir, 'vendor'),
+            '*/vendor' => Path::join($baseDir, '*/vendor'),
+            '*/vendor/*' => Path::join($baseDir, '*/vendor/*'),
+            '**/vendor' => Path::join($baseDir, '**/vendor'),
+            '**/vendor/*' => Path::join($baseDir, '**/vendor/*'),
         ];
+
+        $directories = [];
+
+        foreach (self::TOOLING_EXCLUDED_DIRECTORIES as $excludedDirectory) {
+            $directories[] = $excludeFromBaseDir[$excludedDirectory];
+        }
+
+        return $directories;
     }
 
     /**
@@ -81,7 +106,7 @@ public static function getToolingSourcePaths(string $baseDir = ''): array
             ->files()
             ->name('*.php')
             ->in($workingDirectory)
-            ->exclude(['.dev-tools', 'backup', 'cache', 'public', 'resources', 'tmp', 'vendor'])
+            ->exclude(self::TOOLING_EXCLUDED_DIRECTORIES)
             ->sortByName();
         $paths = [];
 

tests/Console/Command/MetricsCommandTest.php

@@ -73,7 +73,7 @@ protected function setUp(): void
         $this->process = $this->prophesize(Process::class);
 
         $this->input->getOption('exclude')
-            ->willReturn('vendor,tests/Fixtures');
+            ->willReturn('vendor');
         $this->input->getOption('target')
             ->willReturn(ManagedWorkspace::getOutputDirectory(ManagedWorkspace::METRICS));
         $this->input->getOption('junit')

tests/Fixtures/composer-plugin-consumer/.gitignore

@@ -26,11 +26,13 @@
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 
+use function Safe\scandir;
+use function Safe\rmdir;
+use function Safe\unlink;
 use function Safe\file_put_contents;
 use function Safe\getcwd;
 use function Safe\mkdir;
 use function Safe\realpath;
-use function sys_get_temp_dir;
 use function uniqid;
 
 #[CoversClass(WorkingProjectPathResolver::class)]
@@ -113,9 +115,9 @@ public function itWillExposeRelativeToolingSkipPatternsByDefault(): void
      * @return void
      */
     #[Test]
-    public function itWillExposeToolingSourcePathsWithoutTraversingVendorDirectories(): void
+    public function itWillExposeToolingSourcePathsIgnoringExcludedDirectories(): void
     {
-        $fixtureDirectory = sys_get_temp_dir() . '/dev-tools-path-resolver-' . uniqid();
+        $fixtureDirectory = \dirname(__DIR__, 2) . '/backup/dev-tools-path-resolver-' . uniqid();
 
         mkdir($fixtureDirectory . '/src', recursive: true);
         mkdir($fixtureDirectory . '/tests/Fixtures/consumer/vendor/package/src', recursive: true);
@@ -130,13 +132,55 @@ public function itWillExposeToolingSourcePathsWithoutTraversingVendorDirectories
         file_put_contents($fixtureDirectory . '/backup/Backup.php', '<?php');
         file_put_contents($fixtureDirectory . '/.dev-tools/cache/Cached.php', '<?php');
 
-        self::assertSame(
-            [
-                realpath($fixtureDirectory) . '/src/Example.php',
-                realpath($fixtureDirectory) . '/tests/Fixtures/Example.php',
-            ],
-            WorkingProjectPathResolver::getToolingSourcePaths(realpath($fixtureDirectory))
-        );
+        try {
+            self::assertSame(
+                [
+                    realpath($fixtureDirectory) . '/src/Example.php',
+                    realpath($fixtureDirectory) . '/tests/Fixtures/Example.php',
+                ],
+                WorkingProjectPathResolver::getToolingSourcePaths(realpath($fixtureDirectory))
+            );
+        } finally {
+            self::cleanupFixtureDirectory($fixtureDirectory);
+        }
+    }
+
+    /**
+     * @param string $fixtureDirectory
+     *
+     * @return void
+     */
+    private static function cleanupFixtureDirectory(string $fixtureDirectory): void
+    {
+        if (! is_dir($fixtureDirectory) && ! is_link($fixtureDirectory)) {
+            return;
+        }
+
+        $entries = scandir($fixtureDirectory);
+        if (false === $entries) {
+            return;
+        }
+
+        foreach ($entries as $entry) {
+            if ('.' === $entry) {
+                continue;
+            }
+
+            if ('..' === $entry) {
+                continue;
+            }
+
+            $path = $fixtureDirectory . '/' . $entry;
+
+            if (is_link($path) || is_file($path)) {
+                unlink($path);
+                continue;
+            }
+
+            self::cleanupFixtureDirectory($path);
+        }
+
+        rmdir($fixtureDirectory);
     }
 
     /**