Merge pull request #485 from qossmic/report-skipped-table-output-form…

…atter Add support for report skipped option in TableOutputFormatter
qossmic · Feb 8, 2021 · 707f136 · 707f136
2 parents 20db2a4 + 3813a8c
commit 707f136
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 7 deletions.
diff --git a/src/OutputFormatter/TableOutputFormatter.php b/src/OutputFormatter/TableOutputFormatter.php
@@ -40,13 +40,14 @@ public function finish(
     ): void {
         $groupedRules = [];
         $reportUncovered = $outputFormatterInput->getOptionAsBoolean(AnalyzeCommand::OPTION_REPORT_UNCOVERED);
+        $reportSkipped = $outputFormatterInput->getOptionAsBoolean(AnalyzeCommand::OPTION_REPORT_SKIPPED);
 
         foreach ($context->rules() as $rule) {
             if ($rule instanceof Allowed) {
                 continue;
             }
 
-            if ($rule instanceof Violation || $rule instanceof SkippedViolation) {
+            if ($rule instanceof Violation || ($reportSkipped && $rule instanceof SkippedViolation)) {
                 $groupedRules[$rule->getLayerA()][] = $rule;
             } elseif ($reportUncovered && $rule instanceof Uncovered) {
                 $groupedRules[$rule->getLayer()][] = $rule;

diff --git a/tests/OutputFormatter/TableOutputFormatterTest.php b/tests/OutputFormatter/TableOutputFormatterTest.php
@@ -139,7 +139,7 @@ public function basicDataProvider(): iterable
 ',
         ];
 
-        yield [
+        yield 'skipped violations' => [
             [
                 new SkippedViolation(
                     new Dependency($originalA, $originalB, FileOccurrence::fromFilepath('originalA.php', 12)),
@@ -168,15 +168,39 @@ public function basicDataProvider(): iterable
 ',
         ];
 
-        yield [
+        yield 'skipped violations without reporting' => [
             [
+                new SkippedViolation(
+                    new Dependency($originalA, $originalB, FileOccurrence::fromFilepath('originalA.php', 12)),
+                    'LayerA',
+                    'LayerB'
+                ),
+            ],
+            [],
+            '
+ -------------------- ----- 
+  Report                    
+ -------------------- ----- 
+  Violations           0    
+  Skipped violations   1    
+  Uncovered            0    
+  Allowed              0    
+ -------------------- ----- 
+
+',
+            'reportUncovered' => true,
+            'reportSkipped' => false,
+        ];
+
+        yield 'uncovered' => [
+            'rules' => [
                 new Uncovered(
                     new Dependency($originalA, $originalB, FileOccurrence::fromFilepath('originalA.php', 12)),
                     'LayerA'
                 ),
             ],
-            [],
-            ' ----------- ------------------------------------------------- 
+            'errors' => [],
+            'expectedOutput' => ' ----------- ------------------------------------------------- 
   Reason      LayerA                                           
  ----------- ------------------------------------------------- 
   Uncovered   OriginalA has uncovered dependency on OriginalB  
@@ -196,6 +220,28 @@ public function basicDataProvider(): iterable
 ',
         ];
 
+        yield 'uncovered without reporting' => [
+            'rules' => [
+                new Uncovered(
+                    new Dependency($originalA, $originalB, FileOccurrence::fromFilepath('originalA.php', 12)),
+                    'LayerA'
+                ),
+            ],
+            'errors' => [],
+            'expectedOutput' => '
+ -------------------- ----- 
+  Report                    
+ -------------------- ----- 
+  Violations           0    
+  Skipped violations   0    
+  Uncovered            1    
+  Allowed              0    
+ -------------------- ----- 
+
+',
+            'reportUncovered' => false,
+        ];
+
         yield 'an error occurred' => [
             [],
             [new Error('an error occurred')],
@@ -222,7 +268,7 @@ public function basicDataProvider(): iterable
     /**
      * @dataProvider basicDataProvider
      */
-    public function testBasic(array $rules, array $errors, string $expectedOutput): void
+    public function testBasic(array $rules, array $errors, string $expectedOutput, bool $reportUncovered = true, bool $reportSkipped = true): void
     {
         $bufferedOutput = new BufferedOutput();
         $output = new SymfonyOutput(
@@ -234,7 +280,10 @@ public function testBasic(array $rules, array $errors, string $expectedOutput):
         $formatter->finish(
             new Context($rules, $errors),
             $output,
-            new OutputFormatterInput([AnalyzeCommand::OPTION_REPORT_UNCOVERED => true])
+            new OutputFormatterInput([
+                AnalyzeCommand::OPTION_REPORT_UNCOVERED => $reportUncovered,
+                AnalyzeCommand::OPTION_REPORT_SKIPPED => $reportSkipped,
+            ])
         );
 
         static::assertEquals($expectedOutput, $bufferedOutput->fetch());