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: support cyclonedx 1.5 #5123

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Conversation

dekelund
Copy link
Contributor

@dekelund dekelund commented Mar 19, 2024

Pull Request Submission

Risk assessment: Low-Medium

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.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • 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?

Updates the cli-extension-sbom version to the latest one which adds the new SBOM formats cyclonedx1.5+json and cyclonedx1.5+xml and adds additional acceptance tests.

In short:

  • Updated snyk sbom to accept CycloneDX 1.5
  • Updated snyk container sbom to accept CycloneDX 1.5

This was accomplished by mainly updating two packages:

  • github.com/snyk/cli-extension-sbom
  • github.com/snyk/container-cli

We have also updated acceptance tests to test the new changes and instructions has been added to the documentation.

Where should the reviewer start?

Verify that it's the correct version in go.mod, and run the command from the manual step below.
Then verify that the tests are actually testing what we claim.

How should this be manually tested?

For acceptance tests:

  • npx jest --runInBand --testPathPattern '/test(/jest)?/acceptance/snyk-container/container.spec.ts'
  • npx jest --runInBand --testPathPattern '/test(/jest)?/acceptance/snyk-sbom/sbom.spec.ts

Manual tests:

  • docker pull postgres:13.7-alpine
  • snyk container sbom --format cyclonedx1.5+json postgres:13.7-alpine

What are the relevant tickets?

UNIFY-38

Additional questions

@dekelund dekelund force-pushed the feat/support-cyclonedx-1_5-UNIFY-38 branch from 1350027 to 3b10250 Compare March 19, 2024 08:46
@dekelund dekelund changed the title Feat: support CycloneDX 1.5 feat: support cyclonedx 1.5 Mar 19, 2024
@dekelund dekelund force-pushed the feat/support-cyclonedx-1_5-UNIFY-38 branch 3 times, most recently from 1dcaeb6 to 6e4990c Compare March 22, 2024 14:11
@dekelund dekelund marked this pull request as ready for review March 22, 2024 14:39
@dekelund dekelund requested a review from a team as a code owner March 22, 2024 14:39
@dekelund dekelund force-pushed the feat/support-cyclonedx-1_5-UNIFY-38 branch from 6e4990c to 039848b Compare March 22, 2024 14:46
- Updated `snyk sbom` to accept CycloneDX 1.5
- Updated `snyk container sbom` to accept CycloneDX 1.5

Co-authored-by: Paul Rosca <paul.rosca@snyk.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants