Merge pull request #649 from snyk/feat/add-target-reference-support-for-test

fix: add possible targetreference to plugin response

Author: aarlaud

lib/response-builder.ts

@@ -20,6 +20,7 @@ async function buildResponse(
   excludeBaseImageVulns: boolean,
   names?: string[],
   ociDistributionMetadata?: OCIDistributionMetadata,
+  options?: Partial<types.PluginOptions>,
 ): Promise<types.PluginResponse> {
   const deps = depsAnalysis.depTree.dependencies;
   const dockerfilePkgs = collectDockerfilePkgs(dockerfileAnalysis, deps);
@@ -204,6 +205,10 @@ async function buildResponse(
         type: depGraph.pkgManager.name,
         args,
       },
+      ...(options &&
+        options["target-reference"] && {
+          targetReference: options["target-reference"] ?? depGraph.rootPkg.name,
+        }),
     },
     ...applicationDependenciesScanResults,
   ];

lib/static.ts

@@ -72,5 +72,6 @@ export async function analyzeStatically(
     excludeBaseImageVulns,
     names,
     ociDistributionMetadata,
+    options,
   );
 }

lib/types.ts

@@ -93,6 +93,8 @@ export interface ScanResult {
   identity: Identity;
   /** Facts are the collection of things you found. */
   facts: Fact[];
+  /** A reference for differentiating project versions, e.g., branch names, versions, etc. */
+  targetReference?: string;
 }
 
 export interface AutoDetectedUserInstructions {
@@ -225,6 +227,7 @@ export interface PluginOptions {
 
   /** The default is "false". */
   "collect-application-files": boolean | string;
+  "target-reference": string;
 }
 
 export interface DepTreeDep {