Create assertion and type-class for xs:ENTITY

Author: tvdijen

src/Assert/EntityTrait.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait EntityTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validEntity(string $value, string $message = ''): void
+    {
+        Assert::validNCName(
+            $value,
+            $message ?: '%s is not a valid xs:Entity',
+            InvalidArgumentException::class,
+        );
+    }
+}

tests/Assert/EntityTest.php

@@ -0,0 +1,66 @@
+<?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\EntityTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class EntityTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $entity
+     */
+    #[DataProvider('provideEntity')]
+    public function testValidEntity(bool $shouldPass, string $entity): void
+    {
+        try {
+            Assert::validEntity($entity);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<int, array{0: bool, 1: string}>
+     */
+    public static function provideEntity(): 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 contain a colon
+            [false, 'Te:st'],
+            // Trailing newlines are forbidden
+            [false, "Test\n"],
+        ];
+    }
+}

tests/Type/EntityValueTest.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\EntityValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\EntityValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(EntityValue::class)]
+final class EntityValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $entity
+     */
+    #[DataProvider('provideEntity')]
+    public function testIDRef(bool $shouldPass, string $entity): void
+    {
+        try {
+            EntityValue::fromString($entity);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideEntity(): 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 digit' => [false, '1Test'],
+            'invalid contains colon' => [false, 'Te:st'],
+            'whitespace collapse' => [true, "foobar\n"],
+            'normalization' => [true, ' foobar '],
+        ];
+    }
+}