avajs/ava

Report does not contain a reference to the location of the test when using macros or helpers from another file

Open

#2722 opened on Mar 20, 2021

View on GitHub
 (5 comments) (2 reactions) (0 assignees)JavaScript (20,600 stars) (1,408 forks)batch import
help wantedscope:assertionsscope:reporters

Description

When using a macro, the failure report does not include a line number that could be used to navigate to the test.

Example of the report:

  Number must be 5

  Difference:

  - 4
  + 5

  › macro (typescript/helper/macro.ts:4:7)

Reproduction: https://github.com/MatthiasKunnen/ava-line-number-reproduction. AVA version: 3.15.0. AVA configuration: See repo.

Proposal
Capture the line number when test is invoked and either add it to the stack trace or add it above the diff, e.g. typescript/spec/something.spec.ts:7

Notes Interestingly, the report is a bit different when the macro is inside vs outside the spec file. This can be seen on the root commit in the reproduction repository. Example diff with the + side representing a macro outside the spec file:

Number must be 5

-typescript/spec/something.spec.ts:4

-3: const macro: Macro<[number]> = (t, number) => {
-4:     t.is(number, 5);                           
-5: }

Difference:

﹣ 4
﹢ 5

-› macro (typescript/spec/something.spec.ts:4:7)
+› macro (typescript/helper/macro.ts:4:7)

Contributor guide

Tech stack
javascripttypescriptnodejs
Domain
testingdeveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js basicsAVA test runner familiarityStack trace handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate how AVA captures the call site of test assertions, focusing on the code that generates the stack trace or failure report. Start by examining the test execution logic, possibly in the 'lib' directory. The reproduction repository at https://github.com/MatthiasKunnen/ava line number reproduction demonstrates the issue and can be used to verify any changes.