tests(CreateHookCommand): Added more tests

Author: Wtyd

src/Commands/CreateHookCommand.php

@@ -3,13 +3,16 @@
 namespace GitHooks\Commands;
 
 use Exception;
+use GitHooks\Hooks;
 use GitHooks\Utils\Printer;
 use Illuminate\Console\Command;
 
 class CreateHookCommand extends Command
 {
-    protected $signature = 'hook  {hook=pre-commit} {scriptFile?}';
+    protected $signature = 'hook  {hook=pre-commit : The hook to be setted} {scriptFile? : The custom script to be setted as the hook (default:GitHooks)}';
     protected $description = 'Copies the hook for the GitHooks execution. The default hook is pre-commit. You can pass scriptFile as argument to set custom scripts.';
+    protected $help = 'The default script is the default GitHooks execution. You can custom your script to execute what ever you want.
+Even the default script and after, other tools which GitHooks not support or vice versa';
 
     /**
      * @var Printer
@@ -28,6 +31,13 @@ public function handle()
         $hook = strval($this->argument('hook'));
         $scriptFile = $this->argument('scriptFile') ?? '';
 
+
+        if (!Hooks::validate($hook)) {
+            $this->printer->error("'$hook' is not a valid git hook. Avaliable hooks are:");
+            $this->printer->error(implode(', ', Hooks::HOOKS));
+            return;
+        }
+
         $origin = $this->path2OriginFile($root, strval($scriptFile));
         try {
             $destiny = "$root/.git/hooks/$hook";

src/Hooks.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GitHooks;
 
 class Hooks

tests/System/Commands/CreateHookCommandTest.php

@@ -8,27 +8,77 @@
 
 class CreateHookCommandTest extends ConsoleTestCase
 {
+    protected $mock;
+
+    protected $supportedHooks = [
+        'applypatch-msg',
+        'pre-applypatch',
+        'post-applypatch',
+        'pre-commit',
+        'pre-merge-commit',
+        'prepare-commit-msg',
+        'commit-msg',
+        'post-commit',
+        'pre-rebase',
+        'post-checkout',
+        'post-merge',
+        'pre-push',
+        'pre-receive',
+        'update',
+        'proc-receive',
+        'post-receive',
+        'post-update',
+        'reference-transaction',
+        'push-to-checkout',
+        'pre-auto-gc',
+        'post-rewrite',
+        'sendemail-validate',
+        'fsmonitor-watchman',
+        'p4-changelist',
+        'p4-prepare-changelist',
+        'p4-post-changelist',
+        'p4-pre-submit',
+        'post-index-change',
+    ];
+
+    /**
+     * Creates the temporal filesystem structure for the tests and mocks the 'getcwd' method for return this path.
+     *
+     * @return void
+     */
     protected function setUp(): void
     {
         parent::setUp();
         $this->deleteDirStructure();
 
         $this->copyDefaultPrecommitToTestDirectory();
         mkdir($this->path . '/.git/hooks', 0777, true);
-    }
 
-    protected function copyDefaultPrecommitToTestDirectory()
-    {
-        mkdir($this->path . '/hooks', 0777, true);
-        shell_exec("cp -r hooks " . $this->path);
+        $this->mock = $this->getMockRootDirectory();
+        $this->mock->enable();
     }
 
     protected function tearDown(): void
     {
+        $this->mock->disable();
         $this->deleteDirStructure();
     }
 
     /**
+     * Copy the 'hooks' directory of the application with de default script for the hooks ('hooks/precommit.php') to the root of the temporal
+     * directory for tests.
+     *
+     * @return void
+     */
+    protected function copyDefaultPrecommitToTestDirectory()
+    {
+        mkdir($this->path . '/hooks', 0777, true);
+        shell_exec('cp -r hooks ' . $this->path);
+    }
+
+    /**
+     * Mocks the 'getcwd' method for return the root of the filesystem for this tests.
+     *
      * @return PhpmockMock
      */
     public function getMockRootDirectory(): PhpmockMock
@@ -38,7 +88,7 @@ public function getMockRootDirectory(): PhpmockMock
             ->setName('getcwd')
             ->setFunction(
                 function () {
-                    return $this->getPath();
+                    return $this->path;
                 }
             );
 
@@ -48,14 +98,10 @@ function () {
     /** @test */
     function it_creates_default_script_for_precommit_when_is_called_without_arguments()
     {
-        $mock = $this->getMockRootDirectory();
-        $mock->enable();
-
         $this->artisan('hook')
             ->containsStringInOutput('Hook pre-commit created');
 
         $this->assertFileExists($this->path . '/.git/hooks/pre-commit', file_get_contents('hooks/pre-commit.php'));
-        $mock->disable();
     }
 
     /**
@@ -64,37 +110,54 @@ function it_creates_default_script_for_precommit_when_is_called_without_argument
      */
     function it_creates_default_script_in_the_hook_passed_as_argument()
     {
-        $hooks = [
-            'applypatch-msg' => 'applypatch-msg',
-            'commit-msg' => 'commit-msg',
-            'fsmonitor-watchman' => 'fsmonitor-watchman',
-            'post-update' => 'post-update',
-            'pre-applypatch' => 'pre-applypatch',
-            'pre-commit' => 'pre-commit',
-            'prepare-commit-msg' => 'prepare-commit-msg',
-            'pre-push' => 'pre-push',
-            'pre-rebase' => 'pre-rebase',
-            'pre-receive' => 'pre-receive',
-            'update' => 'update',
-        ];
-
-        $mock = $this->getMockRootDirectory();
-        $mock->enable();
-
-        foreach ($hooks as $hook) {
+        foreach ($this->supportedHooks as $hook) {
             $this->artisan("hook $hook")
                 ->containsStringInOutput("Hook $hook created");
 
             $this->assertFileExists($this->path . "/.git/hooks/$hook", file_get_contents('hooks/pre-commit.php'));
         }
+    }
 
+    /**
+     * @test
+     * Only is tested pre-push hook but it could be any hook.
+     */
+    function it_sets_a_custom_script_as_some_hook()
+    {
+        $hookContent = 'my custom script';
+        $scriptFilePath = $this->path . '/MyScript.php';
+        file_put_contents($scriptFilePath, $hookContent);
 
-        $mock->disable();
+        $this->artisan("hook pre-push $scriptFilePath")
+            ->containsStringInOutput("Hook pre-push created");
+
+        $this->assertFileExists($this->path . "/.git/hooks/pre-push", $scriptFilePath);
     }
 
-    //Tests
-    // Establezco pre-commit por defecto
-    // Establezco cualquier otro hook (o todos)
-    // Establezco un script personalizado en algún hook
-    // Si el hook no valida lanzo mensaje de error igual que en CleanHookCommand con los hooks soportadosdcon
+    /** @test */
+    function it_shows_an_error_message_when_is_setted_a_custom_script_without_specifying_the_hook()
+    {
+        $hookContent = 'my custom script';
+        $scriptFilePath = $this->path . '/MyScript.php';
+        file_put_contents($scriptFilePath, $hookContent);
+
+        $supportedHooks2String = implode(', ', $this->supportedHooks);
+        $this->artisan("hook $scriptFilePath")
+            ->containsStringInOutput("'$scriptFilePath' is not a valid git hook. Avaliable hooks are:")
+            ->containsStringInOutput($supportedHooks2String);
+
+        $assertFileDoesNotExist = $this->assertFileDoesNotExist;
+        $this->$assertFileDoesNotExist($this->path . "/.git/hooks/pre-commit", $scriptFilePath);
+    }
+
+    /** @test */
+    function it_shows_an_error_message_when_is_setted_an_invalid_hook()
+    {
+        $noSupportedHook = 'no-valid';
+
+        $supportedHooks2String = implode(', ', $this->supportedHooks);
+        $this->artisan("hook $noSupportedHook")
+            ->containsStringInOutput("'$noSupportedHook' is not a valid git hook. Avaliable hooks are:")
+            ->containsStringInOutput($supportedHooks2String);
+    }
 }