simplesamlphp / xml-common

src/XML/TestUtils/SchemaValidationTestTrait.php

<?php

declare(strict_types=1);

namespace SimpleSAML\XML\TestUtils;

use DOMDocument;
use PHPUnit\Framework\Attributes\Depends;

The type PHPUnit\Framework\Attributes\Depends was not found. Maybe you did not declare it correctly or list all dependencies?

use SimpleSAML\XML\DOMDocumentFactory;

use function class_exists;

/**
 * Test for AbstractElement classes to perform schema validation tests.
 *
 * @package simplesamlphp\xml-common
 * @phpstan-ignore trait.unused
 */
trait SchemaValidationTestTrait
{
    /** @var string|null */
    protected static ?string $schemaFile = null;

    /** @var class-string */

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

    protected static string $testedClass;

    /** @var \DOMDocument */
    protected static DOMDocument $xmlRepresentation;


    /**
     * Test schema validation.
     */
    #[Depends('testSerialization')]
    public function testSchemaValidation(): void
    {
        if (!class_exists(self::$testedClass)) {
            $this->markTestSkipped(

It seems like markTestSkipped() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                'Unable to run ' . self::class . '::testSchemaValidation(). Please set ' . self::class
                . ':$testedClass to a class-string representing the XML-class being tested',
            );
        } elseif (empty(self::$xmlRepresentation)) {
            $this->markTestSkipped(
                'Unable to run ' . self::class . '::testSchemaValidation(). Please set ' . self::class
                . ':$xmlRepresentation to a DOMDocument representing the XML-class being tested',
            );
        } else {
            // Validate before serialization
            self::$testedClass::schemaValidate(self::$xmlRepresentation, self::$schemaFile);

            // Perform serialization
            $class = self::$testedClass::fromXML(self::$xmlRepresentation->documentElement);
            $serializedClass = $class->toXML();

            // Validate after serialization
            self::$testedClass::schemaValidate($serializedClass->ownerDocument, self::$schemaFile);

            // Validate after normalization
            if (self::$testedClass::getNormalization() === true) {
                $normalizedDoc = DOMDocumentFactory::normalizeDocument($serializedClass->ownerDocument);
                self::$testedClass::schemaValidate($normalizedDoc, self::$schemaFile);
            }

            // If we got this far and no exceptions were thrown, consider this test passed!
            $this->addToAssertionCount(1);

It seems like addToAssertionCount() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }
    }


    abstract public function testSerialization(): void;
}