Skip to content

Verbose output of test builder isn't verbose enough #1257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jscholes opened this issue Apr 25, 2025 · 4 comments
Open

Verbose output of test builder isn't verbose enough #1257

jscholes opened this issue Apr 25, 2025 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@jscholes
Copy link
Contributor

The create-all-tests script accepts --verbose and --validate flags, intended to help in debugging when a test plan won't build for whatever reason. Unfortunately, output only seems to be logged when:

  • A part of the process completes successfully (such as parsing a CSV file); and
  • explicit errors are thrown.

The script does not, however, log actions it is about to take, nor which file/row/column is being processed. As such, when an unexpected problem occurs, such as that highlighted in #1244, the test plan author is left at a complete loss about where to start looking for the issue.

Sticking with that example, there is literally no output when running node scripts\create-all-tests --verbose --validate --testplan=hang-sample:

  • There are no successful actions for the script to report because it hangs almost immediately.
  • There is no error thrown, because the regexp parser is technically doing its job albeit in a way that causes the script to hang.

As a result, it took me over an hour to track down exactly where the failure was occuring. Consider that if the script had output something like the following instead, it would've been a lot more obvious:

>node scripts\create-all-tests --verbose --validate --testplan=hang-sample
Validating row 0 in data/tests.csv for test plan "hang-sample".
Processing tests.csv column: testId
Processing tests.csv column: title
Processing tests.csv column: presentationNumber
Processing tests.csv column: setupScript
Processing tests.csv column: instructions
Processing tests.csv column: assertions

... it would've been immediately obvious that the script froze right after trying to validate the assertions column on that specific row of that specific file.

CC @howard-e

@jscholes jscholes added the bug Something isn't working label Apr 25, 2025
@mcking65
Copy link
Contributor

mcking65 commented May 1, 2025

@ccanash

The seems like a pretty light-weight request with significant productivity benefits. I'm adding it to the ops and maintenance project as a P1.

@ccanash
Copy link

ccanash commented May 5, 2025

@mcking65 this is noted. I will add it to triage and move it to the aria-at-app repo.

@ccanash ccanash transferred this issue from w3c/aria-at May 5, 2025
@jscholes
Copy link
Contributor Author

jscholes commented Jun 4, 2025

@ccanash This issue relates to scripts in the aria-at repo. The PR to fix it would presumably be submitted to that repo, so I don't think this issue belongs under the app.

@ccanash ccanash added the bug Something isn't working label Jun 10, 2025
@ccanash ccanash transferred this issue from w3c/aria-at-app Jun 10, 2025
@ccanash
Copy link

ccanash commented Jun 10, 2025

This task had been added to the 2024 project by mistake, I have re added it to the 2025 maintenance project and will added it to our queue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants