[DRAFT] Pre push

grumphp.yml.dist

@@ -39,6 +39,8 @@ grumphp:
   testsuites:
     git_pre_commit:
       tasks: [phpcs, phpspec, phpunit, composer, composer_normalize, yamllint, phplint, phpparser, psalm]
+    git_pre_push:
+      tasks: [phpcs, phpspec, phpunit, composer, composer_normalize, yamllint, phplint, phpparser, psalm]
     # On CI, we run paratest separately. For some reason this currently fails in GitHub actions.
     ci:
       tasks: [phpcs, phpspec, phpunit, composer, composer_normalize, yamllint, phplint, phpparser, psalm]

resources/config/console.yml

@@ -65,6 +65,14 @@ services:
             - '@GrumPHP\IO\IOInterface'
         tags:
             - { name: 'console.command' }
+    GrumPHP\Console\Command\Git\PrePushCommand:
+        arguments:
+            - '@GrumPHP\Collection\TestSuiteCollection'
+            - '@GrumPHP\Runner\TaskRunner'
+            - '@GrumPHP\Git\GitRepository'
+            - '@GrumPHP\Locator\RegisteredFiles'
+        tags:
+            - { name: 'console.command' }
 
     # This one is loaded through the TestSuiteCompilerPass
     GrumPHP\Collection\TestSuiteCollection:

resources/hooks/local/pre-push

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+#
+# Run the hook command.
+# Note: this will be replaced by the real command during copy.
+#
+
+# Grumphp env vars
+$(ENV)
+export GRUMPHP_GIT_WORKING_DIR="$(git rev-parse --show-toplevel)"
+
+# Run GrumPHP
+cd "${HOOK_EXEC_PATH}" && $(EXEC_GRUMPHP_COMMAND) $(HOOK_COMMAND) --skip-success-output

spec/Task/Config/MetadataSpec.php

@@ -28,6 +28,7 @@ public function it_contains_an_options_resolver_with_default(): void
             'enabled' => true,
             'task' => '',
             'label' => '',
+            'git_stage' => ['pre-commit', 'pre-push'],
         ]);
     }
 

src/Console/Command/Git/DeInitCommand.php

@@ -22,6 +22,7 @@ class DeInitCommand extends Command
      */
     protected static $hooks = [
         'pre-commit',
+        'pre-push',
         'commit-msg',
     ];
 

src/Console/Command/Git/InitCommand.php

@@ -27,6 +27,7 @@ class InitCommand extends Command
      */
     public static $hooks = [
         'pre-commit',
+        'pre-push',
         'commit-msg',
     ];
 

src/Console/Command/Git/PrePushCommand.php

@@ -0,0 +1,106 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GrumPHP\Console\Command\Git;
+
+use GrumPHP\Collection\FilesCollection;
+use GrumPHP\Collection\TestSuiteCollection;
+use GrumPHP\Git\GitRepository;
+use GrumPHP\Locator\RegisteredFiles;
+use GrumPHP\Runner\TaskRunner;
+use GrumPHP\Runner\TaskRunnerContext;
+use GrumPHP\Task\Context\GitPrePushContext;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * This command runs the git pre-push hook.
+ */
+class PrePushCommand extends Command
+{
+    const COMMAND_NAME = 'git:pre-push';
+    const EXIT_CODE_OK = 0;
+    const EXIT_CODE_NOK = 1;
+    const SHA1_EMPTY = '0000000000000000000000000000000000000000';
+
+    public function __construct(
+        private readonly TestSuiteCollection $testSuites,
+        private readonly TaskRunner $taskRunner,
+        private readonly GitRepository $repository,
+        private readonly RegisteredFiles $registeredFilesLocator,
+    ) {
+        parent::__construct();
+    }
+
+    public static function getDefaultName(): string
+    {
+        return self::COMMAND_NAME;
+    }
+
+    protected function configure(): void
+    {
+        $this->setDescription('Executed by the pre-push hook');
+        $this->addOption(
+            'skip-success-output',
+            null,
+            InputOption::VALUE_NONE,
+            'Skips the success output. This will be shown by another command in the git commit hook chain.'
+        );
+    }
+
+    public function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $files = $this->getChangedFiles();
+        if ($files === null) {
+            return self::EXIT_CODE_OK;
+        }
+
+        $context = (
+            new TaskRunnerContext(
+                new GitPrePushContext($files),
+                $this->testSuites->getOptional('git_pre_push')
+            )
+        )->withSkippedSuccessOutput((bool) $input->getOption('skip-success-output'));
+
+        $output->writeln('<fg=yellow>GrumPHP detected a pre-push command.</fg=yellow>');
+
+        $results = $this->taskRunner->run($context);
+
+        return $results->isFailed() ? self::EXIT_CODE_NOK : self::EXIT_CODE_OK;
+    }
+
+    protected function getChangedFiles(): ?FilesCollection
+    {
+        $fileCollection = new FilesCollection([]);
+
+        // Loop over the commits.
+        while ($commit = trim((string) fgets(STDIN))) {
+            [$localRef, $localSha, , $remoteSha] = explode(' ', $commit);
+
+            if ($localRef === '(delete)' || $localSha === self::SHA1_EMPTY) {
+                // A branch has been deleted or there's no local branch.
+                return null;
+            }
+
+            if ($remoteSha === self::SHA1_EMPTY) {
+                // Do a full check if this is a new branch.
+                return $this->registeredFilesLocator->locate();
+            }
+
+            $args = ['--no-commit-id', '--name-only', '-r', $localSha, $remoteSha];
+            $command = (string) $this->repository->run('diff-tree', $args);
+
+            foreach (explode("\n", $command) as $file) {
+                // Avoid empty lines, missing files, and duplicates.
+                if (!empty($file) && file_exists($file) && !$fileCollection->containsKey($file)) {
+                      $fileCollection->set($file, new \SplFileInfo($file));
+                }
+            }
+        }
+
+        return $fileCollection;
+    }
+}

src/Task/AbstractExternalTask.php

@@ -14,6 +14,8 @@
  */
 abstract class AbstractExternalTask implements TaskInterface
 {
+    use GitContextTrait;
+
     /**
      * @var TaskConfigInterface
      */

src/Task/AbstractLinterTask.php

@@ -17,6 +17,8 @@
  */
 abstract class AbstractLinterTask implements TaskInterface
 {
+    use GitContextTrait;
+
     /**
      * @var TaskConfigInterface
      */

src/Task/AbstractParserTask.php

@@ -17,6 +17,8 @@
  */
 abstract class AbstractParserTask implements TaskInterface
 {
+    use GitContextTrait;
+
     /**
      * @var TaskConfigInterface
      */

src/Task/Ant.php

@@ -9,7 +9,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -36,7 +35,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
 
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     public function run(ContextInterface $context): TaskResultInterface

src/Task/Atoum.php

@@ -9,7 +9,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -47,7 +46,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     /**

src/Task/Behat.php

@@ -9,7 +9,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -43,7 +42,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     /**

src/Task/Brunch.php

@@ -9,7 +9,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -43,7 +42,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     /**

src/Task/CloverCoverage.php

@@ -11,7 +11,6 @@
 use GrumPHP\Task\Config\EmptyTaskConfig;
 use GrumPHP\Task\Config\TaskConfigInterface;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use GrumPHP\Util\Filesystem;
 use SimpleXMLElement;
@@ -22,6 +21,8 @@
 
 class CloverCoverage implements TaskInterface
 {
+    use GitContextTrait;
+
     /**
      * @var Filesystem
      */
@@ -92,7 +93,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     /**

src/Task/Codeception.php

@@ -9,7 +9,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -45,7 +44,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     /**

src/Task/Composer.php

@@ -10,7 +10,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use GrumPHP\Util\Filesystem;
 use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -61,7 +60,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
 
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     public function run(ContextInterface $context): TaskResultInterface

src/Task/ComposerNormalize.php

@@ -8,7 +8,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Process\Process;
@@ -20,7 +19,7 @@ class ComposerNormalize extends AbstractExternalTask
 {
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     public static function getConfigurableOptions(): ConfigOptionsResolver

src/Task/ComposerRequireChecker.php

@@ -9,7 +9,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -41,7 +40,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     /**

src/Task/ComposerScript.php

@@ -9,7 +9,6 @@
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Config\ConfigOptionsResolver;
 use GrumPHP\Task\Context\ContextInterface;
-use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -39,7 +38,7 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $this->isGitContextAllowed($context) || $context instanceof RunContext;
     }
 
     /**

src/Task/Config/Metadata.php

@@ -29,6 +29,7 @@ public static function getConfigurableOptions(): \GrumPHP\Task\Config\ConfigOpti
                 'enabled' => true,
                 'task' => '',
                 'label' => '',
+                'git_stage' => ['pre-commit', 'pre-push'],
             ]);
         }
 
@@ -60,6 +61,11 @@ public function label(): string
         return (string) $this->metadata['label'];
     }
 
+    public function gitStages(): array
+    {
+        return $this->metadata['git_stage'];
+    }
+
     public function toArray(): array
     {
         return $this->metadata;