Create assertion and type-class for xs:QName

Author: tvdijen

src/Assert/QNameTrait.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait QNameTrait
+{
+    /** @var string */
+    private static string $qname_regex = '/^([a-z_][\w.-]*)(:[a-z_][\w.-]*)?$/Dui';
+
+    /***********************************************************************************
+     *  NOTE:  Custom assertions may be added below this line.                         *
+     *         They SHOULD be marked as `protected` to ensure the call is forced       *
+     *          through __callStatic().                                                *
+     *         Assertions marked `public` are called directly and will                 *
+     *          not handle any custom exception passed to it.                          *
+     ***********************************************************************************/
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validQName(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$qname_regex,
+            $message ?: '%s is not a valid xs:QName',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/QNameValue.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class QNameValue extends AbstractValueType
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        // Note: value must already be sanitized before validating
+        Assert::validQName($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/QNameTest.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\Assert;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\Assert\AssertionFailedException;
+use SimpleSAML\XML\Assert\Assert;
+
+/**
+ * Class \SimpleSAML\Test\XML\Assert\QNameTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class QNameTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $name
+     */
+    #[DataProvider('provideQName')]
+    public function testValidQName(bool $shouldPass, string $name): void
+    {
+        try {
+            Assert::validQName($name);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<int, array{0: bool, 1: string}>
+     */
+    public static function provideQName(): array
+    {
+        return [
+            [true, 'some:Test'],
+            // both parts can contain a dash
+            [true, 'som-e:Test'],
+            [true, 'so-me:T-est'],
+            // Neither part can start with a dash
+            [false, 'some:-Test'],
+            [false, '-some:-Test'],
+            [true, 'Test'],
+            // Cannot start with a colon
+            [false, ':test'],
+            // Cannot contain multiple colons
+            [false, 'test:test:test'],
+            // Cannot start with a number
+            [false, '1Test'],
+            // Cannot contain a wildcard character
+            [false, 'Te*st'],
+            // Prefixed newlines are forbidden
+            [false, "\nsome:Test"],
+            // Trailing newlines are forbidden
+            [false, "some:Test\n"],
+        ];
+    }
+}

tests/Type/QNameValueTest.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\Type;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XML\Type\QNameValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\QNameValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(QNameValue::class)]
+final class QNameValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $qname
+     */
+    #[DataProvider('provideQName')]
+    public function testQName(bool $shouldPass, string $qname): void
+    {
+        try {
+            QNameValue::fromString($qname);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideQName(): array
+    {
+        return [
+            'valid' => [true, 'some:Test'],
+            'first part containing dash' => [true, 'som-e:Test'],
+            'both parts containing dash' => [true, 'so-me:T-est'],
+            'start 2nd part with dash' => [false, 'some:-Test'],
+            'start both parts with dash' => [false, '-some:-Test'],
+            'no colon' => [true, 'Test'],
+            'start with colon' => [false, ':test'],
+            'multiple colons' => [false, 'test:test:test'],
+            'start with digit' => [false, '1Test'],
+            'wildcard' => [false, 'Te*st'],
+            'prefixed newline' => [false, "\nsome:Test"],
+            'trailing newline' => [false, "some:Test\n"],
+        ];
+    }
+}