Merge branch 'master' into add/chrome-for-testing

Author: MikeMcC399

README.md

@@ -157,6 +157,34 @@ container:
 
 See [Tag Selection](#tag-selection) above for advice on selecting a non-default image tag.
 
+## EACCES permission denied binary_state.json
+
+### Problem
+
+If a custom Docker image is built from a `cypress/base` or `cypress/browsers` Cypress Docker image, using a `Dockerfile` to install the Cypress binary (for instance with `npx cypress install`), and the custom image is then run as a container with a non-root user, Cypress will fail to run with an error message:
+
+> Error: EACCES: permission denied, open '/root/.cache/Cypress/`<Cypress version>`/binary_state.json'
+
+This is due to an open Cypress issue [#30684](https://github.com/cypress-io/cypress/issues/30684) where Cypress fails to verify the installed Cypress binary if it does not have write access to the Cypress binary directory.
+
+### Workaround
+
+To workaround this issue, either make the Cypress binary directory writable, or skip the Cypress binary verification.
+
+To make the complete Cypress binary directory writable, add the following to the `Dockerfile` after the step to install the Cypress binary:
+
+```Dockerfile
+RUN chmod -R 777 /root/.cache/Cypress
+```
+
+To skip Cypress binary verification using the environment variable `CYPRESS_SKIP_VERIFY`, described in the Cypress documentation [Advanced Installation](https://docs.cypress.io/app/references/advanced-installation#Environment-variables), either add the following to the `Dockerfile`:
+
+```Dockerfile
+ENV CYPRESS_SKIP_VERIFY=true
+```
+
+or pass the environment variable as an additional CLI option `--env CYPRESS_SKIP_VERIFY=true` to the [docker run](https://docs.docker.com/reference/cli/docker/container/run/) command.
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)

examples/included-as-non-root/README.md

@@ -33,3 +33,20 @@ docker run --rm -v .:/test -w /test -u node cypress/included
 ```
 
 You can expect this command to run successfully.
+
+## GitHub Actions
+
+In general when running Cypress Docker images in GitHub Actions it is recommended to use the GitHub Actions' `container` syntax (see [Running jobs in a container](https://docs.github.com/en/actions/writing-workflows/choosing-where-your-workflow-runs/running-jobs-in-a-container) and [.github/workflows/example-cypress-github-action.yml](../../.github/workflows/example-cypress-github-action.yml)).
+
+If however Docker is run directly in a GitHub Actions workflow, such as:
+
+```yaml
+- run: docker run --rm -v .:/test -w /test -u node cypress/included
+  working-directory: examples/included-as-non-root
+```
+
+then the `docker` command will be run from GitHub's `runner` user `1001` and the Cypress Docker image `node` user `1000` will have no write access to the `/test` directory. Cypress will warn that the project root directory is read-only and that screenshots and videos cannot be captured.
+
+To enable screenshot and video captures, redirect the folders to a writable folder, such as `/tmp`. See [cypress.config.js](./cypress.config.js) for an example.
+
+Pending resolution of Cypress issue https://github.com/cypress-io/cypress/issues/30810, Cypress will however still produce a warning.

examples/included-as-non-root/cypress.config.js

@@ -1,8 +1,11 @@
-const { defineConfig } = require('cypress')
+const { defineConfig } = require('cypress');
 
 module.exports = defineConfig({
+  downloadsFolder: '/tmp/cypress/downloads',
+  screenshotsFolder: '/tmp/cypress/screenshots',
+  videosFolder: '/tmp/cypress/videos',
   fixturesFolder: false,
   e2e: {
     supportFile: false,
   },
-})
+});

examples/included-as-non-root/cypress/e2e/spec.cy.js

@@ -2,5 +2,6 @@ describe('test local demo page', () => {
   it('heading', () => {
     cy.visit('index.html')
     cy.contains('h2', 'Test')
+    cy.screenshot()
   })
 })