Core: Add assertion event

Implements the assertion event according to js-reporters standard
qunitjs · Feb 7, 2017 · 721f380 · 721f380
1 parent 59e9f5a
commit 721f380
Show file tree

Hide file tree

Showing 4 changed files with 92 additions and 2 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -116,6 +116,7 @@ grunt.initConfig( {
 			"test/reorderError1.html",
 			"test/reorderError2.html",
 			"test/callbacks.html",
+			"test/events.html",
 			"test/logs.html",
 			"test/setTimeout.html",
 			"test/amd.html",
@@ -145,6 +146,7 @@ grunt.initConfig( {
 			"test/main/modules",
 			"test/main/deepEqual",
 			"test/main/stack",
+			"test/events",
 			"test/only",
 			"test/setTimeout",
 			"test/main/dump",

diff --git a/src/test.js b/src/test.js
@@ -2,6 +2,7 @@ import global from "global";
 
 import { internalState, process, begin } from "./core";
 import { setTimeout, clearTimeout } from "./globals";
+import { emit } from "./events";
 import Assert from "./assert";
 
 import config from "./core/config";
@@ -356,7 +357,7 @@ Test.prototype = {
 			}
 		}
 
-		runLoggingCallbacks( "log", details );
+		this.logAssertion( details );
 
 		this.assertions.push( {
 			result: !!resultInfo.result,
@@ -384,14 +385,31 @@ Test.prototype = {
 			details.source = source;
 		}
 
-		runLoggingCallbacks( "log", details );
+		this.logAssertion( details );
 
 		this.assertions.push( {
 			result: false,
 			message: message
 		} );
 	},
 
+	/**
+	 * Log assertion details using both the old QUnit.log interface and
+	 * QUnit.on( "assertion" ) interface.
+	 *
+	 * @private
+	 */
+	logAssertion( details ) {
+		runLoggingCallbacks( "log", details );
+		emit( "assertion", {
+			passed: details.result,
+			actual: details.actual,
+			expected: details.expected,
+			message: details.message,
+			stack: details.source
+		} );
+	},
+
 	resolvePromise: function( promise, phase ) {
 		var then, resume, message,
 			test = this;

diff --git a/test/events.html b/test/events.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="UTF-8">
+	<title>QUnit Events Test Suite</title>
+	<link rel="stylesheet" href="../dist/qunit.css">
+	<script src="../dist/qunit.js"></script>
+	<script src="events.js"></script>
+</head>
+<body>
+	<div id="qunit"></div>
+	<div id="qunit-fixture"></div>
+</body>
+</html>
diff --git a/test/events.js b/test/events.js
@@ -0,0 +1,56 @@
+/**
+ * This test file verifies the execution order and contents of events emitted
+ * by QUnit. They are expected to adhere to the js-reporters standard.
+ */
+
+var invokedHooks = [],
+	invokedHookDetails = {},
+	done = false;
+
+function callback( name ) {
+	invokedHookDetails[ name ] = [];
+
+	return function( details ) {
+		if ( done ) {
+			return;
+		}
+
+		invokedHooks.push( name );
+		invokedHookDetails[ name ].push( details );
+	};
+}
+
+QUnit.on( "assertion", callback( "assertion1" ) );
+QUnit.on( "assertion", callback( "assertion2" ) );
+
+// After all the tests run, we verify the events were fired in the correct order
+// with the correct data
+QUnit.done( function() {
+	if ( done ) {
+		return;
+	}
+
+	done = true;
+
+	QUnit.module( "Events" );
+	QUnit.test( "verify callback order and data", function( assert ) {
+		assert.deepEqual( invokedHooks, [
+			"assertion1",
+			"assertion2"
+		], "event callbacks are called in correct order" );
+
+		assert.deepEqual( invokedHookDetails.assertion1[ 0 ], {
+			passed: true,
+			actual: true,
+			expected: true,
+			message: "passing assertion",
+			stack: undefined
+		}, "assertion callback data is correct" );
+	} );
+} );
+
+QUnit.module( "Events", function() {
+	QUnit.test( "test1", function( assert ) {
+		assert.ok( true, "passing assertion" );
+	} );
+} );