aq - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

lib/aq.js

 /**
  * Manage unit testing
- * @version 1.0.2
  */
@@ -16,3 +15,3 @@ (function ($, window) {
 				failedTests = [],		// List of all unit tests that have failed
-				currTest = {}, 			// Keeps track of the current test runing
+				currTest = null, 		// Keeps track of the current test runing
 				directory = '',			// Directory of where the unit tests are located
@@ -62,4 +61,6 @@ unitTestFilenames = [], // List of all the unit tests
 				if (!obj.result) {
+					if (!currTest) {
+						currTest = {};
+					}
 					currTest.message = obj.message;
-					failedTests.push(currTest);
 				}
@@ -73,2 +74,4 @@ }
 					currTest.name = obj.name;
+					failedTests.push(currTest);
+					currTest = null;
 				}
@@ -75,0 +78,0 @@ }

package.json

 {
 	"name" : "aq",
-	"version" : "0.0.5",
+	"version" : "0.0.6",
 	"description" : "App which automates QUnit tests",
@@ -13,3 +13,3 @@ "author" : "Kirollos Risk <[e-mail]>",
 		"socket.io" : ">= 0.9.0",
-		"optimist" : ">= 0.3.1"
+		"optimist" : "0.3.1"
 	},
@@ -16,0 +16,0 @@ "main": "index",

README.md

@@ -1,9 +0,107 @@
-Automate QUnit tests
+[![Build Status](https://secure.travis-ci.org/krisk/aq.png?branch=master)](http://travis-ci.org/krisk/aq)
 
-### To run the tests
+# AQ
 
-#### From the test server
+## What is it?
 
-	node server.js
+(Note: this is still a work in progress. Nonetheless, the base functioality is there, and works)
 
+AQ allows you to automate your QUnit tests, leveraging Node.js.
+
+To get started, create a Node.js server.
+
+## Install
+
+Using npm:
+
+`npm install aq`
+
+Update the packages:
+
+`npm update`
+
+In your `server.js`,
+
+```javascript
+aq = require('aq'),
+
+app = http.createServer( function( request, response ) {
+	// ..whatever you use to serve content
+} ).listen( port );
+
+// AQ options
+var options = {
+		// Display test results on the terminal
+		log: true,
+
+		// Name of the folder where the unit test files reside
+		testFolder: 'unit-tests',
+
+		// Directory
+		dir: path.normalize(__dirname + '/test/unit-tests/'),
+
+		// The test page
+		page: '/test/index.html'
+	};
+
+// Let AQ listen to the server
+aq = aq.listen(app, options);
+```
+
+## Creating the tests
+
+### The test page
+
+Before you can automate your tests, you first need a page where the tests can run in.
+
+In your test page (perhaps index.html), include AQ and socket.io:
+
+```html
+<script src="/socket.io/socket.io.js"></script>
+<script src="/aq/aq.js"></script>
+```
+
+Additionally, there has to be a target container called `aq-container` where AQ can load the proper unit test into.
+
+```html
+<div id="aq-container"></div>
+```
+
+AQ will begin testing only when explicitly told.  You can do this by calling `AQ.start()`, in the test page:
+
+```javascript
+window.AQ.start();
+```
+
+### Struture of a Unit Test file
+
+Each unit test file within the unit test filder should be an HTML file containing a global `run` function.  This function **must** exist so the test harness can execute the tests defined therein properly.
+
+```html
+<!-- Maybe some DOM here -->
+<script>
+    // global function needed by AQ
+	function run() {
+
+		// All QUnit tests, modules, etc.. go here.
+		test('some test', function() {
+			ok(true, 'always true');
+		}
+
+	}
+</script>
+```
+
+### How does it all work?
+
+When the server starts, AQ scans the specified directory where the unit tests are contained.  Each file name is then returned to the client side.  The content of each test file is loaded via an AJAX request, and inserted into `aq-container`.  Once iserted, the `run` function is called, and the tests are executed.  Upon completion of the tests, the next unit test file is loaded.
+
+All tests results (and final results) are passed to the server.
+
+## Running the tests
+
+### Run all tests in the unit test folder
+
+`node server.js`
+
 ### Command line options:
@@ -27,2 +125,61 @@
 
-`node server.js -- test1.html test2.html`
+`node server.js -- test1.html test2.html`
+
+## Events
+
+### On the client
+
+AQ provides a `beforeTestRun` event which is executed after a unit test file is loaded.  If this is event is bound, **no test will run unless an explicit call to `AQ.run` is made.**  For example, in the test page:
+
+```javascript
+window.AQ.start();
+
+$(window.AQ).on('beforeTestRun', function() {
+	// .. do some setup before the test
+	window.AQ.run(); // Run the tests
+});
+```
+
+### On the server
+
+On the server side, once AQ is listening, you can bind onto certain events:
+
+```javascript
+aq = aq.listen(app, options);
+
+/**
+* Triggers when a new unit test file is executing
+*
+* @param filename {String} name of the file
+*/
+aq.on('test-executing', function(filename) {
+	console.log(filename);
+});
+
+/**
+* Triggers when a file containing unit tests has completed
+*
+* @param data {Object} object literal containing:
+*
+* 	failed: {Int} - number of tests that failed
+*	passed: {Int} - number of tests that passed
+*	total: {Int} -  number of tests run
+*	details: {Array} - list of all tests that failed and their details
+*/
+aq.on('test-done', function(data) {
+	console.log(data);
+});
+
+/**
+* Triggers when all the unit test files have been executed
+*
+* @param data {Object} object literal containing:
+*
+* 	failed: {Int} - number of tests that failed
+*	passed: {Int} - number of tests that passed
+*	total: {Int} - number of tests run
+*/
+aq.on('done', function(data) {
+	console.log(data);
+});
+```

No alert changes

Improved metrics

Total package byte prevSize

14775

increased by36.69%

Lines of code

333

increased by0.91%

Number of lines in readme file

184

increased by581.48%

Dependency changes

• + Addedoptimist@0.3.1(transitive)

• - Removedminimist@0.0.10(transitive)

• - Removedoptimist@0.6.1(transitive)

• Updatedoptimist@0.3.1