Add tooling for integration tests with initial tests

.github/workflows/integration.yml

@@ -45,7 +45,10 @@ jobs:
       run: GITHUB_AUTH_TOKEN=${{ secrets.GITHUB_TOKEN }} tools/phive --no-progress --home ./.phive install --force-accept-unsigned --trust-gpg-keys 4AA394086372C20A,31C7E470E2138192,8E730BA25823D8B5,CF1A108D0E7AE720
 
     - name: Execute unit tests
-      run: tools/phpunit --configuration=phpunit.ci.xml
+      run: tools/phpunit --configuration=phpunit.ci.xml --testsuite CaptainHook
+
+    - name: Execute integration tests
+      run: tools/phpunit --configuration=phpunit.ci.xml --testsuite Integration
 
     - name: Check coding style
       run: tools/phpcs --standard=psr12 src tests

composer.json

@@ -27,7 +27,8 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "CaptainHook\\App\\": "tests/CaptainHook/"
+      "CaptainHook\\App\\": "tests/CaptainHook/",
+      "CaptainHook\\App\\Integration\\": "tests/integration/"
     }
   },
   "require": {
@@ -67,7 +68,8 @@
     "post-install-cmd": "tools/phive install --force-accept-unsigned",
     "tools": "tools/phive install --force-accept-unsigned",
     "compile": "tools/box compile",
-    "test": "tools/phpunit",
+    "test": "tools/phpunit --testsuite CaptainHook",
+    "test:integration": "tools/phpunit --testsuite Integration --no-coverage",
     "analyse": "tools/phpstan analyse",
     "style": "tools/phpcs --standard=psr12 src tests"
   }

phpunit.ci.xml

@@ -4,5 +4,8 @@
     <testsuite name="CaptainHook">
       <directory>tests/CaptainHook</directory>
     </testsuite>
+    <testsuite name="Integration">
+      <directory>tests/integration</directory>
+    </testsuite>
   </testsuites>
 </phpunit>

phpunit.xml

@@ -13,6 +13,9 @@
     <testsuite name="CaptainHook">
       <directory>tests/CaptainHook</directory>
     </testsuite>
+    <testsuite name="Integration">
+      <directory>tests/integration</directory>
+    </testsuite>
   </testsuites>
   <logging>
     <junit outputFile="build/logs/junit.xml"/>

tests/constants.php

@@ -10,3 +10,4 @@
  */
 
 define('CH_PATH_FILES', realpath(__DIR__ . '/files'));
+define('CH_PATH_ROOT', realpath(__DIR__ . '/..'));

tests/files/template-acceptance/.gitignore

@@ -0,0 +1,2 @@
+/composer.lock
+/vendor/

tests/files/template-acceptance/README.md

@@ -0,0 +1,3 @@
+# CaptainHook Acceptance Testing
+
+This is a sample project directory to use with acceptance tests.

tests/files/template-acceptance/captainhook.json

@@ -0,0 +1,39 @@
+{
+    "config": {},
+    "commit-msg": {
+        "enabled": false,
+        "actions": []
+    },
+    "pre-push": {
+        "enabled": false,
+        "actions": []
+    },
+    "pre-commit": {
+        "enabled": false,
+        "actions": []
+    },
+    "prepare-commit-msg": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-commit": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-merge": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-checkout": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-rewrite": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-change": {
+        "enabled": false,
+        "actions": []
+    }
+}

tests/files/template-acceptance/composer.json

@@ -0,0 +1,13 @@
+{
+    "name": "captainhook/repo-test",
+    "description": "A sample project to use with CaptainHook acceptance tests.",
+    "type": "project",
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require-dev": {
+        "captainhook/captainhook": "*"
+    },
+    "scripts": {
+        "post-autoload-dump": "captainhook install --no-interaction --no-ansi --force"
+    }
+}

tests/integration/HookInstallTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace CaptainHook\App\Integration;
+
+class HookInstallTest extends IntegrationTestCase
+{
+    public function testGitHooksSuccessfullyInstallWithComposerUpdate(): void
+    {
+        $repoPath = $this->setUpRepository(false);
+
+        $result = $this->runInShell(['composer', 'update', '--no-ansi', '--no-interaction'], $repoPath);
+
+        $this->assertStringContainsString("'commit-msg' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'pre-push' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'pre-commit' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'prepare-commit-msg' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'post-commit' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'post-merge' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'post-checkout' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'post-rewrite' hook installed successfully", $result->getStdout());
+        $this->assertStringContainsString("'post-change' hook installed successfully", $result->getStdout());
+    }
+}

tests/integration/HookPluginTest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace CaptainHook\App\Integration;
+
+class HookPluginTest extends IntegrationTestCase
+{
+    public function testHookPluginRunsBeforeAndAfterHookAndActions(): void
+    {
+        $repoPath = $this->setUpRepository();
+
+        $this->setConfig($repoPath, 'plugins', [
+            [
+                'plugin' => '\\CaptainHook\\App\\Integration\\Plugin\\SimplePlugin',
+                'options' => [
+                    'stuff' => 'cool things',
+                ],
+            ],
+        ]);
+
+        $this->enableHook($repoPath, 'pre-commit', [
+            [
+                'action' => 'echo "action1"',
+            ],
+            [
+                'action' => 'echo "action2"',
+            ],
+        ]);
+
+        $this->enableHook($repoPath, 'post-commit');
+
+        $this->filesystem()->touch($repoPath . '/foo.txt');
+        $this->mustRunInShell(['git', 'add', 'foo.txt'], $repoPath);
+
+        $result = $this->runInShell(['git', 'commit', '-m', 'Add foo.txt'], $repoPath);
+
+        $this->assertStringContainsString('Do cool things before pre-commit runs', $result->getStderr());
+        $this->assertStringContainsString('Do cool things before action echo "action1" runs', $result->getStderr());
+        $this->assertStringContainsString('Do cool things after action echo "action1" runs', $result->getStderr());
+        $this->assertStringContainsString('Do cool things before action echo "action2" runs', $result->getStderr());
+        $this->assertStringContainsString('Do cool things after action echo "action2" runs', $result->getStderr());
+        $this->assertStringContainsString('Do cool things after pre-commit runs', $result->getStderr());
+
+        $this->assertStringContainsString('Do cool things before post-commit runs', $result->getStderr());
+        $this->assertStringContainsString('Do cool things after post-commit runs', $result->getStderr());
+
+        $this->assertStringNotContainsString('commit-msg', $result->getStderr());
+        $this->assertStringNotContainsString('prepare-commit-msg', $result->getStderr());
+    }
+}