Create assertion and type-class for xs:duration

Author: tvdijen

src/Assert/DurationTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait DurationTrait
+{
+    /** @var string */
+    private static string $duration_regex = '/^([-+]?)P(?!$)(?:(?<years>\d+(?:[\.\,]\d+)?)Y)?(?:(?<months>\d+(?:[\.\,]\d+)?)M)?(?:(?<weeks>\d+(?:[\.\,]\d+)?)W)?(?:(?<days>\d+(?:[\.\,]\d+)?)D)?(T(?=\d)(?:(?<hours>\d+(?:[\.\,]\d+)?)H)?(?:(?<minutes>\d+(?:[\.\,]\d+)?)M)?(?:(?<seconds>\d+(?:[\.\,]\d+)?)S)?)?$/D';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validDuration(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$duration_regex,
+            $message ?: '%s is not a valid xs:duration',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/DurationValue.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class DurationValue extends AbstractValueType
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::validDuration($value, SchemaViolationException::class);
+    }
+}

tests/Assert/DurationTest.php

@@ -0,0 +1,56 @@
+<?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\DurationTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class DurationTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $duration
+     */
+    #[DataProvider('provideDuration')]
+    public function testValidDuration(bool $shouldPass, string $duration): void
+    {
+        try {
+            Assert::validDuration($duration);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDuration(): array
+    {
+        return [
+            'valid long seconds' => [true, 'PT1004199059S'],
+            'valid short seconds' => [true, 'PT130S'],
+            'valid minutes and seconds' => [true, 'PT2M10S'],
+            'valid one day and two seconds' => [true, 'P1DT2S'],
+            'valid minus one year' => [true, '-P1Y'],
+            'valid complex sub-second' => [true, 'P1Y2M3DT5H20M30.123S'],
+            'invalid missing P' => [false, '1Y'],
+            'invalid missing T' => [false, 'P1S'],
+            'invalid all parts must be positive' => [false, 'P-1Y'],
+            'invalid order Y must precede M' => [false, 'P1M2Y'],
+            'invalid all parts must me positive' => [false, 'P1Y-1M'],
+        ];
+    }
+}

tests/Type/DurationValueTest.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\DurationValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\DurationValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(DurationValue::class)]
+final class DurationValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $duration
+     */
+    #[DataProvider('provideDuration')]
+    public function testDuration(bool $shouldPass, string $duration): void
+    {
+        try {
+            DurationValue::fromString($duration);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDuration(): array
+    {
+        return [
+            'valid long seconds' => [true, 'PT1004199059S'],
+            'valid short seconds' => [true, 'PT130S'],
+            'valid minutes and seconds' => [true, 'PT2M10S'],
+            'valid one day and two seconds' => [true, 'P1DT2S'],
+            'valid minus one year' => [true, '-P1Y'],
+            'valid complex sub-second' => [true, 'P1Y2M3DT5H20M30.123S'],
+            'invalid missing P' => [false, '1Y'],
+            'invalid missing T' => [false, 'P1S'],
+            'invalid all parts must be positive' => [false, 'P-1Y'],
+            'invalid order Y must precede M' => [false, 'P1M2Y'],
+            'invalid all parts must me positive' => [false, 'P1Y-1M'],
+        ];
+    }
+}