Feature adding no colors to run command

lib/cli.js

@@ -185,6 +185,9 @@ var describeRun = function () {
     .describe('fail-on-empty-test-suite', 'Fail on empty test suite.')
     .describe('no-fail-on-empty-test-suite', 'Do not fail on empty test suite.')
     .describe('help', 'Print usage.')
+    .describe('log-level', '<disable | error | warn | info | debug> Level of logging.')
+    .describe('colors', 'Use colors when reporting and printing logs.')
+    .describe('no-colors', 'Do not use colors when reporting or printing logs.')
 }
 
 var describeCompletion = function () {

lib/init.js

@@ -6,7 +6,6 @@ var exec = require('child_process').exec
 
 var helper = require('./helper')
 var logger = require('./logger')
-var constant = require('./constants')
 
 var log = logger.create('init')
 
@@ -211,21 +210,13 @@ var processAnswers = function (answers, basePath, testMainFile) {
 }
 
 exports.init = function (config) {
-  var useColors = true
-  var logLevel = constant.LOG_INFO
+  logger.setupFromConfig(config)
+
   var colorScheme = COLOR_SCHEME.ON
 
   if (helper.isDefined(config.colors)) {
     colorScheme = config.colors ? COLOR_SCHEME.ON : COLOR_SCHEME.OFF
-    useColors = config.colors
-  }
-
-  if (helper.isDefined(config.logLevel)) {
-    logLevel = config.logLevel
   }
-
-  logger.setup(logLevel, useColors)
-
   // need to be registered before creating readlineInterface
   process.stdin.on('keypress', function (s, key) {
     sm.onKeypress(key)

lib/logger.js

@@ -43,6 +43,29 @@ var setup = function (level, colors, appenders) {
   })
 }
 
+// Setup the logger by passing in the config object. The function sets the
+// `colors` and `logLevel` if they are defined. It takes two arguments:
+//
+//     setupFromConfig(config, appenders)
+//
+// * `config`: *Object* The configuration object.
+// * `appenders`: *Array* This will be passed as appenders to log4js
+//   to allow for fine grained configuration of log4js. For more information
+//   see https://github.com/nomiddlename/log4js-node.
+var setupFromConfig = function (config, appenders) {
+  var useColors = true
+  var logLevel = constant.LOG_INFO
+
+  if (helper.isDefined(config.colors)) {
+    useColors = config.colors
+  }
+
+  if (helper.isDefined(config.logLevel)) {
+    logLevel = config.logLevel
+  }
+  setup(logLevel, useColors, appenders)
+}
+
 // Create a new logger. There are two optional arguments
 // * `name`, which defaults to `karma` and
 //   If the `name = 'socket.io'` this will create a special wrapper
@@ -60,3 +83,4 @@ var create = function (name, level) {
 
 exports.create = create
 exports.setup = setup
+exports.setupFromConfig = setupFromConfig

lib/middleware/runner.js

@@ -33,9 +33,10 @@ var createRunnerMiddleware = function (emitter, fileList, capturedBrowsers, repo
         response.write('Waiting for previous execution...\n')
       }
 
+      var data = request.body
       emitter.once('run_start', function () {
         var responseWrite = response.write.bind(response)
-
+        responseWrite.colors = data.colors
         reporter.addAdapter(responseWrite)
 
         // clean up, close runner response
@@ -46,7 +47,6 @@ var createRunnerMiddleware = function (emitter, fileList, capturedBrowsers, repo
         })
       })
 
-      var data = request.body
       log.debug('Setting client.args to ', data.args)
       config.client.args = data.args
 

lib/reporter.js

@@ -91,8 +91,10 @@ var createReporters = function (names, config, emitter, injector) {
   // TODO(vojta): instantiate all reporters through DI
   names.forEach(function (name) {
     if (['dots', 'progress'].indexOf(name) !== -1) {
-      var Cls = require('./reporters/' + name + (config.colors ? '_color' : ''))
-      return reporters.push(new Cls(errorFormatter, config.reportSlowerThan))
+      var Cls = require('./reporters/' + name)
+      var ClsColor = require('./reporters/' + name + '_color')
+      reporters.push(new Cls(errorFormatter, config.reportSlowerThan, config.colors))
+      return reporters.push(new ClsColor(errorFormatter, config.reportSlowerThan, config.colors))
     }
 
     var locals = {

lib/reporters/base.js

@@ -2,7 +2,7 @@ var util = require('util')
 
 var helper = require('../helper')
 
-var BaseReporter = function (formatError, reportSlow, adapter) {
+var BaseReporter = function (formatError, reportSlow, useColors, adapter) {
   this.adapters = [adapter || process.stdout.write.bind(process.stdout)]
 
   this.onRunStart = function () {
@@ -46,9 +46,15 @@ var BaseReporter = function (formatError, reportSlow, adapter) {
 
   this.write = function () {
     var msg = util.format.apply(null, Array.prototype.slice.call(arguments))
-
+    var self = this
     this.adapters.forEach(function (adapter) {
-      adapter(msg)
+      if (!helper.isDefined(adapter.colors)) {
+        adapter.colors = useColors
+      }
+
+      if (adapter.colors === self.USE_COLORS) {
+        return adapter(msg)
+      }
     })
   }
 
@@ -136,7 +142,7 @@ BaseReporter.decoratorFactory = function (formatError, reportSlow) {
   }
 }
 
-BaseReporter.decoratorFactory.$inject = ['formatError', 'config.reportSlowerThan']
+BaseReporter.decoratorFactory.$inject = ['formatError', 'config.reportSlowerThan', 'config.colors']
 
 // PUBLISH
 module.exports = BaseReporter

lib/reporters/dots.js

@@ -1,7 +1,7 @@
 var BaseReporter = require('./base')
 
-var DotsReporter = function (formatError, reportSlow) {
-  BaseReporter.call(this, formatError, reportSlow)
+var DotsReporter = function (formatError, reportSlow, useColors) {
+  BaseReporter.call(this, formatError, reportSlow, useColors)
 
   var DOTS_WRAP = 80
 

lib/reporters/dots_color.js

@@ -1,8 +1,8 @@
 var DotsReporter = require('./dots')
 var BaseColorReporter = require('./base_color')
 
-var DotsColorReporter = function (formatError, reportSlow) {
-  DotsReporter.call(this, formatError, reportSlow)
+var DotsColorReporter = function (formatError, reportSlow, useColors) {
+  DotsReporter.call(this, formatError, reportSlow, useColors)
   BaseColorReporter.call(this)
 }
 

lib/reporters/progress.js

@@ -1,7 +1,7 @@
 var BaseReporter = require('./base')
 
-var ProgressReporter = function (formatError, reportSlow) {
-  BaseReporter.call(this, formatError, reportSlow)
+var ProgressReporter = function (formatError, reportSlow, useColors) {
+  BaseReporter.call(this, formatError, reportSlow, useColors)
 
   this.writeCommonMsg = function (msg) {
     this.write(this._remove() + msg + this._render())

lib/reporters/progress_color.js

@@ -1,8 +1,8 @@
 var ProgressReporter = require('./progress')
 var BaseColorReporter = require('./base_color')
 
-var ProgressColorReporter = function (formatError, reportSlow) {
-  ProgressReporter.call(this, formatError, reportSlow)
+var ProgressColorReporter = function (formatError, reportSlow, useColors) {
+  ProgressReporter.call(this, formatError, reportSlow, useColors)
   BaseColorReporter.call(this)
 }
 

lib/runner.js

@@ -32,6 +32,8 @@ var parseExitCode = function (buffer, defaultCode, failOnEmptyTestSuite) {
 
 // TODO(vojta): read config file (port, host, urlRoot)
 exports.run = function (config, done) {
+  logger.setupFromConfig(config)
+
   done = helper.isFunction(done) ? done : process.exit
   config = cfg.parseConfig(config.configFile, config)
 
@@ -71,6 +73,7 @@ exports.run = function (config, done) {
     removedFiles: config.removedFiles,
     changedFiles: config.changedFiles,
     addedFiles: config.addedFiles,
-    refresh: config.refresh
+    refresh: config.refresh,
+    colors: config.colors
   }))
 }

lib/server.js

@@ -39,17 +39,11 @@ function createSocketIoServer (webServer, executor, config) {
   return server
 }
 
-function setupLogger (level, colors) {
-  var logLevel = logLevel || constant.LOG_INFO
-  var logColors = helper.isDefined(colors) ? colors : true
-  logger.setup(logLevel, logColors, [constant.CONSOLE_APPENDER])
-}
-
 // Constructor
 var Server = function (cliOptions, done) {
   EventEmitter.call(this)
 
-  setupLogger(cliOptions.logLevel, cliOptions.colors)
+  logger.setupFromConfig(cliOptions)
 
   this.log = logger.create()
 

test/unit/reporters/base.spec.js

@@ -16,7 +16,7 @@ describe('reporter', function () {
 
     beforeEach(function () {
       adapter = sinon.spy()
-      reporter = new m.BaseReporter(null, null, adapter)
+      reporter = new m.BaseReporter(null, null, false, adapter)
       return reporter
     })
 
@@ -29,6 +29,34 @@ describe('reporter', function () {
       return expect(anotherAdapter).to.have.been.calledWith('some')
     })
 
+    it('should omit adapters not using the right color', function () {
+      var anotherAdapter = sinon.spy()
+      anotherAdapter.colors = true
+      reporter.adapters.push(anotherAdapter)
+      reporter.write('some')
+      expect(adapter).to.have.been.calledWith('some')
+      return expect(anotherAdapter).to.not.have.been.called
+    })
+
+    it('should not call non-colored adapters when wrong default setting', function () {
+      var reporter = new m.BaseReporter(null, null, true, adapter)
+      var anotherAdapter = sinon.spy()
+      reporter.adapters.push(anotherAdapter)
+      reporter.write('some')
+      expect(adapter).to.not.have.been.called
+      return expect(anotherAdapter).to.not.have.been.called
+    })
+
+    it('should call colored adapters regardless of default setting', function () {
+      var reporter = new m.BaseReporter(null, null, true, adapter)
+      var anotherAdapter = sinon.spy()
+      reporter.adapters.push(anotherAdapter)
+      adapter.colors = false
+      reporter.write('some')
+      expect(adapter).to.have.been.calledWith('some')
+      return expect(anotherAdapter).to.not.have.been.called
+    })
+
     it('should format', function () {
       reporter.write('Success: %d Failure: %d', 10, 20)