Create assertion and type-class for xs:dateTime

Author: tvdijen

src/Assert/DateTimeTrait.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait DateTimeTrait
+{
+    /**
+     * The ·lexical space· of dateTime consists of finite-length sequences of characters of the form:
+     * '-'? yyyy '-' mm '-' dd 'T' hh ':' mm ':' ss ('.' s+)? (zzzzzz)?, where
+     *
+     * * '-'? yyyy is a four-or-more digit optionally negative-signed numeral that represents the year;
+     *   if more than four digits, leading zeros are prohibited, and '0000' is prohibited (see the Note above (§3.2.7);
+     *   also note that a plus sign is not permitted);
+     * * the remaining '-'s are separators between parts of the date portion;
+     * * the first mm is a two-digit numeral that represents the month;
+     * * dd is a two-digit numeral that represents the day;
+     * * 'T' is a separator indicating that time-of-day follows;
+     * * hh is a two-digit numeral that represents the hour; '24' is permitted if the minutes and seconds represented
+     *   are zero, and the dateTime value so represented is the first instant of the following day
+     *   (the hour property of a dateTime object in the ·value space· cannot have a value greater than 23);
+     * * ':' is a separator between parts of the time-of-day portion;
+     * * the second mm is a two-digit numeral that represents the minute;
+     * * ss is a two-integer-digit numeral that represents the whole seconds;
+     * * '.' s+ (if present) represents the fractional seconds;
+     * * zzzzzz (if present) represents the timezone (as described below).
+     *
+     * @var string
+     */
+    private static string $datetime_regex = '/^-?([1-9][0-9]*|[0-9]{4})-(((0(1|3|5|7|8)|1(0|2))-(0[1-9]|(1|2)[0-9]|3[0-1]))|((0(4|6|9)|11)-(0[1-9]|(1|2)[0-9]|30))|(02-(0[1-9]|(1|2)[0-9])))T([0-1][0-9]|2[0-4]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])(\.[0-9]{0,6})?((\+|-)([0-1][0-9]|2[0-4]):(0[0-9]|[1-5][0-9])|Z)?$/Di';
+
+    /***********************************************************************************
+     *  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 validDateTime(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$datetime_regex,
+            $message ?: '%s is not a valid xs:dateTime',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/DateTimeValue.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 DateTimeValue extends AbstractValueType
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::validDateTime($value, SchemaViolationException::class);
+    }
+}

tests/Assert/DateTimeTest.php

@@ -0,0 +1,59 @@
+<?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\DateTimeTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class DateTimeTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $dateTime
+     */
+    #[DataProvider('provideDateTime')]
+    public function testValidDateTime(bool $shouldPass, string $dateTime): void
+    {
+        try {
+            Assert::validDateTime($dateTime);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDateTime(): array
+    {
+        return [
+            'valid' => [true, '2001-10-26T21:32:52'],
+            'valid with numeric difference' => [true, '2001-10-26T21:32:52+02:00'],
+            'valid with Zulu' => [true, '2001-10-26T19:32:52Z'],
+            'valid with 00:00 difference' => [true, '2001-10-26T19:32:52+00:00'],
+            'valid with negative value' => [true, '-2001-10-26T21:32:52'],
+            'valid with subseconds' => [true, '2001-10-26T21:32:52.12679'],
+            'valid with more than four digit year' => [true, '-22001-10-26T21:32:52+02:00'],
+            'valid with sub-seconds' => [true, '2001-10-26T21:32:52.12679'],
+            'missing time' => [false, '2001-10-26'],
+            'missing second' => [false, '2001-10-26T21:32'],
+            'hour out of range' => [false, '2001-10-26T25:32:52+02:00'],
+            'year 0000' => [false, '0000-10-26T25:32:52+02:00'],
+            'prefixed zero' => [false, '02001-10-26T25:32:52+02:00'],
+            'wrong format' => [false, '01-10-26T21:32'],
+        ];
+    }
+}

tests/Type/DateTimeValueTest.php

@@ -0,0 +1,59 @@
+<?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\DateTimeValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\DateTimeValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(DateTimeValue::class)]
+final class DateTimeValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $dateTime
+     */
+    #[DataProvider('provideDateTime')]
+    public function testDateTime(bool $shouldPass, string $dateTime): void
+    {
+        try {
+            DateTimeValue::fromString($dateTime);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDateTime(): array
+    {
+        return [
+            'valid' => [true, '2001-10-26T21:32:52'],
+            'valid with numeric difference' => [true, '2001-10-26T21:32:52+02:00'],
+            'valid with Zulu' => [true, '2001-10-26T19:32:52Z'],
+            'valid with 00:00 difference' => [true, '2001-10-26T19:32:52+00:00'],
+            'valid with negative value' => [true, '-2001-10-26T21:32:52'],
+            'valid with subseconds' => [true, '2001-10-26T21:32:52.12679'],
+            'valid with more than four digit year' => [true, '-22001-10-26T21:32:52+02:00'],
+            'valid with sub-seconds' => [true, '2001-10-26T21:32:52.12679'],
+            'missing time' => [false, '2001-10-26'],
+            'missing second' => [false, '2001-10-26T21:32'],
+            'hour out of range' => [false, '2001-10-26T25:32:52+02:00'],
+            'year 0000' => [false, '0000-10-26T25:32:52+02:00'],
+            'prefixed zero' => [false, '02001-10-26T25:32:52+02:00'],
+            'wrong format' => [false, '01-10-26T21:32'],
+        ];
+    }
+}