Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 37 additions & 11 deletions lib/extractor/oci-archive/layer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export async function extractArchive(

const layers: Record<string, ExtractedLayers> = {};
const manifests: Record<string, OciArchiveManifest> = {};
const configs: ImageConfig[] = [];
const configs: Record<string, ImageConfig> = {};
let mainIndexFile: OciImageIndex;
const indexFiles: Record<string, OciImageIndex> = {};

Expand Down Expand Up @@ -85,7 +85,7 @@ export async function extractArchive(
} else if (isImageIndexFile(manifest)) {
indexFiles[digest] = manifest as OciImageIndex;
} else if (isImageConfigFile(manifest)) {
configs.push(manifest as ImageConfig);
configs[digest] = manifest as ImageConfig;
}
if (layer !== undefined) {
layers[digest] = layer as ExtractedLayers;
Expand Down Expand Up @@ -131,15 +131,16 @@ function getLayersContentAndArchiveManifest(
imageIndex: OciImageIndex | undefined,
manifestCollection: Record<string, OciArchiveManifest>,
indexFiles: Record<string, OciImageIndex>,
configs: ImageConfig[],
configs: Record<string, ImageConfig>,
layers: Record<string, ExtractedLayers>,
options: Partial<PluginOptions>,
): {
layers: ExtractedLayers[];
manifest: OciArchiveManifest;
imageConfig: ImageConfig;
} {
const filteredConfigs = configs.filter((config) => {
const allConfigs = Object.values(configs);
const filteredConfigs = allConfigs.filter((config) => {
return config?.os !== "unknown" || config?.architecture !== "unknown";
});
const platform =
Expand All @@ -154,6 +155,7 @@ function getLayersContentAndArchiveManifest(
imageIndex,
manifestCollection,
indexFiles,
configs,
platformInfo,
);

Expand All @@ -169,7 +171,7 @@ function getLayersContentAndArchiveManifest(
throw new Error("We found no layers in the provided image");
}

const imageConfig = getImageConfig(configs, platformInfo);
const imageConfig = getImageConfig(allConfigs, platformInfo);

if (imageConfig === undefined) {
throw new Error("Could not find the image config in the provided image");
Expand All @@ -186,14 +188,20 @@ function getManifest(
imageIndex: OciImageIndex | undefined,
manifestCollection: Record<string, OciArchiveManifest>,
indexFiles: Record<string, OciImageIndex>,
configs: Record<string, ImageConfig>,
platformInfo: OciPlatformInfo,
): OciArchiveManifest {
if (!imageIndex) {
return manifestCollection[Object.keys(manifestCollection)[0]];
}

const allManifests = getAllManifestsIndexItems(imageIndex, indexFiles);
const manifestInfo = getImageManifestInfo(allManifests, platformInfo);
const manifestInfo = getImageManifestInfo(
allManifests,
manifestCollection,
configs,
platformInfo,
);

if (manifestInfo === undefined) {
throw new Error(
Expand Down Expand Up @@ -266,6 +274,8 @@ function getOciPlatformInfoFromOptionString(platform: string): OciPlatformInfo {

function getImageManifestInfo(
manifests: OciManifestInfo[],
manifestCollection: Record<string, OciArchiveManifest>,
configs: Record<string, ImageConfig>,
platformInfo: OciPlatformInfo,
): OciManifestInfo | undefined {
// manifests do not always have a plaform, this is the case for OCI
Expand All @@ -278,11 +288,27 @@ function getImageManifestInfo(
manifests,
platformInfo,
(target: OciManifestInfo): OciPlatformInfo => {
return {
os: target.platform?.os,
architecture: target.platform?.architecture,
variant: target.platform?.variant,
};
if (target.platform) {
return {
os: target.platform.os,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a reason here why we switched from optional chaining to direct access?

architecture: target.platform.architecture,
variant: target.platform.variant,
};
}

// try to resolve platform from config
const manifest = manifestCollection[target.digest];
if (manifest) {
const config = configs[manifest.config.digest];
if (config) {
return {
os: config.os,
architecture: config.architecture,
};
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we return the variant too here?

}
}

return {};
},
);
}
Expand Down
Binary file not shown.
20 changes: 20 additions & 0 deletions test/lib/extractor/extractor.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -164,5 +164,25 @@ describe("extractImageContent", () => {
).resolves.not.toThrow();
});
});

describe("with multi-tag images missing platform info in index.json", () => {
it("extracts when platform is resolved from config blobs", async () => {
const fixture = getFixture("docker-oci-archives/busybox.multi-tag.tar");
const result = await extractImageContent(type, fixture, [], {
platform: "linux/arm64",
});
expect(result).toBeDefined();
expect(result.platform).toBe("linux/arm64");
});

it("fails when requested platform does not match any config blob", async () => {
const fixture = getFixture("docker-oci-archives/busybox.multi-tag.tar");
await expect(
extractImageContent(type, fixture, [], { platform: "linux/amd64" }),
).rejects.toThrow(
"Unsupported archive type. Please use a Docker archive, OCI image layout, or Kaniko-compatible tarball.",
);
});
});
});
});