Skip to content

Commit 3472856

Browse files
crazy-maxcrazy-max
committed
support standalone mode and display version
Signed-off-by: CrazyMax <[email protected]>
1 parent 2a6fbda commit 3472856

9 files changed

+223
-46
lines changed

‎README.md

+31-3
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ ___
2424
* [BuildKit daemon configuration](#buildkit-daemon-configuration)
2525
* [Registry mirror](#registry-mirror)
2626
* [Max parallelism](#max-parallelism)
27+
* [Standalone mode](#standalone-mode)
2728
* [Customizing](#customizing)
2829
* [inputs](#inputs)
2930
* [outputs](#outputs)
@@ -180,6 +181,33 @@ jobs:
180181
config: .github/buildkitd.toml
181182
```
182183

184+
### Standalone mode
185+
186+
If you don't have the Docker CLI installed on the GitHub Runner, buildx binary
187+
is invoked directly, instead of calling it as a docker plugin. This can be
188+
useful if you want to use the `kubernetes` driver in your self-hosted runner:
189+
190+
```yaml
191+
name: ci
192+
193+
on:
194+
push:
195+
196+
jobs:
197+
buildx:
198+
runs-on: ubuntu-latest
199+
steps:
200+
-
201+
name: Set up Docker Buildx
202+
uses: docker/setup-buildx-action@v1
203+
with:
204+
driver: kubernetes
205+
-
206+
name: Build
207+
run: |
208+
buildx build .
209+
```
210+
183211
## Customizing
184212

185213
### inputs
@@ -195,10 +223,10 @@ Following inputs can be used as `step.with` keys
195223
| `install` | Bool | Sets up `docker build` command as an alias to `docker buildx` (default `false`) |
196224
| `use` | Bool | Switch to this builder instance (default `true`) |
197225
| `endpoint` | String | [Optional address for docker socket](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#description) or context from `docker context ls` |
198-
| `config` | String | [BuildKit config file](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#config) |
199-
| `config-inline` | String | Same as `config` but inline |
226+
| `config`¹ | String | [BuildKit config file](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#config) |
227+
| `config-inline`¹ | String | Same as `config` but inline |
200228

201-
> `config` and `config-inline` are mutually exclusive.
229+
> * ¹ `config` and `config-inline` are mutually exclusive
202230

203231
> `CSV` type must be a newline-delimited string
204232
> ```yaml

‎__tests__/buildx.test.ts

+26-12
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@ describe('isAvailable', () => {
3232
});
3333
});
3434

35+
describe('isAvailable standalone', () => {
36+
const execSpy = jest.spyOn(exec, 'getExecOutput');
37+
buildx.isAvailable(true);
38+
39+
// eslint-disable-next-line jest/no-standalone-expect
40+
expect(execSpy).toHaveBeenCalledWith(`buildx`, [], {
41+
silent: true,
42+
ignoreReturnCode: true
43+
});
44+
});
45+
3546
describe('getVersion', () => {
3647
it('valid', async () => {
3748
const version = await buildx.getVersion();
@@ -75,29 +86,32 @@ describe('build', () => {
7586

7687
// eslint-disable-next-line jest/no-disabled-tests
7788
it.skip('builds refs/pull/648/head', async () => {
78-
const buildxBin = await buildx.build('https://github.com/docker/buildx.git#refs/pull/648/head', tmpDir);
89+
const buildxBin = await buildx.build('https://github.com/docker/buildx.git#refs/pull/648/head', tmpDir, false);
7990
expect(fs.existsSync(buildxBin)).toBe(true);
8091
}, 100000);
8192

8293
// eslint-disable-next-line jest/no-disabled-tests
8394
it.skip('builds 67bd6f4dc82a9cd96f34133dab3f6f7af803bb14', async () => {
84-
const buildxBin = await buildx.build('https://github.com/docker/buildx.git#67bd6f4dc82a9cd96f34133dab3f6f7af803bb14', tmpDir);
95+
const buildxBin = await buildx.build('https://github.com/docker/buildx.git#67bd6f4dc82a9cd96f34133dab3f6f7af803bb14', tmpDir, false);
8596
expect(fs.existsSync(buildxBin)).toBe(true);
8697
}, 100000);
8798
});
8899

89100
describe('install', () => {
90101
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'setup-buildx-'));
91-
92-
it('acquires v0.4.1 version of buildx', async () => {
93-
const buildxBin = await buildx.install('v0.4.1', tmpDir);
94-
expect(fs.existsSync(buildxBin)).toBe(true);
95-
}, 100000);
96-
97-
it('acquires latest version of buildx', async () => {
98-
const buildxBin = await buildx.install('latest', tmpDir);
99-
expect(fs.existsSync(buildxBin)).toBe(true);
100-
}, 100000);
102+
test.each([
103+
['v0.4.1', false],
104+
['latest', false],
105+
['v0.4.1', true],
106+
['latest', true]
107+
])(
108+
'acquires %p of buildx (standalone: %p)',
109+
async (version, standalone) => {
110+
const buildxBin = await buildx.install(version, tmpDir, standalone);
111+
expect(fs.existsSync(buildxBin)).toBe(true);
112+
},
113+
100000
114+
);
101115
});
102116

103117
describe('getConfig', () => {

‎__tests__/docker.test.ts

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import {describe, expect, it, jest} from '@jest/globals';
2+
import * as docker from '../src/docker';
3+
import * as exec from '@actions/exec';
4+
5+
describe('isAvailable', () => {
6+
it('cli', () => {
7+
const execSpy = jest.spyOn(exec, 'getExecOutput');
8+
docker.isAvailable();
9+
10+
// eslint-disable-next-line jest/no-standalone-expect
11+
expect(execSpy).toHaveBeenCalledWith(`docker`, undefined, {
12+
silent: true,
13+
ignoreReturnCode: true
14+
});
15+
});
16+
});

‎dist/index.js

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/index.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/buildx.ts

+78-12
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,10 @@ export async function getConfig(s: string, file: boolean): Promise<string> {
4141
return configFile;
4242
}
4343

44-
export async function isAvailable(): Promise<boolean> {
44+
export async function isAvailable(standalone?: boolean): Promise<boolean> {
45+
const cmd = getCommand([], standalone);
4546
return await exec
46-
.getExecOutput('docker', ['buildx'], {
47+
.getExecOutput(cmd.commandLine, cmd.args, {
4748
ignoreReturnCode: true,
4849
silent: true
4950
})
@@ -52,12 +53,17 @@ export async function isAvailable(): Promise<boolean> {
5253
return false;
5354
}
5455
return res.exitCode == 0;
56+
})
57+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
58+
.catch(error => {
59+
return false;
5560
});
5661
}
5762

58-
export async function getVersion(): Promise<string> {
63+
export async function getVersion(standalone?: boolean): Promise<string> {
64+
const cmd = getCommand(['version'], standalone);
5965
return await exec
60-
.getExecOutput('docker', ['buildx', 'version'], {
66+
.getExecOutput(cmd.commandLine, cmd.args, {
6167
ignoreReturnCode: true,
6268
silent: true
6369
})
@@ -81,9 +87,10 @@ export function satisfies(version: string, range: string): boolean {
8187
return semver.satisfies(version, range) || /^[0-9a-f]{7}$/.exec(version) !== null;
8288
}
8389

84-
export async function inspect(name: string): Promise<Builder> {
90+
export async function inspect(name: string, standalone?: boolean): Promise<Builder> {
91+
const cmd = getCommand(['inspect', name], standalone);
8592
return await exec
86-
.getExecOutput(`docker`, ['buildx', 'inspect', name], {
93+
.getExecOutput(cmd.commandLine, cmd.args, {
8794
ignoreReturnCode: true,
8895
silent: true
8996
})
@@ -133,7 +140,7 @@ export async function inspect(name: string): Promise<Builder> {
133140
});
134141
}
135142

136-
export async function build(inputBuildRef: string, dockerConfigHome: string): Promise<string> {
143+
export async function build(inputBuildRef: string, dest: string, standalone: boolean): Promise<string> {
137144
// eslint-disable-next-line prefer-const
138145
let [repo, ref] = inputBuildRef.split('#');
139146
if (ref.length == 0) {
@@ -152,8 +159,27 @@ export async function build(inputBuildRef: string, dockerConfigHome: string): Pr
152159
toolPath = tc.find('buildx', vspec);
153160
if (!toolPath) {
154161
const outFolder = path.join(context.tmpDir(), 'out').split(path.sep).join(path.posix.sep);
162+
let buildWithStandalone = false;
163+
const standaloneFound = await isAvailable(true);
164+
const pluginFound = await isAvailable(false);
165+
if (standalone && standaloneFound) {
166+
core.debug(`Buildx standalone found, build with it`);
167+
buildWithStandalone = true;
168+
} else if (!standalone && pluginFound) {
169+
core.debug(`Buildx plugin found, build with it`);
170+
buildWithStandalone = false;
171+
} else if (standaloneFound) {
172+
core.debug(`Buildx plugin not found, but standalone found so trying to build with it`);
173+
buildWithStandalone = true;
174+
} else if (pluginFound) {
175+
core.debug(`Buildx standalone not found, but plugin found so trying to build with it`);
176+
buildWithStandalone = false;
177+
} else {
178+
throw new Error(`Neither buildx standalone or plugin have been found to build from ref`);
179+
}
180+
const buildCmd = getCommand(['build', '--target', 'binaries', '--build-arg', 'BUILDKIT_CONTEXT_KEEP_GIT_DIR=1', '--output', `type=local,dest=${outFolder}`, inputBuildRef], buildWithStandalone);
155181
toolPath = await exec
156-
.getExecOutput('docker', ['buildx', 'build', '--target', 'binaries', '--build-arg', 'BUILDKIT_CONTEXT_KEEP_GIT_DIR=1', '--output', `type=local,dest=${outFolder}`, inputBuildRef], {
182+
.getExecOutput(buildCmd.commandLine, buildCmd.args, {
157183
ignoreReturnCode: true
158184
})
159185
.then(res => {
@@ -164,10 +190,13 @@ export async function build(inputBuildRef: string, dockerConfigHome: string): Pr
164190
});
165191
}
166192

167-
return setPlugin(toolPath, dockerConfigHome);
193+
if (standalone) {
194+
return setStandalone(toolPath, dest);
195+
}
196+
return setPlugin(toolPath, dest);
168197
}
169198

170-
export async function install(inputVersion: string, dockerConfigHome: string): Promise<string> {
199+
export async function install(inputVersion: string, dest: string, standalone: boolean): Promise<string> {
171200
const release: github.GitHubRelease | null = await github.getRelease(inputVersion);
172201
if (!release) {
173202
throw new Error(`Cannot find buildx ${inputVersion} release`);
@@ -185,10 +214,40 @@ export async function install(inputVersion: string, dockerConfigHome: string): P
185214
toolPath = await download(version);
186215
}
187216

188-
return setPlugin(toolPath, dockerConfigHome);
217+
if (standalone) {
218+
return setStandalone(toolPath, dest);
219+
}
220+
return setPlugin(toolPath, dest);
221+
}
222+
223+
async function setStandalone(toolPath: string, dest: string): Promise<string> {
224+
core.info('Standalone mode');
225+
const toolBinPath = path.join(toolPath, context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
226+
227+
const binDir = path.join(dest, 'bin');
228+
core.debug(`Bin dir is ${binDir}`);
229+
if (!fs.existsSync(binDir)) {
230+
fs.mkdirSync(binDir, {recursive: true});
231+
}
232+
233+
const filename: string = context.osPlat == 'win32' ? 'buildx.exe' : 'buildx';
234+
const buildxPath: string = path.join(binDir, filename);
235+
core.debug(`Bin path is ${buildxPath}`);
236+
fs.copyFileSync(toolBinPath, buildxPath);
237+
238+
core.info('Fixing perms');
239+
fs.chmodSync(buildxPath, '0755');
240+
241+
core.addPath(binDir);
242+
core.info('Added buildx to the path');
243+
244+
return buildxPath;
189245
}
190246

191247
async function setPlugin(toolPath: string, dockerConfigHome: string): Promise<string> {
248+
core.info('Docker plugin mode');
249+
const toolBinPath = path.join(toolPath, context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
250+
192251
const pluginsDir: string = path.join(dockerConfigHome, 'cli-plugins');
193252
core.debug(`Plugins dir is ${pluginsDir}`);
194253
if (!fs.existsSync(pluginsDir)) {
@@ -198,7 +257,7 @@ async function setPlugin(toolPath: string, dockerConfigHome: string): Promise<st
198257
const filename: string = context.osPlat == 'win32' ? 'docker-buildx.exe' : 'docker-buildx';
199258
const pluginPath: string = path.join(pluginsDir, filename);
200259
core.debug(`Plugin path is ${pluginPath}`);
201-
fs.copyFileSync(path.join(toolPath, filename), pluginPath);
260+
fs.copyFileSync(toolBinPath, pluginPath);
202261

203262
core.info('Fixing perms');
204263
fs.chmodSync(pluginPath, '0755');
@@ -269,3 +328,10 @@ export async function getBuildKitVersion(containerID: string): Promise<string> {
269328
return bkitimage.stdout.trim();
270329
});
271330
}
331+
332+
export function getCommand(args: Array<string>, standalone?: boolean) {
333+
return {
334+
commandLine: standalone ? 'buildx' : 'docker',
335+
args: standalone ? args : ['buildx', ...args]
336+
};
337+
}

‎src/docker.ts

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import * as exec from '@actions/exec';
2+
3+
export async function isAvailable(): Promise<boolean> {
4+
return await exec
5+
.getExecOutput('docker', undefined, {
6+
ignoreReturnCode: true,
7+
silent: true
8+
})
9+
.then(res => {
10+
if (res.stderr.length > 0 && res.exitCode != 0) {
11+
return false;
12+
}
13+
return res.exitCode == 0;
14+
})
15+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
16+
.catch(error => {
17+
return false;
18+
});
19+
}

0 commit comments

Comments
 (0)