spec style formatting

README.md

@@ -146,6 +146,7 @@ suite('math', function () {
 **lab** supports the following command line options:
 - `-r` - the reporter used to generate the test results. Defaults to `console`. Options are:
     - `console` - simple text output to console
+    - `spec` - specification output to console
     - `coverage` - JSON code coverage report
     - `html` - HTML code coverage report
     - `threshold` - Code coverage percentage check

lib/execute.js

@@ -58,7 +58,7 @@ exports.execute = function (skipTraverse) {
 
         .alias('r', 'reporter')
         .default('r', 'console')
-        .describe('r', 'reporter module [console, json, html, coverage, threshold]')
+        .describe('r', 'reporter module [console, spec, json, html, coverage, threshold]')
 
         .alias('s', 'silence')
         .default('s', false)
@@ -153,8 +153,11 @@ exports.execute = function (skipTraverse) {
 
     // Subscribe reporter to events
 
-    // test      - (test, failed, err)   test results
-    // end       - (ms)                  execution complete
+    // start            - ()                    execution start
+    // startExperiment  - (experiment)          experiment start
+    // test             - (test)                test results
+    // endExperiment    - (experiment)          experiment end
+    // end              - (ms)                  execution complete
 
     var emitter = new Events.EventEmitter();
 
@@ -169,38 +172,12 @@ exports.execute = function (skipTraverse) {
 
     Reporter[argv.r](emitter, options);
 
-    var failures = 0;
-
     // Execute experiments
 
     var startTime = Date.now();
-    Async.forEachSeries(Lab.experiments, function (experiment, nextExperiment) {
-
-        Async.series([
-            function (next) {
-
-                internals.executeDeps(experiment.befores, next);
-            },
-            function (next) {
-
-                internals.executeTests(experiment, emitter, options.ids, next);
-            },
-            function (next) {
-
-                internals.executeDeps(experiment.afters, next);
-            }
-        ],
-        function (err, results) {
-
-            failures += results.failures;
-            if (err) {
-                failures++;
-            }
+    emitter.emit('start');
 
-            nextExperiment();
-        });
-    },
-    function (err) {
+    internals.executeExperiment(Lab.root, emitter, options.ids, function (err, failures) {
 
         var leaks = null;
         if (argv.G) {
@@ -232,8 +209,61 @@ internals.executeDeps = function (deps, callback) {
     });
 };
 
+internals.executeExperiment = function (experiment, emitter, ids, callback) {
+
+    var failures = 0;
+
+    if (experiment.parent) {
+        emitter.emit('startExperiment', experiment);
+    }
+
+    Async.series([
+        function (next) {
+
+            internals.executeDeps(experiment.befores, next);
+        },
+        function (next) {
+
+            internals.executeTests(experiment.tests, emitter, ids, next);
+        },
+        function (next) {
+
+            internals.executeExperiments(experiment.experiments, emitter, ids, next);
+        },
+        function (next) {
+
+            internals.executeDeps(experiment.afters, next);
+        }
+    ], function (err, results) {
+
+        failures += results[1] + results[2];
+        if (err) {
+            failures++;
+        }
+
+        if (experiment.parent) {
+            emitter.emit('endExperiment', experiment);
+        }
+        callback(err, failures);
+    });
+}
+
+internals.executeExperiments = function (experiments, emitter, ids, callback) {
+
+    var failures = 0;
+
+    Async.forEachSeries(experiments || [], function (experiment, nextExperiment) {
+        internals.executeExperiment(experiment, emitter, ids, function(err, experimentFailures) {
+            failures += experimentFailures;
+            nextExperiment();
+        });
+    },
+    function (err) {
+        callback(err, failures);
+    });
+};
 
-internals.executeTests = function (experiment, emitter, ids, callback) {
+internals.executeTests = function (tests, emitter, ids, callback) {
 
     var failures = 0;
 
@@ -257,7 +287,7 @@ internals.executeTests = function (experiment, emitter, ids, callback) {
         });
     }
 
-    Async.forEachSeries(experiment.tests || [], function (test, nextTest) {
+    Async.forEachSeries(tests || [], function (test, nextTest) {
 
         if (ids.length &&
             ids.indexOf(test.id) === -1) {
@@ -268,15 +298,15 @@ internals.executeTests = function (experiment, emitter, ids, callback) {
         Async.series([
             function (next) {
 
-                internals.executeDeps(experiment.beforeEaches, next);
+                internals.executeDeps(test.parent.beforeEaches, next); // query: should do ancestors not just parent
             },
             function (next) {
 
                 runTest(test, next);
             },
             function (next) {
 
-                internals.executeDeps(experiment.afterEaches, next);
+                internals.executeDeps(test.parent.afterEaches, next); // query: should do ancestors not just parent
             }
         ], function (err, results) {
 

lib/index.js

@@ -24,27 +24,38 @@ var internals = {};
     });
  */
 
+exports.root = {}; // root wraps any top level elements
+exports.experiments = [exports.root]; // preserve for backwards compatibility - deprecated
+exports.index = {};
 
 internals.id = 0;
-internals.current = {};
+internals.current = exports.root;
 internals.titles = [];
 
-exports.experiments = [internals.current];
-exports.index = {};
 
 Chai.config.includeStack = true;                                     // Show the stack where where the issue occurs
 
 
 exports.experiment = exports.describe = function (title, fn) {
 
-    var prev = internals.current;
+    var experiment = {
+        parent: internals.current,
+        path: internals.titles.join('/'),
+        title: internals.titles.join(' ') + ' ' + title,
+        relativeTitle: title
+    };
 
-    internals.current = {};
-    exports.experiments.push(internals.current);
+    internals.current.experiments = internals.current.experiments || [];
+    internals.current.experiments.push(experiment);
+    exports.experiments.push(experiment);
+
+    var prev = internals.current;
+    internals.current = experiment;
 
     internals.titles.push(title);
     fn();
     internals.titles.pop();
+
     internals.current = prev;
 };
 
@@ -55,7 +66,7 @@ exports.before = function (fn) {
         title: 'Before ' + internals.titles.join(' '),
         fn: fn
     };
-    
+
     internals.current.befores = internals.current.befores || [];
     internals.current.befores.push(before);
 };
@@ -100,6 +111,7 @@ exports.afterEach = function (fn) {
 exports.test = exports.it = function (title, fn) {
 
     var test = {
+        parent: internals.current,
         id: ++internals.id,
         path: internals.titles.join('/'),
         title: internals.titles.join(' ') + ' ' + title,
@@ -109,7 +121,7 @@ exports.test = exports.it = function (title, fn) {
 
     internals.current.tests = internals.current.tests || [];
     internals.current.tests.push(test);
-    
+
     exports.index[test.id] = test;
 };