Merge remote-tracking branch 'origin/custom-reporters'

Author: brian-mann

lib/cli.coffee

@@ -8,16 +8,17 @@ pkg       = require("../package.json")
 updater({pkg: pkg, updateCheckInterval: human("one hour")}).notify()
 
 parseOpts = (opts) ->
-  _.pick(opts, "spec", "reporter", "path", "destination", "port", "env", "cypressVersion", "config")
+  _.pick(opts, "spec", "reporter", "reporterOptions", "path", "destination", "port", "env", "cypressVersion", "config")
 
 descriptions = {
-  destination: "destination path to extract and install Cypress to"
-  spec:        "runs a specific spec file. defaults to 'all'"
-  reporter:    "runs a specific mocha reporter. pass a path to use a custom reporter. defaults to 'spec'"
-  port:        "runs Cypress on a specific port. overrides any value in cypress.json. defaults to '2020'"
-  env:         "sets environment variables. separate multiple values with a comma. overrides any value in cypress.json or cypress.env.json"
-  config:      "sets configuration values. separate multiple values with a comma. overrides any value in cypress.json."
-  version:     "installs a specific version of Cypress"
+  destination:     "destination path to extract and install Cypress to"
+  spec:            "runs a specific spec file. defaults to 'all'"
+  reporter:        "runs a specific mocha reporter. pass a path to use a custom reporter. defaults to 'spec'"
+  reporterOptions: "options for the mocha reporter. defaults to 'null'"
+  port:            "runs Cypress on a specific port. overrides any value in cypress.json. defaults to '2020'"
+  env:             "sets environment variables. separate multiple values with a comma. overrides any value in cypress.json or cypress.env.json"
+  config:          "sets configuration values. separate multiple values with a comma. overrides any value in cypress.json."
+  version:         "installs a specific version of Cypress"
 }
 
 text = (d) ->
@@ -57,23 +58,25 @@ module.exports = ->
     .command("run [project]")
     .usage("[project] [options]")
     .description("Runs Cypress Tests Headlessly")
-    .option("-s, --spec <spec>",         text("spec"))
-    .option("-r, --reporter <reporter>", text("reporter"))
-    .option("-p, --port <port>",         text("port"))
-    .option("-e, --env <env>",           text("env"))
-    .option("-c, --config <config>",     text("config"))
+    .option("-s, --spec <spec>",                         text("spec"))
+    .option("-r, --reporter <reporter>",                 text("reporter"))
+    .option("-o, --reporter-options <reporter-options>", text("reporterOptions"))
+    .option("-p, --port <port>",                         text("port"))
+    .option("-e, --env <env>",                           text("env"))
+    .option("-c, --config <config>",                     text("config"))
     .action (project, opts) ->
       require("./commands/run")(project, parseOpts(opts))
 
   program
     .command("ci [key]")
     .usage("[key] [options]")
     .description("Runs Cypress in CI Mode")
-    .option("-s, --spec <spec>",         text("spec"))
-    .option("-r, --reporter <reporter>", text("reporter"))
-    .option("-p, --port <port>",         text("port"))
-    .option("-e, --env <env vars>",      text("env"))
-    .option("-c, --config <config>",     text("config"))
+    .option("-s, --spec <spec>",                         text("spec"))
+    .option("-r, --reporter <reporter>",                 text("reporter"))
+    .option("-o, --reporter-options <reporter-options>", text("reporterOptions"))
+    .option("-p, --port <port>",                         text("port"))
+    .option("-e, --env <env vars>",                      text("env"))
+    .option("-c, --config <config>",                     text("config"))
     .action (key, opts) ->
       require("./commands/ci")(key, parseOpts(opts))
 
@@ -130,4 +133,4 @@ module.exports = ->
     ## then display the help
     program.help()
 
-  return program
+  return program

lib/commands/run.coffee

@@ -8,10 +8,11 @@ class Run
       return new Run(project, options)
 
     _.defaults options,
-      key:      null
-      spec:     null
-      reporter: null
-      project:  path.resolve(process.cwd(), project)
+      key:             null
+      spec:            null
+      reporter:        null
+      reporterOptions: null
+      project:         path.resolve(process.cwd(), project)
 
     @run(options)
 
@@ -36,11 +37,15 @@ class Run
     if options.reporter
       args.push("--reporter", options.reporter)
 
+    ## if we have a specific reporter push that into the args
+    if options.reporterOptions
+      args.push("--reporter-options", options.reporterOptions)
+
     ## if we have a key assume we're in CI mode
     if options.key
       args.push("--ci", "--key", options.key)
       opts.xvfb = true
 
     utils.spawn(args, opts)
 
-module.exports = Run
+module.exports = Run

readme.md

@@ -96,6 +96,11 @@ cypress run --port 8080
 cypress run --reporter json
 ```
 
+```bash
+## specify options for the mocha reporter
+cypress run --reporter-options mochaFile=result.xml,toConsole=true
+```
+
 ```bash
 ## specify a spec to run instead of running all the tests
 cypress run --spec cypress/integration/app_spec.js

test/commands/ci_spec.coffee

@@ -17,6 +17,10 @@ describe "Ci", ->
       @parse("ci abc123 --reporter junit")
       expect(@spy).to.be.calledWith("abc123", {reporter: "junit"})
 
+    it "calls ci with reporter options", ->
+      @parse("ci abc123 --reporter-options mochaFile=result.xml")
+      expect(@spy).to.be.calledWith("abc123", {reporterOptions: "mochaFile=result.xml"})
+
     it "calls with no key", ->
       @parse("ci")
       expect(@spy).to.be.calledWith(undefined)
@@ -144,4 +148,4 @@ describe "Ci", ->
       expect(@log).to.be.calledWith("Please provide us your project's secret key and then rerun.")
 
     it "logs the env key we checked for", ->
-      expect(@log).to.be.calledWithMatch(/\w+/, "CYPRESS_CI_KEY")
+      expect(@log).to.be.calledWithMatch(/\w+/, "CYPRESS_CI_KEY")