Add assert and unit tests

Author: samlitowitz

src/Framework/Assert.php

@@ -65,6 +65,7 @@
 use PHPUnit\Framework\Constraint\TraversableContainsEqual;
 use PHPUnit\Framework\Constraint\TraversableContainsIdentical;
 use PHPUnit\Framework\Constraint\TraversableContainsOnly;
+use PHPUnit\Framework\Constraint\Dictionary\IsIdenticalKeysValues;
 use PHPUnit\Util\Xml\Loader as XmlLoader;
 use PHPUnit\Util\Xml\XmlException;
 
@@ -1763,6 +1764,21 @@ final public static function assertNotSame(mixed $expected, mixed $actual, strin
         );
     }
 
+    /**
+     * Assert that two arrays have the same keys and values for those keys.
+     * The order of the keys is ignored.
+     *
+     * @throws ExpectationFailedException
+     */
+    final public static function assertSameDictionaryKeysValues(array $expected, array $actual, string $message = ''): void
+    {
+        self::assertThat(
+            $actual,
+            new IsIdenticalKeysValues($expected),
+            $message
+        );
+    }
+
     /**
      * Asserts that a variable is of a given type.
      *

tests/unit/Framework/Assert/assertSameDictionaryKeysValuesTest.php

@@ -0,0 +1,104 @@
+<?php declare(strict_types=1);
+
+namespace PHPUnit\Framework;
+
+use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Small;
+use PHPUnit\Framework\Attributes\TestDox;
+use stdClass;
+
+#[CoversMethod(Assert::class, 'assertSameDictionaryKeysValuesTest')]
+#[TestDox('assertSameDictionaryKeysValuesTest()')]
+#[Small]
+final class assertSameDictionaryKeysValuesTest extends TestCase
+{
+    /**
+     * @return non-empty-list<array{0: mixed, 1: mixed}>
+     */
+    public static function successProvider(): array
+    {
+        return [
+            [
+                [
+                    'string' => 'string',
+                    true => true,
+                    1 => 1,
+                    2 => 2.5,
+                    'object' => new stdClass(),
+                    'array' => [1, 2, 3],
+                    'dictionary' => [
+                        'string' => 'string',
+                        true => true,
+                        1 => 1,
+                        2 => 2.5,
+                        'object' => new stdClass(),
+                        'array' => [1, 2, 3],
+                    ],
+                ],
+                [
+                    'dictionary' => [
+                        'object' => new stdClass(),
+                        'array' => [1, 2, 3],
+                        'string' => 'string',
+                        true => true,
+                        1 => 1,
+                        2 => 2.5,
+                    ],
+                    'string' => 'string',
+                    true => true,
+                    1 => 1,
+                    2 => 2.5,
+                    'object' => new stdClass(),
+                    'array' => [1, 2, 3],
+                ],
+            ],
+        ];
+    }
+
+    /**
+     * @return non-empty-list<array{0: mixed, 1: mixed}>
+     */
+    public static function failureProvider(): array
+    {
+        return [
+            [
+                [
+                    'string' => 'string',
+                    true => true,
+                    1 => 1,
+                    2 => 2.5,
+                    'object' => new stdClass(),
+                    'array' => [1, 2, 3],
+                    'dictionary' => [
+                        'string' => 'string',
+                        true => true,
+                        1 => 1,
+                        2 => 2.5,
+                        'object' => new stdClass(),
+                        'array' => [1, 2, 3],
+                    ],
+                ],
+                [
+                    'string' => 'string',
+                    true => true,
+                    1 => 1,
+                ],
+            ],
+        ];
+    }
+
+    #[DataProvider('successProvider')]
+    public function testSucceedsWhenConstraintEvaluatesToTrue(mixed $expected, mixed $actual): void
+    {
+        $this->assertSameDictionaryKeysValues($expected, $actual);
+    }
+
+    #[DataProvider('failureProvider')]
+    public function testFailsWhenConstraintEvaluatesToFalse(mixed $expected, mixed $actual): void
+    {
+        $this->expectException(AssertionFailedError::class);
+
+        $this->assertSameDictionaryKeysValues($expected, $actual);
+    }
+}