Pre push testsuites

README.md

@@ -119,6 +119,7 @@ Since GrumPHP is just a CLI tool, these commands can be triggered:
 - [git:deinit](doc/commands.md#installation)
 - [git:pre-commit](doc/commands.md#git-hooks)
 - [git:commit-msg](doc/commands.md#git-hooks)
+- [git:pre-push](doc/commands.md#git-hooks)
 - [run](doc/commands.md#run)
 
 ## Compatibility

doc/commands.md

@@ -26,6 +26,7 @@ GrumPHP will be triggered with GIT hooks. However, you can run following command
 ```sh
 php ./vendor/bin/grumphp git:pre-commit
 php ./vendor/bin/grumphp git:commit-msg
+php ./vendor/bin/grumphp git:pre-push
 ```
 
 Both commands support raw git diffs and file lists as STDIN input. 
@@ -76,4 +77,3 @@ git ls-files src | php ./vendor/bin/grumphp run
 ```
 
 :exclamation: *If you use the stdin, we won't be able to answer questions interactively.*
-

doc/testsuites.md

@@ -44,4 +44,7 @@ grumphp:
         # Specify the test-suite for the git:pre-commit command:
         git_pre_commit:
             tasks: []
+        # Specify the test-suite for the git:pre-push command:
+        git_pre_push:
+            tasks: []
 ```

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,15 @@ services:
             - '@GrumPHP\IO\IOInterface'
         tags:
             - { name: 'console.command' }
+    GrumPHP\Console\Command\Git\PrePushCommand:
+      arguments:
+        - '@GrumPHP\Collection\TestSuiteCollection'
+        - '@GrumPHP\Locator\StdInFiles'
+        - '@GrumPHP\Locator\ChangedFiles'
+        - '@GrumPHP\Runner\TaskRunner'
+        - '@GrumPHP\IO\IOInterface'
+      tags:
+        - { name: 'console.command' }
 
     # This one is loaded through the TestSuiteCompilerPass
     GrumPHP\Collection\TestSuiteCollection:

resources/hooks/local/pre-push

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+$(ENV)
+
+# Run GrumPHP
+(cd "${HOOK_EXEC_PATH}" | $(EXEC_GRUMPHP_COMMAND) $(HOOK_COMMAND))

resources/hooks/vagrant/pre-push

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+$(ENV)
+
+# Run GrumPHP
+cd $(VAGRANT_HOST_DIR) && vagrant ssh --command '$(which sh)' << COMMANDS
+  cd $(VAGRANT_PROJECT_DIR)
+
+  # Add grumphp envs:
+  $(ENV)
+
+  $(EXEC_GRUMPHP_COMMAND) $(HOOK_COMMAND))
+COMMANDS

src/Console/Command/Git/PrePushCommand.php

@@ -0,0 +1,115 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GrumPHP\Console\Command\Git;
+
+use GrumPHP\Collection\FilesCollection;
+use GrumPHP\Collection\TestSuiteCollection;
+use GrumPHP\IO\IOFactory;
+use GrumPHP\IO\IOInterface;
+use GrumPHP\Locator\ChangedFiles;
+use GrumPHP\Locator\StdInFiles;
+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;
+
+    /**
+     * @var TestSuiteCollection
+     */
+    private $testSuites;
+
+    /**
+     * @var StdInFiles
+     */
+    private $stdInFilesLocator;
+
+    /**
+     * @var ChangedFiles
+     */
+    private $changedFilesLocator;
+
+    /**
+     * @var TaskRunner
+     */
+    private $taskRunner;
+
+    private IOInterface $io;
+
+    public function __construct(
+        TestSuiteCollection $testSuites,
+        StdInFiles $stdInFilesLocator,
+        ChangedFiles $changedFilesLocator,
+        TaskRunner $taskRunner,
+        IOInterface $io
+    ) {
+        parent::__construct();
+
+        $this->testSuites = $testSuites;
+        $this->stdInFilesLocator = $stdInFilesLocator;
+        $this->changedFilesLocator = $changedFilesLocator;
+        $this->taskRunner = $taskRunner;
+        $this->io = $io;
+    }
+
+    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
+    {
+        $localRef = $this->changedFilesLocator->getLocalRef();
+        $localSha = $this->changedFilesLocator->getLocalSHA1();
+        $remoteSha = $this->changedFilesLocator->getRemoteSHA1();
+
+        $taskRunnerContext = (
+            new TaskRunnerContext(
+                new GitPrePushContext($this->getPushedFiles($localRef, $localSha, $remoteSha)),
+                $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($taskRunnerContext);
+
+        return $results->isFailed() ? self::EXIT_CODE_NOK : self::EXIT_CODE_OK;
+    }
+
+    protected function getPushedFiles(?string $localRef, ?string $localSha, ?string $remoteSha): FilesCollection
+    {
+        if (empty($remoteSha)) {
+            return $this->changedFilesLocator->locateFromRawDiffInput('HEAD');
+        }
+
+        if ($localRef === '(delete)') {
+            return new FilesCollection([]);
+        }
+
+        return $this->changedFilesLocator->locateFromGitDiff($remoteSha, $localSha);
+    }
+}

src/Locator/ChangedFiles.php

@@ -10,7 +10,7 @@
 use GrumPHP\Git\GitRepository;
 use GrumPHP\Util\Filesystem;
 use GrumPHP\Util\Paths;
-use Symfony\Component\Finder\SplFileInfo;
+use SplFileInfo;
 
 /**
  * Class Git.
@@ -46,6 +46,66 @@ public function locateFromGitRepository(): FilesCollection
         return $this->parseFilesFromDiff($diff);
     }
 
+    public function getLocalRef(): ?string
+    {
+        return $this->repository->run('symbolic-ref', ['HEAD']);
+    }
+    public function getLocalSHA1(): ?string
+    {
+        return $this->repository->run('rev-parse', ['HEAD']);
+    }
+    private function getRemoteRef(): ?string
+    {
+        return $this->repository->tryToRunWithFallback(
+            function (): ?string {
+                return $this->repository->run('rev-parse', ['--abbrev-ref', '--symbolic-full-name', '@{u}']);
+            },
+            'null'
+        );
+    }
+
+    public function getRemoteSHA1(): ?string
+    {
+        if ($this->getRemoteRef() === 'null') {
+            return null;
+        }
+        /**
+         * @psalm-suppress PossiblyUndefinedArrayOffset
+         * @psalm-suppress PossiblyNullArgument
+         */
+        list($remoteName, $branchName) = explode('/', $this->getRemoteRef(), 2);
+        $output = $this->repository->run('ls-remote', [$remoteName, $branchName]);
+        return $output ? strtok($output, "\t") : null;
+    }
+
+    /**
+     * @return FilesCollection
+     */
+    public function locateFromGitDiff(string $fromSha, ?string $toSha): FilesCollection
+    {
+        if (empty($toSha)) {
+            $toSha = 'HEAD';
+        }
+        $files = [];
+        $commits = $fromSha . '..' . $toSha;
+        $diff = $this->repository->tryToRunWithFallback(
+            function () use ($commits): ?string {
+                return $this->repository->run('diff', ['--name-only', trim($commits), '--oneline']);
+            },
+            'null'
+        );
+        if ($diff === 'null') {
+            return new FilesCollection($files);
+        }
+
+        foreach (explode("\n", $diff) as $file) {
+            $fileObject = new SplFileInfo($file);
+            $files[] = $fileObject;
+        }
+
+        return new FilesCollection($files);
+    }
+
     public function locateFromRawDiffInput(string $rawDiff): FilesCollection
     {
         $diff = $this->repository->createRawDiff($rawDiff);
@@ -75,6 +135,6 @@ private function makeFileRelativeToProjectDir(File $file): SplFileInfo
             $file->isRename() ? $file->getNewName() : $file->getName()
         );
 
-        return new SplFileInfo($filePath, dirname($filePath), $filePath);
+        return new SplFileInfo($filePath);
     }
 }

src/Task/Ant.php

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

src/Task/Atoum.php

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

src/Task/Behat.php

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

src/Task/Brunch.php

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

src/Task/CloverCoverage.php

@@ -11,6 +11,7 @@
 use GrumPHP\Task\Config\TaskConfigInterface;
 use GrumPHP\Task\Context\ContextInterface;
 use GrumPHP\Task\Context\GitPreCommitContext;
+use GrumPHP\Task\Context\GitPrePushContext;
 use GrumPHP\Task\Context\RunContext;
 use GrumPHP\Util\Filesystem;
 use SimpleXMLElement;
@@ -72,7 +73,9 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
      */
     public function canRunInContext(ContextInterface $context): bool
     {
-        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+        return $context instanceof GitPreCommitContext
+            || $context instanceof GitPrePushContext
+            || $context instanceof RunContext;
     }
 
     /**

src/Task/Codeception.php

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