Merge pull request #17 from bguiz/karma-reporter-dynamic

Karma reporter dynamic

Author: bholloway

lib/test/karma.js

@@ -7,6 +7,8 @@ var gulp            = require('gulp'),
     querystring     = require('querystring'),
     childProcess    = require('child_process');
 
+var yargs           = require('../util/yargs');
+
 /**
  * Wrap the given value in quotation marks
  * @param {*} value The value to wrap
@@ -16,7 +18,73 @@ function quote(value) {
   return '"' + value + '"';
 }
 
+var defaultReporterName = 'angularity-karma-reporter';
+
 var filesAppendRegex = /\/\*+\s*ANGULARITY_FILE_LIST\s*\*+\// ;
+var reportersAppendRegex = /\/\*+\s*ANGULARITY_REPORTER_LIST\s*\*+\// ;
+var pluginsAppendRegex = /\/\*+\s*ANGULARITY_PLUGIN_LIST\s*\*+\// ;
+var karmaReporterMatchNameRegex = /^karma-(.+)-reporter$/ ;
+
+/**
+ * Determine the `require` path for a plugin.
+ *
+ * @param {string} reporterName Either a package name,
+ *   *OR* an absolute path, for a karma reporter.
+ * @return {string} In karma config file, `plugins` will be inline `require`d
+ *   using this return value.
+ */
+function getKarmaReporterPluginPath(reporterName) {
+  if (typeof reporterName !== 'string') {
+    throw 'Get Karma Reporter Plugin Path: Reporter name is unspecified';
+  }
+
+  if (reporterName === defaultReporterName) {
+    return defaultReporterName;
+  }
+  else {
+    var reporterPath = (path.dirname(reporterName) === '.') ?
+      path.resolve('node_modules', 'karma-' + reporterName + '-reporter') :
+      reporterName;
+    try {
+      require(reporterPath);
+    }
+    catch (ex) {
+      throw 'Get Karma Reporter Plugin Path: Attempt to require reporter from path ' +
+        reporterPath + ' with no success.';
+    }
+    reporterPath = path.normalize(reporterPath);
+    //quirk: nodejs identifies all windows (both win32 and win64) as win32
+    if (process.platform === 'win32') {
+      //replace any single backslash characters in file paths with
+      //double backslash on windows; neither path.normalize nor path.resolve do this
+      reporterPath = reporterPath.replace( /\\/g , '\\\\' );
+    }
+    return reporterPath;
+  }
+}
+
+/**
+ * Determine the registered reporter name.
+ *
+ * @param {string} reporterName Either the registered reporter name,
+ *   *OR* an absolute path, for a karma reporter.
+ * @return {string} The registered reporter name for use in
+ *   the `reporters` section of the karma config file.
+ */
+function getKarmaReporterName(reporterName) {
+  if (typeof reporterName !== 'string') {
+    throw 'Get Karma Reporter Name: Reporter name is unspecified';
+  }
+
+  var name = (path.dirname(reporterName) === '.') ?
+    reporterName :
+    path.basename(reporterName);
+  var match = karmaReporterMatchNameRegex.exec(name);
+  if (!!match && match.length === 2) {
+    name = match[1];
+  }
+  return name
+}
 
 /**
  * Create a through2 object stream.
@@ -27,13 +95,15 @@ var filesAppendRegex = /\/\*+\s*ANGULARITY_FILE_LIST\s*\*+\// ;
  * The new karma config file is added to the stream,
  * All input `*.js` files are filtered out of the stream
  *
- * @param {string} configFileName The project local karma config file to augment
+ * @param {Array.<string>} [reporters] The name of the karma reporter to use
+ * @param {string} [configFileName] The project local karma config file to augment
  *   Defaults to "karma.conf.js"
  * @return {stream.Through} The output of this stream is expected to contain
  *   just one file: the augmented karma config file.
  */
-function karmaCreateConfig(configFileName) {
-  configFileName = 'karma.conf.js';
+function karmaCreateConfig(reporters, configFileName) {
+  reporters = reporters || [];
+  configFileName = configFileName || 'karma.conf.js';
   var files = [];
 
   function transformFn(file, encoding, done) {
@@ -47,13 +117,20 @@ function karmaCreateConfig(configFileName) {
   function flushFn(done) {
     var stream = this;
     var filesAppend = JSON.stringify(files, null, '  ');
+    var reportersAppend = JSON.stringify(reporters.map(getKarmaReporterName), null, '  ');
+    var pluginsAppend = '[\n' + reporters.map(function(reporter) {
+      return 'require("' + getKarmaReporterPluginPath(reporter) + '")';
+    }).join(',\n  ') + '\n]';
 
     //aggregate and append to karma.conf.js in the project root folder
     gulp
       .src(path.resolve(configFileName))
       .on('data', function(karmaConfigFile) {
-        var contents = karmaConfigFile.contents.toString();
-        contents = contents.replace(filesAppendRegex, filesAppend);
+        var contents = karmaConfigFile.contents.toString()
+          .replace(filesAppendRegex, filesAppend)
+          .replace(reportersAppendRegex, reportersAppend)
+          .replace(reportersAppendRegex, reportersAppend)
+          .replace(pluginsAppendRegex, pluginsAppend);
         karmaConfigFile.contents = new Buffer(contents);
         stream.push(karmaConfigFile);
       })
@@ -70,13 +147,15 @@ function karmaCreateConfig(configFileName) {
  * No output. Ends when the Karma process ends.
  * Runs karma in a child process, to avoid `process.exit()` called by karma.
  *
+ * @param {Array.<string>} [reporters] The name of the karma reporter to use
  * @param {number} [bannerWidth] The width of banner comment, zero or omitted for none
  * @returns {stream.Through} A through strconcateam that performs the operation of a gulp stream
  */
-function karmaRun(bannerWidth) {
+function karmaRun(reporters, bannerWidth) {
   var options = {
     configFile: undefined
   };
+  reporters = reporters || [];
 
   return through.obj(function transformFn(file, encoding, done) {
     options.configFile = file.path;
@@ -87,23 +166,32 @@ function karmaRun(bannerWidth) {
     var data    = querystring.escape(JSON.stringify(options));
     var command = [ 'node', quote(appPath), data ].join(' ');
 
-    //TODO @bguiz replace reporter function with a standard karma reporter,
-    //and extract it to own module
-    //perhaps extend the spec reporter to do what is being done here, instead of post processing its output here
-    //check if there is a webstorm/ teamcity reporter
     childProcess.exec(command, { cwd: process.cwd() }, function reporter(stderr, stdout) {
+      if (reporters.length > 0) {
+        if (stdout) {
+          process.stdout.write(stdout);
+        }
+        if (stderr) {
+          process.stderr.write(stderr);
+        }
+        done();
+        return;
+      }
+
+      //TODO @bguiz replace reporter function with a standard karma reporter,
+      //and extract it to own module
+
+      //default reporter by parsing the stdout and stderr of karma
       var report;
       if (stdout) {
-        console.log(stdout);
         report = stdout
           .replace(/^\s+/gm, '')                                  // remove leading whitespace
           .replace(/^(LOG.*\n$)/gm, options.silent ? '' : '$1')   // remove logging
           .replace(/at\s+null\..*/gm, '')                         // remove file reference
           .replace(/\n\n/gm, '\n')                                // consolidate consecutive line breaks
           .replace(/^\n|\n$/g, '');                               // remove leading and trailing line breaks overall
-      } else if (stderr) {
-        console.log(stderr);
-
+      }
+      else if (stderr) {
         var analysis = /$Error\:\s*(.*)$/mg.exec(stderr);
         report = analysis ? analysis[1] : stderr;
       }
@@ -119,7 +207,37 @@ function karmaRun(bannerWidth) {
   });
 };
 
+var yargsOptionDefiniton = {
+  key: 'karmareporter',
+  value: {
+    describe: 'Specify a custom Karma reporter to use. ' +
+      'Either a locally npm installed module, or an asolute path to one.',
+    alias: ['k'],
+    default: defaultReporterName,
+    string:true,
+  }
+};
+var checkKarmaReporter = yargs.createCheck()
+  .withGate(function (argv) {
+    return !argv.help;
+  })
+  .withTest({
+    karmareporter: function(value) {
+      if (typeof value !== 'undefined') {
+        try {
+          getKarmaReporterPluginPath(value);
+        }
+        catch (ex) {
+          return 'Illegal value for "reporter"\n' + ex;
+        }
+      }
+    },
+  })
+  .commit();
+
 module.exports = {
   createConfig: karmaCreateConfig,
-  run: karmaRun
+  run: karmaRun,
+  yargsCheck: checkKarmaReporter,
+  yargsOption: yargsOptionDefiniton,
 };

lib/util/jshint-reporter.js

@@ -7,16 +7,6 @@ var gulpJshint = require('gulp-jshint');
 var yargs = require('./yargs');
 
 var defaultReporterName = 'angularity-jshint-reporter';
-var yargsOptionDefiniton = {
-  key: 'reporter',
-  value: {
-    describe: 'Specify a custom JsHint reporter to use. '+
-      'Either a locally npm installed module, or an asolute path to one.',
-    alias: ['r'],
-    default: defaultReporterName,
-    string:true,
-  }
-};
 
 /**
  * Dynamically load a JsHint reporter
@@ -35,7 +25,7 @@ var yargsOptionDefiniton = {
 var jsHintReporter;
 function getJsHintReporter(reporterName) {
   if (typeof reporterName !== 'string') {
-    throw 'Reporter name is unspecified';
+    throw 'Get JsHint Reporter: Reporter name is unspecified';
   }
   if (jsHintReporter) {
     return jsHintReporter; //cached copy
@@ -64,6 +54,16 @@ function getJsHintReporter(reporterName) {
   return jsHintReporter;
 }
 
+var yargsOptionDefiniton = {
+  key: 'reporter',
+  value: {
+    describe: 'Specify a custom JsHint reporter to use. '+
+      'Either a locally npm installed module, or an asolute path to one.',
+    alias: ['r'],
+    default: defaultReporterName,
+    string: true,
+  }
+};
 var checkJsHintReporter = yargs.createCheck()
   .withGate(function (argv) {
     return !argv.help;

tasks/javascript.js

@@ -64,9 +64,11 @@ yargs.getInstance('test')
     boolean : true
   })
   .options(jshintReporter.yargsOption.key, jshintReporter.yargsOption.value)
+  .options(karma.yargsOption.key, karma.yargsOption.value)
   .strict()
   .check(yargs.subCommandCheck)
   .check(jshintReporter.yargsCheck)
+  .check(karma.yargsCheck)
   .wrap(80);
 
 gulp.task('javascript', function (done) {
@@ -113,6 +115,17 @@ gulp.task('javascript:lint', function () {
 
 // karma unit tests in local library only
 gulp.task('javascript:unit', function () {
+  var reporters = cliArgs.karmareporter;
+  if (reporters.constructor === Array) {
+    reporters = Array;
+  }
+  else if (typeof reporters === 'string' &&
+    reporters !== karma.yargsOption.value.default) {
+    reporters = [reporters];
+  }
+  else {
+    reporters = [];
+  }
   return combined.create()
     .append(
       streams
@@ -130,9 +143,9 @@ gulp.task('javascript:unit', function () {
         .pipe(gulp.dest(streams.TEST))
         .pipe(gulpFilter('*.js'))
     )
-    .pipe(karma.createConfig())
+    .pipe(karma.createConfig(reporters))
     .pipe(gulp.dest(streams.TEST))
-    .pipe(karma.run(80));
+    .pipe(karma.run(reporters, 80));
 });
 
 // give a single optimised javascript file in the build directory with source map for each

templates/angularity/karma.conf.js

@@ -19,9 +19,14 @@ module.exports = function(config) {
     // list of files to exclude
     exclude: [],
 
+    // register any plugins which are not siblings of karma in angularity global
+    // installation and thus need to be registered manually
+    // append to existing value to preserve plugins loaded automatically
+    plugins: [].concat(config.plugins, /*ANGULARITY_PLUGIN_LIST*/),
+
     // use dots reporter, as travis terminal does not support escaping sequences
     // possible values: 'dots', 'progress', 'junit', 'teamcity'
-    reporter: [],
+    reporters: [].concat(/*ANGULARITY_REPORTER_LIST*/),
 
     // web server port
     port: <%= port %>,