Clearer messages for Node assert errors

jestjs · Aug 7, 2019 · 5ec8ba5 · 5ec8ba5
1 parent e740de2
commit 5ec8ba5
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 29 deletions.
diff --git a/e2e/__tests__/__snapshots__/failures.test.ts.snap b/e2e/__tests__/__snapshots__/failures.test.ts.snap
@@ -399,7 +399,7 @@ FAIL __tests__/assertionError.test.js
 
   ● assert
 
-    assert.equal(received, expected) or assert(received) 
+    assert(received)
 
     Expected value to be equal to:
       true
@@ -418,7 +418,7 @@ FAIL __tests__/assertionError.test.js
 
   ● assert with a message
 
-    assert.equal(received, expected) or assert(received) 
+    assert(received)
 
     Expected value to be equal to:
       true
@@ -440,7 +440,7 @@ FAIL __tests__/assertionError.test.js
 
   ● assert.ok
 
-    assert.equal(received, expected) or assert(received) 
+    assert(received)
 
     Expected value to be equal to:
       true
@@ -459,7 +459,7 @@ FAIL __tests__/assertionError.test.js
 
   ● assert.ok with a message
 
-    assert.equal(received, expected) or assert(received) 
+    assert(received)
 
     Expected value to be equal to:
       true
@@ -481,7 +481,7 @@ FAIL __tests__/assertionError.test.js
 
   ● assert.equal
 
-    assert.equal(received, expected) or assert(received) 
+    assert.equal(received, expected)
 
     Expected value to be equal to:
       2
@@ -747,7 +747,7 @@ FAIL __tests__/assertionError.test.js
 
   ● async
 
-    assert.equal(received, expected) or assert(received) 
+    assert.equal(received, expected)
 
     Expected value to be equal to:
       "hello"

diff --git a/packages/jest-circus/src/formatNodeAssertErrors.ts b/packages/jest-circus/src/formatNodeAssertErrors.ts
@@ -101,10 +101,17 @@ const assertThrowingMatcherHint = (operatorName: string) =>
 const assertMatcherHint = (
   operator: string | undefined | null,
   operatorName: string,
+  expected: unknown,
 ) => {
   let message = '';
 
-  if (operatorName) {
+  if (operator === '==' && expected === true) {
+    message =
+      chalk.dim('assert') +
+      chalk.dim('(') +
+      chalk.red('received') +
+      chalk.dim(')');
+  } else if (operatorName) {
     message =
       chalk.dim('assert') +
       chalk.dim('.' + operatorName + '(') +
@@ -114,15 +121,6 @@ const assertMatcherHint = (
       chalk.dim(')');
   }
 
-  if (operator === '==') {
-    message +=
-      ' or ' +
-      chalk.dim('assert') +
-      chalk.dim('(') +
-      chalk.red('received') +
-      chalk.dim(') ');
-  }
-
   return message;
 };
 
@@ -160,7 +158,7 @@ function assertionErrorMessage(
   }
 
   return (
-    buildHintString(assertMatcherHint(operator, operatorName)) +
+    buildHintString(assertMatcherHint(operator, operatorName, expected)) +
     chalk.reset(`Expected value ${operatorMessage(operator)}`) +
     `  ${printExpected(expected)}\n` +
     chalk.reset(`Received:\n`) +

diff --git a/packages/jest-jasmine2/src/assertionErrorMessage.ts b/packages/jest-jasmine2/src/assertionErrorMessage.ts
@@ -62,10 +62,20 @@ const assertThrowingMatcherHint = (operatorName: string) =>
       chalk.dim(')')
     : '';
 
-const assertMatcherHint = (operator: string | null, operatorName: string) => {
+const assertMatcherHint = (
+  operator: string | null,
+  operatorName: string,
+  expected: unknown,
+) => {
   let message = '';
 
-  if (operatorName) {
+  if (operator === '==' && expected === true) {
+    message =
+      chalk.dim('assert') +
+      chalk.dim('(') +
+      chalk.red('received') +
+      chalk.dim(')');
+  } else if (operatorName) {
     message =
       chalk.dim('assert') +
       chalk.dim('.' + operatorName + '(') +
@@ -75,15 +85,6 @@ const assertMatcherHint = (operator: string | null, operatorName: string) => {
       chalk.dim(')');
   }
 
-  if (operator === '==') {
-    message +=
-      ' or ' +
-      chalk.dim('assert') +
-      chalk.dim('(') +
-      chalk.red('received') +
-      chalk.dim(') ');
-  }
-
   return message;
 };
 
@@ -121,7 +122,7 @@ function assertionErrorMessage(
   }
 
   return (
-    buildHintString(assertMatcherHint(operator, operatorName)) +
+    buildHintString(assertMatcherHint(operator, operatorName, expected)) +
     chalk.reset(`Expected value ${operatorMessage(operator)}`) +
     `  ${printExpected(expected)}\n` +
     chalk.reset(`Received:\n`) +