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

fix: do not show test deps for Dverbose mvn with dependencyManagement #5422

Merged
merged 1 commit into from
Aug 29, 2024

Conversation

orsagie
Copy link
Contributor

@orsagie orsagie commented Aug 14, 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.
    • 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 snyk-mvn-plugin to support the case when a pom brings in a dependency that is managed by a parent with dependencyManagement and the --Dverbose flag is used when the user requests test scope dependncies.

Where should the reviewer start?

How should this be manually tested?

Use the following command on the following pom.xml to see that with the current CLI dev deps are being shown, while with the new snyk-mvn-plugin those deps will not be shown, as expected (since all the dependencies are in the test scope).

  • Current snyk test --dev --print-deps -- -Dverbose and snyk test --print-deps -- -Dverbose show the same deps
  • With change they are different (dev deps don't show up when not specified)
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.1</version>
    </parent>

    <groupId>com.example</groupId>
    <artifactId>my-app</artifactId>
    <version>1.2.3</version>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@orsagie orsagie requested a review from a team as a code owner August 14, 2024 12:15
@orsagie orsagie force-pushed the fix/mvn-plugin-test-scope-dependency-management branch 2 times, most recently from 209f030 to edddb0c Compare August 14, 2024 18:55
@orsagie orsagie force-pushed the fix/mvn-plugin-test-scope-dependency-management branch 3 times, most recently from 04d6105 to b1d012b Compare August 29, 2024 09:47
@PeterSchafer PeterSchafer enabled auto-merge August 29, 2024 10:45
@orsagie orsagie force-pushed the fix/mvn-plugin-test-scope-dependency-management branch from b1d012b to b3d1b18 Compare August 29, 2024 11:52
@orsagie orsagie force-pushed the fix/mvn-plugin-test-scope-dependency-management branch from b3d1b18 to 67e0de9 Compare August 29, 2024 12:39
@PeterSchafer PeterSchafer merged commit 682065b into main Aug 29, 2024
11 checks passed
@PeterSchafer PeterSchafer deleted the fix/mvn-plugin-test-scope-dependency-management branch August 29, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants