Cypress tests fail in air-gapped network on Firefox

[ChadiEM]

Current behavior

In an air gapped network, running a component or e2e tests using cypress on Firefox using the cypress/included docker image fails with the following error:

Cypress failed to make a connection to Firefox.

This usually indicates there was a problem opening the Firefox browser.

FetchError: request to https://raw.githubusercontent.com/mozilla/geckodriver/release/Cargo.toml failed, reason: read ECONNRESET
    at ClientRequest.<anonymous> (file:///root/.cache/Cypress/14.0.2/Cypress/resources/app/packages/server/node_modules/node-fetch/src/index.js:108:11)
    at ClientRequest.emit (node:events:518:28)
    at emitErrorEvent (node:_http_client:101:11)
    at TLSSocket.socketErrorListener (node:_http_client:504:5)
    at TLSSocket.emit (node:events:518:28)
    at emitErrorNT (node:internal/streams/destroy:169:8)
    at emitErrorCloseNT (node:internal/streams/destroy:128:3)
    at process.processTicksAndRejections (node:internal/process/task_queues:82:21)

This is likely a regression introduced in release 13.15.1 which started using geckodriver.

Desired behavior

I expect the test to run in an air gapped network. It should not send any request to the internet.

Test code to reproduce

Any test in Firefox in an air-gapped network.

Cypress Docker Image

cypress/included:14.0.2

Other

I also attempted to override the environment variables supported by geckodriver to use a local path

GECKODRIVER_VERSION = '0.35.0'
GECKODRIVER_CDNURL = 'file:///path/to/geckodriver/'

But it failed node-fetch does not support file:.

Related issue

cypress-io/cypress#31036

[MikeMcC399]

@ChadiEM

Thanks for opening a new issue specifically for Docker! Here are the results of my analysis with a recommendation for you:

Situation

Firefox testing with Cypress fails in an air-gapped network environment.

Background

The npm package geckodriver by default dynamically downloads and caches an architecture-dependent geckodriver from GitHub. This default behavior requires an Internet connection, meaning that these images cannot be used in an air-gapped environment.

Assessment

None of the published Cypress Docker images, nor ones generated using cypress/factory, contain a cached geckodriver required for Firefox testing.

To cover this situation in a general way would require making geckodriver into a parameter for cypress/factory. This could be looked at as a feature request.

The environment variable GECKODRIVER_AUTO_INSTALL documented in Installing allows an auto-install of the driver.

Recommendation

In order to reach a workable solution quickly, I suggest building and using a customized Docker image similar to cypress/included that includes a cached version of the geckodriver.

Example Docker image

First in an environment with Internet connectivity:

git clone https://github.com/cypress-io/cypress-docker-images
cd cypress-docker-images
cd examples/basic-mini

Create a Dockerfile.geckodriver with the following contents:

ARG FIREFOX_VERSION='135.0'
ARG CYPRESS_VERSION='14.0.2'

FROM cypress/factory

COPY . /opt/app
WORKDIR /opt/app
ENTRYPOINT ["cypress", "run"]
RUN GECKODRIVER_AUTO_INSTALL=1 npm install geckodriver --no-package-lock
RUN npm uninstall geckodriver

Then execute:

docker build -f Dockerfile.geckodriver -t test-firefox-included .

Disconnect network and execute:

docker run -it --rm -v .:/app -w /app --entrypoint cypress test-firefox-included run -b firefox

[MikeMcC399]

@ChadiEM

Please give feedback if this suggestion is helpful to you.

[MikeMcC399]

@ChadiEM

A workaround has been provided as an incident resolution. It does not however resolve the underlying problem that Cypress and Cypress Docker images testing Firefox require an Internet connection at some point in their setup stage.

If you want to suggest any changes to regular Cypress Docker images or the factory build process for instance, please open a new issue as there would be additional topics that would need consideration.

[SamTV12345]

@ChadiEM

Thanks for opening a new issue specifically for Docker! Here are the results of my analysis with a recommendation for you:

Situation

Firefox testing with Cypress fails in an air-gapped network environment.

Background

The npm package geckodriver by default dynamically downloads and caches an architecture-dependent geckodriver from GitHub. This default behavior requires an Internet connection, meaning that these images cannot be used in an air-gapped environment.

Assessment

None of the published Cypress Docker images, nor ones generated using cypress/factory, contain a cached geckodriver required for Firefox testing.

To cover this situation in a general way would require making geckodriver into a parameter for cypress/factory. This could be looked at as a feature request.

The environment variable GECKODRIVER_AUTO_INSTALL documented in Installing allows an auto-install of the driver.

Recommendation

In order to reach a workable solution quickly, I suggest building and using a customized Docker image similar to cypress/included that includes a cached version of the geckodriver.

Example Docker image

First in an environment with Internet connectivity:

git clone https://github.com/cypress-io/cypress-docker-images
cd cypress-docker-images
cd examples/basic-mini
Create a Dockerfile.geckodriver with the following contents:

ARG FIREFOX_VERSION='135.0'
ARG CYPRESS_VERSION='14.0.2'

FROM cypress/factory

COPY . /opt/app
WORKDIR /opt/app
ENTRYPOINT ["cypress", "run"]
RUN GECKODRIVER_AUTO_INSTALL=1 npm install geckodriver --no-package-lock
RUN npm uninstall geckodriver
Then execute:

docker build -f Dockerfile.geckodriver -t test-firefox-included .
Disconnect network and execute:

docker run -it --rm -v .:/app -w /app --entrypoint cypress test-firefox-included run -b firefox

Tested and working flawlessly in our CI. Thank you :)

[wietseeggink]

Hi,

We're working in an air-gapped environment where it isn't easy for us to use the cypress/factory images as these also require internet access to be readily available. I've been looking at installing the geckodriver binary into the cypress/included image.

With the binary properly installed into the image and accessible via the geckodriver command, Cypress still tries to access the internet for geckodriver. Is there any way to prevent this?

[MikeMcC399]

@wietseeggink

If you clone this repo you can generate your own local cypress/factory image

See https://github.com/cypress-io/cypress-docker-images/blob/master/CONTRIBUTING.md#building-locally
This would however need internet access at that time.

If that does not help, then please open a new issue.