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(iac): paths showing proper resource for partial tfplans [IAC-2940] #5504

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mihai-snyk
Copy link

@mihai-snyk mihai-snyk commented Sep 20, 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?

Upgrades the snyk-iac-test version and brings the following changes:

  • 0.54.1 -> upgrades module to address vulnerability in go-getter
  • 0.55.0 -> adds a flag to snyk-iac-test
  • 0.55.1 -> vulns should not have excluded resources attached

To better understand the effects of v0.55.1, imagine we have the following terraform code already applied:

resource "aws_security_group" "snyk" {
    vpc_id = "vpc-example-id"
}

After applying the above, we add another resource to the terraform code:

resource "aws_security_group_rule" "snyk" {
    security_group_id = aws_security_group.snyk.id
    cidr_blocks = [ "0.0.0.0/0" ]
    from_port = 443
    to_port = 443
    protocol = "tcp"
    type = "ingress"
}

And then we want to do a scan via snyk-iac-test on the resulting tfplan. The plan will be filtered from the no-op resources (aws_security_group in our case as it already existed, so no action will be made on it), thus in our scan results, we will have the the rule result containing a reference to the "missing" aws_security_group resource, resulting in an error later in the reporting part. We fixed the above issue by replacing the missing resource with one that exists.

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

@mihai-snyk mihai-snyk requested a review from a team as a code owner September 20, 2024 10:54
Copy link
Contributor

Warnings
⚠️

You've modified files in src/ directory, but haven't updated anything in test folder. Is there something that could be tested?

Generated by 🚫 dangerJS against e532df4

@mihai-snyk mihai-snyk changed the title fix: upgrade snyk-iac-test to v0.55.1 fix(iac): paths showing proper resource for partial tfplans Sep 20, 2024
@mihai-snyk mihai-snyk changed the title fix(iac): paths showing proper resource for partial tfplans fix(iac): paths showing proper resource for partial tfplans [IAC-2940] Sep 20, 2024
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.

1 participant