Gleb Bahmutov
b3e40b08cd
* WIP: log spec search steps * add multiple files via glob test * allow testFiles to be a string or a list of strings to match * failing config tests: testFiles type change Change `testFiles` from a string to either a string **or** array of strings; following similar pattern as `ignoreTestFiles` * testFiles type change passing tests * update verbiage related to testFiles type change * enable running integration tests locally See https://github.com/paulmillr/chokidar/issues/855 for more details. * integration tests; failing Seems to fail for similar reason as #4543 and is likely resolved with PR #4849 * correct test verbiage Distinguish between the two tests; as they are subtly different. * update TS types for testFiles type change Updated the comments, but forgot to update the actual type. This commit rectifies that. * correct CLI syntax in test `--config` was not being passed the appropriate value. Now matches other test cases; such as that found in [args_spec](https://github.com/cypress-io/cypress/blob/92b91fe514e5ff6286b4d4e26d2df23062bdf869/packages/server/test/unit/args_spec.coffee#L210) * remove unsupported syntax from tests From looking at other tests, it does not appear that the syntax `--config=testFiles=glob1,glob2` is current supported. Removing the test for this test case. * test the correct config value Previously was testing `ignoreTestFiles` instead of `testFies` * provide more accurate test assertion * correct config's `testFiles` type Should be a string or an array of strings. * remove unnecessary newline * tweak verbiage to better align with intention Co-Authored-By: Ben Kucera <14625260+Bkucera@users.noreply.github.com> Co-authored-by: Andrew Smith <andrew@andrew.codes>
CLI
The CLI is used to build the cypress npm module to be run within a terminal.
The CLI has the following responsibilities:
- Allow users to print CLI commands
- Allow users to install the Cypress executable
- Allow users to print their current Cypress version
- Allow users to run Cypress tests from the terminal
- Allow users to open Cypress in the interactive Test Runner.
- Allow users to verify that Cypress is installed correctly and executable
- Allow users to manages the Cypress binary cache
- Allow users to pass in options that change way tests are ran or recorded (browsers used, specfiles ran, grouping, parallelization)
Installing
The CLI's dependencies can be installed with:
cd cli
npm install
Building
See scripts/build.js. Note that the built npm package will include NPM_README.md as its public README file.
Testing
Automated
You can run unit tests with:
npm test
This will take and compare snapshots of the CLI output. To update snapshots, see snap-shot-it instructions: https://github.com/bahmutov/snap-shot-it#advanced-use
Manual
To build and test an NPM package:
npm installnpm run build
This creates build folder.
cd build; npm pack
This creates an archive, usually named cypress-<version>.tgz. You can install this archive from other projects, but because there is no corresponding binary yet (probably), skip binary download. For example from inside cypress-example-kitchensink folder
npm i ~/{your-dirs}/cypress/cli/build/cypress-3.3.1.tgz --ignore-scripts
Which installs the tgz file we have just built from folder Users/jane-lane/{your-dirs}/cypress/cli/build.