ADD ability for results parser to throw exception if SA tool reports …

…a failure

src/Domain/Creator/BaseLineCreatorInterface.php

@@ -12,6 +12,7 @@
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\HistoryAnalyser\HistoryAnalyserException;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\HistoryAnalyser\HistoryFactory;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsImportException;
+use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ErrorReportedByStaticAnalysisTool;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser;
 
 interface BaseLineCreatorInterface
@@ -21,6 +22,7 @@ interface BaseLineCreatorInterface
      * @throws BaseLineImportException
      * @throws AnalysisResultsImportException
      * @throws HistoryAnalyserException
+     * @throws ErrorReportedByStaticAnalysisTool
      */
     public function createBaseLine(
         HistoryFactory $historyFactory,

src/Domain/Pruner/ResultsPruner.php

@@ -13,6 +13,7 @@
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\HistoryAnalyser\HistoryAnalyserException;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsImporter;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsImportException;
+use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ErrorReportedByStaticAnalysisTool;
 
 class ResultsPruner implements ResultsPrunerInterface
 {
@@ -44,6 +45,7 @@ public function __construct(
      * @throws FileAccessException
      * @throws AnalysisResultsImportException
      * @throws HistoryAnalyserException
+     * @throws ErrorReportedByStaticAnalysisTool
      */
     public function getPrunedResults(
         BaseLineFileName $baseLineFileName,

src/Domain/ResultsParser/AnalysisResultsImporter.php

@@ -12,6 +12,7 @@ class AnalysisResultsImporter
 {
     /**
      * @throws AnalysisResultsImportException
+     * @throws ErrorReportedByStaticAnalysisTool
      */
     public function import(
         ResultsParser $resultsParser,

src/Domain/ResultsParser/ErrorReportedByStaticAnalysisTool.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * Static Analysis Results Baseliner (sarb).
+ *
+ * (c) Dave Liddament
+ *
+ * For the full copyright and licence information please view the LICENSE file distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser;
+
+use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\SarbException;
+
+/**
+ * Thrown if the static analysis tool reports an error.
+ */
+final class ErrorReportedByStaticAnalysisTool extends SarbException
+{
+}

src/Domain/ResultsParser/ResultsParser.php

@@ -23,6 +23,7 @@ interface ResultsParser
      *
      * @throws ParseAtLocationException
      * @throws InvalidContentTypeException
+     * @throws ErrorReportedByStaticAnalysisTool
      */
     public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults;
 

src/Framework/Command/internal/ErrorReporter.php

@@ -9,6 +9,7 @@
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\File\FileAccessException;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\HistoryAnalyser\HistoryAnalyserException;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsImportException;
+use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ErrorReportedByStaticAnalysisTool;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ErrorReporter
@@ -37,6 +38,10 @@ public static function reportError(OutputInterface $output, \Throwable $throwabl
             OutputWriter::writeToStdError($output, $e->getMessage(), true);
 
             return 15;
+        } catch (ErrorReportedByStaticAnalysisTool $e) {
+            OutputWriter::writeToStdError($output, $e->getMessage(), true);
+
+            return 16;
         } catch (\Throwable $e) {
             // This should never happen. All exceptions should extend SarbException
             OutputWriter::writeToStdError($output, "Unexpected critical error: {$e->getMessage()}", true);

tests/Unit/Framework/Command/CreateBaseLineCommandTest.php

@@ -8,6 +8,7 @@
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\ProjectRoot;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\HistoryAnalyser\HistoryFactory;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\HistoryAnalyser\UnifiedDiffParser\Parser;
+use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ErrorReportedByStaticAnalysisTool;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Command\CreateBaseLineCommand;
 use DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Container\HistoryFactoryRegistry;
@@ -224,6 +225,26 @@ public function testSimulateThrowable(): void
         $this->assertReturnCode(100, $commandTester);
     }
 
+    public function testSimulateStaticAnalysisToolFailed(): void
+    {
+        $commandTester = $this->createCommandTester(
+            $this->historyFactoryStub,
+            $this->defaultResultsParser,
+            self::BASELINE_FILENAME,
+            null,
+            new ErrorReportedByStaticAnalysisTool('Tool failed'),
+        );
+
+        $commandTester->execute([
+            self::HISTORY_ANALYSER => HistoryFactoryStub::CODE,
+            self::BASELINE_FILE_ARGUMENT => self::BASELINE_FILENAME,
+            self::PROJECT_ROOT => '/tmp',
+        ]);
+
+        $this->assertReturnCode(16, $commandTester);
+        $this->assertResponseContains('Tool failed', $commandTester);
+    }
+
     private function createCommandTester(
         HistoryFactory $expectedHistoryFactory,
         ResultsParser $expectedResultsParser,