cypress 3.3.2 → 3.6.0

package/lib/util.js

@@ -9,6 +9,7 @@ function _taggedTemplateLiteral(strings, raw) { return Object.freeze(Object.defi
 var _ = require('lodash');
 var R = require('ramda');
 var os = require('os');
+var crypto = require('crypto');
 var la = require('lazy-ass');
 var is = require('check-more-types');
 var tty = require('tty');
@@ -30,11 +31,44 @@ var _isInstalledGlobally = require('is-installed-globally');
 var pkg = require(path.join(__dirname, '..', 'package.json'));
 var logger = require('./logger');
 var debug = require('debug')('cypress:cli');
+var fs = require('./fs');
 
 var issuesUrl = 'https://github.com/cypress-io/cypress/issues';
 
 var getosAsync = Promise.promisify(getos);
 
+/**
+ * Returns SHA512 of a file
+ *
+ * Implementation lifted from https://github.com/sindresorhus/hasha
+ * but without bringing that dependency (since hasha is Node v8+)
+ */
+var getFileChecksum = function getFileChecksum(filename) {
+  la(is.unemptyString(filename), 'expected filename', filename);
+
+  var hashStream = function hashStream() {
+    var s = crypto.createHash('sha512');
+
+    s.setEncoding('hex');
+
+    return s;
+  };
+
+  return new Promise(function (resolve, reject) {
+    var stream = fs.createReadStream(filename);
+
+    stream.on('error', reject).pipe(hashStream()).on('error', reject).on('finish', function () {
+      resolve(this.read());
+    });
+  });
+};
+
+var getFileSize = function getFileSize(filename) {
+  la(is.unemptyString(filename), 'expected filename', filename);
+
+  return fs.statAsync(filename).get('size');
+};
+
 var isBrokenGtkDisplayRe = /Gtk: cannot open display/;
 
 var stringify = function stringify(val) {
@@ -75,6 +109,7 @@ var logBrokenGtkDisplayWarning = function logBrokenGtkDisplayWarning() {
 
   // if we get this error, we are on Linux and DISPLAY is set
   logger.warn(stripIndent(_templateObject, logSymbols.warning, process.env.DISPLAY));
+
   logger.warn();
 };
 
@@ -85,6 +120,25 @@ function stdoutLineMatches(expectedLine, stdout) {
   return lines.some(lineMatches);
 }
 
+/**
+ * Confirms if given value is a valid CYPRESS_ENV value. Undefined values
+ * are valid, because the system can set the default one.
+ *
+ * @param {string} value
+ * @example util.isValidCypressEnvValue(process.env.CYPRESS_ENV)
+ */
+function isValidCypressEnvValue(value) {
+  if (_.isUndefined(value)) {
+    // will get default value
+    return true;
+  }
+
+  // names of config environments, see "packages/server/config/app.yml"
+  var names = ['development', 'test', 'staging', 'production'];
+
+  return _.includes(names, value);
+}
+
 /**
  * Prints NODE_OPTIONS using debug() module, but only
  * if DEBUG=cypress... is set
@@ -103,9 +157,30 @@ function printNodeOptions() {
   }
 }
 
+/**
+ * Removes double quote characters
+ * from the start and end of the given string IF they are both present
+ *
+ * @example
+  ```
+  dequote('"foo"')
+  // returns string 'foo'
+  dequote('foo')
+  // returns string 'foo'
+  ```
+ */
+var dequote = function dequote(str) {
+  la(is.string(str), 'expected a string to remove double quotes', str);
+  if (str.length > 1 && str[0] === '"' && str[str.length - 1] === '"') {
+    return str.substr(1, str.length - 2);
+  }
+
+  return str;
+};
+
 var util = {
   normalizeModuleOptions: normalizeModuleOptions,
-
+  isValidCypressEnvValue: isValidCypressEnvValue,
   printNodeOptions: printNodeOptions,
 
   isCi: function isCi() {
@@ -167,6 +242,10 @@ var util = {
 
     process.exit(1);
   },
+
+
+  dequote: dequote,
+
   titleize: function titleize() {
     for (var _len = arguments.length, args = Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
@@ -184,7 +263,7 @@ var util = {
   calculateEta: function calculateEta(percent, elapsed) {
     // returns the number of seconds remaining
 
-    // if we're at 100 already just return 0
+    // if we're at 100% already just return 0
     if (percent === 100) {
       return 0;
     }
@@ -194,6 +273,12 @@ var util = {
     // subtracting what's already elapsed
     return elapsed * (1 / (percent / 100)) - elapsed;
   },
+  convertPercentToPercentage: function convertPercentToPercentage(num) {
+    // convert a percent with values between 0 and 1
+    // with decimals, so that it is between 0 and 100
+    // and has no decimal places
+    return Math.round(_.isFinite(num) ? num * 100 : 0);
+  },
   secsRemaining: function secsRemaining(eta) {
     // calculate the seconds reminaing with no decimal places
     return (_.isFinite(eta) ? eta / 1000 : 0).toFixed(0);
@@ -244,30 +329,39 @@ var util = {
 
     return path.join(process.cwd(), '..', '..', filename);
   },
-  getEnv: function getEnv(varName) {
+  getEnv: function getEnv(varName, trim) {
+    la(is.unemptyString(varName), 'expected environment variable name, not', varName);
+
     var envVar = process.env[varName];
     var configVar = process.env['npm_config_' + varName];
     var packageConfigVar = process.env['npm_package_config_' + varName];
 
+    var result = void 0;
+
     if (envVar) {
       debug('Using ' + varName + ' from environment variable');
 
-      return envVar;
-    }
-
-    if (configVar) {
+      result = envVar;
+    } else if (configVar) {
       debug('Using ' + varName + ' from npm config');
 
-      return configVar;
-    }
-
-    if (packageConfigVar) {
+      result = configVar;
+    } else if (packageConfigVar) {
       debug('Using ' + varName + ' from package.json config');
 
-      return packageConfigVar;
+      result = packageConfigVar;
     }
 
-    return undefined;
+    // environment variables are often set double quotes to escape characters
+    // and on Windows it can lead to weird things: for example
+    //  set FOO="C:\foo.txt" && node -e "console.log('>>>%s<<<', process.env.FOO)"
+    // will print
+    //    >>>"C:\foo.txt" <<<
+    // see https://github.com/cypress-io/cypress/issues/4506#issuecomment-506029942
+    // so for sanity sake we should first trim whitespace characters and remove
+    // double quotes around environment strings if the caller is expected to
+    // use this environment string as a file path
+    return trim ? dequote(_.trim(result)) : result;
   },
   getCacheDir: function getCacheDir() {
     return cachedir('Cypress');
@@ -294,7 +388,12 @@ var util = {
     la(_.isInteger(number), 'github issue should be an integer', number);
 
     return issuesUrl + '/' + number;
-  }
+  },
+
+
+  getFileChecksum: getFileChecksum,
+
+  getFileSize: getFileSize
 };
 
 module.exports = util;

package/package.json

@@ -1,21 +1,15 @@
 {
   "name": "cypress",
-  "version": "3.3.2",
+  "version": "3.6.0",
   "main": "index.js",
-  "bin": {
-    "cypress": "bin/cypress"
-  },
-  "engines": {
-    "node": ">=4.0.0"
-  },
   "scripts": {
     "postinstall": "node index.js --exec install",
     "size": "t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";"
   },
-  "types": "types",
   "dependencies": {
     "@cypress/listr-verbose-renderer": "0.4.1",
     "@cypress/xvfb": "1.2.4",
+    "@types/sizzle": "2.3.2",
     "arch": "2.1.1",
     "bluebird": "3.5.0",
     "cachedir": "1.3.0",
@@ -29,20 +23,20 @@
     "extract-zip": "1.6.7",
     "fs-extra": "5.0.0",
     "getos": "3.1.1",
-    "glob": "7.1.3",
     "is-ci": "1.2.1",
     "is-installed-globally": "0.1.0",
     "lazy-ass": "1.6.0",
     "listr": "0.12.0",
-    "lodash": "4.17.11",
+    "lodash": "4.17.15",
     "log-symbols": "2.2.0",
     "minimist": "1.2.0",
     "moment": "2.24.0",
     "ramda": "0.24.1",
     "request": "2.88.0",
-    "request-progress": "0.4.0",
+    "request-progress": "3.0.0",
     "supports-color": "5.5.0",
     "tmp": "0.1.0",
+    "untildify": "3.0.3",
     "url": "0.11.0",
     "yauzl": "2.10.0"
   },
@@ -52,6 +46,13 @@
     "index.js",
     "types/**/*.d.ts"
   ],
+  "bin": {
+    "cypress": "bin/cypress"
+  },
+  "engines": {
+    "node": ">=4.0.0"
+  },
+  "types": "types",
   "description": "Cypress.io end to end testing tool",
   "author": "Brian Mann",
   "homepage": "https://github.com/cypress-io/cypress",
@@ -64,18 +65,18 @@
     "url": "https://github.com/cypress-io/cypress.git"
   },
   "keywords": [
+    "automation",
     "browser",
     "cypress",
     "cypress.io",
-    "automation",
-    "end-to-end",
     "e2e",
+    "end-to-end",
     "integration",
     "mocks",
-    "test",
-    "testing",
     "runner",
     "spies",
-    "stubs"
+    "stubs",
+    "test",
+    "testing"
   ]
 }

package/types/blob-util/package.json

@@ -0,0 +1,51 @@
+{
+  "_from": "@types/blob-util@1.3.3",
+  "_id": "@types/blob-util@1.3.3",
+  "_inBundle": false,
+  "_integrity": "sha512-4ahcL/QDnpjWA2Qs16ZMQif7HjGP2cw3AGjHabybjw7Vm1EKu+cfQN1D78BaZbS1WJNa1opSMF5HNMztx7lR0w==",
+  "_location": "/@types/blob-util",
+  "_phantomChildren": {},
+  "_requested": {
+    "type": "version",
+    "registry": true,
+    "raw": "@types/blob-util@1.3.3",
+    "name": "@types/blob-util",
+    "escapedName": "@types%2fblob-util",
+    "scope": "@types",
+    "rawSpec": "1.3.3",
+    "saveSpec": null,
+    "fetchSpec": "1.3.3"
+  },
+  "_requiredBy": [
+    "#DEV:/"
+  ],
+  "_resolved": "https://registry.npmjs.org/@types/blob-util/-/blob-util-1.3.3.tgz",
+  "_shasum": "adba644ae34f88e1dd9a5864c66ad651caaf628a",
+  "_spec": "@types/blob-util@1.3.3",
+  "_where": "/root/cypress/cli",
+  "bugs": {
+    "url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues"
+  },
+  "bundleDependencies": false,
+  "contributors": [
+    {
+      "name": "Max Battcher",
+      "url": "https://github.com/WorldMaker"
+    }
+  ],
+  "dependencies": {},
+  "deprecated": false,
+  "description": "TypeScript definitions for blob-util",
+  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme",
+  "license": "MIT",
+  "main": "",
+  "name": "@types/blob-util",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+  },
+  "scripts": {},
+  "typeScriptVersion": "2.1",
+  "typesPublisherContentHash": "251d66da417b64481e7f82fee1849478af0caa6fce0b1feee2146884d2dc9c98",
+  "version": "1.3.3"
+}

package/types/bluebird/package.json

@@ -0,0 +1,51 @@
+{
+  "_from": "@types/bluebird@3.5.18",
+  "_id": "@types/bluebird@3.5.18",
+  "_inBundle": false,
+  "_integrity": "sha512-OTPWHmsyW18BhrnG5x8F7PzeZ2nFxmHGb42bZn79P9hl+GI5cMzyPgQTwNjbem0lJhoru/8vtjAFCUOu3+gE2w==",
+  "_location": "/@types/bluebird",
+  "_phantomChildren": {},
+  "_requested": {
+    "type": "version",
+    "registry": true,
+    "raw": "@types/bluebird@3.5.18",
+    "name": "@types/bluebird",
+    "escapedName": "@types%2fbluebird",
+    "scope": "@types",
+    "rawSpec": "3.5.18",
+    "saveSpec": null,
+    "fetchSpec": "3.5.18"
+  },
+  "_requiredBy": [
+    "#DEV:/"
+  ],
+  "_resolved": "https://registry.npmjs.org/@types/bluebird/-/bluebird-3.5.18.tgz",
+  "_shasum": "6a60435d4663e290f3709898a4f75014f279c4d6",
+  "_spec": "@types/bluebird@3.5.18",
+  "_where": "/root/cypress/cli",
+  "bugs": {
+    "url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues"
+  },
+  "bundleDependencies": false,
+  "contributors": [
+    {
+      "name": "Leonard Hecker",
+      "url": "https://github.com/lhecker"
+    }
+  ],
+  "dependencies": {},
+  "deprecated": false,
+  "description": "TypeScript definitions for bluebird",
+  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme",
+  "license": "MIT",
+  "main": "",
+  "name": "@types/bluebird",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+  },
+  "scripts": {},
+  "typeScriptVersion": "2.3",
+  "typesPublisherContentHash": "c9b100367d31f8bd36031e55737d6ffde1a9b85dac3df3693f8f684f914c94cb",
+  "version": "3.5.18"
+}

package/types/chai/package.json

@@ -0,0 +1,81 @@
+{
+  "_from": "@types/chai@4.0.8",
+  "_id": "@types/chai@4.0.8",
+  "_inBundle": false,
+  "_integrity": "sha512-m812CONwdZn/dMzkIJEY0yAs4apyTkTORgfB2UsMOxgkUbC205AHnm4T8I0I5gPg9MHrFc1dJ35iS75c0CJkjg==",
+  "_location": "/@types/chai",
+  "_phantomChildren": {},
+  "_requested": {
+    "type": "version",
+    "registry": true,
+    "raw": "@types/chai@4.0.8",
+    "name": "@types/chai",
+    "escapedName": "@types%2fchai",
+    "scope": "@types",
+    "rawSpec": "4.0.8",
+    "saveSpec": null,
+    "fetchSpec": "4.0.8"
+  },
+  "_requiredBy": [
+    "#DEV:/",
+    "/@types/chai-jquery",
+    "/@types/sinon-chai"
+  ],
+  "_resolved": "https://registry.npmjs.org/@types/chai/-/chai-4.0.8.tgz",
+  "_shasum": "d27600e9ba2f371e08695d90a0fe0408d89c7be7",
+  "_spec": "@types/chai@4.0.8",
+  "_where": "/root/cypress/cli",
+  "bugs": {
+    "url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues"
+  },
+  "bundleDependencies": false,
+  "contributors": [
+    {
+      "name": "Jed Mao",
+      "url": "https://github.com/jedmao"
+    },
+    {
+      "name": "Bart van der Schoor",
+      "url": "https://github.com/Bartvds"
+    },
+    {
+      "name": "Andrew Brown",
+      "url": "https://github.com/AGBrown"
+    },
+    {
+      "name": "Olivier Chevet",
+      "url": "https://github.com/olivr70"
+    },
+    {
+      "name": "Matt Wistrand",
+      "url": "https://github.com/mwistrand"
+    },
+    {
+      "name": "Josh Goldberg",
+      "url": "https://github.com/joshuakgoldberg"
+    },
+    {
+      "name": "Shaun Luttin",
+      "url": "https://github.com/shaunluttin"
+    },
+    {
+      "name": "Gintautas Miselis",
+      "url": "https://github.com/Naktibalda"
+    }
+  ],
+  "dependencies": {},
+  "deprecated": false,
+  "description": "TypeScript definitions for chai",
+  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme",
+  "license": "MIT",
+  "main": "",
+  "name": "@types/chai",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+  },
+  "scripts": {},
+  "typeScriptVersion": "2.0",
+  "typesPublisherContentHash": "1c89ea9e229c46de0cd9fc9a48b4ce18c27a3bab9d443d01bec054b1126ede4a",
+  "version": "4.0.8"
+}

package/types/chai-jquery/package.json

@@ -0,0 +1,55 @@
+{
+  "_from": "@types/chai-jquery@1.1.38",
+  "_id": "@types/chai-jquery@1.1.38",
+  "_inBundle": false,
+  "_integrity": "sha512-j/b++tOoQtkqXdkUWnojd+dM+YxkMiWJ193mToN/vv+rkBLv3MSSNwyDxFSXDwdi82Y+J2Js4fvdVkv/JiVeow==",
+  "_location": "/@types/chai-jquery",
+  "_phantomChildren": {},
+  "_requested": {
+    "type": "version",
+    "registry": true,
+    "raw": "@types/chai-jquery@1.1.38",
+    "name": "@types/chai-jquery",
+    "escapedName": "@types%2fchai-jquery",
+    "scope": "@types",
+    "rawSpec": "1.1.38",
+    "saveSpec": null,
+    "fetchSpec": "1.1.38"
+  },
+  "_requiredBy": [
+    "#DEV:/"
+  ],
+  "_resolved": "https://registry.npmjs.org/@types/chai-jquery/-/chai-jquery-1.1.38.tgz",
+  "_shasum": "bbab052200871e1b26b9a239caa63b2a2eaa00bc",
+  "_spec": "@types/chai-jquery@1.1.38",
+  "_where": "/root/cypress/cli",
+  "bugs": {
+    "url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues"
+  },
+  "bundleDependencies": false,
+  "contributors": [
+    {
+      "name": "Kazi Manzur Rashid",
+      "url": "https://github.com/kazimanzurrashid"
+    }
+  ],
+  "dependencies": {
+    "@types/chai": "*",
+    "@types/jquery": "*"
+  },
+  "deprecated": false,
+  "description": "TypeScript definitions for chai-jquery",
+  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme",
+  "license": "MIT",
+  "main": "",
+  "name": "@types/chai-jquery",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+  },
+  "scripts": {},
+  "typeScriptVersion": "2.3",
+  "types": "index",
+  "typesPublisherContentHash": "e12e44b47bd00c6f4a82ba74968fe19edad29fdcd0ffc07a23da854653181f17",
+  "version": "1.1.38"
+}

package/types/cy-chai.d.ts

@@ -1,12 +1,10 @@
 // Shim definition to export a namespace. Cypress is actually a global module
 // so import/export isn't allowed there. We import here and define a global module
 /// <reference path="./chai/index.d.ts" />
-
-export = Chai
-export as namespace Chai
-
 declare namespace Chai {
-  type ChaiStatic = typeof chai
-  type ExpectStatic = typeof chai.expect
-  type AssertStatic = typeof chai.assert
+  interface Include {
+    html(html: string): Assertion
+    text(text: string): Assertion
+    value(text: string): Assertion
+  }
 }

package/types/cypress-npm-api.d.ts

@@ -43,9 +43,9 @@ declare module 'cypress' {
      */
     reporter: string,
     /**
-     * A String glob pattern of the test files to load.
+     * A String or Array of string glob pattern of the test files to load.
      */
-    testFiles: string
+    testFiles: string | string[]
 
     //
     // timeouts
@@ -224,7 +224,7 @@ declare module 'cypress' {
     })
     ```
    */
-  interface CypressRunOptions {
+  interface CypressRunOptions extends CypressCommonOptions {
     /**
      * Specify different browser to run tests in, either by name or by filesystem path
     */
@@ -233,14 +233,6 @@ declare module 'cypress' {
      * Specify a unique identifier for a run to enable grouping or parallelization
      */
     ciBuildId: string
-    /**
-     * Specify configuration
-     */
-    config: Partial<CypressConfiguration>
-    /**
-     * Specify environment variables
-     */
-    env: object
     /**
      * Group recorded tests together under a single run name
      */
@@ -265,10 +257,6 @@ declare module 'cypress' {
      * Override default port
      */
     port: number
-    /**
-     * Path to a specific project
-     */
-    project: string
     /**
      * Whether to record the test run
      */
@@ -302,23 +290,15 @@ declare module 'cypress' {
     })
     ```
    */
-  interface CypressOpenOptions {
+  interface CypressOpenOptions extends CypressCommonOptions {
     /**
      * Specify a filesystem path to a custom browser
      */
     browser: string
-    /**
-     * Specify configuration
-     */
-    config: Partial<CypressConfiguration>
     /**
      * Open Cypress in detached mode
      */
     detached: boolean
-    /**
-     * Specify environment variables
-     */
-    env: object
     /**
      * Run in global mode
      */
@@ -327,6 +307,28 @@ declare module 'cypress' {
      * Override default port
      */
     port: number
+  }
+
+  /**
+   * Options available for `cypress.open` and `cypress.run`
+   */
+  interface CypressCommonOptions {
+    /**
+     * Specify configuration
+     */
+    config: Partial<CypressConfiguration>
+    /**
+     * Path to the config file to be used.
+     *
+     * If `false` is passed, no config file will be used.
+     *
+     * @default "cypress.json"
+     */
+    configFile: string | false
+    /**
+     * Specify environment variables
+     */
+    env: object
     /**
      * Path to a specific project
      */
@@ -443,6 +445,7 @@ declare module 'cypress' {
 
   /**
    * Results returned by the test run.
+   * @see https://on.cypress.io/module-api
    */
   interface CypressRunResult {
     startedTestsAt: dateTimeISO
@@ -463,6 +466,29 @@ declare module 'cypress' {
     cypressVersion: string
     // TODO add resolved object to the configuration
     config: CypressConfiguration
+    /**
+     * If Cypress fails to run at all (for example, if there are no spec files to run),
+     * then it will set failures to 1 and will have actual error message in the
+     * property "message". Check this property before checking other properties.
+     *
+     * @type {number}
+     * @example
+      ```
+      const result = await cypress.run()
+      if (result.failures) {
+        console.error(result.message)
+        process.exit(result.failures)
+      }
+      ```
+     */
+    failures?: number
+    /**
+     * If returned result has "failures" set, then this property gives
+     * the error message.
+     *
+     * @type {string}
+     */
+    message?: string
   }
 
   /**