refactor to add needed assert methods to TAP, reverting last commit's approach

Author: dmanto

src/user-agent/test.ts

@@ -20,6 +20,16 @@ import StackUtils from 'stack-utils';
 
 type SkipFunction = (...args: any[]) => any;
 
+// Helper function to add required `TestUserAgent` assert methods
+// that are missing in a `TAP` instance. This is as an intended side effect
+// to ensure compatibility with `TestUserAgent` class below
+function addNodeAssertMethods(tapInstance: Test): void {
+  (tapInstance as any).strictEqual = tapInstance.equal.bind(tapInstance);
+  (tapInstance as any).notStrictEqual = tapInstance.not.bind(tapInstance);
+  (tapInstance as any).doesNotMatch = tapInstance.notMatch.bind(tapInstance);
+  (tapInstance as any).deepStrictEqual = tapInstance.same.bind(tapInstance);
+}
+
 /**
  * Test user-agent class.
  */
@@ -46,31 +56,23 @@ export class TestUserAgent extends MockUserAgent {
    * Delegate assertion to test framework currently in use.
    */
   assert(name: string, args: any[], msg: string, skip: SkipFunction): void {
-    const test: any = this._assert ?? {
-      equal: assert.strictEqual,
-      not: assert.notStrictEqual,
-      match: assert.match,
-      notMatch: assert.doesNotMatch,
-      ok: assert.ok,
-      notOk: (value: any, message: string) => assert.ok(!value, message),
-      same: assert.deepStrictEqual
-    };
+    const test: any = this._assert ?? assert;
     test[name](...args, msg, {stack: this._stack.captureString(10, skip).replaceAll('file://', '')});
   }
 
   /**
    * Check response content for exact match.
    */
   bodyIs(body: string): this {
-    this.assert('equal', [this.body.toString(), body], 'body is equal', this.bodyIs);
+    this.assert('strictEqual', [this.body.toString(), body], 'body is equal', this.bodyIs);
     return this;
   }
 
   /**
    * Opposite of `bodyIs`.
    */
   bodyIsnt(body: string): this {
-    this.assert('not', [this.body.toString(), body], 'body is not equal', this.bodyIsnt);
+    this.assert('notStrictEqual', [this.body.toString(), body], 'body is not equal', this.bodyIsnt);
     return this;
   }
 
@@ -86,7 +88,7 @@ export class TestUserAgent extends MockUserAgent {
    * Opposite of `bodyLike`.
    */
   bodyUnlike(regex: RegExp): this {
-    this.assert('notMatch', [this.body.toString(), regex], 'body is not similar', this.bodyUnlike);
+    this.assert('doesNotMatch', [this.body.toString(), regex], 'body is not similar', this.bodyUnlike);
     return this;
   }
 
@@ -105,7 +107,7 @@ export class TestUserAgent extends MockUserAgent {
   async closedOk(code: number): Promise<void> {
     await this._waitFinished();
     const finished = this._finished == null ? null : this._finished[0];
-    this.assert('equal', [finished, code], `WebSocket closed with status ${code}`, this.closedOk);
+    this.assert('strictEqual', [finished, code], `WebSocket closed with status ${code}`, this.closedOk);
   }
 
   /**
@@ -159,23 +161,23 @@ export class TestUserAgent extends MockUserAgent {
    * Opposite of `headerExists`.
    */
   headerExistsNot(name: string): this {
-    this.assert('notOk', [this.res.get(name) !== null], `no "${name}" header`, this.headerExistsNot);
+    this.assert('ok', [this.res.get(name) === null], `no "${name}" header`, this.headerExistsNot);
     return this;
   }
 
   /**
    * Check response header for exact match.
    */
   headerIs(name: string, value: string): this {
-    this.assert('equal', [this.res.get(name), value], `${name}: ${value}`, this.headerIs);
+    this.assert('strictEqual', [this.res.get(name), value], `${name}: ${value}`, this.headerIs);
     return this;
   }
 
   /**
    * Opposite of `headerIs`.
    */
   headerIsnt(name: string, value: string): this {
-    this.assert('not', [this.res.get(name), value], `not ${name}: ${value}`, this.headerIsnt);
+    this.assert('notStrictEqual', [this.res.get(name), value], `not ${name}: ${value}`, this.headerIsnt);
     return this;
   }
 
@@ -202,7 +204,7 @@ export class TestUserAgent extends MockUserAgent {
    */
   jsonIs(value: JSONValue, pointer = ''): this {
     const expected = jsonPointer(JSON.parse(this.body.toString()), pointer);
-    this.assert('same', [expected, value], `exact match for JSON Pointer "${pointer}" (JSON)`, this.jsonIs);
+    this.assert('deepStrictEqual', [expected, value], `exact match for JSON Pointer "${pointer}" (JSON)`, this.jsonIs);
     return this;
   }
 
@@ -277,7 +279,7 @@ export class TestUserAgent extends MockUserAgent {
    * Check response status for exact match.
    */
   statusIs(status: number): this {
-    this.assert('equal', [this.res.statusCode, status], `response status is ${status}`, this.statusIs);
+    this.assert('strictEqual', [this.res.statusCode, status], `response status is ${status}`, this.statusIs);
     return this;
   }
 
@@ -299,7 +301,7 @@ export class TestUserAgent extends MockUserAgent {
    */
   textUnlike(selector: string, regex: RegExp): this {
     this.assert(
-      'notMatch',
+      'doesNotMatch',
       [this._html.at(selector)?.text() ?? '', regex],
       `no similar match for selector "${selector}"`,
       this.textLike
@@ -311,7 +313,7 @@ export class TestUserAgent extends MockUserAgent {
    * Check response `Content-Type` header for exact match.
    */
   typeIs(value: string): this {
-    this.assert('equal', [this.res.type, value], `Content-Type: ${value}`, this.typeIs);
+    this.assert('strictEqual', [this.res.type, value], `Content-Type: ${value}`, this.typeIs);
     return this;
   }
 
@@ -361,7 +363,7 @@ export class TestUserAgent extends MockUserAgent {
    */
   yamlIs(value: JSONValue, pointer = ''): this {
     const expected = jsonPointer(yaml.load(this.body.toString()) as JSONValue, pointer);
-    this.assert('same', [expected, value], `exact match for JSON Pointer "${pointer}" (YAML)`, this.yamlIs);
+    this.assert('deepStrictEqual', [expected, value], `exact match for JSON Pointer "${pointer}" (YAML)`, this.yamlIs);
     return this;
   }
 
@@ -371,11 +373,13 @@ export class TestUserAgent extends MockUserAgent {
   }
 
   _prepareTap(tap: Test): void {
+    addNodeAssertMethods(tap);
     this._assert = tap;
     const subtests = [tap];
     const assert = this._assert;
 
     assert.beforeEach(async t => {
+      addNodeAssertMethods(t);
       subtests.push(t);
       this._assert = t;
     });

test/test-user-agent.js

@@ -28,7 +28,7 @@ t.test('TestUserAgent', async t => {
 
   app.get('/target', ctx => ctx.render({text: 'Hi'}));
 
-  for (const useTap of [true, false]) {
+  for (const useTap of [false, true]) {
     const ua = useTap ? await app.newTestUserAgent({tap: t}) : await app.newTestUserAgent();
 
     await t.test('Status Assertion test', async () => {
@@ -96,7 +96,7 @@ t.test('TestUserAgent', async t => {
 
       t.same(results, [
         ['ok', [true], 'GET request for /'],
-        ['equal', [200, 200], 'response status is 200']
+        ['strictEqual', [200, 200], 'response status is 200']
       ]);
     });
 
@@ -115,12 +115,12 @@ t.test('TestUserAgent', async t => {
 
       t.same(results, [
         ['ok', [true], 'GET request for /'],
-        ['equal', ['text/plain; charset=utf-8', 'text/plain'], 'Content-Type: text/plain'],
+        ['strictEqual', ['text/plain; charset=utf-8', 'text/plain'], 'Content-Type: text/plain'],
         ['match', ['text/plain; charset=utf-8', /plain/], 'Content-Type is similar'],
         ['ok', [true], 'header "Content-Type" exists'],
-        ['notOk', [false], 'no "Content-Disposition" header'],
-        ['equal', ['text/plain; charset=utf-8', 'text/plain'], 'Content-Type: text/plain'],
-        ['not', ['text/plain; charset=utf-8', 'text/plain'], 'not Content-Type: text/plain'],
+        ['ok', [true], 'no "Content-Disposition" header'],
+        ['strictEqual', ['text/plain; charset=utf-8', 'text/plain'], 'Content-Type: text/plain'],
+        ['notStrictEqual', ['text/plain; charset=utf-8', 'text/plain'], 'not Content-Type: text/plain'],
         ['match', ['text/plain; charset=utf-8', /plain/], 'Content-Type is similar']
       ]);
     });
@@ -137,10 +137,10 @@ t.test('TestUserAgent', async t => {
 
       t.same(results, [
         ['ok', [true], 'GET request for /'],
-        ['equal', ['Hello Mojo!', 'test'], 'body is equal'],
-        ['not', ['Hello Mojo!', 'test'], 'body is not equal'],
+        ['strictEqual', ['Hello Mojo!', 'test'], 'body is equal'],
+        ['notStrictEqual', ['Hello Mojo!', 'test'], 'body is not equal'],
         ['match', ['Hello Mojo!', /that/], 'body is similar'],
-        ['notMatch', ['Hello Mojo!', /whatever/], 'body is not similar']
+        ['doesNotMatch', ['Hello Mojo!', /whatever/], 'body is not similar']
       ]);
     });
 
@@ -166,8 +166,8 @@ t.test('TestUserAgent', async t => {
         ['ok', [false], 'no element for selector "div"'],
         ['match', ['Two', /test/], 'similar match for selector "div"'],
         ['match', ['', /123/], 'similar match for selector "nothing"'],
-        ['notMatch', ['Two', /test/], 'no similar match for selector "div"'],
-        ['notMatch', ['', /123/], 'no similar match for selector "nothing"']
+        ['doesNotMatch', ['Two', /test/], 'no similar match for selector "div"'],
+        ['doesNotMatch', ['', /123/], 'no similar match for selector "nothing"']
       ]);
 
       results = [];
@@ -196,15 +196,15 @@ t.test('TestUserAgent', async t => {
         ['ok', [true], 'has value for JSON Pointer "/a" (JSON)'],
         ['ok', [false], 'has value for JSON Pointer "/d" (JSON)'],
         [
-          'same',
+          'deepStrictEqual',
           [
             ['b', 'c'],
             ['b', 'c']
           ],
           'exact match for JSON Pointer "/a" (JSON)'
         ],
-        ['same', [undefined, 'e'], 'exact match for JSON Pointer "/d" (JSON)'],
-        ['same', [{a: ['b', 'c']}, {a: ['b', 'c']}], 'exact match for JSON Pointer "" (JSON)']
+        ['deepStrictEqual', [undefined, 'e'], 'exact match for JSON Pointer "/d" (JSON)'],
+        ['deepStrictEqual', [{a: ['b', 'c']}, {a: ['b', 'c']}], 'exact match for JSON Pointer "" (JSON)']
       ]);
     });
 
@@ -224,15 +224,15 @@ t.test('TestUserAgent', async t => {
         ['ok', [true], 'has value for JSON Pointer "/a" (YAML)'],
         ['ok', [false], 'has value for JSON Pointer "/d" (YAML)'],
         [
-          'same',
+          'deepStrictEqual',
           [
             ['b', 'c'],
             ['b', 'c']
           ],
           'exact match for JSON Pointer "/a" (YAML)'
         ],
-        ['same', [undefined, 'e'], 'exact match for JSON Pointer "/d" (YAML)'],
-        ['same', [{a: ['b', 'c']}, {a: ['b', 'c']}], 'exact match for JSON Pointer "" (YAML)']
+        ['deepStrictEqual', [undefined, 'e'], 'exact match for JSON Pointer "/d" (YAML)'],
+        ['deepStrictEqual', [{a: ['b', 'c']}, {a: ['b', 'c']}], 'exact match for JSON Pointer "" (YAML)']
       ]);
     });
 
@@ -261,7 +261,7 @@ t.test('TestUserAgent', async t => {
         ['ok', [true], 'send message'],
         ['ok', [true], 'message received'],
         ['ok', [true], 'closed WebSocket'],
-        ['equal', [1000, 1000], 'WebSocket closed with status 1000']
+        ['strictEqual', [1000, 1000], 'WebSocket closed with status 1000']
       ]);
     });