Fail when passing undefined as the expectation for equals

sinonjs · Mar 9, 2019 · 41f8748 · 41f8748
1 parent 574839a
commit 41f8748
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/lib/assertions/equals.js b/lib/assertions/equals.js
@@ -14,6 +14,11 @@ module.exports = function(referee) {
         // Uses arguments[2] because the function's .length is used to determine
         // the minimum required number of arguments.
         assert: function(actual, expected) {
+            if (typeof expected === "undefined") {
+                return this.fail(
+                    "Expectation for equals should not be undefined. Use assert.defined or refute.defined instead."
+                );
+            }
             return samsam.deepEqual(actual, expected);
         },
         assertMessage:

diff --git a/lib/assertions/equals.test.js b/lib/assertions/equals.test.js
@@ -17,7 +17,7 @@ testHelper.assertionTests("assert", "equals", function(pass, fail, msg, error) {
     pass("when comparing numbers", 32, 32);
     pass("when comparing booleans", false, false);
     pass("when comparing null", null, null);
-    pass("when comparing undefined", undefined, undefined);
+    fail("when comparing undefined", undefined, undefined);
     pass("when comparing function to itself", func, func);
     fail("when comparing functions", function() {}, function() {});
     pass("when comparing array to itself", arr, arr);
@@ -295,7 +295,7 @@ testHelper.assertionTests("refute", "equals", function(pass, fail, msg, error) {
     pass("when comparing different objects", obj, {});
     pass("when comparing object to null", {}, null);
     pass("when comparing null to object", {}, null);
-    pass("when comparing object to undefined", {}, undefined);
+    fail("when comparing object to undefined", {}, undefined);
     pass("when comparing undefined to object", undefined, {});
     pass("when comparing object to false", {}, false);
     pass("when comparing false to object", false, {});