Merge pull request #35 from sinonjs/error-properties

Set code, actual and expected properties on errors
sinonjs · Aug 9, 2018 · d990731 · d990731
2 parents d3d71a4 + ce794ee
commit d990731
Show file tree

Hide file tree

Showing 26 changed files with 1,273 additions and 149 deletions.
diff --git a/demo/diff.test.js b/demo/diff.test.js
@@ -0,0 +1,20 @@
+/*
+ * Demo error messages and diff rendering with Mocha.
+ */
+"use strict";
+
+var assert = require("..").assert;
+
+describe("diff", function() {
+    it("multiline string", function() {
+        assert.equals("foo\nbar\ndoo\n", "bar\ndoo\nxyz\n");
+    });
+
+    it("objects", function() {
+        assert.equals({ foo: 42 }, { foo: 66 });
+    });
+
+    it("matchJson", function() {
+        assert.matchJson('{"foo":42,"bar":true}', { foo: 42, bar: false });
+    });
+});
diff --git a/lib/assertions/equals.js b/lib/assertions/equals.js
@@ -22,14 +22,16 @@ module.exports = function(referee) {
         },
 
         assertMessage:
-            "${customMessage}${actual} expected to be equal to ${expected}",
+            "${customMessage}${escapedActual} expected to be equal to ${escapedExpected}",
         refuteMessage:
-            "${customMessage}${actual} expected not to be equal to ${expected}",
+            "${customMessage}${escapedActual} expected not to be equal to ${escapedExpected}",
         expectation: "toEqual",
         values: function(actual, expected, message) {
             return {
-                actual: escapeNewlines(actual),
-                expected: escapeNewlines(expected),
+                escapedActual: escapeNewlines(actual),
+                escapedExpected: escapeNewlines(expected),
+                actual: actual,
+                expected: expected,
                 customMessage: message
             };
         }

diff --git a/lib/assertions/is-array-buffer.js b/lib/assertions/is-array-buffer.js
@@ -1,6 +1,6 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 var toString = Object.prototype.toString;
 
 module.exports = function(referee) {
@@ -13,6 +13,6 @@ module.exports = function(referee) {
         refuteMessage:
             "${customMessage}Expected ${actual} not to be an ArrayBuffer",
         expectation: "toBeArrayBuffer",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-array-like.js b/lib/assertions/is-array-like.js
@@ -1,7 +1,7 @@
 "use strict";
 
 var isArguments = require("lodash.isarguments");
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 
 module.exports = function(referee) {
     function isArrayLike(object) {
@@ -24,6 +24,6 @@ module.exports = function(referee) {
         refuteMessage:
             "${customMessage}Expected ${actual} not to be array like",
         expectation: "toBeArrayLike",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-array.js b/lib/assertions/is-array.js
@@ -1,6 +1,6 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 
 module.exports = function(referee) {
     referee.add("isArray", {
@@ -10,6 +10,6 @@ module.exports = function(referee) {
         assertMessage: "${customMessage}Expected ${actual} to be array",
         refuteMessage: "${customMessage}Expected ${actual} not to be array",
         expectation: "toBeArray",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-boolean.js b/lib/assertions/is-boolean.js
@@ -1,16 +1,21 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
-
 module.exports = function(referee) {
     referee.add("isBoolean", {
         assert: function(actual) {
             return typeof actual === "boolean";
         },
         assertMessage:
-            "${customMessage}Expected ${actual} (${actualType}) to be boolean",
-        refuteMessage: "${customMessage}Expected ${actual} not to be boolean",
+            "${customMessage}Expected ${value} (${actual}) to be boolean",
+        refuteMessage: "${customMessage}Expected ${value} not to be boolean",
         expectation: "toBeBoolean",
-        values: actualAndTypeOfMessageValues
+        values: function(actual, message) {
+            return {
+                value: actual,
+                actual: typeof actual,
+                expected: "boolean",
+                customMessage: message
+            };
+        }
     });
 };
diff --git a/lib/assertions/is-data-view.js b/lib/assertions/is-data-view.js
@@ -1,6 +1,6 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 var toString = Object.prototype.toString;
 
 module.exports = function(referee) {
@@ -12,6 +12,6 @@ module.exports = function(referee) {
         refuteMessage:
             "${customMessage}Expected ${actual} not to be a DataView",
         expectation: "toBeDataView",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-error.js b/lib/assertions/is-error.js
@@ -1,6 +1,6 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 
 module.exports = function(referee) {
     referee.add("isError", {
@@ -10,6 +10,6 @@ module.exports = function(referee) {
         assertMessage: "${customMessage}Expected ${actual} to be an Error",
         refuteMessage: "${customMessage}Expected ${actual} not to be an Error",
         expectation: "toBeError",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-eval-error.js b/lib/assertions/is-eval-error.js
@@ -1,6 +1,6 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 
 module.exports = function(referee) {
     referee.add("isEvalError", {
@@ -11,6 +11,6 @@ module.exports = function(referee) {
         refuteMessage:
             "${customMessage}Expected ${actual} not to be an EvalError",
         expectation: "toBeEvalError",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-float-32-array.js b/lib/assertions/is-float-32-array.js
@@ -1,6 +1,6 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 
 module.exports = function(referee) {
     referee.add("isFloat32Array", {
@@ -12,6 +12,6 @@ module.exports = function(referee) {
         refuteMessage:
             "${customMessage}Expected ${actual} not to be a Float32Array",
         expectation: "toBeFloat32Array",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-float-64-array.js b/lib/assertions/is-float-64-array.js
@@ -1,6 +1,6 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var actualMessageValues = require("../actual-message-values");
 
 module.exports = function(referee) {
     referee.add("isFloat64Array", {
@@ -12,6 +12,6 @@ module.exports = function(referee) {
         refuteMessage:
             "${customMessage}Expected ${actual} not to be a Float64Array",
         expectation: "toBeFloat64Array",
-        values: actualAndTypeOfMessageValues
+        values: actualMessageValues
     });
 };
diff --git a/lib/assertions/is-function.js b/lib/assertions/is-function.js
@@ -6,15 +6,16 @@ module.exports = function(referee) {
             return typeof actual === "function";
         },
         assertMessage:
-            "${customMessage}${actual} (${actualType}) expected to be function",
-        refuteMessage: "${customMessage}${actual} expected not to be function",
+            "${customMessage}${value} (${actual}) expected to be function",
+        refuteMessage: "${customMessage}${value} expected not to be function",
         expectation: "toBeFunction",
         values: function(actual, message) {
             return {
-                actual: String(actual)
+                value: String(actual)
                     .replace("function(", "function (")
                     .replace("\n", ""),
-                actualType: typeof actual,
+                actual: typeof actual,
+                expected: "function",
                 customMessage: message
             };
         }

diff --git a/lib/assertions/is-infinity.js b/lib/assertions/is-infinity.js
@@ -1,7 +1,5 @@
 "use strict";
 
-var actualMessageValues = require("../actual-message-values");
-
 module.exports = function(referee) {
     referee.add("isInfinity", {
         assert: function(actual) {
@@ -10,6 +8,12 @@ module.exports = function(referee) {
         assertMessage: "${customMessage}Expected ${actual} to be Infinity",
         refuteMessage: "${customMessage}Expected ${actual} not to be Infinity",
         expectation: "toBeInfinity",
-        values: actualMessageValues
+        values: function(actual, message) {
+            return {
+                actual: actual,
+                expected: Infinity,
+                customMessage: message
+            };
+        }
     });
 };
diff --git a/lib/assertions/is-nan.js b/lib/assertions/is-nan.js
@@ -1,7 +1,5 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
-
 module.exports = function(referee) {
     referee.add("isNaN", {
         assert: function(actual) {
@@ -10,6 +8,12 @@ module.exports = function(referee) {
         assertMessage: "${customMessage}Expected ${actual} to be NaN",
         refuteMessage: "${customMessage}Expected not to be NaN",
         expectation: "toBeNaN",
-        values: actualAndTypeOfMessageValues
+        values: function(actual, message) {
+            return {
+                actual: actual,
+                expected: "NaN",
+                customMessage: message
+            };
+        }
     });
 };
diff --git a/lib/assertions/is-null.js b/lib/assertions/is-null.js
@@ -1,7 +1,5 @@
 "use strict";
 
-var actualMessageValues = require("../actual-message-values");
-
 module.exports = function(referee) {
     referee.add("isNull", {
         assert: function(actual) {
@@ -10,6 +8,12 @@ module.exports = function(referee) {
         assertMessage: "${customMessage}Expected ${actual} to be null",
         refuteMessage: "${customMessage}Expected not to be null",
         expectation: "toBeNull",
-        values: actualMessageValues
+        values: function(actual, message) {
+            return {
+                actual: actual,
+                expected: null,
+                customMessage: message
+            };
+        }
     });
 };
diff --git a/lib/assertions/is-number.js b/lib/assertions/is-number.js
@@ -1,17 +1,22 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
-
 module.exports = function(referee) {
     referee.add("isNumber", {
         assert: function(actual) {
             return typeof actual === "number" && !isNaN(actual);
         },
         assertMessage:
-            "${customMessage}Expected ${actual} (${actualType}) to be a non-NaN number",
+            "${customMessage}Expected ${value} (${actual}) to be a non-NaN number",
         refuteMessage:
-            "${customMessage}Expected ${actual} to be NaN or a non-number value",
+            "${customMessage}Expected ${value} to be NaN or a non-number value",
         expectation: "toBeNumber",
-        values: actualAndTypeOfMessageValues
+        values: function(actual, message) {
+            return {
+                value: actual,
+                actual: typeof actual,
+                expected: "number",
+                customMessage: message
+            };
+        }
     });
 };
diff --git a/lib/assertions/is-object.js b/lib/assertions/is-object.js
@@ -1,17 +1,22 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
-
 module.exports = function(referee) {
     referee.add("isObject", {
         assert: function(actual) {
             return typeof actual === "object" && !!actual;
         },
         assertMessage:
-            "${customMessage}${actual} (${actualType}) expected to be object and not null",
+            "${customMessage}${value} (${actual}) expected to be object and not null",
         refuteMessage:
-            "${customMessage}${actual} expected to be null or not an object",
+            "${customMessage}${value} expected to be null or not an object",
         expectation: "toBeObject",
-        values: actualAndTypeOfMessageValues
+        values: function(actual, message) {
+            return {
+                value: actual,
+                actual: typeof actual,
+                expected: "object",
+                customMessage: message
+            };
+        }
     });
 };
diff --git a/lib/assertions/is-string.js b/lib/assertions/is-string.js
@@ -1,16 +1,21 @@
 "use strict";
 
-var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
-
 module.exports = function(referee) {
     referee.add("isString", {
         assert: function(actual) {
             return typeof actual === "string";
         },
         assertMessage:
-            "${customMessage}Expected ${actual} (${actualType}) to be string",
-        refuteMessage: "${customMessage}Expected ${actual} not to be string",
+            "${customMessage}Expected ${value} (${actual}) to be string",
+        refuteMessage: "${customMessage}Expected ${value} not to be string",
         expectation: "toBeString",
-        values: actualAndTypeOfMessageValues
+        values: function(actual, message) {
+            return {
+                value: actual,
+                actual: typeof actual,
+                expected: "string",
+                customMessage: message
+            };
+        }
     });
 };
diff --git a/lib/assertions/is-symbol.js b/lib/assertions/is-symbol.js
@@ -1,7 +1,5 @@
 "use strict";
 
-var actualMessageValues = require("../actual-message-values");
-
 module.exports = function(referee) {
     referee.add("isSymbol", {
         assert: function(actual) {
@@ -10,6 +8,12 @@ module.exports = function(referee) {
         assertMessage: "${customMessage}Expected ${actual} to be a Symbol",
         refuteMessage: "${customMessage}Expected ${actual} not to be a Symbol",
         expectation: "toBeSymbol",
-        values: actualMessageValues
+        values: function(actual, message) {
+            return {
+                actual: actual,
+                expected: "symbol",
+                customMessage: message
+            };
+        }
     });
 };