Create assertion and type-class for xs:ENTITIES

Author: tvdijen

src/Assert/EntitiesTrait.php

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

src/Type/EntitiesValue.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 EntitiesValue 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::validEntities($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/EntitiesTest.php

@@ -0,0 +1,57 @@
+<?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\EntitiesTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class EntitiesTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $entities
+     */
+    #[DataProvider('provideEntities')]
+    public function testValidEntities(bool $shouldPass, string $entities): void
+    {
+        try {
+            Assert::validEntities($entities);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<int, array{0: bool, 1: string}>
+     */
+    public static function provideEntities(): array
+    {
+        return [
+            [true, 'Snoopy'],
+            [true, 'CMS'],
+            [true, 'fööbár'],
+            [false, '-1950-10-04'],
+            [false, '0836217462 0836217463'],
+            [true, 'foo bar'],
+            // Quotes are forbidden
+            [false, 'foo "bar" baz'],
+            // Commas are forbidden
+            [false, 'foo,bar'],
+            // Trailing newlines are forbidden
+            [false, "foobar\n"],
+        ];
+    }
+}

tests/Type/EntitiesValueTest.php

@@ -0,0 +1,56 @@
+<?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\EntitiesValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\EntitiesValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(EntitiesValue::class)]
+final class EntitiesValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $entities
+     */
+    #[DataProvider('provideEntities')]
+    public function testIDRefs(bool $shouldPass, string $entities): void
+    {
+        try {
+            EntitiesValue::fromString($entities);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideEntities(): array
+    {
+        return [
+            'valid' => [true, 'Snoopy foobar'],
+            'diacritical' => [true, 'Snööpy fööbár'],
+            'start with colon' => [false, 'foobar :CMS'],
+            'start with underscore' => [true, '_1950-10-04 foobar'],
+            'invalid first char' => [false, '0836217462 1378943'],
+            'empty string' => [false, ''],
+            'space' => [true, 'foo bar'],
+            'colon' => [false, 'foo:bar'],
+            'comma' => [false, 'foo,bar'],
+            'whitespace collapse' => [true, "foobar\n"],
+            'normalization' => [true, ' foobar '],
+        ];
+    }
+}