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: ignore php composer lockfiles that are invalid #5012

Merged
merged 1 commit into from
Jan 19, 2024

Conversation

SteveShani
Copy link
Contributor

@SteveShani SteveShani commented Jan 19, 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?

Fixed an issue where invalid lockfiles and metadata files were causing snyk container test to fail. This change skips over invalid files, by catching InvalidUserInputError exceptions thrown by https://github.com/snyk/composer-lockfile-parser and ignoring the files that caused that error.

Where should the reviewer start?

Please see the pull requests that fixed the issue: snyk/snyk-docker-plugin#563

How should this be manually tested?

Running snyk container test drupal:fpm-alpine should not fail.

Risk assessment

Low - this only fixes an edge case in some docker images. There are no breaking changes.
The change is in snyk-docker-plugin and affects the php ecosystem.

Automated Testing

https://github.com/snyk/snyk-docker-plugin/blob/main/test/lib/analyzer/php.spec.ts

Fixed issue where invalid lockfiles and metadata files were causing snyk container test to fail completely.
This change skips over invalid files.
@SteveShani SteveShani self-assigned this Jan 19, 2024
@SteveShani SteveShani requested a review from a team as a code owner January 19, 2024 10:40
@SteveShani SteveShani enabled auto-merge (squash) January 19, 2024 11:32
@SteveShani SteveShani merged commit 7852cb3 into master Jan 19, 2024
14 checks passed
@SteveShani SteveShani deleted the fix/ignore-invalid-php-composer-lockfiles branch January 19, 2024 13:14
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