feat: Show auto detected user instructions in 'container test' output

Updated 'container test' Dockerfile instructions to "Image layer:" to be consistent with what we show in the UI. Added showing auto detected instructions if Dockerfile not present.
snyk · Feb 11, 2021 · 2e3237e · 2e3237e
1 parent 157663f
commit 2e3237e
Show file tree

Hide file tree

Showing 3 changed files with 105 additions and 5 deletions.
diff --git a/src/cli/commands/test/formatters/legacy-format-issue.ts b/src/cli/commands/test/formatters/legacy-format-issue.ts
@@ -136,11 +136,12 @@ export function titleCaseText(text) {
 
 function dockerfileInstructionText(vuln) {
   if (vuln.dockerfileInstruction) {
-    return `\n  Introduced in your Dockerfile by '${vuln.dockerfileInstruction}'`;
+    JSON.stringify(vuln.dockerfileInstruction);
+    return `\n  Image layer: '${vuln.dockerfileInstruction}'`;
   }
 
   if (vuln.dockerBaseImage) {
-    return `\n  Introduced by your base image (${vuln.dockerBaseImage})`;
+    return `\n  Image layer: Introduced by your base image (${vuln.dockerBaseImage})`;
   }
 
   return '';

diff --git a/src/lib/snyk-test/run-test.ts b/src/lib/snyk-test/run-test.ts
@@ -104,10 +104,13 @@ function prepareEcosystemResponseForParsing(
     depGraphData !== undefined
       ? depGraphLib.createFromJSON(depGraphData)
       : undefined;
-  const dockerfileAnalysisFact = payloadBody?.facts.find(
-    (fact) => fact.type === 'dockerfileAnalysis',
+  const imageUserInstructions = payloadBody?.facts.find(
+    (fact) =>
+      fact.type === 'dockerfileAnalysis' ||
+      fact.type === 'autoDetectedUserInstructions',
   );
-  const dockerfilePackages = dockerfileAnalysisFact?.data?.dockerfilePackages;
+
+  const dockerfilePackages = imageUserInstructions?.data?.dockerfilePackages;
   const projectName = payloadBody?.name || depGraph?.rootPkg.name;
   const packageManager = payloadBody?.identity?.type as SupportedProjectTypes;
   const targetFile = payloadBody?.identity?.targetFile || options.file;

diff --git a/test/acceptance/cli-test/cli-test.docker.spec.ts b/test/acceptance/cli-test/cli-test.docker.spec.ts
@@ -642,6 +642,102 @@ export const DockerTests: AcceptanceTests = {
       }
     },
 
+    '`test foo:latest --docker with dockerfile instructions`': (
+      params,
+    ) => async (t) => {
+      stubDockerPluginResponse(
+        params.ecoSystemPlugins,
+        {
+          scanResults: [
+            {
+              facts: [
+                { type: 'depGraph', data: {} },
+                {
+                  type: 'dockerfileAnalysis',
+                  data: {
+                    dockerfilePackages: {
+                      bzip2: {
+                        instruction: 'RUN test instruction',
+                      },
+                    },
+                  },
+                },
+              ],
+              identity: {
+                type: 'deb',
+              },
+              target: {
+                image: 'docker-image|ubuntu',
+              },
+            },
+          ],
+        },
+        t,
+      );
+
+      const vulns = require('../fixtures/docker/find-result-remediation.json');
+      params.server.setNextResponse(vulns);
+
+      try {
+        await params.cli.test('foo:latest', {
+          docker: true,
+          org: 'explicit-org',
+        });
+        t.fail('should have found vuln');
+      } catch (err) {
+        const msg = err.message;
+        t.match(msg, "Image layer: 'RUN test instruction'");
+      }
+    },
+
+    '`test foo:latest --docker with auto detected instructions`': (
+      params,
+    ) => async (t) => {
+      stubDockerPluginResponse(
+        params.ecoSystemPlugins,
+        {
+          scanResults: [
+            {
+              facts: [
+                { type: 'depGraph', data: {} },
+                {
+                  type: 'autoDetectedUserInstructions',
+                  data: {
+                    dockerfilePackages: {
+                      bzip2: {
+                        instruction: 'RUN test instruction',
+                      },
+                    },
+                  },
+                },
+              ],
+              identity: {
+                type: 'deb',
+              },
+              target: {
+                image: 'docker-image|ubuntu',
+              },
+            },
+          ],
+        },
+        t,
+      );
+
+      const vulns = require('../fixtures/docker/find-result-remediation.json');
+      params.server.setNextResponse(vulns);
+
+      try {
+        await params.cli.test('foo:latest', {
+          docker: true,
+          org: 'explicit-org',
+        });
+        t.fail('should have found vuln');
+      } catch (err) {
+        const msg = err.message;
+        t.match(msg, "Image layer: 'RUN test instruction'");
+      }
+    },
+
     '`test --docker --file=Dockerfile --sarif `': (params, utils) => async (
       t,
     ) => {