Add TestContainer and start using it to reduce overhead

Author: tvdijen

composer.json

@@ -24,6 +24,7 @@
     },
     "autoload-dev": {
         "psr-4": {
+            "SimpleSAML\\Test\\Container\\": ["tests/Container/"],
             "SimpleSAML\\Test\\Helper\\": ["tests/Helper/"],
             "SimpleSAML\\Test\\Registry\\": ["tests/Registry/"],
             "SimpleSAML\\Test\\XML\\": ["tests/XML/"],

src/XML/Container/AbstractTestContainer.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Container;
+
+use SimpleSAML\XML\Attribute as XMLAttribute;
+use SimpleSAML\XML\Chunk;
+use SimpleSAML\XML\Type\LangValue;
+use SimpleSAML\XMLSchema\Type\LanguageValue;
+use SimpleSAML\XMLSchema\XML\Appinfo;
+
+/**
+ * Class \SimpleSAML\XML\Container\AbstractTestContainer
+ */
+abstract class AbstractTestContainer implements TestContainerInterface
+{
+    abstract public function getAppinfo(int $x = 1): Appinfo;
+
+
+    abstract public function getChunk(): Chunk;
+
+
+    abstract public function getLangValue(string $lang = 'en'): LangValue;
+
+
+    abstract public function getLanguageValue(string $language = 'en'): LanguageValue;
+
+
+    abstract public function getXMLAttribute(int $x = 1): XMLAttribute;
+}

src/XML/Container/TestContainerInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Container;
+
+/**
+ * Class \SimpleSAML\XML\Container\TestContainerInterface
+ */
+interface TestContainerInterface
+{
+}

src/XML/Container/TestContainerSingleton.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Container;
+
+use SimpleSAML\XML\Assert\Assert;
+
+/**
+ * Class \SimpleSAML\XML\Container\TestContainerSingleton
+ */
+final class TestContainerSingleton
+{
+    protected static AbstractTestContainer $testContainer;
+
+
+    /** Set a container to use. */
+    public static function setContainer(AbstractTestContainer $testContainer): void
+    {
+        self::$testContainer = $testContainer;
+    }
+
+
+    public static function getContainer(): AbstractTestContainer
+    {
+        Assert::notNull(self::$testContainer, 'No container set.');
+        return self::$testContainer;
+    }
+}

src/XML/Container/XMLElementsTrait.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Container;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Attribute as XMLAttribute;
+use SimpleSAML\XML\Chunk;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XML\Type\LangValue;
+use SimpleSAML\XMLSchema\Type\LanguageValue;
+use SimpleSAML\XMLSchema\Type\StringValue;
+
+use function array_key_exists;
+use function sprintf;
+
+/**
+ * One-time instantiation of common elements in XML, for re-use in unit-tests.
+ *
+ * @package simplesamlphp\xml-common
+ * @phpstan-ignore trait.unused
+ */
+trait XMLElementsTrait
+{
+    protected const string NAMESPACE = 'urn:x-simplesamlphp:namespace';
+
+
+    protected ?Chunk $chunk = null;
+
+    /** @var array<string, \SimpleSAML\XML\Type\LangValue> $lang */
+    protected array $lang = [];
+
+    /** @var array<string, \SimpleSAML\XMLSchema\Type\LanguageValue> $language */
+    protected array $language = [];
+
+    /** @var array<positive-int, \SimpleSAML\XML\Attribute> $attribute */
+    protected array $attribute = [];
+
+
+    public function getChunk(): Chunk
+    {
+        if ($this->chunk === null) {
+            $this->chunk = new Chunk(DOMDocumentFactory::fromString(
+                '<ssp:Chunk xmlns:ssp="urn:x-simplesamlphp:namespace">Some</ssp:Chunk>',
+            )->documentElement);
+        }
+
+        return $this->chunk;
+    }
+
+
+    public function getLangValue(string $lang = 'en'): LangValue
+    {
+        if (array_key_exists($lang, $this->lang)) {
+            $this->lang[$lang] = LangValue::fromString($lang);
+        }
+
+        return $this->lang[$lang];
+    }
+
+
+    public function getLanguageValue(string $language = 'en'): LanguageValue
+    {
+        if (array_key_exists($language, $this->language)) {
+            $this->language[$language] = LanguageValue::fromString($language);
+        }
+
+        return $this->language[$language];
+    }
+
+
+    /** @param positive-int $x */
+    public function getXMLAttribute(int $x = 1): XMLAttribute
+    {
+        Assert::positiveInteger($x);
+
+        if (!array_key_exists($x, $this->attribute)) {
+            $this->attribute[$x] = new XMLAttribute(
+                static::NAMESPACE,
+                'ssp',
+                sprintf('attr%d', $x),
+                StringValue::fromString(sprintf('value%d', $x)),
+            );
+        }
+
+        return $this->attribute[$x];
+    }
+}

src/XML/Container/XMLSchemaElementsTrait.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Container;
+
+use DOMText;
+use SimpleSAML\XML\DOMDocumentFactory;
+use SimpleSAML\XMLSchema\Type\AnyURIValue;
+use SimpleSAML\XMLSchema\XML\Appinfo;
+
+use function array_key_exists;
+use function sprintf;
+
+/**
+ * One-time instantiation of common elements in XML, for re-use in unit-tests.
+ *
+ * @package simplesamlphp\xml-common
+ * @phpstan-ignore trait.unused
+ */
+trait XMLSchemaElementsTrait
+{
+    protected const string SOURCE = 'urn:x-simplesamlphp:source';
+
+
+    /** @var array<positive-int, \SimpleSAML\XMLSchema\XML\Appinfo> */
+    protected array $appinfo = [];
+
+
+    /** @param positive-int $x */
+    public function getAppinfo(int $x = 1): Appinfo
+    {
+        if (!array_key_exists($x, $this->appinfo)) {
+            $appinfoDocument = DOMDocumentFactory::create();
+            $text = new DOMText(sprintf('Application Information (%d)', $x));
+            $appinfoDocument->appendChild($text);
+
+            $this->appinfo[$x] = new Appinfo(
+                $appinfoDocument->childNodes,
+                AnyURIValue::fromString(static::SOURCE),
+                [$this->getXMLAttribute($x)],
+            );
+        }
+
+        return $this->appinfo[$x];
+    }
+}

src/XML/TestUtils/TestContainerTestTrait.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\TestUtils;
+
+use SimpleSAML\XML\Container\AbstractTestContainer;
+use SimpleSAML\XML\Container\TestContainerSingleton;
+
+/**
+ * Trait for importing the TestContainer into the unit test.
+ *
+ * @package simplesamlphp\xml-common
+ * @phpstan-ignore trait.unused
+ */
+trait TestContainerTestTrait
+{
+    protected static AbstractTestContainer $testContainer;
+
+
+    protected static function instantiateTestContainer(): void
+    {
+        self::$testContainer = TestContainerSingleton::getContainer();
+    }
+}

tests/Container/TestContainer.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\Container;
+
+use SimpleSAML\XML\Container\AbstractTestContainer;
+use SimpleSAML\XML\Container\XMLElementsTrait;
+use SimpleSAML\XML\Container\XMLSchemaElementsTrait;
+
+/**
+ * Class \SimpleSAML\Test\Container\TestContainer
+ */
+class TestContainer extends AbstractTestContainer
+{
+    use XMLElementsTrait;
+    use XMLSchemaElementsTrait;
+}