Merge pull request #31 from bfrymire/event-firing-around-run

Add event functions for run and make name an argument for BaseTestClass

Author: bfrymire

scripts/BaseTestClass/BaseTestClass.gml

@@ -1,22 +1,27 @@
 /**
- * Base "class" test constructors will inherit from
+ * Base "class" that test constructors will inherit from
  * @constructor BaseTestClass
+ * @param {string} name - Name of class
  */
-function BaseTestClass() {
+function BaseTestClass(_name) {
 
 	name = undefined;
 	static setUp = undefined;
 	static __setUp__ = undefined;
 	static tearDown = undefined;
 	static __tearDown__ = undefined;
+	static __onRunBegin__ = undefined
+	static __onRunEnd__ = undefined
+	setName(_name);
 
 	// Give self cripsyStructUnpack() function
 	crispyMixinStructUnpack(self);
 
+
 	/**
-	 * Set the name of the TestCase
+	 * Set name of class object
 	 * @function setName
-	 * @param {string} name - Name of the test
+	 * @param {string} name - Name of the object
 	 */
 	static setName = function(_name) {
 		if !is_string(_name) {
@@ -25,4 +30,44 @@ function BaseTestClass() {
 		name = _name;
 	}
 
+	/**
+	 * Event to be called at the beginning of run
+	 * @function onRunBegin
+	 * @param [method] func - Method to override __onRunBegin__ with
+	 */
+	static onRunBegin = function() {
+		if argument_count > 0 {
+			var _func = argument[0];
+			if is_method(_func) {
+				__onRunBegin__ = method(self, _func);
+			} else {
+				crispyThrowExpected(self, "onRunBegin", "method", typeof(_func));
+			}
+		} else {
+			if is_method(__onRunBegin__) {
+				__onRunBegin__();
+			}
+		}
+	}
+
+	/**
+	 * Event to be called at the end of run
+	 * @function onRunEnd
+	 * @param [method] func - Method to override __onRunEnd__ with
+	 */
+	static onRunEnd = function() {
+		if argument_count > 0 {
+			var _func = argument[0];
+			if is_method(_func) {
+				__onRunEnd__ = method(self, _func);
+			} else {
+				crispyThrowExpected(self, "onRunEnd", "method", typeof(_func));
+			}
+		} else {
+			if is_method(__onRunEnd__) {
+				__onRunEnd__();
+			}
+		}
+	}
+
 }

scripts/TestCase/TestCase.gml

@@ -5,13 +5,12 @@
  * @param {method} func - Test assertion to run for TestCase
  * @param [struct] unpack - Struct for crispyStructUnpack
  */
-function TestCase(_name, _func) : BaseTestClass() constructor {
+function TestCase(_name, _func) : BaseTestClass(_name) constructor {
 
 	if !is_method(_func) {
 		crispyThrowExpected(self, "", "method", typeof(_func));
 	}
 
-	setName(_name);
 	class = instanceof(self);
 	parent = undefined;
 	test = undefined;
@@ -365,7 +364,9 @@ function TestCase(_name, _func) : BaseTestClass() constructor {
 	 */
 	static run = function() {
 		setUp();
+		onRunBegin();
 		test();
+		onRunEnd();
 		tearDown();
 	}
 
@@ -387,6 +388,7 @@ function TestCase(_name, _func) : BaseTestClass() constructor {
 
 	/**
 	 * Run struct unpacker if unpack argument was provided
+	 * Stays after all variables are initialized so it may be overwritten
 	 */
 	if argument_count > 2 {
 		crispyStructUnpack(argument[2]);

scripts/TestRunner/TestRunner.gml

@@ -4,9 +4,8 @@
  * @param {string} name - Name of runner
  * @param [struct] unpack - Struct for crispyStructUnpack
  */
-function TestRunner(_name) : BaseTestClass() constructor {
+function TestRunner(_name) : BaseTestClass(_name) constructor {
 
-	setName(_name);
 	start_time = 0;
 	stop_time = 0;
 	total_time = 0;
@@ -97,8 +96,10 @@ function TestRunner(_name) : BaseTestClass() constructor {
 		setUp();
 		var _len = array_length(suites);
 		for(var i = 0; i < _len; i++) {
+			onRunBegin();
 			suites[i].run();
 			captureLogs(suites[i]);
+			onRunEnd();
 		}
 		tearDown();
 	}
@@ -288,6 +289,7 @@ function TestRunner(_name) : BaseTestClass() constructor {
 
 	/**
 	 * Run struct unpacker if unpack argument was provided
+	 * Stays after all variables are initialized so it may be overwritten
 	 */
 	if argument_count > 1 {
 		crispyStructUnpack(argument[1]);

scripts/TestSuite/TestSuite.gml

@@ -4,9 +4,8 @@
  * @param {string} name - Name of suite
  * @param [struct] unpack - Struct for crispyStructUnpack
  */
-function TestSuite(_name) : BaseTestClass() constructor {
+function TestSuite(_name) : BaseTestClass(_name) constructor {
 
-	setName(_name);
 	parent = undefined;
 	tests = [];
 
@@ -76,13 +75,16 @@ function TestSuite(_name) : BaseTestClass() constructor {
 		setUp();
 		var _len = array_length(tests);
 		for(var i = 0; i < _len; i++) {
+			onRunBegin();
 			tests[i].run();
+			onRunEnd();
 		}
 		tearDown();
 	}
 
 	/**
 	 * Run struct unpacker if unpack argument was provided
+	 * Stays after all variables are initialized so it may be overwritten
 	 */
 	if argument_count > 1 {
 		crispyStructUnpack(argument[1]);