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: remove ignored paths when discovering npm manifests UNIFY-216 #5384

Merged

Conversation

adrobuta
Copy link
Contributor

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?

With the release of v6.12.0 of the docker cli plugin we added support for scanning npm projects without manifest/lockfiles. npm ecosystem has both global and local scoped dependencies and, to avoid false positives, we decided to ignore a set of folders from the containers at that time of release. We realised that the accuracy of the cli was impacted by that change and we decided to remove the ignoring of the /usr/ and /opt folders.

This PR aims to solve the issue mentioned above by remove the ignored paths and refactor the way we handle node projects discovery as shown in the following diagram:
RFC  Removal of ignored folders on container scanning

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@adrobuta adrobuta requested a review from a team as a code owner July 29, 2024 15:08
@adrobuta adrobuta force-pushed the hotfix/v1.1292.0-container-remove-ignored-paths branch 3 times, most recently from 14287ec to ae18680 Compare July 30, 2024 10:21
@adrobuta adrobuta force-pushed the hotfix/v1.1292.0-container-remove-ignored-paths branch from ae18680 to 8164ad8 Compare July 30, 2024 11:39
A dotnet 8.0.0 vulnerability was discovered on 2024-07-09 which caused
dotnet acceptance tests to fail on platforms with the vulnerable version
installed.

While the toolchain could be updated, the test can be made more
robust to future reoccurances of dotnet system vulns.

For this test we care more about the operation of the test command
rather than its findings, so we can test for consistency between exit
code and test output instead.

In updating this test, a defect was discovered in the dotnet plugin
which corrupts json output. The test works around this, but it will
require a dotnet plugin upgrade as a followup to mitigate user impact.

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch fix/dotnet-test-fail-20240710
# Changes to be committed:
#	modified:   test/jest/acceptance/snyk-test/basic-test-all-languages.spec.ts
#
# Untracked files:
#	distroless-main-jq.json
#	distroless-main.json
#	distroless-pr.json
#	junit.xml
#	monitor-json-compare.bash
#	snyk-linux-monitor-main-1.jq.json
#	snyk-linux-monitor-main-1.json
#	snyk-linux-monitor-main-2.jq.json
#	snyk-linux-monitor-main-2.json
#	snyk-linux-monitor-main.json
#	snyk-linux-monitor-pr.json
#	snyk-linux-test-main.json
#	test.env
#	test/acceptance/workspaces/swift-app/.build/
#	test/acceptance/workspaces/swift/.build/
#	test/fixtures/find-files/swift/test.build/.build/
#
@PeterSchafer PeterSchafer merged commit 9af7971 into release-candidate Jul 31, 2024
8 checks passed
@PeterSchafer PeterSchafer deleted the hotfix/v1.1292.0-container-remove-ignored-paths branch July 31, 2024 13:07
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.

4 participants