cypress: Not able to detect ciBuildId for Jenkins or run in --parallel
This issue stemmed out of a conversion with @bahmutov on gitter
Current behavior:
Running my specs in Jenkins I get this error:
12:10:32 cypress-tests | You passed the --group or --parallel flag but we could not automatically determine or generate a ciBuildId.
12:10:32 cypress-tests |
12:10:32 cypress-tests | The --parallel flag you passed was: true
12:10:32 cypress-tests |
12:10:32 cypress-tests | In order to use either of these features a ciBuildId must be determined.
12:10:32 cypress-tests |
12:10:32 cypress-tests | The ciBuildId is automatically detected if you are running Cypress in any of the these CI providers:
12:10:32 cypress-tests |
12:10:32 cypress-tests | - appveyor
12:10:32 cypress-tests | - bamboo
12:10:32 cypress-tests | - buildkite
12:10:32 cypress-tests | - circle
12:10:32 cypress-tests | - codeship
12:10:32 cypress-tests | - drone
12:10:32 cypress-tests | - gitlab
12:10:32 cypress-tests | - jenkins
12:10:32 cypress-tests | - semaphore
12:10:32 cypress-tests | - shippable
12:10:32 cypress-tests | - travis
12:10:32 cypress-tests |
12:10:32 cypress-tests | Because the ciBuildId could not be auto-detected you must pass the --ci-build-id flag manually.
12:10:32 cypress-tests |
12:10:32 cypress-tests | https://on.cypress.io/indeterminate-ci-build-id
If I add --ci-build-id ${BUILD_NUMBER} to the run command my test will run and report to the dashboard, however the values for Brach/Author/Commit/Message/CI are not populated in the dashboard, they show “unknown”, and I am only running on one executor - not in parallel.
I am running inside a docker container, I think this may be part of the issues I am having and I may have to explicitly expose the environment variables that Cypress uses to my container. However, I do not know what environment variables Cypress needs to figure this all out.
Desired behavior:
Cypress should detect Jenkins and all environment variables automatically
Steps to reproduce:
Run Cypress specs in a docker container in Jenkins with the --parallel flag specified. I am on v1.642.4
Versions
Cypress 3.1.0 Jenkins 1.642.4 Electron 59
About this issue
- Original URL
- State: closed
- Created 6 years ago
- Comments: 27 (13 by maintainers)
I spent a good deal of time on this but have parallelization working across multiple nodes in Jenkins, running in docker containers. Here’s what I did for anyone who stumbles on this in the future. This assumes you already have cypress running successfully in a Jenkins job.
Sign up for the cypress dashboard, this is required for parallelization. Follow cypress docs on how to get your project reporting to the dashboard, it’s easy, I won’t explain it.
In Jenkins I created a
cypress dispatcherjob, which uses the Jenkins build-flow plugin to determine how many jobs to kick off in parallel and kicks off acypress runnerjob for each of those inside of aparallel()block. The dispatcher waits for all of these to complete, then returns pass if they all pass, or a fail if any of those fail.The runner job does basically what you already have set up to run serially, except it also passes these flags to the cypress run command:
--parallel --ci-build-id ${CI_BUILD_ID}. The CI build ID is how cypress knows that all the jobs are supposed to run together, then does a bunch of magic behind the scenes to distribute specs and group results.The dispatcher job passes the same CI_BUILD_ID parameter to the runner jobs, this needs to be a key that is unique to each run of the dispatcher, so I used the env variable BUILD_NUMBER.
Ahhh thank you! I passed those into my container via the
environment:section of mydocker-composefile and it detects Jenkins and runs without me specifying the ci build id. The CI field is populated in the dashboard and the link works.Some docs around what env vars Cypress uses would be very useful so we know which ones to provide to a docker container.
I still don’t have Author, Commit, or Message populated in the dashboard, so that needs work.
And still need to work with someone to get parallelization working.
Closing as resolved. Please comment if you are still having this issue and we will consider reopening.
Sure thing, these is the dump from the
printenvcommand in thecypress runnerjob, with a liberal amount of stuff changed. Some of these will be params passed into the job, some are jenkins env variables. Any questions just ask.Box#1:
Box#2:
@drewbrend thanks so much for this! We are putting a fix for commit information here https://github.com/cypress-io/cypress/pull/2345 so that hopefully fills the missing fields
Some more info.
From https://github.com/cypress-io/cypress/blob/develop/packages/server/lib/util/ci_provider.coffee#L20 it looks like if I pass the
JENKINS_URLenv var into my docker container it should triggerisJekinsto be true. I have done this and removed--ci-build-id ${BUILD_NUMBER}from my run command. It seems like it attempts to work with Jenkins but something goes wrong. Here is the error that’s spit out