From 23df1c563efee65e6d549308ed0671a9e2933c05 Mon Sep 17 00:00:00 2001
From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com>
Date: Wed, 21 Oct 2020 18:53:27 +0200
Subject: feat(std/testing): Add support for object assertion against object
 subset  (#8001)

This commit add supports for a new assertion function
"assertObjectMatch" which allows to test an actual object
against an expected object subset (i.e. inclusivity, not equality).
---
 std/testing/asserts_test.ts | 175 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 175 insertions(+)

(limited to 'std/testing/asserts_test.ts')

diff --git a/std/testing/asserts_test.ts b/std/testing/asserts_test.ts
index 7b57fbfa0..a0db48e7b 100644
--- a/std/testing/asserts_test.ts
+++ b/std/testing/asserts_test.ts
@@ -9,6 +9,7 @@ import {
   assertNotEquals,
   assertNotMatch,
   assertNotStrictEquals,
+  assertObjectMatch,
   assertStrictEquals,
   assertStringContains,
   assertThrows,
@@ -259,6 +260,180 @@ Deno.test("testingAssertStringNotMatchingThrows", function (): void {
   assert(didThrow);
 });
 
+Deno.test("testingAssertObjectMatching", function (): void {
+  const sym = Symbol("foo");
+  const a = { foo: true, bar: false };
+  const b = { ...a, baz: a };
+  const c = { ...b, qux: b };
+  const d = { corge: c, grault: c };
+  const e = { foo: true } as { [key: string]: unknown };
+  e.bar = e;
+  const f = { [sym]: true, bar: false };
+  // Simple subset
+  assertObjectMatch(a, {
+    foo: true,
+  });
+  // Subset with another subset
+  assertObjectMatch(b, {
+    foo: true,
+    baz: { bar: false },
+  });
+  // Subset with multiple subsets
+  assertObjectMatch(c, {
+    foo: true,
+    baz: { bar: false },
+    qux: {
+      baz: { foo: true },
+    },
+  });
+  // Subset with same object reference as subset
+  assertObjectMatch(d, {
+    corge: {
+      foo: true,
+      qux: { bar: false },
+    },
+    grault: {
+      bar: false,
+      qux: { foo: true },
+    },
+  });
+  // Subset with circular reference
+  assertObjectMatch(e, {
+    foo: true,
+    bar: {
+      bar: {
+        bar: {
+          foo: true,
+        },
+      },
+    },
+  });
+  // Subset with same symbol
+  assertObjectMatch(f, {
+    [sym]: true,
+  });
+  // Missing key
+  {
+    let didThrow;
+    try {
+      assertObjectMatch({
+        foo: true,
+      }, {
+        foo: true,
+        bar: false,
+      });
+      didThrow = false;
+    } catch (e) {
+      assert(e instanceof AssertionError);
+      didThrow = true;
+    }
+    assertEquals(didThrow, true);
+  }
+  // Simple subset
+  {
+    let didThrow;
+    try {
+      assertObjectMatch(a, {
+        foo: false,
+      });
+      didThrow = false;
+    } catch (e) {
+      assert(e instanceof AssertionError);
+      didThrow = true;
+    }
+    assertEquals(didThrow, true);
+  }
+  // Subset with another subset
+  {
+    let didThrow;
+    try {
+      assertObjectMatch(b, {
+        foo: true,
+        baz: { bar: true },
+      });
+      didThrow = false;
+    } catch (e) {
+      assert(e instanceof AssertionError);
+      didThrow = true;
+    }
+    assertEquals(didThrow, true);
+  }
+  // Subset with multiple subsets
+  {
+    let didThrow;
+    try {
+      assertObjectMatch(c, {
+        foo: true,
+        baz: { bar: false },
+        qux: {
+          baz: { foo: false },
+        },
+      });
+      didThrow = false;
+    } catch (e) {
+      assert(e instanceof AssertionError);
+      didThrow = true;
+    }
+    assertEquals(didThrow, true);
+  }
+  // Subset with same object reference as subset
+  {
+    let didThrow;
+    try {
+      assertObjectMatch(d, {
+        corge: {
+          foo: true,
+          qux: { bar: true },
+        },
+        grault: {
+          bar: false,
+          qux: { foo: false },
+        },
+      });
+      didThrow = false;
+    } catch (e) {
+      assert(e instanceof AssertionError);
+      didThrow = true;
+    }
+    assertEquals(didThrow, true);
+  }
+  // Subset with circular reference
+  {
+    let didThrow;
+    try {
+      assertObjectMatch(e, {
+        foo: true,
+        bar: {
+          bar: {
+            bar: {
+              foo: false,
+            },
+          },
+        },
+      });
+      didThrow = false;
+    } catch (e) {
+      assert(e instanceof AssertionError);
+      didThrow = true;
+    }
+    assertEquals(didThrow, true);
+  }
+  // Subset with symbol key but with string key subset
+  {
+    let didThrow;
+    try {
+      assertObjectMatch(f, {
+        foo: true,
+      });
+      didThrow = false;
+    } catch (e) {
+      assert(e instanceof AssertionError);
+      didThrow = true;
+    }
+    assertEquals(didThrow, true);
+  }
+});
+
 Deno.test("testingAssertsUnimplemented", function (): void {
   let didThrow = false;
   try {
-- 
cgit v1.2.3