Initial commit

Author: sandcastle

.gitignore

@@ -1 +1,2 @@
-node_modules/
+node_modules/
+test/ouput/

.npmignore

@@ -0,0 +1,2 @@
+test/
+.travis.yml

.travis.yml

@@ -0,0 +1,9 @@
+language: node_js
+node_js:
+    - "iojs"
+    - "0.12"
+    - "0.11"
+    - "0.10"
+matrix:
+  fast_finish: true
+sudo: false

README.md

@@ -1,2 +1,47 @@
-# mocha-circleci-reporter
-A mocha reporter that supports Circle CI, via a combined jUnit and Spec reporter output.
+# mocha-circleci-reporter [![Build Status](https://travis-ci.org/sandcastle/mocha-circleci-reporter.svg)](https://travis-ci.org/sandcastle/mocha-circleci-reporter)
+
+> A Mocha reporter specifically for [Circle CI](https://circleci.com/).
+
+
+## Getting Started
+
+Install the reporter as a development dependency:
+
+```sh
+npm install mocha --save-dev
+npm install mocha-circleci-reporter --save-dev
+```
+
+Update your `package.json` to use the reporter when running Mocha: 
+
+```json
+{
+  "name": "my-package",
+  "version": "0.0.1",
+  "scripts": {
+    "test": "node_modules/.bin/mocha --reporter mocha-circleci-reporter test/*.js"
+  }
+}
+```
+
+
+## Background
+
+### Why another reporter?
+
+As of Mocha 2.x, its not possible to use multple reporters out of the box.
+This complicates things when dealing with CI systems like Circle CI that 
+require a format such as [jUnit XML](https://windyroad.com.au/dl/Open%20Source/JUnit.xsd)
+as a lot of the goodness that is written to console when running the default
+reporter (`Spec`). 
+
+To overcome this, the `mocha-circleci-reporter` report combines both the 
+builtin `Spec` and `mocha-junit-report` reporters.
+
+### Mocha 3.x
+
+There is work underway in Mocha 3.x to move to a plugin architecture that would
+make multiple reporters dead simple, until then I hope this simplifies things.
+
+https://github.com/mochajs/mocha/issues/1457
+

index.js

@@ -0,0 +1,12 @@
+'use-strict';
+
+var Spec = require('mocha').reporters.Spec;
+var JUnit = require('mocha-junit-reporter');
+
+
+function MochaCircleCIReporter(runner, options) {
+  new Spec(runner, options);
+  new JUnit(runner, options);
+}
+
+module.exports = MochaCircleCIReporter;

package.json

@@ -4,7 +4,7 @@
   "description": "A mocha reporter that supports Cicle CI, via a combined jUnit and Spec reporter output.",
   "main": "index.js",
   "scripts": {
-    "test": "mocha --harmony test/**/*.js"
+    "test": "node_modules/.bin/mocha --harmony test/index.js"
   },
   "repository": {
     "type": "git",
@@ -28,6 +28,10 @@
   "homepage": "https://github.com/sandcastle/mocha-circleci-reporter#readme",
   "devDependencies": {
     "assert": "^1.3.0",
-    "mocha": "^2.2.5"
+    "test-console": "^1.0.0"
+  },
+  "dependencies": {
+    "mocha": "^2.2.5",
+    "mocha-junit-reporter": "^1.6.1"
   }
 }

test/helpers/mock-runner.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var EventEmitter = require('events').EventEmitter;
+var util = require('util');
+
+// mock test runner
+function Runner() {
+  Runner.super_.call(this);
+}
+
+util.inherits(Runner, EventEmitter);
+
+Runner.prototype.start = function() {
+  this.emit('start');
+};
+
+Runner.prototype.end = function() {
+  this.emit('end');
+};
+
+Runner.prototype.startSuite = function(suite) {
+  this.emit('suite', suite);
+};
+
+Runner.prototype.pass = function(test) {
+  this.emit('pass', test);
+  this.endTest();
+};
+
+Runner.prototype.fail = function(test, reason) {
+  this.emit('fail', test, reason);
+  this.endTest();
+};
+
+Runner.prototype.endTest = function() {
+  this.emit('end test');
+};
+
+module.exports = Runner;

test/helpers/mock-test.js

@@ -0,0 +1,15 @@
+'use strict';
+
+function Test(fullTitle, title, duration) {
+  
+  this.title = title;
+  this.duration = duration;
+  
+  this.fullTitle = function() { 
+    return fullTitle; 
+  };
+  
+  this.slow = function() { };
+}
+
+module.exports = Test

test/index.js

@@ -0,0 +1,80 @@
+'use-strict';
+/* global describe, it, beforeEach */
+
+var Reporter = require('../index');
+var Runner = require('./helpers/mock-runner');
+var Test = require('./helpers/mock-test');
+var testConsole = require('test-console');
+var assert = require('assert');
+var fs = require('fs');
+
+
+describe('mocha-circleci-reporter', function() {
+    
+    var runner;
+    
+    beforeEach(function() {
+        runner = new Runner();
+    });
+    
+    it('should output spec to stdout', function() {
+        
+        new Reporter(runner, {
+          reporterOptions: { mochaFile: 'test/output/console.xml' }
+        });
+        
+        var stdout = testConsole.stdout.inspect();
+        try{
+          executeTestRunner();
+        }
+        finally{            
+          stdout.restore();
+        }
+        
+        assert(stdout.output[1], '\u001b[0mFoo Bar module\u001b[0m\n');
+    });
+    
+    it('should output junit file', function() {
+        
+        new Reporter(runner, {
+          reporterOptions: { mochaFile: 'test/output/console.xml' }
+        });
+        
+        var stdout = testConsole.stdout.inspect();
+        try{
+          executeTestRunner();
+          
+          var file = './test/output/console.xml';
+          assert(fs.existsSync(file));
+          fs.unlinkSync(file);
+        }
+        finally{            
+          stdout.restore();
+        }
+    });
+    
+    function executeTestRunner(char){
+        
+        char = char || '';
+        runner.start();
+
+        runner.startSuite({
+          title: 'Foo Bar module',
+          tests: [1, 2]
+        });
+        
+        runner.pass(new Test('Foo can weez the juice', 'can weez the juice', 1));
+        runner.fail(new Test('Bar can narfle the garthog', 'can narfle the garthog', 1), {
+          message: char + 'expected garthog to be dead' + char
+        });
+    
+        runner.startSuite({
+          title: 'Another suite!',
+          tests: [1]
+        });
+        runner.pass(new Test('Another suite', 'works', 4));
+    
+        runner.end();
+    }
+        
+});