Merge pull request #1881 from snyk/refactor/iac-documentation-url-in-…

…outputs refactor: iac documentation url in outputs
snyk · May 6, 2021 · 9c6dcfd · 9c6dcfd
2 parents 7bc9229 + be34e5c
commit 9c6dcfd
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 0 deletions.
diff --git a/src/cli/commands/test/iac-local-execution/results-formatter.ts b/src/cli/commands/test/iac-local-execution/results-formatter.ts
@@ -65,6 +65,7 @@ function formatScanResult(
       },
       severity: policy.severity,
       lineNumber,
+      documentation: `https://snyk.io/security-rules/${policy.publicId}`,
     };
   });
 

diff --git a/src/cli/commands/test/iac-output.ts b/src/cli/commands/test/iac-output.ts
@@ -209,6 +209,7 @@ export function extractReportingDescriptor(
       },
       properties: {
         tags: ['security', `${issue.type}/${issue.subType}`],
+        documentation: issue.documentation,
       },
     };
   });

diff --git a/src/lib/snyk-test/iac-test-result.ts b/src/lib/snyk-test/iac-test-result.ts
@@ -10,6 +10,7 @@ export interface AnnotatedIacIssue {
   type: string;
   subType: string;
   path: string[];
+  documentation: string;
   // Legacy fields from Registry, unused.
   name?: string;
   from?: string[];

diff --git a/test/acceptance/cli-test/iac/cli-test.iac-utils.ts b/test/acceptance/cli-test/iac/cli-test.iac-utils.ts
@@ -303,6 +303,7 @@ function generateDummyIssue(severity): AnnotatedIacIssue {
     subType: 'Deployment',
     path: [],
     lineNumber: 1,
+    documentation: 'https://snyk.io/security-rules/SNYK-CC-K8S-1',
   };
 }
 

diff --git a/test/jest/unit/iac-unit-tests/results-formatter.fixtures.ts b/test/jest/unit/iac-unit-tests/results-formatter.fixtures.ts
@@ -80,6 +80,7 @@ export const expectedFormattedResults = {
         },
         severity: anotherPolicyStub.severity,
         lineNumber: 3,
+        documentation: `https://snyk.io/security-rules/${anotherPolicyStub.publicId}`,
       },
     ],
     projectType: 'k8sconfig',