docker/actions-toolkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

make Context static

Browse Source 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax
2023-02-20 07:19:57 +01:00
parent 580aee99c0
commit a0e8f0bf18
14 changed files with 80 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/buildkit/buildkit.ts
View File

@@ -18,7 +18,6 @@ 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 {Config} from './config';
@@ -26,24 +25,17 @@ import {Config} from './config';
import {BuilderInfo, NodeInfo} from '../types/builder';
export interface BuildKitOpts {
context: Context;
buildx?: Buildx;
}
export class BuildKit {
private readonly context: Context;
private readonly buildx: Buildx;
public readonly config: Config;
constructor(opts: BuildKitOpts) {
this.context = opts.context;
this.config = new Config(this.context);
this.buildx =
opts?.buildx ||
new Buildx({
context: this.context
});
constructor(opts?: BuildKitOpts) {
this.config = new Config();
this.buildx = opts?.buildx || new Buildx();
}
public async getVersion(node: NodeInfo): Promise<string | undefined> {
@@ -89,10 +81,7 @@ export class BuildKit {
public async versionSatisfies(builderName: string, range: string, builderInfo?: BuilderInfo): Promise<boolean> {
if (!builderInfo) {
builderInfo = await new Builder({
context: this.context,
buildx: this.buildx
}).inspect(builderName);
builderInfo = await new Builder({buildx: this.buildx}).inspect(builderName);
}
for (const node of builderInfo.nodes) {
core.debug(`BuildKit.versionSatisfies ${node}: ${range}`);

8
src/buildkit/config.ts
View File

@@ -19,12 +19,6 @@ import fs from 'fs';
import {Context} from '../context';
export class Config {
private readonly context: Context;
constructor(context: Context) {
this.context = context;
}
public resolveFromString(s: string): string {
return this.resolve(s, false);
}
@@ -40,7 +34,7 @@ export class Config {
}
s = fs.readFileSync(s, {encoding: 'utf-8'});
}
const configFile = this.context.tmpName({tmpdir: this.context.tmpDir()});
const configFile = Context.tmpName({tmpdir: Context.tmpDir()});
fs.writeFileSync(configFile, s);
return configFile;
}

12
src/buildx/builder.ts
View File

@@ -17,26 +17,18 @@
import * as exec from '@actions/exec';
import {Buildx} from './buildx';
import {Context} from '../context';
import {BuilderInfo, NodeInfo} from '../types/builder';
export interface BuilderOpts {
context: Context;
buildx?: Buildx;
}
export class Builder {
private readonly context: Context;
private readonly buildx: Buildx;
constructor(opts: BuilderOpts) {
this.context = opts.context;
this.buildx =
opts?.buildx ||
new Buildx({
context: this.context
});
constructor(opts?: BuilderOpts) {
this.buildx = opts?.buildx || new Buildx();
}
public async inspect(name: string): Promise<BuilderInfo> {

8
src/buildx/buildx.ts
View File

@@ -21,13 +21,11 @@ import * as exec from '@actions/exec';
import * as semver from 'semver';
import {Docker} from '../docker';
import {Context} from '../context';
import {Inputs} from './inputs';
import {Cert} from '../types/buildx';
export interface BuildxOpts {
context: Context;
standalone?: boolean;
}
@@ -35,15 +33,13 @@ export class Buildx {
private _version: string | undefined;
private readonly _standalone: boolean | undefined;
private readonly context: Context;
public readonly inputs: Inputs;
public static readonly containerNamePrefix = 'buildx_buildkit_';
constructor(opts: BuildxOpts) {
constructor(opts?: BuildxOpts) {
this._standalone = opts?.standalone;
this.context = opts.context;
this.inputs = new Inputs(this.context);
this.inputs = new Inputs();
}
static get configDir(): string {

19
src/buildx/inputs.ts
View File

@@ -22,18 +22,12 @@ import {parse} from 'csv-parse/sync';
import {Context} from '../context';
export class Inputs {
private readonly context: Context;
constructor(context: Context) {
this.context = context;
}
public getBuildImageIDFilePath(): string {
return path.join(this.context.tmpDir(), 'iidfile');
return path.join(Context.tmpDir(), 'iidfile');
}
public getBuildMetadataFilePath(): string {
return path.join(this.context.tmpDir(), 'metadata-file');
return path.join(Context.tmpDir(), 'metadata-file');
}
public resolveBuildImageID(): string | undefined {
@@ -89,7 +83,7 @@ export class Inputs {
}
value = fs.readFileSync(value, {encoding: 'utf-8'});
}
const secretFile = this.context.tmpName({tmpdir: this.context.tmpDir()});
const secretFile = Context.tmpName({tmpdir: Context.tmpDir()});
fs.writeFileSync(secretFile, value);
return `id=${key},src=${secretFile}`;
}
@@ -100,9 +94,8 @@ export class Inputs {
// if input is not set returns empty string
return input;
}
const builderID = this.context.provenanceBuilderID;
try {
return core.getBooleanInput(name) ? `builder-id=${builderID}` : 'false';
return core.getBooleanInput(name) ? `builder-id=${Context.provenanceBuilderID()}` : 'false';
} catch (err) {
// not a valid boolean, so we assume it's a string
return this.resolveProvenanceAttrs(input);
@@ -111,7 +104,7 @@ export class Inputs {
public resolveProvenanceAttrs(input: string): string {
if (!input) {
return `builder-id=${this.context.provenanceBuilderID}`;
return `builder-id=${Context.provenanceBuilderID()}`;
}
// parse attributes from input
const fields = parse(input, {
@@ -129,7 +122,7 @@ export class Inputs {
}
}
// if not add builder-id attribute
return `${input},builder-id=${this.context.provenanceBuilderID}`;
return `${input},builder-id=${Context.provenanceBuilderID()}`;
}
public static hasLocalExporter(exporters: string[]): boolean {

14
src/buildx/install.ts
View File

@@ -32,17 +32,13 @@ import {Git} from '../git';
import {GitHubRelease} from '../types/github';
export interface InstallOpts {
context?: Context;
standalone?: boolean;
}
export class Install {
private readonly _standalone: boolean | undefined;
private readonly context: Context;
constructor(opts?: InstallOpts) {
this.context = opts?.context || new Context();
this._standalone = opts?.standalone;
}
@@ -84,7 +80,7 @@ export class Install {
let toolPath: string;
toolPath = tc.find('buildx', vspec);
if (!toolPath) {
const outputDir = path.join(this.context.tmpDir(), 'build-cache');
const outputDir = path.join(Context.tmpDir(), 'build-cache');
const buildCmd = await this.buildCommand(gitContext, outputDir);
toolPath = await exec
.getExecOutput(buildCmd.command, buildCmd.args, {
@@ -103,7 +99,7 @@ export class Install {
public async installStandalone(toolPath: string, dest?: string): Promise<string> {
core.info('Standalone mode');
dest = dest || this.context.tmpDir();
dest = dest || Context.tmpDir();
const toolBinPath = path.join(toolPath, os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
const binDir = path.join(dest, 'bin');
if (!fs.existsSync(binDir)) {
@@ -143,8 +139,8 @@ export class Install {
}
private async buildCommand(gitContext: string, outputDir: string): Promise<{args: Array<string>; command: string}> {
const buildxStandaloneFound = await new Buildx({context: this.context, standalone: true}).isAvailable();
const buildxPluginFound = await new Buildx({context: this.context, standalone: false}).isAvailable();
const buildxStandaloneFound = await new Buildx({standalone: true}).isAvailable();
const buildxPluginFound = await new Buildx({standalone: false}).isAvailable();
let buildStandalone = false;
if ((await this.isStandalone()) && buildxStandaloneFound) {
@@ -164,7 +160,7 @@ export class Install {
}
//prettier-ignore
return await new Buildx({context: this.context, standalone: buildStandalone}).getCommand([
return await new Buildx({standalone: buildStandalone}).getCommand([
'build',
'--target', 'binaries',
'--build-arg', 'BUILDKIT_CONTEXT_KEEP_GIT_DIR=1',

43
src/context.ts
View File

@@ -23,29 +23,32 @@ import * as github from '@actions/github';
import {GitHub} from './github';
export class Context {
public gitRef: string;
public buildGitContext: string;
public provenanceBuilderID: string;
private static readonly _tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-actions-toolkit-'));
private readonly _tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-actions-toolkit-'));
constructor() {
this.gitRef = github.context.ref;
if (github.context.sha && this.gitRef && !this.gitRef.startsWith('refs/')) {
this.gitRef = `refs/heads/${github.context.ref}`;
}
if (github.context.sha && !this.gitRef.startsWith(`refs/pull/`)) {
this.gitRef = github.context.sha;
}
this.buildGitContext = `${GitHub.serverURL}/${github.context.repo.owner}/${github.context.repo.repo}.git#${this.gitRef}`;
this.provenanceBuilderID = `${GitHub.serverURL}/${github.context.repo.owner}/${github.context.repo.repo}/actions/runs/${github.context.runId}`;
public static tmpDir(): string {
return Context._tmpDir;
}
public tmpDir(): string {
return this._tmpDir;
}
public tmpName(options?: tmp.TmpNameOptions): string {
public static tmpName(options?: tmp.TmpNameOptions): string {
return tmp.tmpNameSync(options);
}
public static gitRef(): string {
let gitRef = github.context.ref;
if (github.context.sha && gitRef && !gitRef.startsWith('refs/')) {
gitRef = `refs/heads/${github.context.ref}`;
}
if (github.context.sha && !gitRef.startsWith(`refs/pull/`)) {
gitRef = github.context.sha;
}
return gitRef;
}
public static gitContext(): string {
return `${GitHub.serverURL}/${github.context.repo.owner}/${github.context.repo.repo}.git#${Context.gitRef()}`;
}
public static provenanceBuilderID(): string {
return `${GitHub.serverURL}/${github.context.repo.owner}/${github.context.repo.repo}/actions/runs/${github.context.runId}`;
}
}

11
src/toolkit.ts
View File

@@ -14,7 +14,6 @@
* limitations under the License.
*/
import {Context} from './context';
import {Buildx} from './buildx/buildx';
import {Install} from './buildx/install';
import {Builder} from './buildx/builder';
@@ -30,7 +29,6 @@ export interface ToolkitOpts {
}
export class Toolkit {
public context: Context;
public github: GitHub;
public buildx: Buildx;
public buildxInstall: Install;
@@ -38,11 +36,10 @@ export class Toolkit {
public buildkit: BuildKit;
constructor(opts: ToolkitOpts = {}) {
this.context = new Context();
this.github = new GitHub({token: opts.githubToken});
this.buildx = new Buildx({context: this.context});
this.buildxInstall = new Install({context: this.context});
this.builder = new Builder({context: this.context, buildx: this.buildx});
this.buildkit = new BuildKit({context: this.context, buildx: this.buildx});
this.buildx = new Buildx();
this.buildxInstall = new Install();
this.builder = new Builder({buildx: this.buildx});
this.buildkit = new BuildKit({buildx: this.buildx});
}
}