feat: add geckodriver to factory process

CONTRIBUTING.md

@@ -61,13 +61,13 @@ docker compose run --build --rm test-factory-all-included
 
 The [factory/.env](./factory/.env) in the `master` branch should be maintained with the latest stable and supported versions. An exception is the `FACTORY_DEFAULT_NODE_VERSION` which should be set to the [Node.js Active LTS](https://nodejs.org/en/about/previous-releases) version, not the "Current" version.
 
-To publish a new image for `factory`, `base`, `browsers`, or `included`, open a PR with the desired version(s) updated in the [factory/.env](./factory/.env) file. If you change any of the following environment variables in [factory/.env](./factory/.env), then you should also bump the `FACTORY_VERSION` in the same file and make a note of the change in the factory [CHANGELOG](./factory/CHANGELOG.md):
+To publish a new image for `factory`, `base`, `browsers`, or `included`, open a PR with the desired version(s) updated in the [factory/.env](./factory/.env) file. If you change installation scripts or any of the following environment variables in [factory/.env](./factory/.env), then you should also bump the `FACTORY_VERSION` in the same file and make a note of the change in the factory [CHANGELOG](./factory/CHANGELOG.md):
 
 - `BASE_IMAGE`
 - `FACTORY_DEFAULT_NODE_VERSION`
 - `YARN_VERSION`
 
-You should not change the `FACTORY_VERSION` or make an entry into the factory [CHANGELOG](./factory/CHANGELOG.md) if you are only changing browser versions or the Cypress version.
+You should not change the `FACTORY_VERSION` or make an entry into the factory [CHANGELOG](./factory/CHANGELOG.md) if you are only changing browser versions, geckodriver version or the Cypress version.
 
 Once the PR is merged into the `master` branch, the corresponding images will be pushed to [Docker Hub](https://hub.docker.com/u/cypress) and to the [Amazon ECR (Elastic Container Registry) Public Gallery](https://gallery.ecr.aws/cypress-io) via an automated script run through [CircleCI](circle.yml). Please check that the CI jobs pass after merge. Any CI failure can cause the release process to be interrupted.
 

circle.yml

@@ -260,6 +260,7 @@ workflows:
                   test-factory-cypress-included-electron,
                   test-factory-cypress-included-electron-non-root-user,
                   test-factory-cypress-included-firefox,
+                  test-factory-cypress-included-firefox-geckodriver,
                   test-factory-cypress-included-firefox-non-root-user,
                   test-factory-all-included-electron-only,
                 ]
@@ -280,6 +281,7 @@ workflows:
                   test-factory-cypress-included-electron-non-root-user,
                   test-factory-cypress-included-chrome,
                   test-factory-cypress-included-firefox,
+                  test-factory-cypress-included-firefox-geckodriver,
                   test-factory-cypress-included-firefox-non-root-user,
                   test-factory-cypress-included-edge,
                   test-factory-all-included,

examples/basic-mini/Dockerfile.factory

@@ -0,0 +1,3 @@
+FROM cypress/factory
+COPY . /opt/app
+WORKDIR /opt/app

examples/basic/Dockerfile.factory

@@ -0,0 +1,4 @@
+FROM cypress/factory
+COPY . /opt/app
+WORKDIR /opt/app
+RUN npx cypress install # Install Cypress binary into image

examples/firefox-esr/Dockerfile.factory

@@ -0,0 +1,6 @@
+FROM cypress/factory
+COPY . /opt/app
+WORKDIR /opt/app
+RUN apt-get update                 # Update package index
+RUN apt-get install firefox-esr -y # Install Firefox ESR
+RUN npx cypress install            # Install Cypress binary

factory/.env

@@ -18,7 +18,7 @@ NODE_VERSION="${FACTORY_DEFAULT_NODE_VERSION}"
 
 # Update the FACTORY_VERSION to deploy cypress/factory if you make changes to
 # BASE_IMAGE, FACTORY_DEFAULT_NODE_VERSION, YARN_VERSION, factory.Dockerfile or installScripts
-FACTORY_VERSION='5.8.4'
+FACTORY_VERSION='5.9.0'
 
 # Chrome versions: https://www.ubuntuupdates.org/package/google_chrome/stable/main/base/google-chrome-stable
 # Linux/amd64 only
@@ -35,6 +35,12 @@ EDGE_VERSION='136.0.3240.76-1'
 # Linux/amd64 for all versions, Linux/arm64 for versions 136.0 and above
 FIREFOX_VERSION='138.0.4'
 
+# Geckodriver versions: https://github.com/mozilla/geckodriver/releases
+# Geckodriver documentation: https://firefox-source-docs.mozilla.org/testing/geckodriver/index.html
+# Linux/amd64 and Linux/arm64 for all versions
+# Minimum version is 0.34.0
+GECKODRIVER_VERSION='0.36.0'
+
 # Yarn versions: https://www.npmjs.com/package/yarn and
 # Yarn v1 Classic only https://classic.yarnpkg.com/latest-version
 # Yarn Modern (versions 2 and above) are not supported https://yarnpkg.com/

factory/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 5.9.0
+
+- Added ability to install geckodriver with `GECKODRIVER_VERSION`. Addresses [#1351](https://github.com/cypress-io/cypress-docker-images/issues/1351).
+
 ## 5.8.4
 
 - Updated default node version from `22.15.1` to `22.16.0`. Addressed in [#1358](https://github.com/cypress-io/cypress-docker-images/pull/1358).

factory/README.md

@@ -6,6 +6,7 @@
 - Yarn v1 Classic
 - Chrome
 - Firefox
+- geckodriver
 - Edge
 - Cypress
 
@@ -67,7 +68,7 @@ Example: `CYPRESS_VERSION='13.11.0'`
 
 ### CHROME_VERSION
 
-The version of Chrome to install. If the `ARG` variable is unset or an empty string, Chrome is not installed. The exact version must be used, no wildcards or shorthands are supported.
+The version of Google Chrome to install. If the `ARG` variable is unset or an empty string, Chrome is not installed. The exact version must be used, no wildcards or shorthands are supported.
 
 Example: `CHROME_VERSION='131.0.6778.264-1'`
 
@@ -77,17 +78,25 @@ This browser is currently available only for the `Linux/amd64` platform.
 
 ### FIREFOX_VERSION
 
-The version of Firefox to install. If the `ARG` variable is unset or an empty string, Firefox is not installed. The exact version must be used, no wildcards or shorthands are supported.
+The version of Mozilla Firefox to install. If the `ARG` variable is unset or an empty string, Firefox is not installed. The exact version must be used, no wildcards or shorthands are supported.
 
 Example: `FIREFOX_VERSION='134.0'`
 
 [Firefox versions](https://download-installer.cdn.mozilla.net/pub/firefox/releases/)
 
 This browser is available for the `Linux/amd64` platform in all versions, and for the `Linux/arm64` platform in Firefox `136.0` and above.
 
+### GECKODRIVER_VERSION
+
+The version of [Mozilla geckodriver](https://firefox-source-docs.mozilla.org/testing/geckodriver/index.html) to install. If the `ARG` variable is unset or an empty string, the `geckodriver` is not installed. The exact version must be used, no wildcards or shorthands are supported. A minimum version `0.34.0` is required.
+
+Example: `GECKODRIVER_VERSION='0.36.0'`
+
+[Mozilla geckodriver releases](https://github.com/mozilla/geckodriver/releases) provides drivers for both `Linux/amd64` and `Linux/arm64` platforms. Cypress release [13.15.1](https://docs.cypress.io/app/references/changelog#13-15-1), and above, require `geckodriver` when testing Firefox. If `GECKODRIVER_VERSION` is not defined, Cypress uses the npm wrapper package [geckodriver](https://www.npmjs.com/package/geckodriver) to download [Mozilla geckodriver](https://github.com/mozilla/geckodriver) at run-time. Specifying `GECKODRIVER_VERSION` is advised if testing in an air-gapped environment, and to use a defined version of `geckodriver`.
+
 ### EDGE_VERSION
 
-The version of Edge to install. If the `ARG` variable is unset or an empty string, Edge is not installed. The exact version must be used, no wildcards or shorthands are supported.
+The version of Microsoft Edge to install. If the `ARG` variable is unset or an empty string, Edge is not installed. The exact version must be used, no wildcards or shorthands are supported.
 
 Example: `EDGE_VERSION='131.0.2903.112-1'`
 

factory/docker-compose.yml

@@ -112,6 +112,20 @@ services:
         - ${REPO_PREFIX-}cypress/firefox:${FIREFOX_VERSION}
     command: firefox --version
 
+  firefox-geckodriver:
+    image: ${REPO_PREFIX-}cypress/firefox-geckodriver
+    build:
+      target: default_image
+      context: .
+      args:
+        NODE_VERSION: ${NODE_VERSION}
+        FACTORY_VERSION: ${FACTORY_VERSION}
+        FIREFOX_VERSION: ${FIREFOX_VERSION}
+        GECKODRIVER_VERSION: ${GECKODRIVER_VERSION}
+      tags:
+        - ${REPO_PREFIX-}cypress/firefox-geckodriver:${FIREFOX_VERSION}-${GECKODRIVER_VERSION}
+    command: firefox --version
+
   # webkit:
   #   image: ${REPO_PREFIX-}cypress/webkit
   #   build:
@@ -179,6 +193,21 @@ services:
         - ${REPO_PREFIX-}cypress/cypress-firefox:cypress-${CYPRESS_VERSION}-firefox-${FIREFOX_VERSION}
     command: node -v
 
+  cypress-firefox-geckodriver:
+    image: ${REPO_PREFIX-}cypress/cypress-firefox-geckodriver
+    build:
+      target: default_image
+      context: .
+      args:
+        NODE_VERSION: ${NODE_VERSION}
+        FACTORY_VERSION: ${FACTORY_VERSION}
+        CYPRESS_VERSION: ${CYPRESS_VERSION}
+        FIREFOX_VERSION: ${FIREFOX_VERSION}
+        GECKODRIVER_VERSION: ${GECKODRIVER_VERSION}
+      tags:
+        - ${REPO_PREFIX-}cypress/cypress-firefox:cypress-${CYPRESS_VERSION}-firefox-${FIREFOX_VERSION}-geckodriver-${GECKODRIVER_VERSION}
+    command: node -v
+
   ## Test image
   test-node-default:
     build:

factory/factory.Dockerfile

@@ -103,6 +103,16 @@ ONBUILD ARG FIREFOX_VERSION
 
 ONBUILD RUN node /opt/installScripts/firefox/install-firefox-version.js ${FIREFOX_VERSION}
 
+# Install Geckodriver: optional
+# Used with Firefox
+ONBUILD ARG GECKODRIVER_VERSION
+# If geckodriver is installed, make it available to npm package geckodriver
+# See https://github.com/webdriverio-community/node-geckodriver/blob/main/README.md#customgeckodriverpath
+# Path is only set if geckodriver is installed
+# see Dockerfile environment variable syntax https://docs.docker.com/reference/dockerfile/#environment-replacement
+ONBUILD ENV GECKODRIVER_PATH=${GECKODRIVER_VERSION:+/opt/geckodriver/geckodriver}
+ONBUILD RUN node /opt/installScripts/geckodriver/install-geckodriver-version.js ${GECKODRIVER_VERSION}
+
 # TODO: Globally installed webkit currently isn't found, see issue https://github.com/cypress-io/cypress/issues/25344
 # Install Webkit: optional
 # ONBUILD ARG WEBKIT_VERSION

factory/installScripts/firefox/default.sh

@@ -4,7 +4,7 @@
 #
 # $1: version (example: 136.0)
 # $2: compression (xz or bz2)
-# $3: platform (linux-x86_64 or linux-aarch64)
+# $3: platformFilename (linux-x86_64 or linux-aarch64)
 
 apt-get update \
   && apt-get install -y \

factory/installScripts/firefox/install-firefox-version.js

@@ -9,14 +9,14 @@ if (!firefoxVersion) {
 }
 
 const architecture = process.arch
-let platform
+let platformFilename
 
 switch (architecture) {
   case 'x64':
-    platform = 'linux-x86_64'
+    platformFilename = 'linux-x86_64'
     break
   case 'arm64':
-    platform = 'linux-aarch64'
+    platformFilename = 'linux-aarch64'
     if (firefoxVersion >= '136.0') {
       break
     }
@@ -41,8 +41,8 @@ if (firefoxVersion >= '135.0') {
   compression = 'xz'
 }
 
-// Insert logic here if needed to run a different install script based on chrome version.
-const install = spawn(`${__dirname}/default.sh`, [firefoxVersion, compression, platform], { stdio: 'inherit' })
+// Insert logic here if needed to run a different install script based on Firefox version.
+const install = spawn(`${__dirname}/default.sh`, [firefoxVersion, compression, platformFilename], { stdio: 'inherit' })
 
 install.on('error', function (error) {
   console.log('child process errored with ' + error.toString())

factory/installScripts/geckodriver/default.sh

@@ -0,0 +1,12 @@
+#! /bin/bash
+
+# geckodriver for Firefox does not have a Debian package, so instead we download the tar to unzip.
+#
+# $1: version (example: 0.36.0)
+# $2: platformFilename (linux64 or linux-aarch64)
+
+wget --no-verbose -O /tmp/geckodriver.tar.gz https://github.com/mozilla/geckodriver/releases/download/v${1}/geckodriver-v${1}-${2}.tar.gz \
+  && mkdir -p /opt/geckodriver \
+  && tar -C /opt/geckodriver -xaf /tmp/geckodriver.tar.gz \
+  && chown -R root:root /opt/geckodriver \
+  && rm /tmp/geckodriver.tar.gz \

factory/installScripts/geckodriver/install-geckodriver-version.js

@@ -0,0 +1,50 @@
+#!/usr/bin/node
+const { spawn } = require('child_process')
+
+const geckodriverVersion = process.argv.slice(2)[0]
+
+if (!geckodriverVersion) {
+  console.log('No geckodriver version provided, skipping geckodriver install')
+  process.exit(0)
+}
+
+// See https://firefox-source-docs.mozilla.org/testing/geckodriver/Support.html for compatibility matrix
+// geckodriver < 0.34.0 only supports up to Firefox 120, which is no longer supported by Cypress
+const MIN_GECKO = '0.34.0'
+
+if (geckodriverVersion < MIN_GECKO) {
+  console.log(`geckodriver version ${geckodriverVersion} provided, minimum version ${MIN_GECKO} required, skipping geckodriver install`)
+  process.exit(0)
+}
+
+const architecture = process.arch
+// Platform filenames taken from https://github.com/mozilla/geckodriver/releases
+let platformFilename
+
+switch (architecture) {
+  case 'x64':
+    platformFilename = 'linux64'
+    break
+  case 'arm64':
+    platformFilename = 'linux-aarch64'
+    break
+
+  default:
+    console.log(`Unsupported architecture ${architecture} for geckodriver installation, skipping install`)
+    process.exit(0)
+}
+
+console.log(`Installing geckodriver version ${geckodriverVersion} for ${architecture}`)
+
+// Insert logic here if needed to run a different install script based on geckodriver version.
+const install = spawn(`${__dirname}/default.sh`, [geckodriverVersion, platformFilename], { stdio: 'inherit' })
+
+install.on('error', function (error) {
+  console.log('child process errored with ' + error.toString())
+  process.exit(1)
+})
+
+install.on('exit', function (code) {
+  console.log('child process exited with code ' + code.toString())
+  process.exit(code)
+})

factory/test-project/docker-compose.yml

@@ -48,6 +48,16 @@ services:
       context: .
     command: npm run test -- -b firefox
 
+  test-factory-firefox-geckodriver:
+    build:
+      args:
+        NODE_VERSION: ${NODE_VERSION}
+        FIREFOX_VERSION: ${FIREFOX_VERSION}
+        GECKODRIVER_VERSION: ${GECKODRIVER_VERSION}
+        BASE_TEST_IMAGE: cypress/factory:${FACTORY_VERSION}
+      context: .
+    command: npm run test -- -b firefox
+
   test-factory-edge:
     build:
       args:
@@ -100,6 +110,18 @@ services:
       context: .
     command: cypress run -b firefox
 
+  test-factory-cypress-included-firefox-geckodriver:
+    build:
+      args:
+        NODE_VERSION: ${NODE_VERSION}
+        CYPRESS_VERSION: ${CYPRESS_VERSION}
+        FIREFOX_VERSION: ${FIREFOX_VERSION}
+        GECKODRIVER_VERSION: ${GECKODRIVER_VERSION}
+        BASE_TEST_IMAGE: cypress/factory:${FACTORY_VERSION}
+      dockerfile: included.Dockerfile
+      context: .
+    command: cypress run -b firefox
+
   test-factory-cypress-included-firefox-non-root-user:
     user: node
     build: