Merge branch 'phpro:v2.x' into patch-2

doc/tasks/infection.md

@@ -28,6 +28,8 @@ grumphp:
             mutators: []
             ignore_patterns: []
             triggered_by: [php]
+            skip_initial_tests: false
+            coverage: ~
 ```
 
 **threads**
@@ -112,3 +114,16 @@ With this option you can skip files like tests. Leave this option blank to run a
 This option will specify which file extensions will trigger the infection task.
 By default, infection will be triggered by altering a php file. 
 You can overwrite this option to whatever file you want to use!
+
+**skip_initial_tests**
+
+*Default: false*
+
+Skip running the initial tests. If set to `true`, it is necessary to set `coverage` to the
+path where `coverage-xml` and `log-junit` is written by `phpunit` task.
+
+**coverage**
+
+*Default: ~*
+
+Path where `coverage-xml` and `log-junit` is written by `phpunit` task.

resources/config/util.yml

@@ -20,5 +20,7 @@ services:
               '7.3': '2021-12-06 23:59:59'
               '7.4': '2022-11-28 23:59:59'
               '8.0': '2023-11-26 23:59:59'
-              '8.1': '2024-11-25 23:59:59'
-              '8.2': '2025-12-08 23:59:59'
+              '8.1': '2025-12-31 23:59:59'
+              '8.2': '2026-12-31 23:59:59'
+              '8.3': '2027-12-31 23:59:59'
+              '8.4': '2028-12-31 23:59:59'

spec/Process/ProcessBuilderSpec.php

@@ -84,6 +84,17 @@ public function getMatchers(): array
     {
         return [
             'beQuoted' => function ($subject, $string) {
+                if ('\\' === DIRECTORY_SEPARATOR) {
+                    if ($subject !== $string) {
+                        throw new FailureException(sprintf(
+                            'Expected %s, got %s.',
+                            $string,
+                            $subject
+                        ));
+                    }
+                    return true;
+                }
+
                 $regex = sprintf('{^([\'"])%s\1$}', preg_quote($string));
                 if (!preg_match($regex, $subject)) {
                     throw new FailureException(sprintf(

spec/Process/ProcessFactorySpec.php

@@ -42,6 +42,17 @@ public function getMatchers(): array
     {
         return [
             'beQuoted' => function ($subject, $string) {
+                if ('\\' === DIRECTORY_SEPARATOR) {
+                    if ($subject !== $string) {
+                        throw new FailureException(sprintf(
+                            'Expected %s, got %s.',
+                            $string,
+                            $subject
+                        ));
+                    }
+                    return true;
+                }
+
                 $regex = sprintf('{^([\'"])%s\1$}', preg_quote($string));
                 if (!preg_match($regex, $subject)) {
                     throw new FailureException(sprintf(

src/Configuration/Loader/DistFileLoader.php

@@ -18,12 +18,12 @@ public function __construct(LoaderInterface $loader)
         $this->loader = $loader;
     }
 
-    public function load(mixed $resource, string $type = null): mixed
+    public function load(mixed $resource, ?string $type = null): mixed
     {
         return $this->loader->load($resource, $type);
     }
 
-    public function supports(mixed $resource, string $type = null): bool
+    public function supports(mixed $resource, ?string $type = null): bool
     {
         if (!\is_string($resource)) {
             return false;

src/Console/Command/ConfigureCommand.php

@@ -147,7 +147,7 @@ protected function buildConfiguration(InputInterface $input, OutputInterface $ou
         ];
     }
 
-    protected function createQuestionString(string $question, string $default = null, string $separator = ':'): string
+    protected function createQuestionString(string $question, ?string $default = null, string $separator = ':'): string
     {
         return null !== $default ?
             sprintf('<fg=green>%s</fg=green> [<fg=yellow>%s</fg=yellow>]%s ', $question, $default, $separator) :

src/Event/Dispatcher/Bridge/SymfonyEventDispatcher.php

@@ -24,7 +24,7 @@ public function __construct($eventDispatcher)
         $this->dispatcher = $eventDispatcher;
     }
 
-    public function dispatch(Event $event, string $name = null): void
+    public function dispatch(Event $event, ?string $name = null): void
     {
         $interfacesImplemented = class_implements($this->dispatcher);
         if (in_array(SymfonyEventDispatcherContract::class, $interfacesImplemented, true)) {

src/Event/Dispatcher/EventDispatcherInterface.php

@@ -8,5 +8,5 @@
 
 interface EventDispatcherInterface
 {
-    public function dispatch(Event $event, string $name = null): void;
+    public function dispatch(Event $event, ?string $name = null): void;
 }

src/Locator/GitRepositoryDirLocator.php

@@ -35,13 +35,55 @@ public function locate(string $gitDir): string
 
         $gitRepositoryDir = $matches[1];
 
-        if ($this->filesystem->isAbsolutePath($gitRepositoryDir)) {
-            return $gitRepositoryDir;
+        if ($this->isWorktree($gitRepositoryDir)) {
+            return $this->locateWorktreeRoot($gitRepositoryDir);
         }
 
         return $this->filesystem->buildPath(
             dirname($gitDir),
             $gitRepositoryDir
         );
     }
+
+    /**
+     * If a given path (from gitdir value) is absolute and there is a commondir file, it is
+     * a worktree.
+     */
+    private function isWorktree(string $gitDir): bool
+    {
+        return $this->filesystem->isAbsolutePath($gitDir)
+            && $this->filesystem->isFile($gitDir.DIRECTORY_SEPARATOR.'commondir');
+    }
+
+    /**
+     * Retreiving repository dir for worktree nominally returns path to the configured worktree,
+     * which does not hold hooks. We need to resolve the actual repository root.
+     *
+     * Example directory structure:
+     * ```
+     * /project
+     *   .git/
+     *     .git/hooks/
+     *     .git/worktrees/
+     *       worktree1
+     *         commondir: relative path to /project/.git
+     * /worktree1
+     *   .git: file with path to /project/.git/worktrees/worktree1
+     * ```
+     */
+    private function locateWorktreeRoot(string $gitRepositoryDir): string
+    {
+        $worktreeRelativeRoot = trim(
+            $this->filesystem->readPath(
+                $gitRepositoryDir.DIRECTORY_SEPARATOR.'commondir'
+            )
+        );
+
+        return $this->filesystem->realpath(
+            $this->filesystem->makePathAbsolute(
+                $worktreeRelativeRoot,
+                $gitRepositoryDir
+            )
+        );
+    }
 }

src/Parser/Php/Configurator/TraverserConfigurator.php

@@ -61,7 +61,7 @@ public function registerVisitorId(string $alias, string $visitorId): void
     /**
      * @throws \GrumPHP\Exception\RuntimeException
      */
-    public function registerStandardEnabledVisitor(string $alias, array $visitorOptions = null): void
+    public function registerStandardEnabledVisitor(string $alias, ?array $visitorOptions = null): void
     {
         if (array_key_exists($alias, $this->standardEnabledVisitors)) {
             throw new RuntimeException(

src/Process/ProcessBuilder.php

@@ -41,7 +41,7 @@ public function __construct(ExternalCommand $externalCommandLocator, IOInterface
      */
     public function createArgumentsForCommand(
         string $command,
-        callable $pathManipulator = null
+        ?callable $pathManipulator = null
     ): ProcessArgumentsCollection {
         $executable = $this->externalCommandLocator->locate($command);
         $manipulatedExecutable = $pathManipulator ? $pathManipulator($executable) : $executable;

src/Runner/TaskRunnerContext.php

@@ -43,7 +43,7 @@ class TaskRunnerContext
      */
     public function __construct(
         ContextInterface $taskContext,
-        TestSuiteInterface $testSuite = null,
+        ?TestSuiteInterface $testSuite = null,
         array $taskNames = []
     ) {
         $this->taskContext = $taskContext;

src/Task/Infection.php

@@ -34,6 +34,8 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
             'mutators' => [],
             'ignore_patterns' => [],
             'triggered_by' => ['php'],
+            'skip_initial_tests' => false,
+            'coverage' => null,
         ]);
 
         $resolver->addAllowedTypes('threads', ['null', 'int']);
@@ -47,6 +49,8 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
         $resolver->addAllowedTypes('mutators', ['array']);
         $resolver->addAllowedTypes('ignore_patterns', ['array']);
         $resolver->addAllowedTypes('triggered_by', ['array']);
+        $resolver->addAllowedTypes('skip_initial_tests', ['bool']);
+        $resolver->addAllowedTypes('coverage', ['null', 'string']);
 
         return ConfigOptionsResolver::fromOptionsResolver($resolver);
     }
@@ -84,6 +88,8 @@ public function run(ContextInterface $context): TaskResultInterface
         $arguments->addOptionalArgument('--configuration=%s', $config['configuration']);
         $arguments->addOptionalArgument('--min-msi=%s', $config['min_msi']);
         $arguments->addOptionalArgument('--min-covered-msi=%s', $config['min_covered_msi']);
+        $arguments->addOptionalArgument('--coverage=%s', $config['coverage']);
+        $arguments->addOptionalArgument('--skip-initial-tests', $config['skip_initial_tests']);
         $arguments->addOptionalCommaSeparatedArgument('--mutators=%s', $config['mutators']);
 
         if ($context instanceof GitPreCommitContext) {

test/E2E/AbstractE2ETestCase.php

@@ -73,6 +73,8 @@ protected function initializeGitSubModule(string $gitPath, string $submodulePath
         $process = new Process(
             [
                 $this->executableFinder->find('git'),
+                '-c',
+                'protocol.file.allow=always',
                 'submodule',
                 'add',
                 '-f',
@@ -174,7 +176,7 @@ protected function mergeComposerConfig(string $composerFile, array $config, $rec
         $this->dumpFile($composerFile, json_encode($newSource,  $flags));
     }
 
-    protected function ensureHooksExist(string $gitPath = null, string $containsPattern = '{grumphp}')
+    protected function ensureHooksExist(?string $gitPath = null, string $containsPattern = '{grumphp}')
     {
         $gitPath = $gitPath ?: $this->rootDir;
         $hooks = ['pre-commit', 'commit-msg'];
@@ -346,7 +348,7 @@ protected function installComposer(string $path, array $arguments = [])
         $this->runCommand('install composer', $process);
     }
 
-    protected function commitAll(string $gitPath = null)
+    protected function commitAll(?string $gitPath = null)
     {
         $gitPath = $gitPath ?: $this->rootDir;
         $git = $this->executableFinder->find('git');
@@ -362,7 +364,7 @@ protected function commitAll(string $gitPath = null)
      * --all: Tell the command to automatically stage files that have been modified and deleted,
      * but new files you have not told Git about are not affected.
      */
-    protected function commitModifiedAndDeleted(string $gitPath = null)
+    protected function commitModifiedAndDeleted(?string $gitPath = null)
     {
         $gitPath = $gitPath ?: $this->rootDir;
         $git = $this->executableFinder->find('git');
@@ -382,7 +384,7 @@ protected function runGrumphp(string $projectPath, string $vendorPath = './vendo
     {
         $projectPath = $this->relativeRootPath($projectPath);
         $process = new Process(
-            [$vendorPath.'/bin/grumphp', 'run', '-vvv'],
+            [$this->executableFinder->find('php'), $vendorPath.'/bin/grumphp', 'run', '-vvv'],
             $projectPath
         );
 
@@ -396,7 +398,7 @@ protected function runGrumphpWithConfig(string $projectPath, string $grumphpFile
         $projectPath = $this->relativeRootPath($projectPath);
         $this->runCommand('grumphp run with config',
             new Process(
-                [$vendorPath.'/bin/grumphp', 'run', '-vvv', '--config='.$grumphpFile],
+                [$this->executableFinder->find('php'), $vendorPath.'/bin/grumphp', 'run', '-vvv', '--config='.$grumphpFile],
                 $projectPath
             )
         );
@@ -407,7 +409,7 @@ protected function runGrumphpInfo(string $projectPath, $vendorPath = './vendor')
         $projectPath = $this->relativeRootPath($projectPath);
         $this->runCommand('grumphp info',
             new Process(
-                [$vendorPath.'/bin/grumphp'],
+                [$this->executableFinder->find('php'), $vendorPath.'/bin/grumphp'],
                 $projectPath
             )
         );
@@ -418,7 +420,7 @@ protected function initializeGrumphpGitHooksWithConfig(string $grumphpFile, $ven
         $this->runCommand(
             'grumphp git:init',
             new Process(
-                [$vendorPath.'/bin/grumphp', 'git:init', '--config='.$grumphpFile],
+                [$this->executableFinder->find('php'), $vendorPath.'/bin/grumphp', 'git:init', '--config='.$grumphpFile],
                 $this->rootDir
             )
         );

test/E2E/GitHookParametersTest.php

@@ -48,7 +48,7 @@ function it_can_specify_hook_exec_command_with_additional_arguments()
 
         $this->installComposer($this->rootDir);
 
-        $hookPattern = sprintf('{[\'"]%s[\'"] [\'"]-d date\.timezone=Europe/Brussels[\'"]}', preg_quote($php));
+        $hookPattern = sprintf('{([\'"]?)%s([\'"]?) [\'"]-d date\.timezone=Europe/Brussels[\'"]}', preg_quote($php));
         $this->ensureHooksExist($this->rootDir, $hookPattern);
 
         $this->enableValidatePathsTask($grumphpFile, $this->rootDir);

test/Unit/Locator/GitRepositoryDirLocatorTest.php

@@ -31,7 +31,7 @@ protected function setUp(): void
 
         $this->filesystem               = new Filesystem();
         $this->locator                  = new GitRepositoryDirLocator($this->filesystem);
-        $this->gitDir = $this->workspace . DIRECTORY_SEPARATOR . '.git';
+        $this->gitDir                   = $this->workspace . DIRECTORY_SEPARATOR . '.git';
     }
 
     /**
@@ -69,7 +69,11 @@ public function it_can_passthrough_git_dir_path_if_file_is_not_parseable(): void
      */
     public function it_can_locate_git_dir_in_workspaces(): void
     {
-        $this->filesystem->dumpFile($this->gitDir, 'gitdir: /dev/null');
-        $this->assertEquals('/dev/null', $this->locator->locate($this->gitDir));
+        $ourWorktreeProject = $this->workspace.'/project1/';
+        $worktreeGitRoot = $this->gitDir.'/worktrees/worktree1/';
+        mkdir($worktreeGitRoot, 0777, true);
+        $this->filesystem->dumpFile($worktreeGitRoot.'/commondir', '../..');
+        $this->filesystem->dumpFile($ourWorktreeProject.'/.git', 'gitdir: '.$this->gitDir.'/worktrees/worktree1');
+        $this->assertEquals($this->gitDir, $this->locator->locate($this->gitDir));
     }
 }

test/Unit/Task/InfectionTest.php

@@ -36,6 +36,8 @@ public function provideConfigurableOptions(): iterable
                 'mutators' => [],
                 'ignore_patterns' => [],
                 'triggered_by' => ['php'],
+                'skip_initial_tests' => false,
+                'coverage' => null
             ]
         ];
     }
@@ -233,5 +235,29 @@ public function provideExternalTaskRuns(): iterable
                 '--filter=hello.php,hello2.php'
             ]
         ];
+        yield 'skip-initial-tests' => [
+            [
+                'skip_initial_tests' => true,
+            ],
+            $this->mockContext(RunContext::class, ['hello.php', 'hello2.php']),
+            'infection',
+            [
+                '--no-interaction',
+                '--ignore-msi-with-no-mutations',
+                '--skip-initial-tests'
+            ]
+        ];
+        yield 'coverage' => [
+            [
+                'coverage' => '/path/to/coverage',
+            ],
+            $this->mockContext(RunContext::class, ['hello.php', 'hello2.php']),
+            'infection',
+            [
+                '--no-interaction',
+                '--ignore-msi-with-no-mutations',
+                '--coverage=/path/to/coverage'
+            ]
+        ];
     }
 }