/test-tag-sample

Primary LanguageTypeScript

test-tag-sample

Getting Started

npm install

What is tags

Tags are words enclosed in square brackets [ and ], that is used to add additional information to test cases and test suites. For example, they can convey information such as:

  • [freaky]: freaky or not?
  • [smoke]: a target or not for smoke testing?
  • [S] / [M] / [L]: test size

Running tests

With specific tags

Jest

The --testNamePattern option is available.

$ npx jest --testNamePattern '\[smoke]'

Mocha

The --fgrep option is useful.

$ nyc mocha **/*.test.ts --fgrep '[smoke]'

Vitest

Same as Jest.

$ npx vitest run --testNamePattern '\[smoke]'

Node.js test runner

Use --test-name-pattern.

$ node --require ts-node/register  --test-name-pattern '\[freaky]' --test **/node.test.ts

Without specific tags

Jest

We can use negative lookahead in regular expressions.

$ npx jest --testNamePattern '^(?!.*\\[freaky]).*$'

Mocha

We can combine --fgrep and --invert.

$ npx nyc mocha **/*.test.ts --fgrep '[freaky]' --invert

Vitest

$ npx vitest run --testNamePattern '^(?!.*\[freaky]).*$'

Node.js test runner

This does not work fine. Negative lookahead is not available with --test-name-pattern?

$ node --require ts-node/register  --test-name-pattern '^(?!.*\[freaky]).*$' --test **/node.test.ts

Appendix

Benchmarking

$ hyperfine -w 3 "npm run jest:testWithout:freaky"
Benchmark 1: npm run jest:testWithout:freaky
  Time (mean ± σ):      3.258 s ±  0.118 s    [User: 5.346 s, System: 0.464 s]
  Range (min … max):    3.128 s …  3.483 s    10 runs

$ hyperfine -w 3 "npm run mocha:testWithout:freaky"
Benchmark 1: npm run mocha:testWithout:freaky
  Time (mean ± σ):     938.2 ms ±   9.3 ms    [User: 809.5 ms, System: 139.0 ms]
  Range (min … max):   929.6 ms … 956.9 ms    10 runs

$ hyperfine -w 3 "npm run vitest:testWithout:freaky"
Benchmark 1: npm run vitest:testWithout:freaky
  Time (mean ± σ):      1.020 s ±  0.009 s    [User: 1.146 s, System: 0.215 s]
  Range (min … max):    1.010 s …  1.039 s    10 runs

$ hyperfine -w 3 "npm run node:testWith:freaky"
Benchmark 1: npm run node:testWith:freaky
  Time (mean ± σ):      1.712 s ±  0.100 s    [User: 2.533 s, System: 0.236 s]
  Range (min … max):    1.646 s …  1.972 s    10 runs