Merge pull request #602 from snyk/fix/detect-arm64-architecture

fix: detect platform from image config file UNIFY-253
snyk · Sep 6, 2024 · 8a15b8b · 8a15b8b
2 parents 894b262 + af0973a
commit 8a15b8b
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/lib/extractor/index.ts b/lib/extractor/index.ts
@@ -153,7 +153,7 @@ export function getRootFsLayersFromConfig(imageConfig: ImageConfig): string[] {
 export function getPlatformFromConfig(
   imageConfig: ImageConfig,
 ): string | undefined {
-  return imageConfig.os && imageConfig.architecture
+  return imageConfig?.os && imageConfig?.architecture
     ? `${imageConfig.os}/${imageConfig.architecture}`
     : undefined;
 }

diff --git a/lib/extractor/oci-archive/layer.ts b/lib/extractor/oci-archive/layer.ts
@@ -4,7 +4,7 @@ import * as gunzip from "gunzip-maybe";
 import { normalize as normalizePath, sep as pathSeparator } from "path";
 import { PassThrough } from "stream";
 import { extract, Extract } from "tar-stream";
-import { InvalidArchiveError } from "..";
+import { getPlatformFromConfig, InvalidArchiveError } from "..";
 import { streamToJson } from "../../stream-utils";
 import { PluginOptions } from "../../types";
 import { extractImageLayer } from "../layer";
@@ -133,7 +133,9 @@ function getLayersContentAndArchiveManifest(
   manifest: OciArchiveManifest;
   imageConfig: ImageConfig;
 } {
-  const platform = options?.platform || "linux/amd64";
+  const platform =
+    options?.platform ||
+    (configs.length === 1 ? getPlatformFromConfig(configs[0]) : "linux/amd64");
   const platformInfo = getOciPlatformInfoFromOptionString(platform as string);
 
   // get manifest file first

diff --git a/test/fixtures/docker-archives/alpine-arm64.tar b/test/fixtures/docker-archives/alpine-arm64.tar
diff --git a/test/system/platforms/arm.spec.ts b/test/system/platforms/arm.spec.ts
@@ -1,5 +1,6 @@
 import { scan } from "../../../lib/index";
 import { execute } from "../../../lib/sub-process";
+import { getFixture } from "../../util";
 
 describe("ARM platform tests", () => {
   afterAll(async () => {
@@ -21,6 +22,18 @@ describe("ARM platform tests", () => {
 
     expect(pluginResult).toMatchSnapshot();
   });
+  test("should correctly scan an arm64 image when platform flag is missing", async () => {
+    const fixturePath = getFixture("docker-archives/alpine-arm64.tar");
+    const imageNameAndTag = `docker-archive:${fixturePath}`;
+    try {
+      const result = await scan({
+        path: imageNameAndTag,
+      });
+      expect(result).toBeDefined();
+    } catch (error) {
+      expect(error.message).not.toBe("Invalid OCI Archive");
+    }
+  });
 
   it.todo(
     "should correctly scan an ARM image when the user provides --platform=arm and return platform: arm",