Check for broken symlinks

Fixes issue #272

Author: sebastianfeldmann

src/Runner/Installer.php

@@ -238,6 +238,7 @@ private function writeHookFile(string $hook): void
         if ($doIt) {
             $code = $this->getHookSourceCode($hook);
             $file = new File($hookFile);
+            $this->checkForBrokenSymlink($file);
             $file->write($code);
             chmod($hookFile, 0755);
             $this->io->write(IOUtil::PREFIX_OK . ' <comment>' . $hook . '</comment> installed');
@@ -256,4 +257,23 @@ private function getHookSourceCode(string $hook): string
     {
         return $this->template->getCode($hook);
     }
+
+    /**
+     * Checks if the provided file is a broken symbolic link
+     *
+     * @param  File $file The File object representing the file.
+     * @return void
+     * @throws RuntimeException If the file is determined to be a broken symbolic link.
+     */
+    protected function checkForBrokenSymlink(File $file): void
+    {
+        if ($file->isLink()) {
+            if (!is_dir(dirname($file->linkTarget()))) {
+                throw new RuntimeException(
+                    'The hook at \'' . $file->getPath() . '\' is a broken symbolic link. ' . PHP_EOL .
+                    'Please remove the symbolic link and try again.'
+                );
+            }
+        }
+    }
 }

tests/unit/Runner/FakeInstaller.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * This file is part of CaptainHook.
+ *
+ * (c) Sebastian Feldmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CaptainHook\App\Runner;
+
+use CaptainHook\App\Storage\File;
+
+class FakeInstaller extends Installer
+{
+    public function checkSymlink(File $file): void
+    {
+        $this->checkForBrokenSymlink($file);
+    }
+}

tests/unit/Runner/InstallerTest.php

@@ -12,11 +12,13 @@
 namespace CaptainHook\App\Runner;
 
 use CaptainHook\App\Config\Mockery as ConfigMockery;
+use CaptainHook\App\Console\IO\DefaultIO;
 use CaptainHook\App\Console\IO\Mockery as IOMockery;
 use CaptainHook\App\Exception\InvalidHookName;
 use CaptainHook\App\Git\DummyRepo;
 use CaptainHook\App\Hook\Mockery as HookMockery;
 use CaptainHook\App\Mockery as CHMockery;
+use CaptainHook\App\Storage\File;
 use Exception;
 use org\bovigo\vfs\vfsStream;
 use PHPUnit\Framework\TestCase;
@@ -171,6 +173,51 @@ public function testWriteHook(): void
         $this->assertFileExists($fakeRepo->getHookDir() . '/pre-commit');
     }
 
+    /**
+     * Tests Installer::checkForBrokenSymlinks
+     */
+    public function testBrokenSymlinkDetectionOnExistingFile(): void
+    {
+        $io       = $this->createIOMock();
+        $config   = $this->createConfigMock();
+        $repo     = $this->createRepositoryMock();
+        $template = $this->createTemplateMock();
+
+        $file = $this->getMockBuilder(File::class)
+                     ->disableOriginalConstructor()
+                     ->getMock();
+
+        $runner = new FakeInstaller($io, $config, $repo, $template);
+        $file->method('isLink')->willReturn(true);
+        $file->method('linkTarget')->willReturn(__FILE__);
+
+        $runner->checkSymlink($file);
+        $this->assertTrue(true);
+    }
+
+    /**
+     * Tests Installer::checkForBrokenSymlinks
+     */
+    public function testBrokenSymlinkDetectionOnBrokenSymlink(): void
+    {
+        $this->expectException(Exception::class);
+
+        $io       = $this->createIOMock();
+        $config   = $this->createConfigMock();
+        $repo     = $this->createRepositoryMock();
+        $template = $this->createTemplateMock();
+
+        $file = $this->getMockBuilder(File::class)
+                     ->disableOriginalConstructor()
+                     ->getMock();
+
+        $runner = new FakeInstaller($io, $config, $repo, $template);
+        $file->method('isLink')->willReturn(true);
+        $file->method('linkTarget')->willReturn('./foo/bar/baz');
+
+        $runner->checkSymlink($file);
+    }
+
     /**
      * Tests Installer::run
      */