Merge pull request #32 from 123inkt/Allow-stdout-as-output-format

frankdekker · web-flow · commit 3708c55022b1 · 2023-03-28T18:29:35.000+02:00
Allow stdout as output format
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -54,7 +54,7 @@ jobs:
         run: php -dpcov.enabled=1 -dpcov.exclude="~vendor~" vendor/bin/phpunit --testsuite unit --coverage-clover ./.coverage/coverage.xml
 
       - name: Check coverage
-        run: php bin/phpfci inspect ./.coverage/coverage.xml ./.coverage/phpfci.xml --exit-code-on-failure
+        run: php bin/phpfci inspect ./.coverage/coverage.xml --exit-code-on-failure
 
   quality:
     name: Quality checks
diff --git a/README.md b/README.md
@@ -66,25 +66,45 @@ The base directory will be subtracted from the filepaths in coverage.xml
 
 Checkstyle format:
 ```shell script
-php vendor/bin/phpfci inspect coverage.xml reports/checkstyle.xml --report=checkstyle
+php vendor/bin/phpfci inspect coverage.xml --reportCheckstyle=reports/checkstyle.xml
 ```
 
 Gitlab format:
 ```shell script
-php vendor/bin/phpfci inspect coverage.xml reports/gitlab.errors.json --report=gitlab
+php vendor/bin/phpfci inspect coverage.xml --reportGitlab=reports/gitlab.errors.json
+```
+
+Gitlab format to file and text output to stdout:
+```shell script
+php vendor/bin/phpfci inspect coverage.xml --reportGitlab=reports/gitlab.errors.json --reportText
+```
+
+Text format to stdout:
+```shell script
+php vendor/bin/phpfci inspect coverage.xml
+```
+```shell script
+php vendor/bin/phpfci inspect coverage.xml --reportText
 ```
 
 ## Command line arguments
 
-| Option                    | Values                                   | Description                                                             |
-|---------------------------|------------------------------------------|-------------------------------------------------------------------------| 
-| `argument 1`              | `inspect`, `baseline`                    | the command to execute.                                                 |
-| `argument 2`              | `coverage.xml`                           | the phpunit clover coverage input file.                                 |
-| `argument 3`              | `phpfci.xml`                             | the output file to write to.                                            |
-| `--report=<report-style>` | `gitlab`, `checkstyle`                   | the output format. If absent will default to console.                   |
-| `--config=<path-to-file>` | `phpfci.xml`                             | the path to the config file.                                            |
-| `--baseDir=<path>`        | defaults to directory of the output file | The root directory of the project, will be used to make paths relative. |
-| `--exit-code-on-failure`  | -                                        | Set exit code to `1` when there are failures.                           |
+| Option                        | Values                                   | Description                                                             |
+|-------------------------------|------------------------------------------|-------------------------------------------------------------------------| 
+| `argument 1`                  | `inspect`, `baseline`                    | the command to execute.                                                 |
+| `argument 2`                  | `coverage.xml`                           | the phpunit clover coverage input file.                                 |
+| `--reportGitlab=[<file>]`     | filepath or if absent stdout             | the file (or stdout) to write the gitlab format to.                     |
+| `--reportCheckstyle=[<file>]` | filepath or if absent stdout             | the file (or stdout) to write the checkstyle format to.                 |
+| `--reportText=[<file>]`       | filepath or if absent stdout             | the file (or stdout) to write the checkstyle format to.                 |
+| `--config=<path-to-file>`     | `phpfci.xml`                             | the path to the config file.                                            |
+| `--baseDir=<path>`            | defaults to directory of the output file | The root directory of the project, will be used to make paths relative. |
+| `--exit-code-on-failure`      | -                                        | Set exit code to `1` when there are failures.                           |
+
+Note: if no `--reportGitlab`, `--reportCheckstyle` or `--reportText` is set, it will default to `--reportText=php://stdout`
+
+## Migrating from 1 to 2
+The third required argument and `--report` has been removed, and should be replaced by:
+`--reportGitlab=<file>`, `--reportCheckstyle=<file>` or `--reportText=<file>` 
 
 ## About us
 
diff --git a/src/Command/BaselineCommand.php b/src/Command/BaselineCommand.php
@@ -66,7 +66,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $failures = (new MetricsAnalyzer($metrics, $config))->analyze();
 
         // write to file
-        FileUtil::writeFile($outputPath, (new ConfigFileRenderer())->render($failures, $config));
+        FileUtil::writeTo($outputPath->getPathname(), (new ConfigFileRenderer())->render($failures, $config));
 
         $output->writeln('Config successfully written to: ' . $outputPath->getPathname());
 
diff --git a/src/Command/InspectCommand.php b/src/Command/InspectCommand.php
@@ -3,6 +3,8 @@
 
 namespace DigitalRevolution\CodeCoverageInspection\Command;
 
+use DigitalRevolution\CodeCoverageInspection\Lib\Config\ConfigFactory;
+use DigitalRevolution\CodeCoverageInspection\Lib\Config\ConfigViolation;
 use DigitalRevolution\CodeCoverageInspection\Lib\IO\DOMDocumentFactory;
 use DigitalRevolution\CodeCoverageInspection\Lib\IO\InspectionConfigFactory;
 use DigitalRevolution\CodeCoverageInspection\Lib\IO\MetricsFactory;
@@ -22,17 +24,26 @@
  */
 class InspectCommand extends Command
 {
-    private const CONFIG_FILES = ['phpfci.xml', 'phpfci.xml.dist'];
+    private ConfigFactory $configFactory;
+    private string        $schemaPath;
+
+    public function __construct(string $name = null)
+    {
+        parent::__construct($name);
+        $this->configFactory = new ConfigFactory();
+        $this->schemaPath    = dirname(__DIR__, 2) . '/resources/phpfci.xsd';
+    }
 
     protected function configure(): void
     {
         $this->setName("inspect")
             ->setDescription("PHPUnit code coverage inspection")
             ->addArgument('coverage', InputOption::VALUE_REQUIRED, 'Path to phpunit\'s coverage.xml')
-            ->addArgument('output', InputOption::VALUE_REQUIRED, 'Path to write inspections report file to')
             ->addOption('config', 'c', InputOption::VALUE_REQUIRED, 'Path to configuration file. Optional')
             ->addOption('baseDir', '', InputOption::VALUE_REQUIRED, 'Base directory from where to determine the relative config paths')
-            ->addOption('report', '', InputOption::VALUE_REQUIRED, 'output format, either checkstyle or gitlab', 'checkstyle')
+            ->addOption('reportGitlab', '', InputOption::VALUE_OPTIONAL, 'Gitlab output format. To file or if absent to stdout', false)
+            ->addOption('reportCheckstyle', '', InputOption::VALUE_OPTIONAL, 'Checkstyle output format. To file or if absent to stdout', false)
+            ->addOption('reportText', '', InputOption::VALUE_OPTIONAL, 'User-friendly text output format. To file or if absent to stdout', false)
             ->addOption('exit-code-on-failure', '', InputOption::VALUE_NONE, 'If failures, exit with failure exit code');
     }
 
@@ -41,25 +52,20 @@ protected function configure(): void
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $configPath       = FileUtil::getExistingFile($input->getOption('config') ?? FileUtil::findFilePath((string)getcwd(), self::CONFIG_FILES));
-        $baseDir          = $input->getOption('baseDir') ?? $configPath->getPath();
-        $coverageFilePath = FileUtil::getExistingFile($input->getArgument('coverage'));
-        $outputFilePath   = FileUtil::getFile($input->getArgument('output'));
-        $schema           = dirname(__DIR__, 2) . '/resources/phpfci.xsd';
-
-        if (is_string($baseDir) === false) {
-            $output->writeln("--baseDir argument is not valid. Expecting string argument");
+        $inputConfig = $this->configFactory->createInspectConfig($input);
+        if ($inputConfig instanceof ConfigViolation) {
+            $output->writeln($inputConfig->getMessage());
 
             return Command::FAILURE;
         }
 
         // gather data
-        $domConfig = DOMDocumentFactory::getValidatedDOMDocument($configPath, $schema);
-        $config    = InspectionConfigFactory::fromDOMDocument($baseDir, $domConfig);
-        $metrics   = MetricsFactory::getFileMetrics(DOMDocumentFactory::getDOMDocument($coverageFilePath));
+        $domConfig = DOMDocumentFactory::getValidatedDOMDocument($inputConfig->getConfigPath(), $this->schemaPath);
+        $config    = InspectionConfigFactory::fromDOMDocument($inputConfig->getBaseDir(), $domConfig);
+        $metrics   = MetricsFactory::getFileMetrics(DOMDocumentFactory::getDOMDocument($inputConfig->getCoverageFilepath()));
 
         if (count($metrics) === 0) {
-            $output->writeln("No metrics found in coverage file: " . $coverageFilePath->getPathname());
+            $output->writeln("No metrics found in coverage file: " . $inputConfig->getCoverageFilepath());
 
             return Command::FAILURE;
         }
@@ -68,20 +74,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $failures = (new MetricsAnalyzer($metrics, $config))->analyze();
 
         // write output
-        switch ($input->getOption('report')) {
-            case 'checkstyle':
-                FileUtil::writeFile($outputFilePath, (new CheckStyleRenderer())->render($config, $failures));
-                break;
-            case 'gitlab':
-                FileUtil::writeFile($outputFilePath, (new GitlabErrorRenderer())->render($config, $failures));
-                break;
-            default:
-                $output->write((new TextRenderer())->render($config, $failures));
-                break;
+        if ($inputConfig->getReportGitlab() !== null) {
+            FileUtil::writeTo($inputConfig->getReportGitlab(), (new GitlabErrorRenderer())->render($config, $failures));
+        }
+        if ($inputConfig->getReportCheckstyle() !== null) {
+            FileUtil::writeTo($inputConfig->getReportCheckstyle(), (new CheckStyleRenderer())->render($config, $failures));
+        }
+        if ($inputConfig->getReportText() !== null) {
+            FileUtil::writeTo($inputConfig->getReportText(), (new TextRenderer())->render($config, $failures));
         }
 
         // raise exit code on failure
-        if (count($failures) > 0 && $input->getOption('exit-code-on-failure') !== false) {
+        if (count($failures) > 0 && $inputConfig->isExitCodeOnFailure()) {
             return Command::FAILURE;
         }
 
diff --git a/src/Lib/Config/ConfigFactory.php b/src/Lib/Config/ConfigFactory.php
@@ -0,0 +1,64 @@
+<?php
+declare(strict_types=1);
+
+namespace DigitalRevolution\CodeCoverageInspection\Lib\Config;
+
+use DigitalRevolution\CodeCoverageInspection\Lib\Utility\FileUtil;
+use Symfony\Component\Console\Input\InputInterface;
+
+class ConfigFactory
+{
+    private const CONFIG_FILES = ['phpfci.xml', 'phpfci.xml.dist'];
+
+    /**
+     * @return ConfigViolation|InspectConfig
+     */
+    public function createInspectConfig(InputInterface $input)
+    {
+        $configPath       = FileUtil::getExistingFile($input->getOption('config') ?? FileUtil::findFilePath((string)getcwd(), self::CONFIG_FILES));
+        $coverageFilepath = FileUtil::getExistingFile($input->getArgument('coverage'));
+        $baseDir          = $input->getOption('baseDir') ?? $configPath->getPath();
+
+        if (is_string($baseDir) === false) {
+            return new ConfigViolation('--base-dir expecting a value string as argument');
+        }
+
+        $reportGitlab     = $this->getReport($input, 'reportGitlab');
+        $reportCheckstyle = $this->getReport($input, 'reportCheckstyle');
+        $reportText       = $this->getReport($input, 'reportText');
+
+        if ($reportGitlab instanceof ConfigViolation) {
+            return $reportGitlab;
+        }
+        if ($reportCheckstyle instanceof ConfigViolation) {
+            return $reportCheckstyle;
+        }
+        if ($reportText instanceof ConfigViolation) {
+            return $reportText;
+        }
+
+        $reports = array_filter([$reportGitlab, $reportCheckstyle, $reportText]);
+        if (count($reports) === 0) {
+            $reportText = 'php://stdout';
+        } elseif ($reports !== array_unique($reports)) {
+            return new ConfigViolation('Two or more reports output to the same destination');
+        }
+
+        $exitCodeOnFailure = $input->getOption('exit-code-on-failure') !== false;
+
+        return new InspectConfig($coverageFilepath, $configPath, $baseDir, $reportGitlab, $reportCheckstyle, $reportText, $exitCodeOnFailure);
+    }
+
+    /**
+     * @return ConfigViolation|string|null
+     */
+    private function getReport(InputInterface $input, string $option)
+    {
+        $report = $input->getOption($option) ?? 'php://stdout';
+        if ($report !== false && is_string($report) === false) {
+            return new ConfigViolation('--' . $option . ' expecting the value to absent or string argument');
+        }
+
+        return $report === false ? null : $report;
+    }
+}
diff --git a/src/Lib/Config/ConfigViolation.php b/src/Lib/Config/ConfigViolation.php
@@ -0,0 +1,19 @@
+<?php
+declare(strict_types=1);
+
+namespace DigitalRevolution\CodeCoverageInspection\Lib\Config;
+
+class ConfigViolation
+{
+    private string $message;
+
+    public function __construct(string $message)
+    {
+        $this->message = $message;
+    }
+
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+}
diff --git a/src/Lib/Config/InspectConfig.php b/src/Lib/Config/InspectConfig.php
@@ -0,0 +1,70 @@
+<?php
+declare(strict_types=1);
+
+namespace DigitalRevolution\CodeCoverageInspection\Lib\Config;
+
+use SplFileInfo;
+
+class InspectConfig
+{
+    private SplFileInfo $coverageFilepath;
+    private SplFileInfo $configPath;
+    private string      $baseDir;
+    private ?string     $reportGitlab;
+    private ?string     $reportCheckstyle;
+    private ?string     $reportText;
+    private bool        $exitCodeOnFailure;
+
+    public function __construct(
+        SplFileInfo $coverageFilepath,
+        SplFileInfo $configPath,
+        string $baseDir,
+        ?string $reportGitlab,
+        ?string $reportCheckstyle,
+        ?string $reportText,
+        bool $exitCodeOnFailure
+    ) {
+        $this->coverageFilepath  = $coverageFilepath;
+        $this->configPath        = $configPath;
+        $this->baseDir           = $baseDir;
+        $this->reportGitlab      = $reportGitlab;
+        $this->reportCheckstyle  = $reportCheckstyle;
+        $this->reportText        = $reportText;
+        $this->exitCodeOnFailure = $exitCodeOnFailure;
+    }
+
+    public function getCoverageFilepath(): SplFileInfo
+    {
+        return $this->coverageFilepath;
+    }
+
+    public function getConfigPath(): SplFileInfo
+    {
+        return $this->configPath;
+    }
+
+    public function getBaseDir(): string
+    {
+        return $this->baseDir;
+    }
+
+    public function getReportGitlab(): ?string
+    {
+        return $this->reportGitlab;
+    }
+
+    public function getReportCheckstyle(): ?string
+    {
+        return $this->reportCheckstyle;
+    }
+
+    public function getReportText(): ?string
+    {
+        return $this->reportText;
+    }
+
+    public function isExitCodeOnFailure(): bool
+    {
+        return $this->exitCodeOnFailure;
+    }
+}
diff --git a/src/Lib/Utility/FileUtil.php b/src/Lib/Utility/FileUtil.php
@@ -63,19 +63,19 @@ public static function getExistingFile($path): SplFileInfo
         return $fileInfo;
     }
 
-    public static function writeFile(SplFileInfo $file, string $content): void
+    public static function writeTo(string $filepath, string $content): void
     {
-        $dir = $file->getPath();
-        if ($dir !== '' && !is_dir($dir) && !mkdir($dir, 0777, true) && !is_dir($dir)) {
+        $dir = dirname($filepath);
+        if (str_starts_with($filepath, "php://") === false && $dir !== '' && !is_dir($dir) && !mkdir($dir, 0777, true) && !is_dir($dir)) {
             // @codeCoverageIgnoreStart
             throw new RuntimeException(sprintf('Failed to create directory "%s".', $dir));
             // @codeCoverageIgnoreEnd
         }
 
-        $success = @file_put_contents($file->getPathname(), $content);
+        $success = @file_put_contents($filepath, $content);
         if ($success === false) {
             // @codeCoverageIgnoreStart
-            throw new RuntimeException(sprintf('Failed to write to file "%s".', $file->getPathname()));
+            throw new RuntimeException(sprintf('Failed to write to file "%s".', $filepath));
             // @codeCoverageIgnoreEnd
         }
     }
diff --git a/tests/Functional/Command/InspectCommand/InspectCommandTest.php b/tests/Functional/Command/InspectCommand/InspectCommandTest.php
@@ -10,6 +10,7 @@
 use org\bovigo\vfs\vfsStreamFile;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Exception\ExceptionInterface;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Output\ConsoleOutput;
 
@@ -24,9 +25,11 @@ protected function setUp(): void
     }
 
     /**
+     * @param string[] $flags
+     *
      * @coversNothing
      * @dataProvider dataProvider
-     * @throws Exception
+     * @throws Exception|ExceptionInterface
      */
     public function testInspectCommand(array $flags, int $exitStatus): void
     {
@@ -39,7 +42,9 @@ public function testInspectCommand(array $flags, int $exitStatus): void
 
         // prepare command
         $command = new InspectCommand();
-        $input   = new ArgvInput(array_merge(['phpfci', '--config', $configPath, '--baseDir', $baseDir, $coveragePath, $output], $flags));
+        $input   = new ArgvInput(
+            array_merge(['phpfci', '--config', $configPath, '--baseDir', $baseDir, $coveragePath, '--reportCheckstyle', $output], $flags)
+        );
         $output  = new ConsoleOutput();
 
         // run test case
@@ -54,6 +59,9 @@ public function testInspectCommand(array $flags, int $exitStatus): void
         static::assertSame($expected, $result);
     }
 
+    /**
+     * @return array<string, array{0: string[], 1:int}>
+     */
     public function dataProvider(): array
     {
         return [
diff --git a/tests/Unit/Lib/Config/ConfigFactoryTest.php b/tests/Unit/Lib/Config/ConfigFactoryTest.php
diff --git a/tests/Unit/Lib/Config/ConfigViolationTest.php b/tests/Unit/Lib/Config/ConfigViolationTest.php
diff --git a/tests/Unit/Lib/Config/InspectConfigTest.php b/tests/Unit/Lib/Config/InspectConfigTest.php
diff --git a/tests/Unit/Lib/Utility/FileUtilTest.php b/tests/Unit/Lib/Utility/FileUtilTest.php

Original file line number	Diff line number	Diff line change
`@@ -63,19 +63,19 @@ public static function getExistingFile($path): SplFileInfo`
`63`	`63`	`return $fileInfo;`
`64`	`64`	`}`
`65`	`65`
`66`		`- public static function writeFile(SplFileInfo $file, string $content): void`
	`66`	`+ public static function writeTo(string $filepath, string $content): void`
`67`	`67`	`{`
`68`		`- $dir = $file->getPath();`
`69`		`- if ($dir !== '' && !is_dir($dir) && !mkdir($dir, 0777, true) && !is_dir($dir)) {`
	`68`	`+ $dir = dirname($filepath);`
	`69`	`+ if (str_starts_with($filepath, "php://") === false && $dir !== '' && !is_dir($dir) && !mkdir($dir, 0777, true) && !is_dir($dir)) {`
`70`	`70`	`// @codeCoverageIgnoreStart`
`71`	`71`	`throw new RuntimeException(sprintf('Failed to create directory "%s".', $dir));`
`72`	`72`	`// @codeCoverageIgnoreEnd`
`73`	`73`	`}`
`74`	`74`
`75`		`- $success = @file_put_contents($file->getPathname(), $content);`
	`75`	`+ $success = @file_put_contents($filepath, $content);`
`76`	`76`	`if ($success === false) {`
`77`	`77`	`// @codeCoverageIgnoreStart`
`78`		`- throw new RuntimeException(sprintf('Failed to write to file "%s".', $file->getPathname()));`
	`78`	`+ throw new RuntimeException(sprintf('Failed to write to file "%s".', $filepath));`
`79`	`79`	`// @codeCoverageIgnoreEnd`
`80`	`80`	`}`
`81`	`81`	`}`