/** * Copyright 2025 actions-toolkit authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import fs from 'fs'; import * as core from '@actions/core'; import {Buildx} from './buildx.js'; import {Context} from '../context.js'; import {Exec} from '../exec.js'; import {AttestationInspectOpts, CreateOpts, CreateResponse, CreateResult, InspectOpts, Manifest as ImageToolsManifest} from '../types/buildx/imagetools.js'; import {Image} from '../types/oci/config.js'; import {Descriptor} from '../types/oci/descriptor.js'; import {Digest} from '../types/oci/digest.js'; export interface ImageToolsOpts { buildx?: Buildx; } export class ImageTools { private readonly buildx: Buildx; constructor(opts?: ImageToolsOpts) { this.buildx = opts?.buildx || new Buildx(); } public async getCommand(args: Array) { return await this.buildx.getCommand(['imagetools', ...args]); } public async getInspectCommand(args: Array) { return await this.getCommand(['inspect', ...args]); } public async getCreateCommand(args: Array) { return await this.getCommand(['create', ...args]); } public async inspectImage(opts: InspectOpts): Promise | Image> { return await this.inspect(opts, '{{json .Image}}', parsedOutput => { if (typeof parsedOutput === 'object' && !Array.isArray(parsedOutput) && parsedOutput !== null) { if (Object.prototype.hasOwnProperty.call(parsedOutput, 'config')) { return parsedOutput; } else { return >parsedOutput; } } throw new Error('Unexpected output format'); }); } public async inspectManifest(opts: InspectOpts): Promise { return await this.inspect(opts, '{{json .Manifest}}', parsedOutput => { if (typeof parsedOutput === 'object' && !Array.isArray(parsedOutput) && parsedOutput !== null) { if (Object.prototype.hasOwnProperty.call(parsedOutput, 'manifests')) { return parsedOutput; } else { return parsedOutput; } } throw new Error('Unexpected output format'); }); } public async attestationDescriptors(opts: AttestationInspectOpts): Promise> { const manifest = await this.inspectManifest(opts); if (typeof manifest !== 'object' || manifest === null || !('manifests' in manifest) || !Array.isArray(manifest.manifests)) { throw new Error(`No descriptor found for ${opts.name}`); } const attestations = manifest.manifests.filter(m => m.annotations?.['vnd.docker.reference.type'] === 'attestation-manifest'); if (!opts.platform) { return attestations; } const platform = opts.platform; const manifestByDigest = new Map(); for (const m of manifest.manifests) { if (m.digest) { manifestByDigest.set(m.digest, m); } } return attestations.filter(attestation => { const refDigest = attestation.annotations?.['vnd.docker.reference.digest']; if (!refDigest) { return false; } const referencedManifest = manifestByDigest.get(refDigest); if (!referencedManifest) { return false; } return referencedManifest.platform?.os === platform.os && referencedManifest.platform?.architecture === platform.architecture && (referencedManifest.platform?.variant ?? '') === (platform.variant ?? ''); }); } public async attestationDigests(opts: AttestationInspectOpts): Promise> { return (await this.attestationDescriptors(opts)).map(attestation => attestation.digest); } public async create(opts: CreateOpts): Promise { const args: Array = []; const metadataFile = Context.tmpName({tmpdir: Context.tmpDir(), template: 'imagetools-metadata-XXXXXX'}); const fileSources: Array = []; const sources: Array = []; for (const source of opts.sources) { if (source.startsWith('cwd://')) { const fileSource = source.substring('cwd://'.length); if (fileSource.length > 0) { fileSources.push(fileSource); } continue; } sources.push(source); } if (opts.tags) { for (const tag of opts.tags) { args.push('--tag', tag); } } if (opts.platforms) { for (const platform of opts.platforms) { args.push('--platform', platform); } } if (opts.annotations) { for (const annotation of opts.annotations) { args.push('--annotation', annotation); } } if (opts.dryRun) { args.push('--dry-run'); } else { args.push('--metadata-file', metadataFile); } for (const fileSource of fileSources) { args.push('--file', fileSource); } for (const source of sources) { args.push(source); } const cmd = await this.getCreateCommand(args); if (opts.skipExec) { core.info(`[command]${cmd.command} ${cmd.args.join(' ')}`); core.info(`Skipped create command`); return undefined; } return await Exec.getExecOutput(cmd.command, cmd.args, { ignoreReturnCode: true, silent: opts.silent }).then(res => { if (res.stderr.length > 0 && res.exitCode != 0) { throw new Error(res.stderr.trim()); } if (!opts.dryRun) { if (!fs.existsSync(metadataFile)) { return undefined; } const dt = fs.readFileSync(metadataFile, {encoding: 'utf-8'}).trim(); if (dt === '' || dt === 'null') { return undefined; } const response = JSON.parse(dt); const descriptor = response['containerimage.descriptor']; if (!descriptor) { return undefined; } return { digest: response['containerimage.digest'] || descriptor.digest, descriptor: descriptor, imageNames: response['image.name'] ? response['image.name'].split(',').map(name => name.trim()) : [] }; } }); } private async inspect(opts: InspectOpts, format: string, parser: (parsedOutput: unknown) => T): Promise { const cmd = await this.getInspectCommand([opts.name, '--format', format]); if (!opts.retryOnManifestUnknown) { return await this.execInspect(cmd.command, cmd.args, parser); } const retries = opts.retryLimit ?? 15; let lastError: Error | undefined; for (let attempt = 0; attempt < retries; attempt++) { try { return await this.execInspect(cmd.command, cmd.args, parser); } catch (err) { lastError = err as Error; if (!ImageTools.isManifestUnknownError(lastError.message) || attempt === retries - 1) { throw lastError; } core.info(`buildx imagetools inspect command failed with MANIFEST_UNKNOWN, retrying attempt ${attempt + 1}/${retries}...\n${lastError.message}`); await new Promise(res => setTimeout(res, Math.pow(2, attempt) * 100)); } } throw lastError ?? new Error(`ImageTools inspect command failed for ${opts.name}`); } private async execInspect(command: string, args: Array, parser: (parsedOutput: unknown) => T): Promise { return await Exec.getExecOutput(command, args, { ignoreReturnCode: true, silent: true }).then(res => { if (res.stderr.length > 0 && res.exitCode != 0) { throw new Error(res.stderr.trim()); } return parser(JSON.parse(res.stdout)); }); } private static isManifestUnknownError(message: string): boolean { return /(MANIFEST_UNKNOWN|manifest unknown|not found: not found)/i.test(message); } }