Allow to print Junit report in human-readable format #154
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace ShipMonk\ComposerDependencyAnalyser\Result; | ||
|
|
||
| use DOMDocument; | ||
| use DOMElement; | ||
| use ShipMonk\ComposerDependencyAnalyser\Printer; | ||
|
|
||
| abstract class AbstractXmlFormatter | ||
|
|
||
| { | ||
|
|
||
| /** | ||
| * @var Printer | ||
| */ | ||
| protected $printer; | ||
|
|
||
| /** | ||
| * @var DOMDocument | ||
| */ | ||
| protected $document; | ||
|
|
||
| /** | ||
| * @var DOMElement | ||
| */ | ||
| protected $rootElement; | ||
|
There was a problem hiding this comment. Please keep only other services inside formatter service. This state is not needed as property as it is needed only for |
||
|
|
||
| public function __construct(Printer $printer, bool $verbose) | ||
| { | ||
| $this->printer = $printer; | ||
|
|
||
| $this->document = new DOMDocument('1.0', 'UTF-8'); | ||
| $this->document->formatOutput = $verbose; | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
|
|
||
| namespace ShipMonk\ComposerDependencyAnalyser\Result; | ||
|
|
||
| use DOMException; | ||
| use ShipMonk\ComposerDependencyAnalyser\CliOptions; | ||
| use ShipMonk\ComposerDependencyAnalyser\Config\Configuration; | ||
| use ShipMonk\ComposerDependencyAnalyser\Config\Ignore\UnusedErrorIgnore; | ||
|
|
@@ -19,9 +20,10 @@ | |
| use function substr; | ||
| use const ENT_COMPAT; | ||
| use const ENT_XML1; | ||
| use const LIBXML_NOEMPTYTAG; | ||
| use const PHP_INT_MAX; | ||
|
|
||
| final class JunitFormatter extends AbstractXmlFormatter implements ResultFormatter | ||
| { | ||
|
|
||
| /** | ||
|
|
@@ -30,25 +32,29 @@ class JunitFormatter implements ResultFormatter | |
| private $cwd; | ||
|
|
||
| /** | ||
| * @throws DOMException | ||
| */ | ||
| public function __construct(string $cwd, Printer $printer, ?bool $verbose = null) | ||
| { | ||
| if ($verbose === null) { | ||
| $verbose = false; | ||
| } | ||
|
|
||
| parent::__construct($printer, $verbose); | ||
| $this->cwd = $cwd; | ||
| $this->rootElement = $this->document->createElement('testsuites'); | ||
| $this->document->appendChild($this->rootElement); | ||
| } | ||
|
|
||
| /** | ||
| * @throws DOMException | ||
| */ | ||
| public function format( | ||
| AnalysisResult $result, | ||
| CliOptions $options, | ||
| Configuration $configuration | ||
| ): int | ||
| { | ||
| $hasError = false; | ||
| $unusedIgnores = $result->getUnusedIgnores(); | ||
|
|
||
|
|
@@ -63,7 +69,7 @@ public function format( | |
|
|
||
| if (count($unknownClassErrors) > 0) { | ||
| $hasError = true; | ||
| $this->createSymbolBasedTestSuite( | ||
| 'unknown classes', | ||
| $unknownClassErrors, | ||
| $maxShownUsages | ||
|
|
@@ -72,7 +78,7 @@ public function format( | |
|
|
||
| if (count($unknownFunctionErrors) > 0) { | ||
| $hasError = true; | ||
| $this->createSymbolBasedTestSuite( | ||
| 'unknown functions', | ||
| $unknownFunctionErrors, | ||
| $maxShownUsages | ||
|
|
@@ -81,7 +87,7 @@ public function format( | |
|
|
||
| if (count($shadowDependencyErrors) > 0) { | ||
| $hasError = true; | ||
| $this->createPackageBasedTestSuite( | ||
| 'shadow dependencies', | ||
| $shadowDependencyErrors, | ||
| $maxShownUsages | ||
|
|
@@ -90,7 +96,7 @@ public function format( | |
|
|
||
| if (count($devDependencyInProductionErrors) > 0) { | ||
| $hasError = true; | ||
| $this->createPackageBasedTestSuite( | ||
| 'dev dependencies in production code', | ||
| $devDependencyInProductionErrors, | ||
| $maxShownUsages | ||
|
|
@@ -99,7 +105,7 @@ public function format( | |
|
|
||
| if (count($prodDependencyOnlyInDevErrors) > 0) { | ||
| $hasError = true; | ||
| $this->createPackageBasedTestSuite( | ||
| 'prod dependencies used only in dev paths', | ||
| array_fill_keys($prodDependencyOnlyInDevErrors, []), | ||
| $maxShownUsages | ||
|
|
@@ -108,7 +114,7 @@ public function format( | |
|
|
||
| if (count($unusedDependencyErrors) > 0) { | ||
| $hasError = true; | ||
| $this->createPackageBasedTestSuite( | ||
| 'unused dependencies', | ||
| array_fill_keys($unusedDependencyErrors, []), | ||
| $maxShownUsages | ||
|
|
@@ -117,12 +123,16 @@ public function format( | |
|
|
||
| if ($unusedIgnores !== [] && $configuration->shouldReportUnmatchedIgnoredErrors()) { | ||
| $hasError = true; | ||
| $this->createUnusedIgnoresTestSuite($unusedIgnores); | ||
| } | ||
|
|
||
| $xmlString = $this->document->saveXML(null, LIBXML_NOEMPTYTAG); | ||
|
|
||
| if ($xmlString === false) { | ||
| $xmlString = ''; | ||
|
There was a problem hiding this comment. Isnt this hiding some failure? I think this should be some exception. There was a problem hiding this comment. Maybe you need something like this to get proper exception message. Not sure tho... |
||
| } | ||
|
|
||
| $this->printer->print($xmlString); | ||
|
|
||
| if ($hasError) { | ||
| return 255; | ||
|
|
@@ -146,13 +156,20 @@ private function getMaxUsagesShownForErrors(CliOptions $options): int | |
|
|
||
| /** | ||
| * @param array<string, list<SymbolUsage>> $errors | ||
| * @throws DOMException | ||
| */ | ||
| private function createSymbolBasedTestSuite(string $title, array $errors, int $maxShownUsages): void | ||
| { | ||
| $testsuite = $this->document->createElement('testsuite'); | ||
| $testsuite->setAttribute('name', $this->escape($title)); | ||
| $testsuite->setAttribute('failures', sprintf('%u', count($errors))); | ||
|
|
||
| $this->rootElement->appendChild($testsuite); | ||
|
|
||
| foreach ($errors as $symbol => $usages) { | ||
| $testcase = $this->document->createElement('testcase'); | ||
| $testcase->setAttribute('name', $this->escape($symbol)); | ||
| $testsuite->appendChild($testcase); | ||
|
|
||
| if ($maxShownUsages > 1) { | ||
| $failureUsage = []; | ||
|
|
@@ -170,38 +187,43 @@ private function createSymbolBasedTestSuite(string $title, array $errors, int $m | |
| } | ||
| } | ||
|
|
||
| $failureMessage = $this->escape(implode('\n', $failureUsage)); | ||
| } else { | ||
| $firstUsage = $usages[0]; | ||
| $restUsagesCount = count($usages) - 1; | ||
| $rest = $restUsagesCount > 0 ? " (+ {$restUsagesCount} more)" : ''; | ||
|
|
||
| $failureMessage = sprintf('in %s%s', $this->escape($this->relativizeUsage($firstUsage)), $rest); | ||
| } | ||
|
|
||
| $failure = $this->document->createElement('failure', $failureMessage); | ||
| $testcase->appendChild($failure); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param array<string, array<string, list<SymbolUsage>>> $errors | ||
| * @throws DOMException | ||
| */ | ||
| private function createPackageBasedTestSuite(string $title, array $errors, int $maxShownUsages): void | ||
| { | ||
| $testsuite = $this->document->createElement('testsuite'); | ||
| $testsuite->setAttribute('name', $this->escape($title)); | ||
| $testsuite->setAttribute('failures', sprintf('%u', count($errors))); | ||
|
|
||
| $this->rootElement->appendChild($testsuite); | ||
|
|
||
| foreach ($errors as $packageName => $usagesPerClassname) { | ||
| $testcase = $this->document->createElement('testcase'); | ||
| $testcase->setAttribute('name', $this->escape($packageName)); | ||
| $testsuite->appendChild($testcase); | ||
|
|
||
| $failure = $this->document->createElement( | ||
| 'failure', | ||
| $this->escape(implode('\n', $this->createUsages($usagesPerClassname, $maxShownUsages))) | ||
|
There was a problem hiding this comment. I believe this should be Yes, it was buggy even before your change. |
||
| ); | ||
| $testcase->appendChild($failure); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -265,17 +287,23 @@ static function (int $carry, array $usages): int { | |
|
|
||
| /** | ||
| * @param list<UnusedSymbolIgnore|UnusedErrorIgnore> $unusedIgnores | ||
| * @throws DOMException | ||
| */ | ||
| private function createUnusedIgnoresTestSuite(array $unusedIgnores): void | ||
| { | ||
| $testsuite = $this->document->createElement('testsuite'); | ||
| $testsuite->setAttribute('name', 'unused-ignore'); | ||
| $testsuite->setAttribute('failures', sprintf('%u', count($unusedIgnores))); | ||
|
|
||
| $this->rootElement->appendChild($testsuite); | ||
|
|
||
| foreach ($unusedIgnores as $unusedIgnore) { | ||
| if ($unusedIgnore instanceof UnusedSymbolIgnore) { | ||
| $kind = $unusedIgnore->getSymbolKind() === SymbolKind::CLASSLIKE ? 'class' : 'function'; | ||
| $regex = $unusedIgnore->isRegex() ? ' regex' : ''; | ||
| $message = "Unknown {$kind}{$regex} '{$unusedIgnore->getUnknownSymbol()}' was ignored, but it was never applied."; | ||
|
|
||
| $testcaseName = $this->escape($unusedIgnore->getUnknownSymbol()); | ||
| } else { | ||
| $package = $unusedIgnore->getPackage(); | ||
| $path = $unusedIgnore->getPath(); | ||
|
|
@@ -297,11 +325,16 @@ private function createUnusedIgnoresTestSuite(array $unusedIgnores): string | |
| $message = "'{$unusedIgnore->getErrorType()}' was ignored for package '{$package}' and path '{$this->relativizePath($path)}', but it was never applied."; | ||
| } | ||
|
|
||
| $testcaseName = $this->escape($unusedIgnore->getErrorType()); | ||
| } | ||
|
|
||
| $testcase = $this->document->createElement('testcase'); | ||
| $testcase->setAttribute('name', $testcaseName); | ||
| $testsuite->appendChild($testcase); | ||
|
|
||
| $failure = $this->document->createElement('failure', $this->escape($message)); | ||
| $testcase->appendChild($failure); | ||
| } | ||
| } | ||
|
|
||
| private function relativizeUsage(SymbolUsage $usage): string | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please keep those only soft-required. I dont want to force everybody to have those. Majority uses only console output.
Just detect presence only when junit formatter is used and emit error if not.