Skip to content
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

feat: use sbom api v2024-04-22 #5204

Merged
merged 1 commit into from Apr 29, 2024
Merged

Conversation

dekelund
Copy link
Contributor

@dekelund dekelund commented Apr 26, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • N/A link to the link to the PR for the User-facing documentation N/A
  • User facing Documentation
    • N/A update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here N/A
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , 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.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

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 affecting package-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?

feat: use sbom api v2024-04-22

  • Use RFC 3339 for all timestamps in sbom test result
  • Introduced by should pick the first occurrence for human readable sbom
    test.

Risk: Low - Medium

Breaking change: Fixes so all timestamp fields follow RFC 3339, any implementation making use of the wrong format, might need to update how the digest the json output.

Where should the reviewer start?

I would start by verifying the behaviour of the test suite.

Tests related to this change:

How should this be manually tested?

Run following from the CLI:

make build
./binary-releases/snyk-macos-arm64 sbom test --experimental --file=./test/fixtures/sbom/npm-sbom-cdx15.json
./binary-releases/snyk-macos-arm64 sbom test --experimental --file=./test/fixtures/sbom/npm-sbom-cdx15.json --json

Verify that the human readable version contains just one introduced by and that it's the earliest version.
Verify that the timestamps in the json fields follows RFC 3339.

Feel free to test with different SBOM documents.

What are the relevant tickets?

Screenshots

image image

Additional questions

@dekelund dekelund force-pushed the feat/use-sbom-api-v2024-04-22 branch 6 times, most recently from e87d2bd to 5bcd02e Compare April 29, 2024 09:34
Copy link
Contributor

github-actions bot commented Apr 29, 2024

Warnings
⚠️

Since the CLI is unifying on a standard and improved tooling, we're starting to migrate old-style imports and exports to ES6 ones.
A file you've modified is using either module.exports or require(). If you can, please update them to ES6 import syntax and export syntax.
Files found:

  • test/fixtures/sbom/npm-sbom-test-response.json

Generated by 🚫 dangerJS against de127b5

@dekelund dekelund force-pushed the feat/use-sbom-api-v2024-04-22 branch from 5bcd02e to 7381f22 Compare April 29, 2024 10:04
@dekelund dekelund marked this pull request as ready for review April 29, 2024 10:34
@dekelund dekelund requested a review from a team as a code owner April 29, 2024 10:34
- Use RFC 3339 for all timestamps in sbom test result
- Introduced by should pick the first occurrence for human readable sbom
  test.
@dekelund dekelund force-pushed the feat/use-sbom-api-v2024-04-22 branch from 2060f01 to de127b5 Compare April 29, 2024 14:22
@dekelund dekelund enabled auto-merge (squash) April 29, 2024 14:25
@dekelund dekelund merged commit 91bf191 into main Apr 29, 2024
15 checks passed
@dekelund dekelund deleted the feat/use-sbom-api-v2024-04-22 branch April 29, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants