Add configuration for checkstyle report #8

scheb · Aug 11, 2020 · 5bd1e6e · 5bd1e6e
1 parent 9425472
commit 5bd1e6e
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 0 deletions.
diff --git a/app/tombstone.yml b/app/tombstone.yml
@@ -10,5 +10,6 @@ logs:
     directory: logs
 report:
     php: report/tombstone-report.php
+    checkstyle: report/checkstyle.xml
     html: report
     console: true
diff --git a/src/analyzer/Cli/AnalyzeCommand.php b/src/analyzer/Cli/AnalyzeCommand.php
@@ -19,6 +19,7 @@
 use Scheb\Tombstone\Analyzer\Model\VampireIndex;
 use Scheb\Tombstone\Analyzer\Processing\Processor;
 use Scheb\Tombstone\Analyzer\Processing\VampireMatcher;
+use Scheb\Tombstone\Analyzer\Report\Checkstyle\CheckstyleReportGenerator;
 use Scheb\Tombstone\Analyzer\Report\Console\ConsoleReportGenerator;
 use Scheb\Tombstone\Analyzer\Report\Html\HtmlReportGenerator;
 use Scheb\Tombstone\Analyzer\Report\Html\Renderer\BreadCrumbRenderer;
@@ -137,6 +138,9 @@ private function doExecute(): void
                 )
             );
         }
+        if (isset($config['report']['checkstyle'])) {
+            $reportGenerators[] = new CheckstyleReportGenerator($config['report']['checkstyle']);
+        }
         if (isset($config['report']['php'])) {
             $reportGenerators[] = new PhpReportGenerator($config['report']['php']);
         }

diff --git a/src/analyzer/Config/Configuration.php b/src/analyzer/Config/Configuration.php
@@ -77,6 +77,13 @@ public function getConfigTreeBuilder()
                                 ->thenInvalid('Must be a writable file path, given: %s')
                             ->end()
                         ->end()
+                        ->scalarNode('checkstyle')
+                            ->defaultNull()
+                            ->validate()
+                                ->ifTrue($this->isNotWritableFile())
+                                ->thenInvalid('Must be a writable file path, given: %s')
+                            ->end()
+                        ->end()
                         ->scalarNode('html')
                             ->defaultNull()
                             ->validate()

diff --git a/src/analyzer/Config/YamlConfigProvider.php b/src/analyzer/Config/YamlConfigProvider.php
@@ -44,6 +44,10 @@ public function readConfiguration(): array
             $config['report']['php'] = $this->resolvePath($config['report']['php']);
         }
 
+        if (isset($config['report']['checkstyle'])) {
+            $config['report']['checkstyle'] = $this->resolvePath($config['report']['checkstyle']);
+        }
+
         if (isset($config['report']['html'])) {
             $config['report']['html'] = $this->resolvePath($config['report']['html']);
         }

diff --git a/tests/Analyzer/Cli/ApplicationTest.php b/tests/Analyzer/Cli/ApplicationTest.php
@@ -28,6 +28,7 @@ class ApplicationTest extends TestCase
         '_img/cross.png',
         '_img/deleted.png',
         '_img/vampire.png',
+        'checkstyle.xml',
         'dashboard.html',
         'index.html',
         'src',

diff --git a/tests/Analyzer/Config/ConfigurationTest.php b/tests/Analyzer/Config/ConfigurationTest.php
@@ -26,7 +26,9 @@ class ConfigurationTest extends TestCase
         ],
         'report' => [
             'php' => self::REPORT_DIR.'/report.php',
+            'checkstyle' => self::REPORT_DIR.'/checkstyle.xml',
             'html' => self::REPORT_DIR,
+            'console' => true,
         ],
     ];
 

diff --git a/tests/Analyzer/Config/YamlConfigProviderTest.php b/tests/Analyzer/Config/YamlConfigProviderTest.php
@@ -62,6 +62,7 @@ public function processConfiguration_fullConfig_haveAllValuesSet(): void
             ],
             'report' => [
                 'php' => self::CONFIG_DIR.'report'.DIRECTORY_SEPARATOR.'tombstone-report.php',
+                'checkstyle' => self::CONFIG_DIR.'report'.DIRECTORY_SEPARATOR.'checkstyle.xml',
                 'html' => self::CONFIG_DIR.'report',
                 'console' => true,
             ],

diff --git a/tests/Analyzer/Config/fixtures/full.yml b/tests/Analyzer/Config/fixtures/full.yml
@@ -10,5 +10,6 @@ logs:
     directory: logs
 report:
     php: report/tombstone-report.php
+    checkstyle: report/checkstyle.xml
     html: report
     console: true