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
test: user journey tests for Go based snyk code test #5172
base: main
Are you sure you want to change the base?
Conversation
|
c053d34
to
6534150
Compare
const EXIT_CODE_SUCCESS = 0; | ||
const EXIT_CODE_ACTION_NEEDED = 1; | ||
const EXIT_CODE_FAIL_WITH_ERROR = 2; | ||
const EXIT_CODE_NO_SUPPORTED_FILES = 3; | ||
|
||
describe('code', () => { | ||
describe('snyk code test', () => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: move beforeall/after hooks into dedicated describe blocks for user journey tests
expect(code).toBe(EXIT_CODE_ACTION_NEEDED); | ||
|
||
const jsonOutput = JSON.parse(stdout); | ||
expect(jsonOutput).toMatchSchema(SARIF_SCHEMA); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
praise: Very happy to see us validating against the schema rather than the contents 💜
// INTERNAL_SNYK_CODE_IGNORES_ENABLED: 'true', | ||
// }, | ||
// } | ||
]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue: We are missing mocked responses for the new analysis endpoints.
6534150
to
a0ffe17
Compare
Risk assessment
Low - Changes to test files, no functional changes
Pull Request Submission
Please check the boxes once done.
The pull request must:
feat:
orfix:
, others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.Pull Request Review
All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.
Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.
For Node projects: It’s important to make sure changes in
package.json
are also affectingpackage-lock.json
correctly.If a dependency is not necessary, don’t add it.
When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.
Pull Request Approval
Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.
What does this PR do?
This PR changes the structure of the
snyk code
tests intest/jest/acceptance/snyk-code/snyk-code.spec.ts
. It:Where should the reviewer start?
Reviewing the changes to the test file
How should this be manually tested?
make clean build
TEST_SNYK_COMMAND=./binary-releases/<snyk-binary> npx jest ././test/jest/acceptance/snyk-code/snyk-code.spec.ts
Any background context you want to provide?
What are the relevant tickets?
Screenshots
Additional questions