• Options
  • Config File
  • Override Config File
  • Warning Behavior
  • Run partial test cases
  • Whether collect coverage information
  • Isolated Execution

Options

Config File

  --config <config file>                 path of config file (default: "as-test.config.js")

Override Config File

Command line options have higher priority then config file, so that it can override the configuration in as-test.config.js.

Warning Behavior

  --coverageLimit [error warning...]     set warn(yellow) and error(red) upper limit in coverage report

Run partial test cases

  --testFiles <test files...>              only run specified test cases
  --testNamePattern <test name pattern>  run only tests with a name that matches the regex pattern
  --onlyFailures                         Run tests that failed in the previous

There are several ways to run partial test cases:

Run specified test files

Providing file path to --testFiles, it can specify a certain group of files for testing.

TIP

--testFiles can accept multiple file paths.

Details

- a.test.ts
|- case_1
|- case_2
- b.test.ts
|- case_A
- c.test.ts
|- case_4

run as-test --testFiles a.test.ts b.test.ts will match all tests in a.test.ts and b.test.ts

Run partial tests using a regex name pattern

Providing regex which can match targeted test name to --testNamePattern, it can specify a certain group of tests for testing.

Details

describe("groupA", () => {
  test("case_1", () => {
    ...
  });
  test("case_2", () => {
    ...
  });
  test("case_3", () => {
    ...
  });
});

describe("groupB", () => {
  test("case_A", () => {
    ...
  });
  test("case_B", () => {
    ...
  });
  test("case_C", () => {
    ...
  });
});

run as-test --testNamePattern "groupA case_\d" will run case_1, case_2, case_3.

TIP

The framework join DescriptionName and TestName with " " by default, e.g. groupA case_1 is the full test case name of case_1.

Run only failures

Provides --onlyFailures command line option to run the test cases that failed in the previous test only.

Whether collect coverage information

  --collectCoverage <boolean>            whether to collect coverage information and report

The framework collects coverage and generates reports by default, but it will be disablea while running partial test cases by --testFiles or --testNamePattern.

You can control the coverage collection manually with --collectCoverage option.

Isolated Execution

Isolated test execution helps isolate error propagation between different test scenarios and reduces the burden of restoring context, which is very helpful for rapid technical verification. However, as the project scales, isolated test execution will compile the source code multiple times, slowing down overall test performance. In this case, restoring the context in code and disabling the isolated option after testing can reduce test time.

TIP

In version 1.4.x, isolated is enabled by default. After version 2.x, isolated is disabled by default.

• enable/disable by config:

  {
    // enable
    isolated: true
    // disable
    isolated: false
  }

• enable/disable by cli

  npx as-test ... --isolated true
  npx as-test ... --isolated false