assert: indicate if exception message is generated

glenjamin · tjfontaine · commit 66b8c3c5a037 · 2013-10-11T10:15:03.000-07:00
AssertionError.generatedMessage is now true when AssertionError.message was generated from expected and actual Fixes #5836, #6206
diff --git a/lib/assert.js b/lib/assert.js
@@ -42,7 +42,13 @@ assert.AssertionError = function AssertionError(options) {
   this.actual = options.actual;
   this.expected = options.expected;
   this.operator = options.operator;
-  this.message = options.message || getMessage(this);
+  if (options.message) {
+    this.message = options.message;
+    this.generatedMessage = false;
+  } else {
+    this.message = getMessage(this);
+    this.generatedMessage = true;
+  }
   var stackStartFunction = options.stackStartFunction || fail;
   Error.captureStackTrace(this, stackStartFunction);
 };
diff --git a/test/simple/test-assert.js b/test/simple/test-assert.js
@@ -260,6 +260,7 @@ function testAssertionMessage(actual, expected) {
   } catch (e) {
     assert.equal(e.toString(),
         ['AssertionError:', expected, '==', '""'].join(' '));
+    assert.ok(e.generatedMessage, "Message not marked as generated");
   }
 }
 testAssertionMessage(undefined, '"undefined"');
@@ -299,10 +300,13 @@ try {
   assert.equal(1, 2);
 } catch (e) {
   assert.equal(e.toString().split('\n')[0], 'AssertionError: 1 == 2')
+  assert.ok(e.generatedMessage, 'Message not marked as generated');
 }
 
 try {
   assert.equal(1, 2, 'oh no');
 } catch (e) {
   assert.equal(e.toString().split('\n')[0], 'AssertionError: oh no')
+  assert.equal(e.generatedMessage, false,
+              'Message incorrectly marked as generated');
 }

Original file line number	Diff line number	Diff line change
`@@ -260,6 +260,7 @@ function testAssertionMessage(actual, expected) {`
`260`	`260`	`} catch (e) {`
`261`	`261`	`assert.equal(e.toString(),`
`262`	`262`	`['AssertionError:', expected, '==', '""'].join(' '));`
	`263`	`+ assert.ok(e.generatedMessage, "Message not marked as generated");`
`263`	`264`	`}`
`264`	`265`	`}`
`265`	`266`	`testAssertionMessage(undefined, '"undefined"');`
`@@ -299,10 +300,13 @@ try {`
`299`	`300`	`assert.equal(1, 2);`
`300`	`301`	`} catch (e) {`
`301`	`302`	`assert.equal(e.toString().split('\n')[0], 'AssertionError: 1 == 2')`
	`303`	`+ assert.ok(e.generatedMessage, 'Message not marked as generated');`
`302`	`304`	`}`
`303`	`305`
`304`	`306`	`try {`
`305`	`307`	`assert.equal(1, 2, 'oh no');`
`306`	`308`	`} catch (e) {`
`307`	`309`	`assert.equal(e.toString().split('\n')[0], 'AssertionError: oh no')`
	`310`	`+ assert.equal(e.generatedMessage, false,`
	`311`	`+ 'Message incorrectly marked as generated');`
`308`	`312`	`}`