Add an option to disable all plugins

All hook commands now support the --no-plugins option.

Author: sebastianfeldmann

src/Console/Command/Hook.php

@@ -62,6 +62,12 @@ protected function configure(): void
             InputOption::VALUE_OPTIONAL,
             'Original hook stdIn'
         );
+        $this->addOption(
+            'no-plugins',
+            null,
+            InputOption::VALUE_NONE,
+            'Disable all hook plugins'
+        );
     }
 
     /**
@@ -70,7 +76,7 @@ protected function configure(): void
      * @param  \Symfony\Component\Console\Input\InputInterface   $input
      * @param  \Symfony\Component\Console\Output\OutputInterface $output
      * @return int
-     * @throws \Exception
+     * @throws \Throwable
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
@@ -94,6 +100,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $class = '\\CaptainHook\\App\\Runner\\Hook\\' . Util::getHookCommand($this->hookName);
             /** @var \CaptainHook\App\Runner\Hook $hook */
             $hook  = new $class($io, $config, $repository);
+            $hook->setPluginsDisabled($input->getOption('no-plugins'));
             $hook->run();
 
             return 0;
@@ -124,8 +131,8 @@ private function handleBootstrap(Config $config): void
                 require $bootstrapFile;
             } catch (Throwable $t) {
                 throw new RuntimeException(
-                    'Bootstrapping failed:' . PHP_EOL .
-                    '  Please fix your bootstrap file `' . $bootstrapFile . '`' . PHP_EOL
+                    'Loading bootstrap file failed: ' . $bootstrapFile . PHP_EOL .
+                    $t->getMessage() . PHP_EOL
                 );
             }
         }

src/Runner/Hook.php

@@ -82,6 +82,20 @@ abstract class Hook extends RepositoryAware
      */
     private HookLog $hookLog;
 
+    /**
+     * Should the plugins be disabled?
+     *
+     * @var boolean
+     */
+    private bool $pluginsDisabled = false;
+
+    /**
+     * Set up the hook runner
+     *
+     * @param \CaptainHook\App\Console\IO       $io
+     * @param \CaptainHook\App\Config           $config
+     * @param \SebastianFeldmann\Git\Repository $repository
+     */
     public function __construct(IO $io, Config $config, Repository $repository)
     {
         $this->dispatcher = new Dispatcher($io, $config, $repository);
@@ -91,6 +105,17 @@ public function __construct(IO $io, Config $config, Repository $repository)
         parent::__construct($io, $config, $repository);
     }
 
+    /**
+     * Allow plugins to be disabled
+     *
+     * @param  bool $disabled
+     * @return void
+     */
+    public function setPluginsDisabled(bool $disabled): void
+    {
+        $this->pluginsDisabled = $disabled;
+    }
+
     /**
      * Return this hook's name
      *
@@ -158,6 +183,10 @@ public function run(): void
             return;
         }
 
+        if ($this->pluginsDisabled) {
+            $this->io->write('<fg=magenta>Running with plugins disabled</>');
+        }
+
         $this->checkHookScript();
 
         $this->beforeHook();
@@ -412,6 +441,10 @@ private function setupHookPlugins(): array
      */
     private function executeHookPluginsFor(string $method, ?Config\Action $action = null): void
     {
+        if ($this->pluginsDisabled) {
+            return;
+        }
+
         $plugins = $this->getHookPlugins();
 
         if (count($plugins) === 0) {

tests/unit/Runner/HookTest.php

@@ -252,4 +252,35 @@ public function testRunHookSkipsActionsFromPluginBeforeAction(): void
         $this->assertSame(3, DummyHookPlugin::$afterActionCalled);
         $this->assertSame(1, DummyHookPlugin::$afterHookCalled);
     }
+
+    public function testRunHookWhenPluginsAreDisabled(): void
+    {
+        $pluginConfig1 = new Config\Plugin(DummyHookPlugin::class);
+        $pluginConfig2 = new Config\Plugin(DummyHookPlugin::class);
+
+        $config = $this->createConfigMock();
+        $config->method('failOnFirstError')->willReturn(false);
+        $config->method('getPlugins')->willReturn([$pluginConfig1, $pluginConfig2]);
+
+        $io           = $this->createIOMock();
+        $repo         = $this->createRepositoryMock();
+        $hookConfig   = $this->createHookConfigMock();
+        $actionConfig = $this->createActionConfigMock();
+        $actionConfig->expects($this->atLeastOnce())->method('getAction')->willReturn(CH_PATH_FILES . '/bin/success');
+        $hookConfig->method('isEnabled')->willReturn(true);
+        $hookConfig->expects($this->once())->method('getActions')->willReturn([$actionConfig, clone $actionConfig]);
+        $config->method('isHookEnabled')->willReturn(true);
+        $config->expects($this->once())->method('getHookConfigToExecute')->willReturn($hookConfig);
+
+        $runner = new class ($io, $config, $repo) extends Hook {
+            protected string $hook = Hooks::PRE_COMMIT;
+        };
+        $runner->setPluginsDisabled(true);
+        $runner->run();
+
+        $this->assertSame(0, DummyHookPlugin::$beforeHookCalled);
+        $this->assertSame(0, DummyHookPlugin::$beforeActionCalled);
+        $this->assertSame(0, DummyHookPlugin::$afterActionCalled);
+        $this->assertSame(0, DummyHookPlugin::$afterHookCalled);
+    }
 }