deprecate 'cypress ci', expand 'cypress run'

- allow ‘cypress run’ to verify + install if not installed
- no longer pass —ci args
- enable passing —no-record
- deprecate cypress ci message
- check for CYPRESS_RECORD_KEY env var
- refactor some of these horrendous class interfaces (why god why)

Author: brian-mann

lib/cli.coffee

@@ -8,7 +8,7 @@ pkg       = require("../package.json")
 updater({pkg: pkg, updateCheckInterval: human("one hour")}).notify()
 
 parseOpts = (opts) ->
-  _.pick(opts, "spec", "reporter", "reporterOptions", "path", "destination", "port", "env", "cypressVersion", "config")
+  _.pick(opts, "spec", "reporter", "reporterOptions", "path", "destination", "port", "env", "cypressVersion", "config", "noRecord")
 
 descriptions = {
   destination:     "destination path to extract and install Cypress to"
@@ -19,6 +19,7 @@ descriptions = {
   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"
+  noRecord:        "silences the console warning when you do not provide a record key"
 }
 
 text = (d) ->
@@ -45,32 +46,33 @@ module.exports = ->
     .option("-d, --destination <path>", text("destination"))
     .option("--cypress-version <version>", text("version"))
     .action (opts) ->
-      require("./commands/install")(parseOpts(opts))
+      require("./commands/install").start(parseOpts(opts))
 
   program
     .command("update")
     .description("Updates Cypress to the latest version")
     .option("-d, --destination <path>", text("destination"))
     .action (opts) ->
-      require("./commands/install")(parseOpts(opts))
+      require("./commands/install").start(parseOpts(opts))
 
   program
     .command("run [project]")
     .usage("[project] [options]")
-    .description("Runs Cypress Tests Headlessly")
+    .description("Runs Cypress Headlessly")
     .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"))
+    .option("--no-record",                               text("noRecord"))
     .action (project, opts) ->
-      require("./commands/run")(project, parseOpts(opts))
+      require("./commands/run").start(project, parseOpts(opts))
 
   program
     .command("ci [key]")
     .usage("[key] [options]")
-    .description("Runs Cypress in CI Mode")
+    .description("[DEPRECATED] Use 'cypress run --key <record_key>'")
     .option("-s, --spec <spec>",                         text("spec"))
     .option("-r, --reporter <reporter>",                 text("reporter"))
     .option("-o, --reporter-options <reporter-options>", text("reporterOptions"))

lib/commands/ci.coffee

@@ -1,10 +1,7 @@
 _       = require("lodash")
-path    = require("path")
-os      = require("os")
 chalk   = require("chalk")
+run     = require("./run")
 utils   = require("../utils")
-Run     = require("./run")
-Install = require("./install")
 
 class Ci
   constructor: (key, options = {}) ->
@@ -13,7 +10,7 @@ class Ci
 
     ## if we dont have a key assume
     ## its in an env variable
-    key ?= process.env.CYPRESS_CI_KEY
+    key ?= process.env.CYPRESS_RECORD_KEY or process.env.CYPRESS_CI_KEY
 
     return @_noKeyErr(options) if not key
 
@@ -28,28 +25,17 @@ class Ci
   _noKeyErr: (options) ->
     console.log("")
     console.log(chalk.bgRed.white(" -Error- "))
-    console.log(chalk.red.underline("Running Cypress in CI requires a secret project key."))
+    console.log(chalk.red.underline("Running Cypress in CI requires a Record Key."))
     console.log("")
     console.log("You did not pass a specific key to:", chalk.blue("cypress ci"))
     console.log("")
-    console.log("Since no key was passed, we checked for an environment\nvariable but none was found with the name:", chalk.blue("CYPRESS_CI_KEY"))
+    console.log("Since no key was passed, we checked for an environment\nvariable but none was found with the name:", chalk.blue("CYPRESS_RECORD_KEY"))
     console.log("")
-    console.log("You can receive your project's secret key by running\nthe terminal command:", chalk.blue("cypress get:key"))
-    console.log("")
-    console.log("Please provide us your project's secret key and then rerun.")
+    console.log("https://on.cypress.io/what-is-a-record-key")
+
     process.exit(1)
 
   initialize: (options) ->
-    run = ->
-      Run(null, options)
-
-    utils.verifyCypressExists()
-      .then(run)
-      .catch ->
-        console.log("")
-        console.log("Cypress was not found:", chalk.green("Installing a fresh copy."))
-        console.log("")
-
-        Install({after: run, displayOpen: false})
+    run.start(null, options)
 
-module.exports = Ci
+module.exports = Ci

lib/commands/install.coffee

@@ -19,13 +19,9 @@ fs = Promise.promisifyAll(fs)
 
 baseUrl = "https://download.cypress.io/"
 
-class Install
-  constructor: (options = {}) ->
-    if not (@ instanceof Install)
-      return new Install(options)
-
+module.exports = {
+  start: (options = {}) ->
     _.defaults options,
-      initialize:     true
       displayOpen:    true
       version:        null
       cypressVersion: null
@@ -39,18 +35,16 @@ class Install
       executable:     utils.getPathToUserExecutable()
       after:          ->
 
-    return if not options.initialize
-
     @initialize(options)
 
   initialize: (options) ->
     @download(options)
-      .bind(@)
-      .catch(@downloadErr)
-      .then(@unzip)
-      .catch(@unzipErr)
-      .then ->
-        @finish(options)
+    .bind(@)
+    .catch(@downloadErr)
+    .then(@unzip)
+    .catch(@unzipErr)
+    .then ->
+      @finish(options)
 
   downloadErr: (err) ->
     console.log("")
@@ -273,4 +267,4 @@ class Install
 
       options.after(options)
 
-module.exports = Install
+}

lib/commands/run.coffee

@@ -1,12 +1,49 @@
 _       = require("lodash")
 path    = require("path")
+chalk   = require("chalk")
+install = require("./install")
 utils   = require("../utils")
 
-class Run
-  constructor: (project = ".", options = {}) ->
-    if not (@ instanceof Run)
-      return new Run(project, options)
+run = (options) ->
+  opts = {}
+  args = ["--project", options.project]
 
+  ## if key is set use that - else attempt to find it by env var
+  options.key ?= process.env.CYPRESS_RECORD_KEY or process.env.CYPRESS_CI_KEY
+
+  if options.env
+    args.push("--env", options.env)
+
+  if options.config
+    args.push("--config", options.config)
+
+  if options.port
+    args.push("--port", options.port)
+
+  ## if we have a specific spec push that into the args
+  if options.spec
+    args.push("--spec", options.spec)
+
+  ## if we have a specific reporter push that into the args
+  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 options.noRecord
+    args.push("--no-record")
+
+  ## if we have a key assume we're in record mode
+  if options.key
+    args.push("--key", options.key)
+    opts.xvfb = true
+
+  utils.spawn(args, opts)
+
+module.exports = {
+  start: (project = ".", options = {}) ->
     _.defaults options,
       key:             null
       spec:            null
@@ -17,35 +54,19 @@ class Run
     @run(options)
 
   run: (options) ->
-    opts = {}
-    args = ["--run-project", options.project]
-
-    if options.env
-      args.push("--env", options.env)
-
-    if options.config
-      args.push("--config", options.config)
-
-    if options.port
-      args.push("--port", options.port)
-
-    ## if we have a specific spec push that into the args
-    if options.spec
-      args.push("--spec", options.spec)
-
-    ## if we have a specific reporter push that into the args
-    if options.reporter
-      args.push("--reporter", options.reporter)
+    after = ->
+      run(options)
 
-    ## if we have a specific reporter push that into the args
-    if options.reporterOptions
-      args.push("--reporter-options", options.reporterOptions)
+    utils.verifyCypressExists()
+    .then(after)
+    .catch ->
+      console.log("")
+      console.log("Cypress was not found:", chalk.green("Installing a fresh copy."))
+      console.log("")
 
-    ## if we have a key assume we're in CI mode
-    if options.key
-      args.push("--ci", "--key", options.key)
-      opts.xvfb = true
+      ## TODO: no reason after should be a callback function here
+      ## just use a promise
+      install.start({after: after, displayOpen: false})
 
-    utils.spawn(args, opts)
 
-module.exports = Run
+}

test/commands/ci_spec.coffee

@@ -61,12 +61,12 @@ describe "Ci", ->
         Ci(key, options).initialize(options)
 
     afterEach ->
-      delete process.env.CYPRESS_CI_KEY
+      delete process.env.CYPRESS_RECORD_KEY
 
-    it "spawns --run-project with --ci and --key and xvfb", ->
+    it "spawns --project with --ci and --key and xvfb", ->
       @setup("abc12345").then =>
         pathToProject = path.resolve(process.cwd(), ".")
-        expect(@spawn).to.be.calledWith(["--run-project", pathToProject, "--ci", "--key", "abc12345"], {xvfb: true})
+        expect(@spawn).to.be.calledWith(["--project", pathToProject, "--key", "abc12345"])
 
     it "can pass a specific reporter", ->
       @setup("foo", {reporter: "some/custom/reporter.js"}).then =>
@@ -80,8 +80,8 @@ describe "Ci", ->
         args = @spawn.getCall(0).args[0]
         expect(args).to.include("--port", "2500")
 
-    it "uses process.env.CYPRESS_CI_KEY when no key was passed", ->
-      process.env.CYPRESS_CI_KEY = "987-654-321"
+    it "uses process.env.CYPRESS_RECORD_KEY when no key was passed", ->
+      process.env.CYPRESS_RECORD_KEY = "987-654-321"
       @setup().then =>
         args = @spawn.getCall(0).args[0]
         expect(args).to.include("--key", "987-654-321")
@@ -94,45 +94,9 @@ describe "Ci", ->
     it "spawns with config", ->
       @setup("abc123", {config: "watchForFileChanges=false,baseUrl=localhost"}).then =>
         pathToProject = path.resolve(process.cwd(), ".")
-        expect(@spawn).to.be.calledWith(["--run-project", pathToProject, "--config", "watchForFileChanges=false,baseUrl=localhost", "--ci", "--key", "abc123"])
+        expect(@spawn).to.be.calledWith(["--project", pathToProject, "--config", "watchForFileChanges=false,baseUrl=localhost", "--key", "abc123"])
 
-  context "#initialize", ->
-    beforeEach ->
-      @Ci = proxyquire("../lib/commands/ci", {
-        "./run":     @Run     = @sandbox.stub()
-        "./install": @Install = @sandbox.spy (opts) ->
-          opts.after(opts)
-      })
-
-      @verify = @sandbox.stub(utils,  "verifyCypressExists").resolves()
-      @log    = @sandbox.spy(console, "log")
-
-      @setup = (key, options = {}) =>
-        options.initialize = false
-        @Ci(key, options)
-
-    it "verifies cypress first", ->
-      ci = @setup("abc123")
-      ci.initialize().then =>
-        expect(@verify).to.be.calledOnce
-
-    it "installs cypress if verification failed", ->
-      @verify.rejects()
-
-      ci = @setup("abc123")
-      ci.initialize({key: "abc123"}).then =>
-        expect(@Install.getCall(0).args[0].displayOpen).to.be.false
-        expect(@Install.getCall(0).args[0].after).to.be.a("function")
-        expect(@Run).to.be.calledWithMatch(null, {key: "abc123"})
-
-    it "logs out install message", ->
-      @verify.rejects()
-
-      ci = @setup("abc123")
-      ci.initialize().then =>
-        expect(@log).to.be.calledWithMatch("Cypress was not found:", "Installing a fresh copy.")
-
-  context "#_noKeyErr", ->
+ context "#_noKeyErr", ->
     beforeEach ->
       @exit = @sandbox.stub(process, "exit")
       @log  = @sandbox.stub(console, "log")
@@ -144,8 +108,5 @@ describe "Ci", ->
 
     it "logs error message", ->
       expect(@log).to.be.calledWithMatch("You did not pass a specific key to:", "cypress ci")
-      expect(@log).to.be.calledWithMatch("You can receive your project's secret key by running", "cypress get:key")
-      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("Since no key was passed, we checked for an environment\nvariable but none was found with the name:", "CYPRESS_RECORD_KEY")
+      expect(@log).to.be.calledWith("https://on.cypress.io/what-is-a-record-key")