puppeteer/tools/mochaRunner
Alexandra Borovova 47f51c8a7d
chore: forward mocha arguments through the custom runner (#9502)
<!-- Thanks for submitting a pull request! Please provide enough
information so that others can review your pull request. -->

**What kind of change does this PR introduce?**

This is a change to a custom mocha runner to forward arguments to mocha.

**Summary**

In order to start using puppeteer custom mocha runner, the Firefox team
needs to forward some arguments to mocha through the runner to make it
compatible with our log parser.

**Does this PR introduce a breaking change?**

no
2023-01-13 09:51:59 +00:00
..
src chore: forward mocha arguments through the custom runner (#9502) 2023-01-13 09:51:59 +00:00
README.md chore: refactor utils (#9053) 2022-10-06 10:27:14 +02:00
tsconfig.json chore: refactor utils (#9053) 2022-10-06 10:27:14 +02:00

Mocha Runner

Mocha Runner is a test runner on top of mocha. It uses /test/TestSuites.json and /test/TestExpectations.json files to run mocha tests in multiple configurations and interpret results.

Running tests for Mocha Runner itself.

npm run build:test && npx c8 node tools/mochaRunner/lib/test.js

Running tests using Mocha Runner

npm run build:test && npm run test

By default, the runner runs all test suites applicable to the current platform. To pick a test suite, provide the --test-suite arguments. For example,

npm run build:test && npm run test -- --test-suite chrome-headless

TestSuites.json

Define test suites via the testSuites attribute. parameters can be used in the TestExpectations.json to disable tests based on parameters. The meaning for parameters is defined in parameterDefinitons which tell what env object corresponds to the given parameter.

TestExpectations.json

An expectation looks like this:

  {
    "testIdPattern": "[accessibility.spec]",
    "platforms": ["darwin", "win32", "linux"],
    "parameters": ["firefox"],
    "expectations": ["SKIP"]
  }

testIdPattern defines a string that will be used to prefix-match tests. platforms defines the platforms the expectation is for (or-logic). parameters defines the parameters that the test has to match (and-logic). expectations is the list of test results that are considered to be acceptable.

Currently, expectations are updated manually. The test runner outputs the suggested changes to the expectation file if the test run does not match expectations.