fix(iac): Fix Issue Path in human readable and json output [IAC-2935]

[andreeaneata]

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?

This PR adds a correction to the IaC+ output - specifically to the Path field. For the human readable output and the json one.

Apart from being informative, the path parameter is used to be able to ignore an issue: see doc. If the path is incorrect and not looks like how the it is being taken into consideration for ignores -> the ignore will not work and it's hard to determine how it should look like otherwise.

This change to the path will make ignores work for IaC+ from the CLI without any changes added to the ignores logic -> just on how the output looks like to be able to add proper ignores.

Risk: LOW

Where should the reviewer start?

Trying out the changes and adding an ignore based on the output. See next section for that.

The unit tests that validate this change:

1. https://github.com/snyk/cli/blob/main/test/jest/unit/lib/formatters/iac-output/text/formatters.spec.ts -> changed by the fixtures changed in this PR
2. https://github.com/snyk/cli/blob/main/test/jest/unit/lib/iac/test/v2/json.spec.ts -> changed by the fixtures changed in this PR

How should this be manually tested?

1. Have an org that has IaC+ enabled.
2. Have a directory that has an IaC file in it with possible vulns, e.g. define an S3 bucket:

  bucket = "test-bucket"

  tags = {
    Name        = "test"
    Environment = "Dev"
  }
}

3. Run snyk iac test --org=<your_org_with_iac+>
4. See output and try to add an ignore as described in the doc for a specific issue (should be something like <File> > <Path>). E.g.: snyk ignore --id=SNYK-CC-00234 --path="s3_bucket.tf > aws_s3_bucket > test-bucket > versioning" (before output) VS snyk ignore --id=SNYK-CC-00234 --path="s3_bucket.tf > resource > aws_s3_bucket[test-bucket] > versioning" (after output)
5. Try again snyk iac test --org=<your_org_with_iac+>. In the before case the issue will not be ignored, in the second one it should be properly ignored.

Any background context you want to provide?

Logic for ignores: here
The parts against which the comparison will run: here (notice that they are determined from the same resource.formattedPath field)

What are the relevant tickets?

IAC-2935

Screenshots

Human readable:

Json:

Additional questions