test: unexpected-error test expects non-colored output #4813
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
candrews
added a commit
to candrews/snyk-cli
that referenced
this pull request
Aug 25, 2023
apply patch for unexpected-error test expects non-colored output See: snyk#4813
candrews
added a commit
to candrews/snyk-cli
that referenced
this pull request
Aug 25, 2023
candrews
force-pushed
the
unexpected-error-FORCE_COLOR
branch
from
c2c701c
to
32a1094
Compare
The assertions in unexpected-error.spec.ts expect the output being tested to not contain ANSI color codes. To ensure that is always the case, set FORCE_COLOR="0" so node doesn't output colors. Without this change, this test will pass or fail depending upon the terminal being used to run the tests. With this change, the test runs consistently.
candrews
force-pushed
the
unexpected-error-FORCE_COLOR
branch
from
32a1094
to
558514e
Compare
candrews
added a commit
to candrews/snyk-cli
that referenced
this pull request
Aug 25, 2023
candrews
added a commit
to candrews/snyk-cli
that referenced
this pull request
Aug 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
The assertions in unexpected-error.spec.ts expect the output being tested to not contain ANSI color codes. To ensure that is always the case, set
FORCE_COLOR="0"so node doesn't output colors.Without this change, this test will pass or fail depending upon the terminal being used to run the tests. With this change, the test runs consistently.
Where should the reviewer start?
The diff for the PR is small so I'd start with the diff.
How should this be manually tested?
Run the test with
TERMunset,TERM=dumb,TERM=xterm,TERM=xterm-256color, and any other desired values. Note that with this change, theunexpected-errortests consistently pass.Any background context you want to provide?
Relevant node documentation: https://nodejs.org/dist/latest-v18.x/docs/api/cli.html#force_color1-2-3
What are the relevant tickets?
No, but I can make one if that would be helpful - just point me to the instructions to do so :)
Screenshots
n/a
Additional questions