JUnitOutputFormatter.php

<?php

/**
 * JUnit specification:
 * - https://github.com/junit-team/junit5/blob/main/platform-tests/src/test/resources/jenkins-junit.xsda
 */

declare(strict_types=1);

namespace Rector\ChangesReporting\Output;

use DOMDocument;
use DOMElement;
use Rector\ChangesReporting\Contract\Output\OutputFormatterInterface;
use Rector\ValueObject\Configuration;
use Rector\ValueObject\ProcessResult;
use Symfony\Component\Console\Style\SymfonyStyle;

final readonly class JUnitOutputFormatter implements OutputFormatterInterface
{
    private const NAME = 'junit';

    private const XML_ATTRIBUTE_FILE = 'file';

    private const XML_ATTRIBUTE_NAME = 'name';

    private const XML_ATTRIBUTE_TYPE = 'type';

    private const XML_ELEMENT_TESTSUITES = 'testsuites';

    private const XML_ELEMENT_TESTSUITE = 'testsuite';

    private const XML_ELEMENT_TESTCASE = 'testcase';

    private const XML_ELEMENT_ERROR = 'error';

    public function __construct(
        private SymfonyStyle $symfonyStyle,
    ) {

    }

    public function getName(): string
    {
        return self::NAME;
    }

    public function report(ProcessResult $processResult, Configuration $configuration): void
    {
        if (! extension_loaded('dom')) {
            $this->symfonyStyle->warning(
                'The "dom" extension is not loaded. The rector could not generate a response in the JUnit format',
            );

            return;
        }

        $domDocument = new DOMDocument('1.0', 'UTF-8');

        $xmlTestSuite = $domDocument->createElement(self::XML_ELEMENT_TESTSUITE);
        $xmlTestSuite->setAttribute(self::XML_ATTRIBUTE_NAME, 'rector');

        $xmlTestSuites = $domDocument->createElement(self::XML_ELEMENT_TESTSUITES);
        $xmlTestSuites->appendChild($xmlTestSuite);

        $domDocument->appendChild($xmlTestSuites);

        $this->appendSystemErrors($processResult, $configuration, $domDocument, $xmlTestSuite);
        $this->appendFileDiffs($processResult, $configuration, $domDocument, $xmlTestSuite);

        echo $domDocument->saveXML() . PHP_EOL;
    }

    private function appendSystemErrors(
        ProcessResult $processResult,
        Configuration $configuration,
        DOMDocument $domDocument,
        DOMElement $domElement,
    ): void {
        if ($processResult->getSystemErrors() === []) {
            return;
        }

        foreach ($processResult->getSystemErrors() as $systemError) {
            $filePath = $configuration->isReportingWithRealPath()
                ? ($systemError->getAbsoluteFilePath() ?? '')
                : ($systemError->getRelativeFilePath() ?? '')
            ;

            $xmlError = $domDocument->createElement(self::XML_ELEMENT_ERROR, $systemError->getMessage());
            $xmlError->setAttribute(self::XML_ATTRIBUTE_TYPE, 'Error');

            $xmlTestCase = $domDocument->createElement(self::XML_ELEMENT_TESTCASE);
            $xmlTestCase->setAttribute(self::XML_ATTRIBUTE_FILE, $filePath);
            $xmlTestCase->setAttribute(self::XML_ATTRIBUTE_NAME, $filePath . ':' . $systemError->getLine());
            $xmlTestCase->appendChild($xmlError);

            $domElement->appendChild($xmlTestCase);
        }
    }

    private function appendFileDiffs(
        ProcessResult $processResult,
        Configuration $configuration,
        DOMDocument $domDocument,
        DOMElement $domElement,
    ): void {
        if ($processResult->getFileDiffs() === []) {
            return;
        }

        $fileDiffs = $processResult->getFileDiffs();
        ksort($fileDiffs);

        foreach ($fileDiffs as $fileDiff) {
            $filePath = $configuration->isReportingWithRealPath()
                ? ($fileDiff->getAbsoluteFilePath() ?? '')
                : ($fileDiff->getRelativeFilePath() ?? '')
            ;

            $rectorClasses = implode(' / ', $fileDiff->getRectorShortClasses());

            $xmlError = $domDocument->createElement(self::XML_ELEMENT_ERROR, $fileDiff->getDiff());
            $xmlError->setAttribute(self::XML_ATTRIBUTE_TYPE, $rectorClasses);

            $xmlTestCase = $domDocument->createElement(self::XML_ELEMENT_TESTCASE);
            $xmlTestCase->setAttribute(self::XML_ATTRIBUTE_FILE, $filePath);
            $xmlTestCase->setAttribute(self::XML_ATTRIBUTE_NAME, $filePath . ':' . $fileDiff->getFirstLineNumber());
            $xmlTestCase->appendChild($xmlError);

            $domElement->appendChild($xmlTestCase);
        }
    }
}