Improved error-handling for extendable attributes & elements

Author: tvdijen

src/XML/ExtendableAttributesTrait.php

@@ -9,6 +9,7 @@
 use SimpleSAML\XML\Assert\Assert;
 use SimpleSAML\XML\Attribute;
 use SimpleSAML\XML\Constants as C;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
 use SimpleSAML\XMLSchema\Type\StringValue;
 use SimpleSAML\XMLSchema\XML\Constants\NS;
 
@@ -204,7 +205,7 @@ function (Attribute $attr) {
 
         if ($namespace === NS::LOCAL) {
             // If ##local then all namespaces must be null
-            Assert::allNull($actual_namespaces);
+            Assert::allNull($actual_namespaces, SchemaviolationException::class);
         } elseif (is_array($namespace)) {
             // Make a local copy of the property that we can edit
             $allowed_namespaces = $namespace;
@@ -227,17 +228,18 @@ function (Attribute $attr) {
                     rtrim(implode(', ', $diff)),
                     self::NS,
                 ),
+                SchemaViolationException::class,
             );
         } else {
             if ($namespace === NS::OTHER) {
                 // All attributes must be namespaced, ergo non-null
-                Assert::allNotNull($actual_namespaces);
+                Assert::allNotNull($actual_namespaces, SchemaViolationException::class);
 
                 // Must be any namespace other than the parent element
-                Assert::allNotSame($actual_namespaces, self::NS);
+                Assert::allNotSame($actual_namespaces, self::NS, SchemaViolationException::class);
             } elseif ($namespace === NS::TARGETNAMESPACE) {
                 // Must be the same namespace as the one of the parent element
-                Assert::allSame($actual_namespaces, self::NS);
+                Assert::allSame($actual_namespaces, self::NS, SchemaViolationException::class);
             }
         }
 

src/XML/ExtendableElementTrait.php

@@ -10,6 +10,7 @@
 use SimpleSAML\XML\Chunk;
 use SimpleSAML\XML\Constants as C;
 use SimpleSAML\XML\Registry\ElementRegistry;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
 use SimpleSAML\XMLSchema\XML\Constants\NS;
 
 use function array_diff;
@@ -146,7 +147,7 @@ function (AbstractElement|Chunk $elt): ?string {
 
         if ($namespace === NS::LOCAL) {
             // If ##local then all namespaces must be null
-            Assert::allNull($actual_namespaces);
+            Assert::allNull($actual_namespaces, SchemaViolationException::class);
         } elseif (is_array($namespace)) {
             // Make a local copy of the property that we can edit
             $allowed_namespaces = $namespace;
@@ -169,14 +170,15 @@ function (AbstractElement|Chunk $elt): ?string {
                     rtrim(implode(', ', $diff)),
                     self::NS,
                 ),
+                SchemaViolationException::class,
             );
         } elseif ($namespace === NS::OTHER) {
             // Must be any namespace other than the parent element, excluding elements with no namespace
-            Assert::notInArray(null, $actual_namespaces);
-            Assert::allNotSame($actual_namespaces, self::NS);
+            Assert::notInArray(null, $actual_namespaces, SchemaViolationException::class);
+            Assert::allNotSame($actual_namespaces, self::NS, SchemaViolationException::class);
         } elseif ($namespace === NS::TARGETNAMESPACE) {
             // Must be the same namespace as the one of the parent element
-            Assert::allSame($actual_namespaces, self::NS);
+            Assert::allSame($actual_namespaces, self::NS, SchemaViolationexception::class);
         } else {
             // XS_ANY_NS_ANY
         }

tests/XML/ExtendableAttributesTraitTest.php

@@ -8,6 +8,7 @@
 use SimpleSAML\Assert\AssertionFailedException;
 use SimpleSAML\Test\Helper\ExtendableAttributesElement;
 use SimpleSAML\XML\Attribute;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
 use SimpleSAML\XMLSchema\Type\StringValue;
 use SimpleSAML\XMLSchema\XML\Constants\NS;
 
@@ -124,7 +125,7 @@ public function getAttributeNamespace(): array|string
      */
     public function testOtherNamespacePassingLocalThrowsAnException(): void
     {
-        $this->expectException(AssertionFailedException::class);
+        $this->expectException(SchemaViolationException::class);
         new class ([self::$local]) extends ExtendableAttributesElement {
             /**
              * @return array<int, string>|string
@@ -199,7 +200,7 @@ public function getAttributeNamespace(): array|string
      */
     public function testTargetNamespacePassingOtherThrowsAnException(): void
     {
-        $this->expectException(AssertionFailedException::class);
+        $this->expectException(SchemaViolationException::class);
         new class ([self::$other]) extends ExtendableAttributesElement {
             /**
              * @return array<int, string>|string
@@ -255,7 +256,7 @@ public function getAttributeNamespace(): array|string
      */
     public function testLocalNamespacePassingOtherThrowsAnException(): void
     {
-        $this->expectException(AssertionFailedException::class);
+        $this->expectException(SchemaViolationException::class);
         new class ([self::$other]) extends ExtendableAttributesElement {
             /**
              * @return array<int, string>|string

tests/XML/ExtendableElementTraitTest.php

@@ -10,6 +10,7 @@
 use SimpleSAML\XML\Chunk;
 use SimpleSAML\XML\DOMDocumentFactory;
 use SimpleSAML\XML\ElementInterface;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
 use SimpleSAML\XMLSchema\XML\Constants\NS;
 
 /**
@@ -139,7 +140,7 @@ public function getElementNamespace(): array|string
      */
     public function testOtherNamespacePassingLocalThrowsAnException(): void
     {
-        $this->expectException(AssertionFailedException::class);
+        $this->expectException(SchemaViolationException::class);
         new class ([self::$local]) extends ExtendableElement {
             /**
              * @return array<int, string>|string
@@ -214,7 +215,7 @@ public function getElementNamespace(): array|string
      */
     public function testTargetNamespacePassingOtherThrowsAnException(): void
     {
-        $this->expectException(AssertionFailedException::class);
+        $this->expectException(SchemaViolationException::class);
         new class ([self::$other]) extends ExtendableElement {
             /**
              * @return array<int, string>|string
@@ -270,7 +271,7 @@ public function getElementNamespace(): array|string
      */
     public function testLocalNamespacePassingTargetThrowsAnException(): void
     {
-        $this->expectException(AssertionFailedException::class);
+        $this->expectException(SchemaViolationException::class);
         new class ([self::$target]) extends ExtendableElement {
             /**
              * @return array<int, string>|string
@@ -288,7 +289,7 @@ public function getElementNamespace(): array|string
      */
     public function testLocalNamespacePassingOtherThrowsAnException(): void
     {
-        $this->expectException(AssertionFailedException::class);
+        $this->expectException(SchemaViolationException::class);
         new class ([self::$other]) extends ExtendableElement {
             /**
              * @return array<int, string>|string