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: new json field infrastructureAsCodeSuccesses GA #5435

Conversation

sergiu-snyk
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?

Expose to GA the JSON output field infrastructureAsCodeSuccesses (which has been for the past 2 months available in the preview version)

What are the relevant tickets?

Screenshots

[
  {
    "meta": {
      "isPrivate": true,
      "isLicensesEnabled": false,
      "org": "sergiu-iac-plus",
      "policy": "",
      "ignoreSettings": {
        "adminOnly": false,
        "disregardFilesystemIgnores": false,
        "reasonRequired": false
      }
    },
    "filesystemPolicy": false,
    "vulnerabilities": [],
    "dependencyCount": 0,
    "licensesPolicy": null,
    "ignoreSettings": {
      "adminOnly": false,
      "disregardFilesystemIgnores": false,
      "reasonRequired": false
    },
    "targetFile": "main.tf",
    "projectName": "IAC-3015",
    "org": "sergiu-iac-plus",
    "policy": "",
    "isPrivate": true,
    "targetFilePath": "/Users/sergiub/snyk/IAC-3015/main.tf",
    "packageManager": "terraformconfig",
    "path": "/Users/sergiub/snyk/IAC-3015",
    "projectType": "terraformconfig",
    "ok": false,
    "infrastructureAsCodeIssues": [
      {
        "severity": "low",
        "resolve": "Set the `iam_instance_profile` attribute to the name of an IAM instance profile.",
        "impact": "By passing role information to an EC2 instance at launch instead of using IAM access keys, you can limit the risk of access key exposure and help prevent a malicious user from compromising the instance.",
        "msg": "resource.aws_instance[bar[\"0\"]].iam_instance_profile",
        "remediation": {
          "terraform": "Set the `iam_instance_profile` attribute to the name of an IAM instance profile."
        },
        "type": "terraformconfig",
        "subType": "aws_instance",
        "issue": "EC2 instance is not associated with IAM role and instance profile",
        "publicId": "SNYK-CC-00090",
        "title": "EC2 instance is not associated with IAM role and instance profile",
        "references": [
          "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html"
        ],
        "id": "SNYK-CC-00090",
        "isIgnored": false,
        "iacDescription": {
          "issue": "EC2 instance is not associated with IAM role and instance profile",
          "impact": "By passing role information to an EC2 instance at launch instead of using IAM access keys, you can limit the risk of access key exposure and help prevent a malicious user from compromising the instance.",
          "resolve": "Set the `iam_instance_profile` attribute to the name of an IAM instance profile."
        },
        "lineNumber": 5,
        "documentation": "https://security.snyk.io/rules/cloud/SNYK-CC-00090",
        "isGeneratedByCustomRule": false,
        "path": [
          "resource",
          "aws_instance[bar[\"0\"]]",
          "iam_instance_profile"
        ],
        "compliance": [],
        "description": "By passing role information to an EC2 instance at launch instead of using IAM access keys, you can limit the risk of access key exposure and help prevent a malicious user from compromising the instance."
      }
    ],
    "infrastructureAsCodeSuccesses": [
      {
        "id": "SNYK-CC-00007",
        "severity": "medium",
        "type": "terraformconfig",
        "subType": "aws_instance",
        "path": [
          "resource",
          "aws_instance[bar[\"0\"]]",
          "associate_public_ip_address"
        ],
        "msg": "resource.aws_instance[bar[\"0\"]].associate_public_ip_address",
        "isIgnored": false
      }
    ]
  }
]

Additional questions

@sergiu-snyk sergiu-snyk requested a review from a team as a code owner August 22, 2024 07:44
Copy link
Contributor

github-actions bot commented Aug 22, 2024

Warnings
⚠️

Since the CLI is unifying on a standard and improved tooling, we're starting to migrate old-style imports and exports to ES6 ones.
A file you've modified is using either module.exports or require(). If you can, please update them to ES6 import syntax and export syntax.
Files found:

  • src/lib/iac/test/v2/output.ts
⚠️

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 d4b1ded

@sergiu-snyk
Copy link
Contributor Author

Warnings
⚠️
Since the CLI is unifying on a standard and improved tooling, we're starting to migrate old-style imports and exports to ES6 ones. A file you've modified is using either module.exports or require(). If you can, please update them to ES6 import syntax and export syntax. Files found:

  • src/lib/iac/test/v2/output.ts

⚠️
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 26b74fd

  1. I'd prefer keeping the changes to a minimum at this point, since the release is so close.
  2. Tests are already in place for the feature we expose now. This PR only removes the old path and associated tests.

@PeterSchafer
Copy link
Collaborator

PeterSchafer commented Aug 22, 2024

@sergiu-snyk we already cut the release candidate, can you please edit this PR to go the release-candidate branch rather than main. Main will be synced later by us.

@sergiu-snyk sergiu-snyk changed the base branch from main to release-candidate August 22, 2024 08:07
Copy link
Collaborator

@PeterSchafer PeterSchafer left a comment

Choose a reason for hiding this comment

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

@sergiu-snyk you'll need to rebase your changes as well. there are currently dependency upgrades that are not intended.

@sergiu-snyk sergiu-snyk force-pushed the fix/IAC-3043/infrastructureAsCodeSuccesses-GA-release branch from 26b74fd to d4b1ded Compare August 22, 2024 08:25
@PeterSchafer PeterSchafer merged commit ee39065 into release-candidate Aug 22, 2024
8 checks passed
@PeterSchafer PeterSchafer deleted the fix/IAC-3043/infrastructureAsCodeSuccesses-GA-release branch August 22, 2024 09:39
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.

3 participants