Package Exports
- multi-cypress
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (multi-cypress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
multi-cypress
Roll multiple spec bundles and test in parallel using Cypress and GitLab
Goals
This is a built utility for making and running Cypress tests on a GitLab instance.
- Generate single output spec files from multiple input files using ES6 module syntax
(
importandexportstatements) - Create a GitLab definition file that allows running multiple spec files in parallel.
Install and use
Imagine you have multiple spec files in tests folder. Each spec file can include
other files using import statements. Install this tool npm i -D multi-cypress
and use it to build the spec bundles and .gitlab-ci.yml file.
{
"name": "my-module",
"scripts": {
"build": "multi-cypress"
}
}You can watch the input spec files and keep rebuilding the bundles and .gitlab-ci.yml
file on changes.
{
"name": "my-module",
"scripts": {
"build": "multi-cypress -w"
}
}Custom configuration
You can define input spec file pattern and output folder inside package.json,
see test/package.json for an example
{
"name": "my-module",
"config": {
"multi-cypress": {
"specs": "src/*-spec.js",
"destination": "output"
}
}
}Output .gitlab-ci.yml file
The output file will have single build job and multiple test jobs (single test job per output spec file). See the generated test example test/.gitlab-ci.yml. You can specify the base docker image to use (which should probably include everything Cypress needs to run).
{
"name": "my-module",
"config": {
"multi-cypress": {
"specs": "src/*-spec.js",
"docker": "my-company-hub/test/cypress-base"
}
}
}Debugging
To print debug messages during the build, start the tool with environment variable
DEBUG=multi ...Small print
Author: Kensho, Gleb Bahmutov <gleb@kensho.com> © 2016
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet / open issue on Github
MIT License
Copyright (c) 2016 Kensho
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.