Add info command to display config information

Author: sebastianfeldmann

src/Console/Application.php

@@ -64,6 +64,7 @@ public function getDefaultCommands(): array
                 new Cmd\Install($resolver),
                 new Cmd\Uninstall($resolver),
                 new Cmd\Configuration($resolver),
+                new Cmd\Info($resolver),
                 new Cmd\Add($resolver),
                 new Cmd\Disable($resolver),
                 new Cmd\Enable($resolver),

src/Console/Command/Info.php

@@ -0,0 +1,101 @@
+<?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\Console\Command;
+
+use CaptainHook\App\Console\IOUtil;
+use CaptainHook\App\Runner\Config\Reader;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Command to display configuration information
+ *
+ * @package CaptainHook
+ * @author  Sebastian Feldmann <[email protected]>
+ * @link    https://github.com/captainhookphp/captainhook
+ * @since   Class available since Release 5.24.0
+ */
+class Info extends RepositoryAware
+{
+    /**
+     * Configure the command
+     *
+     * @return void
+     */
+    protected function configure(): void
+    {
+        parent::configure();
+        $this->setName('config:info')
+             ->setAliases(['info'])
+             ->setDescription('Displays information about the configuration')
+             ->setHelp('Displays information about the configuration')
+             ->addArgument('hook', InputArgument::OPTIONAL, 'Hook you want to investigate')
+             ->addOption(
+                 'list-actions',
+                 'a',
+                 InputOption::VALUE_NONE,
+                 'List all actions'
+             )
+             ->addOption(
+                 'list-conditions',
+                 'p',
+                 InputOption::VALUE_NONE,
+                 'List all conditions'
+             )
+             ->addOption(
+                 'list-options',
+                 'o',
+                 InputOption::VALUE_NONE,
+                 'List all options'
+             )
+             ->addOption(
+                 'list-config',
+                 's',
+                 InputOption::VALUE_NONE,
+                 'List all config settings'
+             )
+             ->addOption(
+                 'extensive',
+                 'e',
+                 InputOption::VALUE_NONE,
+                 'Show more detailed information'
+             );
+    }
+
+    /**
+     * Execute the command
+     *
+     * @param  \Symfony\Component\Console\Input\InputInterface   $input
+     * @param  \Symfony\Component\Console\Output\OutputInterface $output
+     * @return int
+     * @throws \CaptainHook\App\Exception\InvalidHookName
+     * @throws \Exception
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io     = $this->getIO($input, $output);
+        $config = $this->createConfig($input, true, ['git-directory']);
+        $repo   = $this->createRepository(dirname($config->getGitDirectory()));
+
+        $editor = new Reader($io, $config, $repo);
+        $editor->setHook(IOUtil::argToString($input->getArgument('hook')))
+               ->display(Reader::OPT_ACTIONS, $input->getOption('list-actions'))
+               ->display(Reader::OPT_CONDITIONS, $input->getOption('list-conditions'))
+               ->display(Reader::OPT_OPTIONS, $input->getOption('list-options'))
+               ->extensive($input->getOption('extensive'))
+               ->run();
+
+        return 0;
+    }
+}

tests/unit/Console/ApplicationTest.php

@@ -49,10 +49,9 @@ public function testExecuteList(): void
                        ->disableOriginalConstructor()
                        ->getMock();
 
-        $output->expects($this->atLeastOnce())->method('write');
-
         $app = new Application('captainhook');
         $app->setAutoExit(false);
-        $app->run($input, $output);
+
+        $this->assertEquals(0, $app->run($input, $output));
     }
 }

tests/unit/Console/Command/InfoTest.php

@@ -0,0 +1,54 @@
+<?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\Console\Command;
+
+use CaptainHook\App\Console\Runtime\Resolver;
+use CaptainHook\App\Git\DummyRepo;
+use CaptainHook\App\Runner\Config\Reader;
+use Exception;
+use org\bovigo\vfs\vfsStream;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\NullOutput;
+
+class InfoTest extends TestCase
+{
+    public function testFailsWithoutConfig(): void
+    {
+        $this->expectException(Exception::class);
+
+        $resolver = new Resolver();
+        $output   = new NullOutput();
+        $input    = new ArrayInput([
+            'hook'            => 'pre-commit',
+            '--configuration' => 'foo',
+        ]);
+
+        $install = new Info($resolver);
+        $install->run($input, $output);
+    }
+
+    public function testDisplaySingleHook(): void
+    {
+        $dummyRepo = new DummyRepo();
+        $resolver  = new Resolver();
+        $output    = new NullOutput();
+        $input     = new ArrayInput([
+            'hook' => 'pre-commit',
+            '-c'   => CH_PATH_FILES . '/config/valid.json',
+            '-g'   => $dummyRepo->getRoot() . '/.git',
+        ]);
+
+        $add = new Info($resolver);
+        $this->assertEquals(0, $add->run($input, $output));
+    }
+}