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 --print-graph with mvn-plugin #5225

Merged
merged 3 commits into from May 14, 2024

Conversation

dekelund
Copy link
Contributor

@dekelund dekelund commented May 7, 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.
    • N/A - 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
  • User facing Documentation
    • N/A - 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?

This PR bumps the snyk-mvn-plugin version to disable depgraph pruning when --print-graph has been provided.

Risk assessment: low, since end users are not intended to make use of --print-graph directly.

Where should the reviewer start?

This is just a bump of the plugin, hence start with the package.json file.
Then take a look at the acceptance test, to make sure we are covering what we expect to be covered.

How should this be manually tested?

  • Run make build
  • Run cd ./test/fixtures/maven-print-graph
  • Run node /Users/ekelund/src/github.com/snyk/cli/dist/cli/index.js test --print-graph
  • Verify that pruning did not happen

To test SBOM behaviour

Generate result from previous implementation:

  • cp -R ./test/fixtures/maven-print-graph /tmp/maven-print-graph
  • git checkout HEAD^ # to checkout build before this patch
  • make clean
  • make build
  • ./binary-releases/snyk-macos-arm64 sbom --file=/tmp/maven-print-graph/pom.xml --format=cyclonedx1.4+json | jq > /tmp/before.json

Generate result from the new implementation:

  • git checkout HEAD^ # to checkout this patch
  • make clean
  • make build
  • ./binary-releases/snyk-macos-arm64 sbom --file=/tmp/maven-print-graph/pom.xml --format=cyclonedx1.4+json | jq > /tmp/after.json

Compare the results:

  • Use vimdiff /tmp/before.json /tmp/after.json and verify the changes (see screenshot below)

What are the relevant tickets?

snyk-mvn-plugin PR177

Screenshots

image

@dekelund dekelund force-pushed the feat/support---print-graph-with-mvn-plugin branch 9 times, most recently from 3680525 to e6bc660 Compare May 10, 2024 09:35
@dekelund dekelund force-pushed the feat/support---print-graph-with-mvn-plugin branch from e6bc660 to fbb33d7 Compare May 10, 2024 09:52
@dekelund dekelund marked this pull request as ready for review May 10, 2024 11:03
@dekelund dekelund requested a review from a team as a code owner May 10, 2024 11:03
Copy link
Contributor

@cmars cmars left a comment

Choose a reason for hiding this comment

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

LGTM

Diff between snyk-mvn-plugin 3.4.2 .. 3.5.0 defaults print-graph to false, so there should not be any perceived change in behavior.

@dekelund dekelund enabled auto-merge May 14, 2024 14:41
@dekelund dekelund merged commit 77b70e2 into main May 14, 2024
15 checks passed
@dekelund dekelund deleted the feat/support---print-graph-with-mvn-plugin branch May 14, 2024 16:12
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