Create assertion and type-class for xs:NCName

Author: tvdijen

src/Assert/NCNameTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait NCNameTrait
+{
+    /** @var string */
+    private static string $ncname_regex = '/^[a-zA-Z_][\w.-]*$/Du';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validNCName(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$ncname_regex,
+            $message ?: '%s is not a valid xs:NCName',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/NCNameTest.php

@@ -0,0 +1,68 @@
+<?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\NCNameTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class NCNameTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $name
+     */
+    #[DataProvider('provideNCName')]
+    public function testValidNCName(bool $shouldPass, string $name): void
+    {
+        try {
+            Assert::validNCName($name);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<int, array{0: bool, 1: string}>
+     */
+    public static function provideNCName(): array
+    {
+        return [
+            [true, 'Test'],
+            // May start with an underscore
+            [true, '_Test'],
+            // May contain dashes
+            [true, '_1950-10-04_10-00'],
+            // May contain dots
+            [true, 'Te.st'],
+            // May contain diacriticals
+            [true, 'fööbár'],
+            // Prefixed v4 UUID
+            [true, '_5425e58e-e799-4884-92cc-ca64ecede32f'],
+            // An empty value is not valid, unless xsi:nil is used
+            [false, ''],
+            // Wildcards are not allowed
+            [false, 'Te*st'],
+            // May not start with a digit
+            [false, '1Test'],
+            // May not start with a dash
+            [false, '-Test'],
+            // May not contain a colon
+            [false, 'Te:st'],
+            // Trailing newlines are forbidden
+            [false, "Test\n"],
+        ];
+    }
+}

tests/Assert/NCNameValue.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 NCNameValue extends TokenValue
+{
+    /**
+     * 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::validNCName($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Type/NCNameValueTest.php

@@ -0,0 +1,58 @@
+<?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\NCNameValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\NCNameValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(NCNameValue::class)]
+final class NCNameValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $ncname
+     */
+    #[DataProvider('provideNCName')]
+    public function testNCName(bool $shouldPass, string $ncname): void
+    {
+        try {
+            NCNameValue::fromString($ncname);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideNCName(): array
+    {
+        return [
+            'valid' => [true, 'Test'],
+            'valid starts with underscore' => [true, '_Test'],
+            'valid contains dashes' => [true, '_1950-10-04_10-00'],
+            'valid contains dots' => [true, 'Te.st'],
+            'valid contains diacriticals' => [true, 'fööbár'],
+            'valid prefixed v4 UUID' => [true, '_5425e58e-e799-4884-92cc-ca64ecede32f'],
+            'invalid empty string' => [false, ''],
+            'invalid contains wildcard' => [false, 'Te*st'],
+            'invalid starts with dash' => [false, '-Test'],
+            'invalid starts with digit' => [false, '1Test'],
+            'invalid contains colon' => [false, 'Te:st'],
+            'whitespace collapse' => [true, "foobar\n"],
+            'normalization' => [true, ' foobar '],
+        ];
+    }
+}