Skip to content

Reduce debug output in tests #75

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.

Sign up for GitHub

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

Jump to bottom
Closed
sampart wants to merge 4 commits into from
Closed

Reduce debug output in tests #75

sampart wants to merge 4 commits into from

Conversation

@sampart
Copy link
Contributor

@sampart sampart commented Jun 23, 2020

The full test output is long, so here's an example of a single test before and after.

Before:

$ npm test

> codeql@0.0.0 test /Users/sam/code/codeql-action
> ava src/fingerprints.test.ts --serial


⠸ hash
⠼ hash

  1 passed::debug::Ignoring location URI "/src/foo/bar.js' as it is outside of the src root
::debug::Ignoring location URI "https:///Users/sam/code/codeql-action/lib/fingerprints.test.js' as the scheme is not recognised
::debug::Ignoring location URI "ftp:///Users/sam/code/codeql-action/lib/fingerprints.test.js' as the scheme is not recognised
::debug::Ignoring location as uri "1" is invalid
::debug::Ignoring location as uri "undefined" is invalid
::debug::Unable to compute fingerprint for non-existent file: /Users/sam/code/codeql-action/lib/fingerprints.test.js2

  4 tests passed

After:

$ npm test

> codeql@0.0.0 test /Users/sam/code/codeql-action
> ava src/fingerprints.test.ts --serial



  4 tests passed

There's still a fair bit of noise that isn't caught by this (e.g. output from system calls), and the output could do with more cleaning generally, but this is a start, and provides a framework for further improvements.

Thanks to @alexrford for pairing with me on much of this.

Merge / deployment checklist

  • Run test builds as necessary. Can be on this repository or elsewhere as needed in order to test the change - please include links to tests in other repos!
    • CodeQL using init/analyze actions
    • 3rd party tool using upload action
  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.

@sampart sampart requested a review from robertbrignull June 23, 2020 09:00
@sampart sampart mentioned this pull request Jun 23, 2020
Closed
4 tasks
sampart
sampart commented Jun 23, 2020
View reviewed changes
src/testing-utils.ts
// Core library will directly call process.stdout.write for commands
// We don't want debug output to be included in tests
if (typeof str === "string") {
str = str.replace(/::(info|debug|warning).*/, '');
Copy link
Contributor Author

@sampart sampart Jun 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't assume that this is at the start of the line, because it gets interleaved with output from Ava, so you might see lines like:

6 passed::debug::{...}

@robertbrignull
Copy link
Contributor

robertbrignull commented Jun 23, 2020

I think you are missing calls to silenceDebugOutput(test) in util.test.ts and setup-tools.test.ts

@sampart
Copy link
Contributor Author

sampart commented Jun 23, 2020

Good spot, thanks. Added in a30a5ba

@robertbrignull robertbrignull mentioned this pull request Jun 23, 2020
Merged
4 tasks
@robertbrignull
Copy link
Contributor

robertbrignull commented Jun 23, 2020

I spent quite a while investigating this to see if I could learn any more or improve things. I ended up opening #79 because that seemed easier. Let me know what you think.

@sampart
Copy link
Contributor Author

sampart commented Jun 24, 2020

Superseded by #79.

@sampart sampart closed this Jun 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@robertbrignull robertbrignull Awaiting requested review from robertbrignull

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sampart @robertbrignull