TenantAtlas/tests/Feature/Guards/NoLegacyRunsTest.php

<?php

use Illuminate\Support\Collection;

it('does not contain legacy run references', function () {
    $root = base_path();
    $self = realpath(__FILE__);

    $directories = [
        $root.'/app',
        $root.'/database',
        $root.'/resources',
        $root.'/routes',
    ];

    $excludedPaths = [
        $root.'/vendor',
        $root.'/storage',
        $root.'/specs',
        $root.'/spechistory',
        $root.'/docs',
        $root.'/references',
        $root.'/bootstrap/cache',
        $root.'/database/migrations',
    ];

    $forbiddenPatterns = [
        '/\\bInventorySyncRun\\b/',
        '/\\binventory_sync_runs\\b/',
        '/\\bInventorySyncRunResource\\b/',
        '/\\bEntraGroupSyncRun\\b/',
        '/\\bentra_group_sync_runs\\b/',
        '/\\bEntraGroupSyncRunResource\\b/',
        '/\\bBackupScheduleRun\\b/',
        '/\\bbackup_schedule_runs\\b/',
        '/\\bBackupScheduleRunsRelationManager\\b/',
        '/\\bbackupScheduleRunId\\b/',
        '/\\bBackupScheduleRunDispatchedNotification\\b/',
        '/inventory sync runs/i',
    ];

    $allowedExceptions = [
        '/\\bbackupScheduleRunId\\b/' => [
            'app/Jobs/RunBackupScheduleJob.php',
        ],
    ];

    /** @var Collection<int, string> $files */
    $files = collect($directories)
        ->filter(fn (string $dir): bool => is_dir($dir))
        ->flatMap(function (string $dir): array {
            $iterator = new RecursiveIteratorIterator(
                new RecursiveDirectoryIterator($dir, FilesystemIterator::SKIP_DOTS)
            );

            $paths = [];

            foreach ($iterator as $file) {
                if (! $file->isFile()) {
                    continue;
                }

                $paths[] = $file->getPathname();
            }

            return $paths;
        })
        ->filter(function (string $path) use ($excludedPaths, $self): bool {
            if ($self && realpath($path) === $self) {
                return false;
            }

            foreach ($excludedPaths as $excluded) {
                if (str_starts_with($path, $excluded)) {
                    return false;
                }
            }

            return true;
        })
        ->values();

    $hits = [];

    foreach ($files as $path) {
        $contents = file_get_contents($path);

        if (! is_string($contents) || $contents === '') {
            continue;
        }

        foreach ($forbiddenPatterns as $pattern) {
            if (! preg_match($pattern, $contents)) {
                continue;
            }

            $lines = preg_split('/\R/', $contents) ?: [];

            foreach ($lines as $index => $line) {
                if (preg_match($pattern, $line)) {
                    $relative = str_replace($root.'/', '', $path);

                    if (array_key_exists($pattern, $allowedExceptions) && in_array($relative, $allowedExceptions[$pattern], true)) {
                        continue;
                    }

                    $hits[] = $relative.':'.($index + 1).' -> '.trim($line);
                }
            }
        }
    }

    expect($hits)->toBeEmpty('Legacy run references found:\n'.implode("\n", $hits));
});