Coverage report for a single file?

[ilg-ul]

Hi,

I'm successfully using tap for my TypeScript projects. However, during development, while working on a single file, I prefer to run tap only for that file, to save some time.

    "test-ci": "tap run --reporter=terse --disable-coverage",
    "test": "tap run --disable-coverage",
    "test-coverage": "tap run",
    "test-all": "tap run --reporter=tap --disable-coverage",
    "test-one-010": "tap run --reporter=tap tests/tap/010-*.ts",
    "test-one-020": "tap run --reporter=tap tests/tap/020-*.ts",
    ...

The singular test itself runs fine, but I'm puzzled that the coverage report always shows the full list of tested files, each with various (and totally irelevant in this use case) coverage figures.

Is this the expected behaviour? Is it possible to somehow configure tap to show the coverage figures only for the input files?

I'm running tap 21.5.0 and the configuration is:

> tap config list

# vim: set filetype=yaml :

# from .taprc
allow-empty-coverage: true
allow-incomplete-coverage: true
branches: 100
browser: true
color: true
coverage-report:
  - text
files:
  - tests/tap/*.ts
functions: 100
lines: 100
reporter: terse
show-full-coverage: true
snapshot-clean-cwd: true
statements: 100
timeout: 30

# env, cli, and defaults
exclude:
  - "**/@(fixture*(s)|dist)/**"
include:
  - "**/@(test?(s)|__test?(s)__)/**/*.@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
  - "**/*.@(test?(s)|spec).@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
  - "**/test?(s).@(js|cjs|mjs|tap|cts|jsx|mts|ts|tsx)"
jobs: 9

Here is an example of a simple run:

> @xpack/[email protected] test-one-110
> tap run --reporter=tap tests/tap/110-*.ts

TAP version 14
1..1
# Subtest: tests/tap/110-classes-policies.ts
    # Subtest: XpmPolicies
        ok 1 - minVersion set to default
        ok 2 - shareNpmDependencies false
        ok 3 - nonHierarchicalLocalXpacksFolder false
        ok 4 - onlyStringDependencies false
        ok 5 - singleParameterXpmInitTemplate false
        1..5
    ok 1 - XpmPolicies # time=7.023ms
    
    # Subtest: XpmPolicies 0.1.2
        ok 1 - minVersion set correctly
        ok 2 - shareNpmDependencies true
        ok 3 - nonHierarchicalLocalXpacksFolder true
        ok 4 - onlyStringDependencies true
        ok 5 - singleParameterXpmInitTemplate true
        1..5
    ok 2 - XpmPolicies 0.1.2 # time=0.86ms
    
    # Subtest: XpmPolicies 0.14.0
        ok 1 - shareNpmDependencies false
        ok 2 - nonHierarchicalLocalXpacksFolder true
        ok 3 - onlyStringDependencies true
        ok 4 - singleParameterXpmInitTemplate true
        1..4
    ok 3 - XpmPolicies 0.14.0 # time=0.804ms
    
    # Subtest: XpmPolicies 0.16.0
        ok 1 - shareNpmDependencies false
        ok 2 - nonHierarchicalLocalXpacksFolder false
        ok 3 - onlyStringDependencies false
        ok 4 - singleParameterXpmInitTemplate true
        1..4
    ok 4 - XpmPolicies 0.16.0 # time=0.499ms
    
    # Subtest: XpmPolicies 0.22.0
        ok 1 - shareNpmDependencies false
        ok 2 - nonHierarchicalLocalXpacksFolder false
        ok 3 - onlyStringDependencies false
        ok 4 - singleParameterXpmInitTemplate false
        1..4
    ok 5 - XpmPolicies 0.22.0 # time=0.493ms
    
    1..5
ok 1 - tests/tap/110-classes-policies.ts # time=1570.323ms

-----------------------------|---------|----------|---------|---------|---------------------------------------------------
File                         | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s                                 
-----------------------------|---------|----------|---------|---------|---------------------------------------------------
All files                    |   37.78 |       25 |    7.69 |   37.78 |                                                   
 src                         |     100 |      100 |     100 |     100 |                                                   
  index.ts                   |     100 |      100 |     100 |     100 |                                                   
 src/classes                 |   16.44 |       25 |   16.66 |   16.44 |                                                   
  actions.ts                 |    9.34 |        0 |       0 |    9.34 | 70-715,742-1036                                   
  build-configurations.ts    |    5.96 |        0 |       0 |    5.96 | 75-757,783-1692                                   
  data-model.ts              |   22.15 |        0 |       0 |   22.15 | 69-314                                            
  errors.ts                  |     100 |      100 |     100 |     100 |                                                   
  init-template-base.ts      |   10.76 |        0 |       0 |   10.76 | 65-611                                            
  liquid-drop.ts             |   24.54 |        0 |       0 |   24.54 | 56-179,204-328                                    
  liquid-engine.ts           |   46.61 |      100 |       0 |   46.61 | 102-190,197-233                                   
  package.ts                 |   10.15 |        0 |       0 |   10.15 | 71-707                                            
  policies.ts                |     100 |      100 |     100 |     100 |                                                   
 src/data                    |     100 |      100 |     100 |     100 |                                                   
  substitutions-variables.ts |     100 |      100 |     100 |     100 |                                                   
 src/functions               |    75.6 |      100 |       0 |    75.6 |                                                   
  chmod-recursively.ts       |   52.34 |      100 |       0 |   52.34 | 69-121,126,131-147                                
  filter-paths.ts            |   90.32 |      100 |       0 |   90.32 | 56-57,85-89,118-122                               
  is-something.ts            |   91.75 |      100 |       0 |   91.75 | 38-41,66-67,90-91,112-113,139-140,163-164,191-192 
  perform-substitutions.ts   |   60.58 |      100 |       0 |   60.58 | 86-136,149-152,157-168                            
  utils.ts                   |   84.95 |      100 |       0 |   84.95 | 51-55,94-101,108-111                              
 src/types                   |     100 |      100 |     100 |     100 |                                                   
  json.ts                    |     100 |      100 |     100 |     100 |                                                   
  xpm-init-template.ts       |     100 |      100 |     100 |     100 |                                                   
  xpm.ts                     |     100 |      100 |     100 |     100 |                                                   
-----------------------------|---------|----------|---------|---------|---------------------------------------------------
# { total: 22, pass: 22 }
# time=1824.264ms

[isaacs]

Use a coverage map.

Here's an example

[ilg-ul]

In case someone else will stumble on this issue, here is a bit more detailed explanation:

I renamed all test files in tests/tap to have the same names as the source file in src, then I created a small coverage-map.js file that exports a default function that maps each test file to the corresponding source file:

export default function getCoverageMapFiles (testFilePath) { 
  const sourceFilePath = testFilePath.replace(/tests\/tap/, 'src')
  // console.log(`Getting coverage map for source file: ${sourceFilePath}`)
  return sourceFilePath
}

When I run a single test, I pass this file to tap run via the ----coverage-map= option:

   "test-one": "tap run --reporter=tap --coverage-map=tests/coverage-map.js tests/tap/classes/init-template-base.ts",

When I run all tests and need to show the coverage results for the entire project, I do not pass any map, neither in .taprc nor on the command line and the default (to show maps for all source files) applies.

[isaacs]

You could even make this a little bit cuter by leaning on the npm_lifecycle_event environment variable.

package.json

{
  "scripts": {
    "test": "tap",
    "test-one": "tap --reporter=tap"
  }
}

.taprc

coverage-map: map.js

map.js

const event = process.env.npm_lifecycle_event ?? 'test'
export default testFile => event === 'test-one' ? testFilePath.replace(/tests\/tap/, 'src')
  : [] // just the default, cover everything
// and you could of course have even more different coverage-map behavior for all those
// different test-all, test-010, test-02x, etc script names in your package.json
// the sky's the limit!

Then, to run a "focused coverage" run, you'd do:

# could of course put more than one filename here, if you want
npm run test-one tests/tap/classes/init-template-base.ts
# or
pnpm test-one tests/tap/classes/init-template-base.ts

And to do the "all tests cover all things" type of run, you'd just do the normal

npm test