PHP-CS-Fixer/tests/Console/Report/FixReport/XmlReporterTest.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\Tests\Console\Report\FixReport;

use PhpCsFixer\Console\Application;
use PhpCsFixer\Console\Report\FixReport\ReporterInterface;
use PhpCsFixer\Console\Report\FixReport\XmlReporter;
use PhpCsFixer\PhpunitConstraintXmlMatchesXsd\Constraint\XmlMatchesXsd;
use Symfony\Component\Console\Formatter\OutputFormatter;

/**
 * @author Boris Gorbylev <ekho@ekho.name>
 * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * @internal
 *
 * @covers \PhpCsFixer\Console\Report\FixReport\XmlReporter
 */
final class XmlReporterTest extends AbstractReporterTestCase
{
    private static ?string $xsd = null;

    public static function setUpBeforeClass(): void
    {
        parent::setUpBeforeClass();

        $content = file_get_contents(__DIR__.'/../../../../doc/schemas/fix/xml.xsd');
        if (false === $content) {
            throw new \RuntimeException('Cannot read file.');
        }

        self::$xsd = $content;
    }

    public static function tearDownAfterClass(): void
    {
        parent::tearDownAfterClass();

        self::$xsd = null;
    }

    protected static function createNoErrorReport(): string
    {
        $about = Application::getAbout();

        return <<<XML
            <?xml version="1.0" encoding="UTF-8"?>
            <report>
              <about value="{$about}"/>
              <files />
            </report>
            XML;
    }

    protected static function createSimpleReport(): string
    {
        $about = Application::getAbout();

        return <<<XML
            <?xml version="1.0" encoding="UTF-8"?>
            <report>
              <about value="{$about}"/>
              <files>
                <file id="1" name="someFile.php">
                  <diff>--- Original
            +++ New
            @@ -2,7 +2,7 @@

             class Foo
             {
            -    public function bar(\$foo = 1, \$bar)
            +    public function bar(\$foo, \$bar)
                 {
                 }
             }</diff>
                </file>
              </files>
            </report>
            XML;
    }

    protected static function createWithDiffReport(): string
    {
        $about = Application::getAbout();

        return <<<XML
            <?xml version="1.0" encoding="UTF-8"?>
            <report>
              <about value="{$about}"/>
              <files>
                <file id="1" name="someFile.php">
                  <diff>--- Original
            +++ New
            @@ -2,7 +2,7 @@

             class Foo
             {
            -    public function bar(\$foo = 1, \$bar)
            +    public function bar(\$foo, \$bar)
                 {
                 }
             }</diff>
                </file>
              </files>
            </report>
            XML;
    }

    protected static function createWithAppliedFixersReport(): string
    {
        $about = Application::getAbout();

        return <<<XML
            <?xml version="1.0" encoding="UTF-8"?>
            <report>
              <about value="{$about}"/>
              <files>
                <file id="1" name="someFile.php">
                  <applied_fixers>
                    <applied_fixer name="some_fixer_name_here_1"/>
                    <applied_fixer name="some_fixer_name_here_2"/>
                  </applied_fixers>
                </file>
              </files>
            </report>
            XML;
    }

    protected static function createWithTimeAndMemoryReport(): string
    {
        $about = Application::getAbout();

        return <<<XML
            <?xml version="1.0" encoding="UTF-8"?>
            <report>
              <about value="{$about}"/>
              <files>
                <file id="1" name="someFile.php">
                  <diff>--- Original
            +++ New
            @@ -2,7 +2,7 @@

             class Foo
             {
            -    public function bar(\$foo = 1, \$bar)
            +    public function bar(\$foo, \$bar)
                 {
                 }
             }</diff>
                </file>
              </files>
              <time unit="s">
                <total value="1.234"/>
              </time>
              <memory value="2.5" unit="MB"/>
            </report>
            XML;
    }

    protected static function createComplexReport(): string
    {
        $about = Application::getAbout();

        return <<<XML
            <?xml version="1.0" encoding="UTF-8"?>
            <report>
              <about value="{$about}"/>
              <files>
                <file id="1" name="someFile.php">
                  <applied_fixers>
                    <applied_fixer name="some_fixer_name_here_1"/>
                    <applied_fixer name="some_fixer_name_here_2"/>
                  </applied_fixers>
                  <diff>this text is a diff ;)</diff>
                </file>
                <file id="2" name="anotherFile.php">
                  <applied_fixers>
                    <applied_fixer name="another_fixer_name_here"/>
                  </applied_fixers>
                  <diff>another diff here ;)</diff>
                </file>
              </files>
              <time unit="s">
                <total value="1.234"/>
              </time>
              <memory value="2.5" unit="MB"/>
            </report>
            XML;
    }

    protected function createReporter(): ReporterInterface
    {
        return new XmlReporter();
    }

    protected function getFormat(): string
    {
        return 'xml';
    }

    protected function assertFormat(string $expected, string $input): void
    {
        $formatter = new OutputFormatter();
        $input = $formatter->format($input);

        self::assertThat($input, new XmlMatchesXsd(self::$xsd));
        self::assertXmlStringEqualsXmlString($expected, $input);
    }
}