feat: add extra fields in AssertionError YAML

Many TAP reporters offer special-case handling of YAML objects containing `expected`, `actual`, and `operator` fields, as produced by `AssertionError` and similar userland Error classes. PR-URL: nodejs/node#44952 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: James M Snell <[email protected]> (cherry picked from commit e260b373f13c150eb5bdf4c336d4b6b764b59c8e)
nodejs · Feb 2, 2023 · 46dce07 · 46dce07
1 parent c5fd64c
commit 46dce07
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/lib/internal/test_runner/tap_stream.js b/lib/internal/test_runner/tap_stream.js
@@ -1,4 +1,4 @@
-// https://github.com/nodejs/node/blob/cb7e0c59df10a42cd6930ca7f99d3acee1ce7627/lib/internal/test_runner/tap_stream.js
+// https://github.com/nodejs/node/blob/e260b373f13c150eb5bdf4c336d4b6b764b59c8e/lib/internal/test_runner/tap_stream.js
 
 'use strict'
 
@@ -183,17 +183,30 @@ function jsToYaml (indent, name, value) {
       code,
       failureType,
       message,
+      expected,
+      actual,
+      operator,
       stack
     } = value
     let errMsg = message ?? '<unknown error>'
     let errStack = stack
     let errCode = code
+    let errExpected = expected
+    let errActual = actual
+    let errOperator = operator
+    let errIsAssertion = isAssertionLike(value)
 
     // If the ERR_TEST_FAILURE came from an error provided by user code,
     // then try to unwrap the original error message and stack.
     if (code === 'ERR_TEST_FAILURE' && kUnwrapErrors.has(failureType)) {
       errStack = cause?.stack ?? errStack
       errCode = cause?.code ?? errCode
+      if (isAssertionLike(cause)) {
+        errExpected = cause.expected
+        errActual = cause.actual
+        errOperator = cause.operator ?? errOperator
+        errIsAssertion = true
+      }
       if (failureType === kTestCodeFailure) {
         errMsg = cause?.message ?? errMsg
       }
@@ -205,6 +218,14 @@ function jsToYaml (indent, name, value) {
       result += jsToYaml(indent, 'code', errCode)
     }
 
+    if (errIsAssertion) {
+      result += jsToYaml(indent, 'expected', errExpected)
+      result += jsToYaml(indent, 'actual', errActual)
+      if (errOperator) {
+        result += jsToYaml(indent, 'operator', errOperator)
+      }
+    }
+
     if (typeof errStack === 'string') {
       const frames = []
 
@@ -233,4 +254,8 @@ function jsToYaml (indent, name, value) {
   return result
 }
 
+function isAssertionLike (value) {
+  return value && typeof value === 'object' && 'expected' in value && 'actual' in value
+}
+
 module.exports = { TapStream }
diff --git a/test/message/test_runner_desctibe_it.out b/test/message/test_runner_desctibe_it.out
@@ -123,6 +123,9 @@ not ok 13 - async assertion fail
     true !== false
 
   code: 'ERR_ASSERTION'
+  expected: false
+  actual: true
+  operator: 'strictEqual'
   stack: |-
     *
     *

diff --git a/test/message/test_runner_output.out b/test/message/test_runner_output.out
@@ -133,6 +133,9 @@ not ok 13 - async assertion fail
     true !== false
 
   code: 'ERR_ASSERTION'
+  expected: false
+  actual: true
+  operator: 'strictEqual'
   stack: |-
     *
     *