[git-hooks] Make packaged hooks canonical (#92) (#93)

* Make packaged git hooks canonical

* Update wiki submodule pointer for PR #93

* Fix canonical symlink assertion

* Corrects the chmod call to use the numeric format instead of octal in hook installation commands.

Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>

* Updates GrumPHP hooks to use the exec command directly and removes the ENV variable.

Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>

---------

Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: coisa

.github/wiki

@@ -1,17 +1,16 @@
 git-hooks
 =========
 
-Installs Fast Forward Git hooks and initializes GrumPHP.
+Installs packaged Fast Forward Git hooks.
 
 Description
 -----------
 
-The ``git-hooks`` command installs Git hooks into the repository and optionally
-runs GrumPHP initialization. It:
+The ``git-hooks`` command installs the hook templates maintained in
+``resources/git-hooks`` into the repository. It:
 
-1. Runs ``grumphp git:init`` to register hooks with GrumPHP (unless ``--skip-grumphp-init``)
-2. Copies hook files from a source directory to the target hooks directory
-3. Sets executable permissions on copied hooks
+1. Copies hook files from a source directory to the target hooks directory
+2. Sets executable permissions on copied hooks
 
 Usage
 -----
@@ -32,9 +31,6 @@ Options
 ``--target, -t`` (optional)
    Path to the target Git hooks directory. Default: ``.git/hooks``.
 
-``--skip-grumphp-init``
-   Skip running ``grumphp git:init`` before copying hooks.
-
 ``--no-overwrite``
    Do not overwrite existing hook files.
 
@@ -47,12 +43,6 @@ Install hooks with defaults:
 
    composer git-hooks
 
-Install hooks without running GrumPHP init:
-
-.. code-block:: bash
-
-   composer git-hooks --skip-grumphp-init
-
 Install hooks without overwriting existing ones:
 
 .. code-block:: bash
@@ -70,4 +60,4 @@ Exit Codes
    * - 0
      - Success. Hooks installed successfully.
    * - 1
-     - Failure. GrumPHP init failed or copy error.
+     - Failure. Copy error.

docs/commands/git-hooks.rst

@@ -258,15 +258,14 @@ Important details:
 ``git-hooks``
 -------------
 
-Installs Fast Forward Git hooks and initializes GrumPHP.
+Installs packaged Fast Forward Git hooks.
 
 .. code-block:: bash
 
-   composer git-hooks --skip-grumphp-init
+   composer git-hooks
 
 Important details:
 
-- runs ``grumphp git:init`` to register hooks with GrumPHP by default;
 - copies hook files from source to target directory;
 - sets executable permissions on copied hooks;
 - ``--source`` defaults to ``resources/git-hooks``;

docs/running/specialized-commands.rst

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+#
+# Run the hook command.
+# Note: this will be replaced by the real command during copy.
+#
+
+GIT_USER=$(git config user.name)
+GIT_EMAIL=$(git config user.email)
+COMMIT_MSG_FILE=$1
+
+# Fetch the GIT diff and format it as command input:
+DIFF=$(git -c diff.mnemonicprefix=false -c diff.noprefix=false --no-pager diff --raw -r -p -m -M --full-index --no-color --staged | cat)
+
+# Grumphp env vars
+
+export GRUMPHP_GIT_WORKING_DIR="$(git rev-parse --show-toplevel)"
+
+# Run GrumPHP
+(cd "./" && printf "%s\n" "${DIFF}" | exec 'vendor/bin/grumphp.phar' 'git:commit-msg' "--git-user='$GIT_USER'" "--git-email='$GIT_EMAIL'" "$COMMIT_MSG_FILE")

resources/git-hooks/commit-msg

@@ -2,22 +2,35 @@
 
 #
 # DevTools post-checkout hook
-# Runs composer update if composer.json was modified after checkout
+# Runs composer update if composer.json or composer.lock changed after checkout
 #
 
 PREV_HEAD="$1"
 NEW_HEAD="$2"
 CHECKOUT_TYPE="$3"
 
-if [ "$CHECKOUT_TYPE" = "1" ]; then
-    if git diff --quiet --cached "$PREV_HEAD" "$NEW_HEAD" -- composer.json; then
-        if git diff --quiet "$PREV_HEAD" "$NEW_HEAD" -- composer.json; then
-            exit 0
-        fi
-    fi
+GIT_TOPLEVEL=$(git rev-parse --show-toplevel 2>/dev/null) || exit 0
+GIT_DIR=$(git rev-parse --git-dir 2>/dev/null) || exit 0
 
-    echo "DevTools: composer.json changed, running composer update..."
-    (cd "$(git rev-parse --show-toplevel)" && composer update --minimal-changes --no-interaction) || true
+export DEVTOOLS_GIT_WORKING_DIR="$GIT_TOPLEVEL"
+export DEVTOOLS_GIT_DIR="$GIT_DIR"
+export DEVTOOLS_GIT_HOOK="post-checkout"
+export DEVTOOLS_GIT_PREV_HEAD="$PREV_HEAD"
+export DEVTOOLS_GIT_NEW_HEAD="$NEW_HEAD"
+export DEVTOOLS_GIT_CHECKOUT_TYPE="$CHECKOUT_TYPE"
+
+if [ "$CHECKOUT_TYPE" != "1" ]; then
+    exit 0
+fi
+
+CHANGED_FILES=$(git diff --name-only "$PREV_HEAD" "$NEW_HEAD" 2>/dev/null || true)
+
+if printf '%s\n' "$CHANGED_FILES" | grep -Eq '^(composer\.json|composer\.lock)$'; then
+    echo "DevTools: composer manifest changed after checkout, running composer update..."
+    (
+        cd "$GIT_TOPLEVEL" || exit 1
+        composer update --minimal-changes --no-interaction
+    ) || true
 fi
 
 exit 0

resources/git-hooks/post-checkout

@@ -2,12 +2,25 @@
 
 #
 # DevTools post-merge hook
-# Runs composer update if composer.json was modified after merge
+# Runs composer update if composer.json or composer.lock changed after merge
 #
 
-if git diff --cached --name-only --diff-filter=M | grep -q "^composer.json$"; then
-    echo "DevTools: composer.json modified in merge, running composer update..."
-    (cd "$(git rev-parse --show-toplevel)" && composer update --minimal-changes --no-interaction) || true
+GIT_TOPLEVEL=$(git rev-parse --show-toplevel 2>/dev/null) || exit 0
+GIT_DIR=$(git rev-parse --git-dir 2>/dev/null) || exit 0
+
+export DEVTOOLS_GIT_WORKING_DIR="$GIT_TOPLEVEL"
+export DEVTOOLS_GIT_DIR="$GIT_DIR"
+export DEVTOOLS_GIT_HOOK="post-merge"
+export DEVTOOLS_GIT_POST_MERGE_SQUASH=${1:-0}
+
+CHANGED_FILES=$(git diff --name-only ORIG_HEAD HEAD 2>/dev/null || true)
+
+if printf '%s\n' "$CHANGED_FILES" | grep -Eq '^(composer\.json|composer\.lock)$'; then
+    echo "DevTools: composer manifest changed after merge, running composer update..."
+    (
+        cd "$GIT_TOPLEVEL" || exit 1
+        composer update --minimal-changes --no-interaction
+    ) || true
 fi
 
 exit 0

resources/git-hooks/post-merge

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+#
+# Run the hook command.
+# Note: this will be replaced by the real command during copy.
+#
+
+# Fetch the GIT diff and format it as command input:
+DIFF=$(git -c diff.mnemonicprefix=false -c diff.noprefix=false --no-pager diff --raw -r -p -m -M --full-index --no-color --staged | cat)
+
+# Grumphp env vars
+
+export GRUMPHP_GIT_WORKING_DIR="$(git rev-parse --show-toplevel)"
+
+# Run GrumPHP
+(cd "./" && printf "%s\n" "${DIFF}" | exec 'vendor/bin/grumphp.phar' 'git:pre-commit' '--skip-success-output')

resources/git-hooks/pre-commit

@@ -22,8 +22,6 @@
 use Composer\Command\BaseCommand;
 use FastForward\DevTools\Filesystem\FinderFactoryInterface;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
-use FastForward\DevTools\Process\ProcessBuilderInterface;
-use FastForward\DevTools\Process\ProcessQueueInterface;
 use Symfony\Component\Config\FileLocatorInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Input\InputInterface;
@@ -32,12 +30,12 @@
 use Symfony\Component\Filesystem\Path;
 
 /**
- * Installs Git hooks and initializes GrumPHP hooks for the consumer repository.
+ * Installs packaged Git hooks for the consumer repository.
  */
 #[AsCommand(
     name: 'git-hooks',
     description: 'Installs Fast Forward Git hooks.',
-    help: 'This command runs GrumPHP hook initialization and copies packaged Git hooks into the current repository.'
+    help: 'This command copies packaged Git hooks into the current repository.'
 )]
 final class GitHooksCommand extends BaseCommand
 {
@@ -46,15 +44,11 @@ final class GitHooksCommand extends BaseCommand
      *
      * @param FilesystemInterface $filesystem the filesystem used to copy hooks
      * @param FileLocatorInterface $fileLocator the locator used to find packaged hooks
-     * @param ProcessBuilderInterface $processBuilder the builder used to assemble GrumPHP processes
-     * @param ProcessQueueInterface $processQueue the queue used to execute GrumPHP initialization
      * @param FinderFactoryInterface $finderFactory the factory used to create finders for hook files
      */
     public function __construct(
         private readonly FilesystemInterface $filesystem,
         private readonly FileLocatorInterface $fileLocator,
-        private readonly ProcessBuilderInterface $processBuilder,
-        private readonly ProcessQueueInterface $processQueue,
         private readonly FinderFactoryInterface $finderFactory,
     ) {
         parent::__construct();
@@ -80,11 +74,6 @@ protected function configure(): void
                 description: 'Path to the target Git hooks directory.',
                 default: '.git/hooks',
             )
-            ->addOption(
-                name: 'skip-grumphp-init',
-                mode: InputOption::VALUE_NONE,
-                description: 'Skip running grumphp git:init before copying hooks.',
-            )
             ->addOption(
                 name: 'no-overwrite',
                 mode: InputOption::VALUE_NONE,
@@ -93,7 +82,7 @@ protected function configure(): void
     }
 
     /**
-     * Initializes GrumPHP hooks and copies packaged hooks.
+     * Copies packaged Git hooks.
      *
      * @param InputInterface $input the command input
      * @param OutputInterface $output the command output
@@ -102,18 +91,6 @@ protected function configure(): void
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        if (! $input->getOption('skip-grumphp-init')) {
-            $this->processQueue->add(
-                $this->processBuilder
-                    ->withArgument('git:init')
-                    ->build('vendor/bin/grumphp')
-            );
-
-            if (self::SUCCESS !== $this->processQueue->run($output)) {
-                return self::FAILURE;
-            }
-        }
-
         $sourcePath = $this->fileLocator->locate((string) $input->getOption('source'));
         $targetPath = (string) $this->filesystem->getAbsolutePath((string) $input->getOption('target'));
         $overwrite = ! $input->getOption('no-overwrite');
@@ -133,7 +110,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
 
             $this->filesystem->copy($file->getRealPath(), $hookPath, $overwrite);
-            $this->filesystem->chmod($hookPath, 0o755, 0o755);
+            $this->filesystem->chmod($hookPath, 755, 0o755);
 
             $output->writeln(\sprintf('<info>Installed %s hook.</info>', $file->getFilename()));
         }

src/Console/Command/GitHooksCommand.php

@@ -22,11 +22,8 @@
 use FastForward\DevTools\Console\Command\GitHooksCommand;
 use FastForward\DevTools\Filesystem\FinderFactoryInterface;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
-use FastForward\DevTools\Process\ProcessBuilder;
-use FastForward\DevTools\Process\ProcessQueueInterface;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
-use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
@@ -36,15 +33,13 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Finder\Finder;
-use Symfony\Component\Process\Process;
 
 use function Safe\mkdir;
 use function Safe\file_put_contents;
 use function Safe\unlink;
 use function Safe\rmdir;
 
 #[CoversClass(GitHooksCommand::class)]
-#[UsesClass(ProcessBuilder::class)]
 final class GitHooksCommandTest extends TestCase
 {
     use ProphecyTrait;
@@ -55,8 +50,6 @@ final class GitHooksCommandTest extends TestCase
 
     private ObjectProphecy $finderFactory;
 
-    private ObjectProphecy $processQueue;
-
     private ObjectProphecy $input;
 
     private ObjectProphecy $output;
@@ -77,15 +70,12 @@ protected function setUp(): void
         $this->filesystem = $this->prophesize(FilesystemInterface::class);
         $this->fileLocator = $this->prophesize(FileLocatorInterface::class);
         $this->finderFactory = $this->prophesize(FinderFactoryInterface::class);
-        $this->processQueue = $this->prophesize(ProcessQueueInterface::class);
         $this->input = $this->prophesize(InputInterface::class);
         $this->output = $this->prophesize(OutputInterface::class);
 
         $this->command = new GitHooksCommand(
             $this->filesystem->reveal(),
             $this->fileLocator->reveal(),
-            new ProcessBuilder(),
-            $this->processQueue->reveal(),
             $this->finderFactory->reveal(),
         );
     }
@@ -110,7 +100,7 @@ public function commandWillSetExpectedNameDescriptionAndHelp(): void
         self::assertSame('git-hooks', $this->command->getName());
         self::assertSame('Installs Fast Forward Git hooks.', $this->command->getDescription());
         self::assertSame(
-            'This command runs GrumPHP hook initialization and copies packaged Git hooks into the current repository.',
+            'This command copies packaged Git hooks into the current repository.',
             $this->command->getHelp()
         );
     }
@@ -119,23 +109,15 @@ public function commandWillSetExpectedNameDescriptionAndHelp(): void
      * @return void
      */
     #[Test]
-    public function executeWillRunGrumPhpInitAndCopyHooks(): void
+    public function executeWillCopyPackagedHooks(): void
     {
-        $this->input->getOption('skip-grumphp-init')
-            ->willReturn(false);
         $this->input->getOption('source')
             ->willReturn('resources/git-hooks');
         $this->input->getOption('target')
             ->willReturn('.git/hooks');
         $this->input->getOption('no-overwrite')
             ->willReturn(false);
 
-        $this->processQueue->add(Argument::type(Process::class))
-            ->shouldBeCalledOnce();
-        $this->processQueue->run($this->output->reveal())
-            ->willReturn(GitHooksCommand::SUCCESS)
-            ->shouldBeCalledOnce();
-
         $this->fileLocator->locate('resources/git-hooks')
             ->willReturn($this->sourceDirectory);
         $this->finderFactory->create()
@@ -145,7 +127,7 @@ public function executeWillRunGrumPhpInitAndCopyHooks(): void
             ->willReturn('/app/.git/hooks');
         $this->filesystem->copy(Argument::containingString('/post-merge'), '/app/.git/hooks/post-merge', true)
             ->shouldBeCalledOnce();
-        $this->filesystem->chmod('/app/.git/hooks/post-merge', 0o755, 0o755)
+        $this->filesystem->chmod('/app/.git/hooks/post-merge', 755, 0o755)
             ->shouldBeCalledOnce();
 
         self::assertSame(GitHooksCommand::SUCCESS, $this->executeCommand());

tests/Console/Command/GitHooksCommandTest.php

@@ -27,6 +27,7 @@
 
 use function Safe\file_put_contents;
 use function Safe\getcwd;
+use function Safe\realpath;
 
 #[CoversClass(Filesystem::class)]
 final class FilesystemTest extends TestCase
@@ -180,6 +181,6 @@ public function symlinkAndReadlinkWillUseAbsolutePaths(): void
         $this->filesystem->mkdir($origin);
         $this->filesystem->symlink($origin, $target);
 
-        self::assertSame($origin, $this->filesystem->readlink($target, true));
+        self::assertSame(realpath($origin), $this->filesystem->readlink($target, true));
     }
 }