Merge pull request #3618 from snyk/fix/target-name

fix: `--target-name` bug
snyk · Aug 25, 2022 · e1132e1 · e1132e1
2 parents 5e47601 + 3431f79
commit e1132e1
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 10 deletions.
diff --git a/src/cli/commands/test/iac/local-execution/process-results/cli-share-results.ts b/src/cli/commands/test/iac/local-execution/process-results/cli-share-results.ts
@@ -34,7 +34,7 @@ export async function shareResults({
   policy: Policy | undefined;
   tags?: Tag[];
   attributes?: ProjectAttributes;
-  options?: IaCTestFlags;
+  options: IaCTestFlags;
   meta: IacOutputMeta;
 }): Promise<ShareResultsOutput> {
   const scanResults = results.map((result) =>

diff --git a/src/lib/ecosystems/types.ts b/src/lib/ecosystems/types.ts
@@ -20,7 +20,7 @@ export interface ContainerTarget {
   image: string;
 }
 
-export interface UnknownTarget {
+export interface NamedTarget extends GitTarget {
   name: string; // Should be equal to the project name
 }
 
@@ -30,7 +30,7 @@ export interface ScanResult {
   findings?: Finding[];
   name?: string;
   policy?: string;
-  target?: GitTarget | ContainerTarget | UnknownTarget;
+  target?: GitTarget | ContainerTarget | NamedTarget;
   analytics?: Analytics[];
   targetReference?: string;
 }

diff --git a/src/lib/iac/envelope-formatters.ts b/src/lib/iac/envelope-formatters.ts
@@ -3,15 +3,15 @@ import {
   IaCTestFlags,
   PolicyMetadata,
 } from '../../cli/commands/test/iac/local-execution/types';
-import { ScanResult } from '../ecosystems/types';
+import { GitTarget, NamedTarget, ScanResult } from '../ecosystems/types';
 import { Policy } from '../policy/find-and-load-policy';
 import { IacOutputMeta } from '../types';
 
 export function convertIacResultToScanResult(
   iacResult: IacShareResultsFormat,
   policy: Policy | undefined,
   meta: IacOutputMeta,
-  options?: IaCTestFlags,
+  options: IaCTestFlags,
 ): ScanResult {
   return {
     identity: {
@@ -26,15 +26,18 @@ export function convertIacResultToScanResult(
       };
     }),
     name: iacResult.projectName,
-    target: buildTarget(meta),
+    target: buildTarget(meta, options),
     policy: policy?.toString() ?? '',
     targetReference: options?.['target-reference'],
   };
 }
 
-function buildTarget(meta: IacOutputMeta) {
+function buildTarget(
+  meta: IacOutputMeta,
+  options: IaCTestFlags,
+): NamedTarget | GitTarget {
   if (meta.gitRemoteUrl) {
-    return { remoteUrl: meta.gitRemoteUrl };
+    return { remoteUrl: meta.gitRemoteUrl, name: options['target-name'] };
   }
   return { name: meta.projectName };
 }
diff --git a/src/lib/polling/types.ts b/src/lib/polling/types.ts
@@ -6,7 +6,7 @@ import {
 import {
   GitTarget,
   ContainerTarget,
-  UnknownTarget,
+  NamedTarget,
   MonitorDependenciesResponse,
 } from '../ecosystems/types';
 
@@ -49,7 +49,7 @@ export interface ResolutionMeta {
   identity: {
     type: string;
   };
-  target?: GitTarget | ContainerTarget | UnknownTarget;
+  target?: GitTarget | ContainerTarget | NamedTarget;
   policy?: string;
   targetReference?: string;
 }
diff --git a/test/jest/unit/iac/cli-share-results.spec.ts b/test/jest/unit/iac/cli-share-results.spec.ts
@@ -43,6 +43,7 @@ describe('CLI Share Results', () => {
         orgName: 'org-name',
         gitRemoteUrl: 'http://github.com/snyk/cli.git',
       },
+      options: {},
     });
 
     expect(envelopeFormattersSpy.mock.calls.length).toBe(2);
@@ -69,6 +70,7 @@ describe('CLI Share Results', () => {
         orgName: 'org-name',
         gitRemoteUrl: 'http://github.com/snyk/cli.git',
       },
+      options: {},
     });
 
     expect(envelopeFormattersSpy.mock.calls.length).toBe(2);
@@ -139,6 +141,7 @@ describe('CLI Share Results', () => {
         orgName: 'org-name',
         gitRemoteUrl: 'http://github.com/snyk/cli.git',
       },
+      options: {},
     });
 
     expect(requestSpy.mock.calls.length).toBe(1);