From e95b64c0f5e43e3b0ee522d1caf1521bf0fd371f Mon Sep 17 00:00:00 2001 From: Matt Schile Date: Thu, 12 Dec 2024 19:14:47 -0700 Subject: [PATCH] docs: add chrome for testing browser (#6038) --- docs/app/references/launching-browsers.mdx | 20 +++++--- docs/app/references/troubleshooting.mdx | 57 ++++++++++++++++------ 2 files changed, 55 insertions(+), 22 deletions(-) diff --git a/docs/app/references/launching-browsers.mdx b/docs/app/references/launching-browsers.mdx index d7e44b0dc6..7fbc337e79 100644 --- a/docs/app/references/launching-browsers.mdx +++ b/docs/app/references/launching-browsers.mdx @@ -31,6 +31,7 @@ using number of browsers including: - [Chrome](https://www.google.com/chrome/) - [Chrome Beta](https://www.google.com/chrome/beta/) - [Chrome Canary](https://www.google.com/chrome/canary/) +- [Chrome for Testing](https://github.com/GoogleChromeLabs/chrome-for-testing/) - [Chromium](https://www.chromium.org/Home) - [Edge](https://www.microsoft.com/edge) - [Edge Beta](https://www.microsoftedgeinsider.com/download) @@ -63,7 +64,7 @@ Cypress supports the browser versions below: The Chrome browser is evergreen - meaning it will automatically update itself, sometimes causing a breaking change in your automated tests. You can use the information in [Download Chromium](https://on.cypress.io/chromium-downloads) to download a -specific released version of Chromium for every platform. +specific released version of Chrome for Testing or Chromium for every platform. ### Electron Browser @@ -123,6 +124,12 @@ Or Chrome Canary: cypress run --browser chrome:canary ``` +Or Chrome for Testing: + +```shell +cypress run --browser chrome-for-testing +``` + ### Edge Browsers Microsoft Edge-family (Chromium-based) browsers are supported by Cypress. @@ -268,11 +275,11 @@ list of browsers you want available for selection during `cypress open`. // name: 'chrome', // channel: 'canary', // family: 'chromium', -// displayName: 'Canary', -// version: '80.0.3966.0', +// displayName: 'Chrome Canary', +// version: '133.0.6890.0', // path: -// '/Applications/Canary.app/Contents/MacOS/Canary', -// majorVersion: 80 +// '/Applications/Google Chrome Canary.app/Contents/MacOS/Canary', +// majorVersion: 133 // } return { browsers: config.browsers.filter( @@ -350,8 +357,7 @@ in the **Settings** tab. ### Unsupported Browsers -Some browsers such as Safari and Internet Explorer are not currently supported. -Support for more browsers is on our roadmap. +Some browsers such as Internet Explorer are not currently supported. ## Browser Environment diff --git a/docs/app/references/troubleshooting.mdx b/docs/app/references/troubleshooting.mdx index 5670ccd602..15b4363cb9 100644 --- a/docs/app/references/troubleshooting.mdx +++ b/docs/app/references/troubleshooting.mdx @@ -415,11 +415,20 @@ On Mac, Cypress attempts to find installed browsers by their bundle identifier. If this does not succeed, it will fall back to the Linux browser detection method. -| Browser Name | Expected Bundle Identifier | Expected Executable | -| --------------- | -------------------------- | ------------------------------------- | -| `chrome` | `com.google.Chrome` | `Contents/MacOS/Google Chrome` | -| `chromium` | `org.chromium.Chromium` | `Contents/MacOS/Chromium` | -| `chrome:canary` | `com.google.Chrome.canary` | `Contents/MacOS/Google Chrome Canary` | +| Browser Name | Expected Bundle Identifier | Expected Executable Path | +| -------------------- | ------------------------------------- | -------------------------------------------------------------------------------------- | +| `chrome` | `com.google.Chrome` | `/Applications/Google Chrome.app/Contents/MacOS/Google Chrome` | +| `chrome:beta` | `com.google.Chrome.beta` | `/Applications/Google Chrome Beta.app/Contents/MacOS/Google Chrome Beta` | +| `chrome:canary` | `com.google.Chrome.canary` | `/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary` | +| `chrome-for-testing` | `com.google.chrome.for.testing` | `/Applications/Google Chrome for Testing.app/Contents/MacOS/Google Chrome for Testing` | +| `chromium` | `org.chromium.Chromium` | `/Applications/Chromium.app/Contents/MacOS/Chromium` | +| `firefox` | `org.mozilla.firefox` | `/Applications/Firefox.app/Contents/MacOS/firefox` | +| `firefox:dev` | `org.mozilla.firefoxdeveloperedition` | `/Applications/Firefox Developer Edition.app/Contents/MacOS/firefox` | +| `firefox:nightly` | `org.mozilla.nightly` | `/Applications/Firefox Nightly.app/Contents/MacOS/firefox` | +| `edge` | `com.microsoft.Edge` | `/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge` | +| `edge:beta` | `com.microsoft.Edge.Beta` | `/Applications/Microsoft Edge Beta.app/Contents/MacOS/Microsoft Edge Beta` | +| `edge:canary` | `com.microsoft.Edge.Canary` | `/Applications/Microsoft Edge Canary.app/Contents/MacOS/Microsoft Edge Canary` | +| `edge:dev` | `com.microsoft.Edge.Dev` | `/Applications/Microsoft Edge Dev.app/Contents/MacOS/Microsoft Edge Dev` | For the current list, see [packages/launcher](https://github.com/cypress-io/cypress/blob/develop/packages/launcher/lib/darwin/index.ts) @@ -431,11 +440,20 @@ On Linux, Cypress scans your `PATH` for a number of different binary names. If the browser you are trying to use does not exist under one of the expected binary names, Cypress will not be able to find it. -| Browser Name | Expected Binary Name(s) | -| --------------- | ---------------------------------------------------- | -| `chrome` | `google-chrome`, `chrome`, or `google-chrome-stable` | -| `chromium` | `chromium-browser` or `chromium` | -| `chrome:canary` | `google-chrome-canary` | +| Browser Name | Expected Binary Name(s) | +| -------------------- | ---------------------------------------------------- | +| `chrome` | `google-chrome`, `chrome`, or `google-chrome-stable` | +| `chrome:beta` | `google-chrome-beta` | +| `chrome:canary` | `google-chrome-canary` | +| `chrome-for-testing` | `chrome` | +| `chromium` | `chromium-browser` or `chromium` | +| `firefox` | `firefox` | +| `firefox:dev` | `firefox-developer-edition`, `firefox` | +| `firefox:nightly` | `firefox-nightly`, `firefox-trunk` | +| `edge` | `edge`, `microsoft-edge` | +| `edge:beta` | `edge-beta`, `microsoft-edge-beta` | +| `edge:canary` | `edge-canary`, `microsoft-edge-canary` | +| `edge:dev` | `edge-dev`, `microsoft-edge-dev` | These binary names should work for most Linux distributions. If your distribution packages browsers under a different binary name, you can add a @@ -452,11 +470,20 @@ sudo ln `which chrome` /usr/local/bin/google-chrome On Windows, Cypress scans the following locations to try to find each browser: -| Browser Name | Expected Path | -| --------------- | ------------------------------------------------------------- | -| `chrome` | `C:/Program Files (x86)/Google/Chrome/Application/chrome.exe` | -| `chromium` | `C:/Program Files (x86)/Google/chrome-win32/chrome.exe` | -| `chrome:canary` | `%APPDATA%/../Local/Google/Chrome SxS/Application/chrome.exe` | +| Browser Name | Expected Executable Path | +| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chrome` | `C:/Program Files (x86)/Google/Chrome/Application/chrome.exe`, `C:/Program Files/Google/Chrome/Application/chrome.exe` | +| `chrome:beta` | `C:/Program Files (x86)/Google/Chrome Beta/Application/chrome.exe`, `C:/Program Files/Google/Chrome Beta/Application/chrome.exe` | +| `chrome:canary` | `%APPDATA%/Local/Google/Chrome SxS/Application/chrome.exe` | +| `chrome-for-testing` | `C:/Program Files/Google/Chrome for Testing/chrome.exe`, `C:/Program Files (x86)/Google/Chrome for Testing/chrome.exe` | +| `chromium` | `C:/Program Files (x86)/Google/chrome-win32/chrome.exe` | +| `firefox` | `C:/Program Files/Mozilla Firefox/firefox.exe`, `C:/Program Files (x86)/Mozilla Firefox/firefox.exe`, `%APPDATA%/Local/Mozilla Firefox/firefox.exe` | +| `firefox:dev` | `C:/Program Files/Firefox Developer Edition/firefox.exe`, `C:/Program Files (x86)/Firefox Developer Edition/firefox.exe`, `%APPDATA%/Local/Firefox Developer Edition/firefox.exe` | +| `firefox:nightly` | `C:/Program Files/Firefox Nightly/firefox.exe`, `C:/Program Files (x86)/Firefox Nightly/firefox.exe`, `%APPDATA%/Local/Firefox Nightly/firefox.exe` | +| `edge` | `C:/Program Files (x86)/Microsoft/Edge/Application/msedge.exe` | +| `edge:beta` | `C:/Program Files (x86)/Microsoft/Edge Beta/Application/msedge.exe` | +| `edge:canary` | `%APPDATA%/Local/Microsoft/Edge SxS/Application/msedge.exe` | +| `edge:dev` | `C:/Program Files (x86)/Microsoft/Edge Dev/Application/msedge.exe` | For the current list, see [packages/launcher](https://github.com/cypress-io/cypress/blob/develop/packages/launcher/lib/windows/index.ts)