Skip to content

Latest commit

 

History

History
75 lines (57 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

75 lines (57 loc) · 3.17 KB
Raw

Contribution guide

This document is currently a work in progress and is not yet comprehensive. Additional info will be added over time.

Running e2e tests

End-to-end testing of html-reporter consists of two stages: generating fixture reports using different tools and tests, then running hermione tests on these reports.

In order to make e2e/screenshot tests stable and reproducible across different environments, you need to launch browsers inside a Docker container.

  1. Make sure you have Docker installed.

    How to?
    1. If you want to make a personal open-source contribution, you may use Docker free of charge and follow the official guide.
    2. If you are acting on behalf of a company, you may not have access to Docker Desktop. In this case:
      • On Linux, you may follow the official installation guide.
      • On Mac, you may use colima as a replacement for Docker Desktop.
      • On Windows, you may use Windows Subsystem for Linux to run the Docker CLI without the Desktop application.

  2. Start an image with browsers:

    npm run browsers:launch

  3. Run e2e tests:

    npm run e2e

End-to-end tests are divided into multiple workspaces:

  • test/func/packages — packages needed for generating fixture reports, e.g. test html-reporter plugins
  • test/func/fixtures — packages to generate fixture reports
  • test/func/tests — hermione tests that run on fixture reports

If you want a finer-grained control over the process, the following commands may be useful:

  • npm run e2e:generate-fixtures — generate fixture reports to run tests on
  • npm run --workspace=test/func/tests gui:plugins — launch hermione GUI for the plugins tests set
  • npm run e2e:test — run e2e tests only, without building packages or generating fixtures

Working with browser docker images

Building an image for current platform

If you want to build an image with browsers you can use this command:

  • npm run browsers:build:local

Building a multiplatform image on Mac (Apple Silicon)

If you use colima then you can follow these steps to build a multiplatform image:

  1. Install buildx
    • brew install docker-buildx
    • docker buildx install
  2. Start 2 instances
    • colima start --profile amd --arch amd
    • colima start --profile arm --arch arm
  3. Create a buildx context to use the created instances as nodes
    • docker buildx create --use --name custom colima-amd
    • docker buildx create --append --name custom colima-arm
  4. Build and publish an image
    • npm run browsers:build-and-push

Note: to use already created buildx instance, execute this command:

  • docker buildx use custom

Managing multiple colima instances

To get the list of all colima instances you can use colima list. To use specific colima instance, you have to set DOCKER_HOST environment variable. To get the desired value for DOCKER_HOST, use colima status [INSTANCE]

If you want to update chromedriver or chrome version, change the variables at the beginning of the Dockerfile.