Add basic documentation for Cypress

I've added some draft text for the Wiki to the issue summary. And created an MR with updated docs for the code in the e2e.js file. I think this is a good start. Happy to add anything else that people might find helpful.

I made a couple of small nits on the MR. For the Wiki, I think more information should be provided around:

Requires an X11 server running on the host machine such as XQuartz on macOS.

It may be common knowledge, but I didn't know what an X11 server was, nor did I know what XQuartz was before trying to install the ddev addon. There are some more steps that are also needed I believe. There is an ongoing discussion on the setup here: https://github.com/tyler36/ddev-cypress/pull/38

A few infrastructure changes were made that changed the test running method; see https://git.drupalcode.org/project/drupal_cms/-/wikis/Contributing-to-Dr....

Do we need to update the proposed documentation to reflect this?

I addressed @thejimbirch's comments in the MR, thanks for the feedback. And added the additional test running examples that @phenaproxima brought up to the proposed text for the Wiki.

Regarding the information about x11 I admittedly have not set this up personally. I think ideally we link to other existing documentation. I'll have a look at the issue you linked and see what I can figure out.

Personally, I set up my local Drupal CMS instance with x11vnc and noVNC on the web container so that I could watch/run the cypress UI via a browser (more like a browser in a browser ... it's a bit of inception, but it works). Do to this I changed the .ddev/config.yml file:

name: drupal-cms-dev
type: drupal
docroot: web
php_version: "8.3"
webserver_type: nginx-fpm
xdebug_enabled: false
additional_hostnames:
  # @see nginx_full/trial.conf
  - drupal-cms-trial
additional_fqdns: []
database:
    type: mariadb
    version: "10.11"
use_dns_when_possible: true
composer_version: "2"
corepack_enable: false
hooks:
  post-start:
    # Generate `composer.json` by merging the project template with our internal
    # dev requirements.
    - exec: 'jq -s ".[0] * .[1]" project_template/composer.json dev.composer.json > composer.json'
    # Add the components as path repositories.
    - exec: "setup-repositories"
    # Install all dependencies.
    - composer: 'install'
    # Copy PHPUnit configuration into the web root.
    - exec: 'cp -f phpunit.xml $DDEV_DOCROOT'
    # Install JavaScript dependencies if needed. The `--foreground-scripts`
    # option is needed to ensure the Cypress binary is actually downloaded;
    # see the warning about Node.js Snap for Linux at
    # https://docs.cypress.io/guides/getting-started/installing-cypress.
    - exec: 'test -d node_modules || npm clean-install --foreground-scripts'
    # Makes sure noVNC is available at https://drupal-cms-dev.ddev.site:6081/.
    - exec: 'cp /usr/share/novnc/vnc.html /usr/share/novnc/index.html'
web_environment:
  # For faster performance, don't audit dependencies automatically.
  - COMPOSER_NO_AUDIT=1
  # To display its UI, Cypress needs to be able to talk to an X11 server
  # running on the host machine.
  # - DISPLAY=host.docker.internal:0
  # Download Cypress to a directory that won't be blown away every time the
  # project is restarted.
  - CYPRESS_CACHE_FOLDER=/var/www/html/.cache/cypress
  # Use the DDEV-provided database to run PHPUnit tests.
  - SIMPLETEST_DB=$DDEV_DATABASE_FAMILY://db:db@db/db
  - SIMPLETEST_BASE_URL=$DDEV_PRIMARY_URL
webimage_extra_packages:
  # Add Cypress' system dependencies.
  # See https://docs.cypress.io/guides/getting-started/installing-cypress#UbuntuDebian
  - libgtk2.0-0
  - libgtk-3-0
  - libgbm-dev
  - libnotify-dev
  - libnss3
  - libxss1
  - libasound2
  - libxtst6
  - xauth
  - xvfb
  # Additional browsers for Cypress to test against.
  - chromium
  - firefox-esr
  # Packages for setting of noVNC to watch Cypress tests.
  - novnc
  - x11vnc
web_extra_exposed_ports:
 - name: novnc
   container_port: 6080
   http_port: 6080
   https_port: 6081
web_extra_daemons:
  - name: Xvfb
    command: Xvfb :0 -screen 0 1920x1280x16
    directory: /var/www/html
  - name: x11vnc
    command: x11vnc -display :0 -forever -nopw
    directory: /var/www/html
  # Make noVNC available at https://drupal-cms-dev.ddev.site:6081/vnc.html
  - name: novnc
    command: /usr/share/novnc/utils/novnc_proxy --web /usr/share/novnc --vnc localhost:5900
    directory: /usr/share/novnc

And now I can run ddev launch :6081/vnc.html and it launches to watch the results of ddev exec npx cypress open. Which might be a bit more portable. Though I can't say if one approach is better than the other for any reason.

Rebased and resolved the conflicts & pipeline is also green. But two additional commands were added, so need to check the documentation.

A few minor things but this looks fantastic. Thanks for doing this!

I've addressed all the feedback in the review so this is now ready for another pass.

Perfect.

Document the things. All the things. Merged into 0.x, thanks!

Automatically closed - issue fixed for 2 weeks with no activity.