/** * Copyright 2023 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 * as exec from '@actions/exec'; import * as semver from 'semver'; import {Context} from './context'; import {Buildx} from './buildx/buildx'; import {Builder} from './buildx/builder'; import {BuilderInfo} from './types/builder'; export interface BuildKitOpts { context: Context; buildx?: Buildx; } export class BuildKit { private readonly context: Context; private readonly buildx: Buildx; private containerNamePrefix = 'buildx_buildkit_'; constructor(opts: BuildKitOpts) { this.context = opts.context; this.buildx = opts?.buildx || new Buildx({ context: this.context }); } public async getVersion(builderName: string): Promise { const builderInfo = await this.getBuilderInfo(builderName); if (builderInfo.nodes.length == 0) { // a builder always have on node, should not happen. return undefined; } // TODO: get version for all nodes const node = builderInfo.nodes[0]; if (!node.buildkitVersion && node.name) { try { return await this.getVersionWithinImage(node.name); } catch (e) { core.warning(e); } } return node.buildkitVersion; } private async getVersionWithinImage(nodeName: string): Promise { return exec .getExecOutput(`docker`, ['inspect', '--format', '{{.Config.Image}}', `${this.containerNamePrefix}${nodeName}`], { ignoreReturnCode: true, silent: true }) .then(bkitimage => { if (bkitimage.exitCode == 0 && bkitimage.stdout.length > 0) { return exec .getExecOutput(`docker`, ['run', '--rm', bkitimage.stdout.trim(), '--version'], { ignoreReturnCode: true, silent: true }) .then(bkitversion => { if (bkitversion.exitCode == 0 && bkitversion.stdout.length > 0) { return `${bkitimage.stdout.trim()} => ${bkitversion.stdout.trim()}`; } else if (bkitversion.stderr.length > 0) { throw new Error(bkitimage.stderr.trim()); } return bkitversion.stdout.trim(); }); } else if (bkitimage.stderr.length > 0) { throw new Error(bkitimage.stderr.trim()); } return bkitimage.stdout.trim(); }); } public async versionSatisfies(builderName: string, range: string): Promise { const builderInfo = await this.getBuilderInfo(builderName); for (const node of builderInfo.nodes) { let bkversion = node.buildkitVersion; if (!bkversion) { try { bkversion = await this.getVersionWithinImage(node.name || ''); } catch (e) { return false; } } // BuildKit version reported by moby is in the format of `v0.11.0-moby` if (builderInfo.driver == 'docker' && !bkversion.endsWith('-moby')) { return false; } if (!semver.satisfies(bkversion.replace(/-moby$/, ''), range)) { return false; } } return true; } public generateConfigInline(s: string): string { return this.generateConfig(s, false); } public generateConfigFile(s: string): string { return this.generateConfig(s, true); } private generateConfig(s: string, file: boolean): string { if (file) { if (!fs.existsSync(s)) { throw new Error(`config file ${s} not found`); } s = fs.readFileSync(s, {encoding: 'utf-8'}); } const configFile = this.context.tmpName({tmpdir: this.context.tmpDir()}); fs.writeFileSync(configFile, s); return configFile; } private async getBuilderInfo(name: string): Promise { const builder = new Builder({ context: this.context, buildx: this.buildx }); return builder.inspect(name); } }