simplesamlphp / xml-common

src/XML/TestUtils/SerializableElementTestTrait.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 function class_exists;

/**
 * Test for Serializable XML classes to perform default serialization tests.
 *
 * @package simplesamlphp\xml-common
 * @phpstan-ignore trait.unused
 */
trait SerializableElementTestTrait
{
    /** @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 creating XML from a class.
     */
    abstract public function testMarshalling(): void;


    /**
     * Test creating a class from XML.
     */
    public function testUnmarshalling(): 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 . '::testUnmarshalling(). 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 . '::testUnmarshalling(). Please set ' . self::class
                . ':$xmlRepresentation to a DOMDocument representing the XML-class being tested',
            );
        } else {
            $elt = self::$testedClass::fromXML(self::$xmlRepresentation->documentElement);

            $this->assertEquals(

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

                self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
                strval($elt),
            );
        }
    }


    /**
     * Test serialization / unserialization.
     */
    #[Depends('testMarshalling')]
    #[Depends('testUnmarshalling')]
    public function testSerialization(): void
    {
        if (!class_exists(self::$testedClass)) {
            $this->markTestSkipped(
                'Unable to run ' . self::class . '::testSerialization(). 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 . '::testSerialization(). Please set ' . self::class
                . ':$xmlRepresentation to a DOMDocument representing the XML-class being tested',
            );
        } else {
            $this->assertEquals(
                self::$xmlRepresentation->saveXML(self::$xmlRepresentation->documentElement),
                strval(unserialize(serialize(self::$testedClass::fromXML(self::$xmlRepresentation->documentElement)))),
            );
        }
    }
}