mirror of
https://github.com/docker/setup-buildx-action.git
synced 2026-11-17 07:35:01 +08:00
feat: allow endpoint derivation from BUILDKIT_HOST for remote driver
Signed-off-by: Suprovo Mallick (DYNO) <143953131+DYNOSuprovo@users.noreply.github.com>
This commit is contained in:
parent
bf8388060d
commit
fa32c19c66
4 changed files with 70 additions and 5 deletions
|
|
@ -92,7 +92,7 @@ The following inputs can be used as `step.with` keys:
|
||||||
| `buildkitd-config` \* | String | | [BuildKit daemon config file](https://docs.docker.com/engine/reference/commandline/buildx_create/#config) |
|
| `buildkitd-config` \* | String | | [BuildKit daemon config file](https://docs.docker.com/engine/reference/commandline/buildx_create/#config) |
|
||||||
| `buildkitd-config-inline` \* | String | | Same as `buildkitd-config` but inline |
|
| `buildkitd-config-inline` \* | String | | Same as `buildkitd-config` but inline |
|
||||||
| `use` | Bool | `true` | Switch to this builder instance |
|
| `use` | Bool | `true` | Switch to this builder instance |
|
||||||
| `endpoint` | String | | [Optional address for docker socket](https://docs.docker.com/engine/reference/commandline/buildx_create/#description) or context from `docker context ls` |
|
| `endpoint` | String | | [Optional address for docker socket](https://docs.docker.com/engine/reference/commandline/buildx_create/#description) or context from `docker context ls` (defaults to `BUILDKIT_HOST` for `remote` driver) |
|
||||||
| `platforms` | List/CSV | | Fixed [platforms](https://docs.docker.com/engine/reference/commandline/buildx_create/#platform) for current node. If not empty, values take priority over the detected ones |
|
| `platforms` | List/CSV | | Fixed [platforms](https://docs.docker.com/engine/reference/commandline/buildx_create/#platform) for current node. If not empty, values take priority over the detected ones |
|
||||||
| `append` | YAML | | [Append additional nodes](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder) to the builder |
|
| `append` | YAML | | [Append additional nodes](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder) to the builder |
|
||||||
| `keep-state` | Bool | `false` | Keep BuildKit state on `cleanup`. This is only useful on persistent self-hosted runners |
|
| `keep-state` | Bool | `false` | Keep BuildKit state on `cleanup`. This is only useful on persistent self-hosted runners |
|
||||||
|
|
|
||||||
|
|
@ -320,6 +320,70 @@ describe('getCreateArgs', () => {
|
||||||
versionSpy.mockRestore();
|
versionSpy.mockRestore();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('derives endpoint from BUILDKIT_HOST env var when driver is remote', async () => {
|
||||||
|
process.env.BUILDKIT_HOST = 'tcp://127.0.0.1:1234';
|
||||||
|
setInput('driver', 'remote');
|
||||||
|
setInput('use', 'true');
|
||||||
|
setInput('cache-binary', 'true');
|
||||||
|
setInput('cleanup', 'true');
|
||||||
|
setInput('keep-state', 'false');
|
||||||
|
const toolkit = new Toolkit();
|
||||||
|
const versionSpy = vi.spyOn(Buildx.prototype, 'version').mockImplementation(async (): Promise<string> => {
|
||||||
|
return 'v0.10.3';
|
||||||
|
});
|
||||||
|
try {
|
||||||
|
const inp = await context.getInputs();
|
||||||
|
expect(inp.endpoint).toBe('tcp://127.0.0.1:1234');
|
||||||
|
const res = await context.getCreateArgs(inp, toolkit);
|
||||||
|
expect(res).toEqual(['create', '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d', '--driver', 'remote', '--use', 'tcp://127.0.0.1:1234']);
|
||||||
|
} finally {
|
||||||
|
versionSpy.mockRestore();
|
||||||
|
delete process.env.BUILDKIT_HOST;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test('endpoint input takes precedence over BUILDKIT_HOST env var when driver is remote', async () => {
|
||||||
|
process.env.BUILDKIT_HOST = 'tcp://127.0.0.1:1234';
|
||||||
|
setInput('driver', 'remote');
|
||||||
|
setInput('endpoint', 'tcp://10.0.0.1:5678');
|
||||||
|
setInput('use', 'true');
|
||||||
|
setInput('cache-binary', 'true');
|
||||||
|
setInput('cleanup', 'true');
|
||||||
|
setInput('keep-state', 'false');
|
||||||
|
const toolkit = new Toolkit();
|
||||||
|
const versionSpy = vi.spyOn(Buildx.prototype, 'version').mockImplementation(async (): Promise<string> => {
|
||||||
|
return 'v0.10.3';
|
||||||
|
});
|
||||||
|
try {
|
||||||
|
const inp = await context.getInputs();
|
||||||
|
expect(inp.endpoint).toBe('tcp://10.0.0.1:5678');
|
||||||
|
const res = await context.getCreateArgs(inp, toolkit);
|
||||||
|
expect(res).toEqual(['create', '--name', 'builder-9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d', '--driver', 'remote', '--use', 'tcp://10.0.0.1:5678']);
|
||||||
|
} finally {
|
||||||
|
versionSpy.mockRestore();
|
||||||
|
delete process.env.BUILDKIT_HOST;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test('does not derive endpoint from BUILDKIT_HOST when driver is not remote', async () => {
|
||||||
|
process.env.BUILDKIT_HOST = 'tcp://127.0.0.1:1234';
|
||||||
|
setInput('driver', 'docker-container');
|
||||||
|
setInput('use', 'true');
|
||||||
|
setInput('cache-binary', 'true');
|
||||||
|
setInput('cleanup', 'true');
|
||||||
|
setInput('keep-state', 'false');
|
||||||
|
const versionSpy = vi.spyOn(Buildx.prototype, 'version').mockImplementation(async (): Promise<string> => {
|
||||||
|
return 'v0.10.3';
|
||||||
|
});
|
||||||
|
try {
|
||||||
|
const inp = await context.getInputs();
|
||||||
|
expect(inp.endpoint).toBe('');
|
||||||
|
} finally {
|
||||||
|
versionSpy.mockRestore();
|
||||||
|
delete process.env.BUILDKIT_HOST;
|
||||||
|
}
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('getAppendArgs', () => {
|
describe('getAppendArgs', () => {
|
||||||
|
|
|
||||||
|
|
@ -34,7 +34,7 @@ inputs:
|
||||||
description: 'Name of the builder. If not specified, one will be generated or if it already exists, it will be used instead of creating a new one.'
|
description: 'Name of the builder. If not specified, one will be generated or if it already exists, it will be used instead of creating a new one.'
|
||||||
required: false
|
required: false
|
||||||
endpoint:
|
endpoint:
|
||||||
description: 'Optional address for docker socket or context from `docker context ls`'
|
description: 'Optional address for docker socket or context from `docker context ls` (defaults to BUILDKIT_HOST for remote driver)'
|
||||||
required: false
|
required: false
|
||||||
platforms:
|
platforms:
|
||||||
description: 'Fixed platforms for current node. If not empty, values take priority over the detected ones'
|
description: 'Fixed platforms for current node. If not empty, values take priority over the detected ones'
|
||||||
|
|
|
||||||
|
|
@ -28,15 +28,16 @@ export interface Inputs {
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function getInputs(): Promise<Inputs> {
|
export async function getInputs(): Promise<Inputs> {
|
||||||
|
const driver = core.getInput('driver') || 'docker-container';
|
||||||
return {
|
return {
|
||||||
version: core.getInput('version'),
|
version: core.getInput('version'),
|
||||||
name: await getBuilderName(core.getInput('name'), core.getInput('driver') || 'docker-container'),
|
name: await getBuilderName(core.getInput('name'), driver),
|
||||||
driver: core.getInput('driver') || 'docker-container',
|
driver: driver,
|
||||||
driverOpts: Util.getInputList('driver-opts', {ignoreComma: true, quote: false}),
|
driverOpts: Util.getInputList('driver-opts', {ignoreComma: true, quote: false}),
|
||||||
buildkitdFlags: core.getInput('buildkitd-flags'),
|
buildkitdFlags: core.getInput('buildkitd-flags'),
|
||||||
platforms: Util.getInputList('platforms'),
|
platforms: Util.getInputList('platforms'),
|
||||||
use: core.getBooleanInput('use'),
|
use: core.getBooleanInput('use'),
|
||||||
endpoint: core.getInput('endpoint'),
|
endpoint: core.getInput('endpoint') || (driver === 'remote' ? process.env.BUILDKIT_HOST || '' : ''),
|
||||||
buildkitdConfig: core.getInput('buildkitd-config'),
|
buildkitdConfig: core.getInput('buildkitd-config'),
|
||||||
buildkitdConfigInline: core.getInput('buildkitd-config-inline'),
|
buildkitdConfigInline: core.getInput('buildkitd-config-inline'),
|
||||||
append: core.getInput('append'),
|
append: core.getInput('append'),
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue