Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions .github/workflows/__test-action-docker-create-images-manifests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,105 @@ jobs:
assert.deepEqual(denied.outputs, {});
}

- name: Test publication digests and mixed batches
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
with:
script: |
const assert = require('node:assert/strict');
const { stdout } = await exec.getExecOutput('ruby', [
'-rjson', '-ryaml', '-e',
'puts JSON.generate(YAML.safe_load(File.read(ARGV[0])))',
'actions/docker/create-images-manifests/action.yml',
]);
const action = JSON.parse(stdout);
const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
const sourceDigest = `sha256:${'a'.repeat(64)}`;
const indexDigest = `sha256:${'b'.repeat(64)}`;
const repository = 'registry.example.com/test/application';
const single = {
name: 'application', registry: 'registry.example.com', repository: 'test/application',
images: [`${repository}@${sourceDigest}`], digest: sourceDigest,
tags: ['test', 'latest'], annotations: { description: 'Application' },
platforms: ['linux/amd64'], 'multi-platform': false,
};

async function publish(input) {
const calls = [];
let images = JSON.stringify(input);
let requiresBuildx;
for (const stepId of ['prepare-images', 'create-images-manifests', 'get-built-images-digest']) {
const script = action.runs.steps.find(step => step.id === stepId).with.script;
await new AsyncFunction('process', 'core', 'exec', script)(
{ env: { INPUT_BUILT_IMAGES: images, BUILT_IMAGES_OUTPUT: images } },
{
debug() {}, info() {},
setOutput(name, value) {
if (name === 'built-images') images = value;
if (name === 'requires-buildx') requiresBuildx = value;
},
},
{ getExecOutput: async (command, args) => {
calls.push([command, ...args]);
return { exitCode: 0, stdout: `Digest: ${indexDigest}`, stderr: '' };
} },
);
}
return { images: JSON.parse(images), calls, requiresBuildx };
}

const reused = await publish({ application: single });
assert.equal(reused.requiresBuildx, 'false');
assert.deepEqual(reused.calls, []);
assert.deepEqual(reused.images.application, {
...single, images: single.tags.map(tag => `${repository}:${tag}@${sourceDigest}`),
});

const withoutDigest = { ...single };
delete withoutDigest.digest;
assert.deepEqual((await publish({ application: withoutDigest })).images, reused.images);
const taggedSource = { ...single, images: [`${repository}:test@${sourceDigest}`] };
assert.deepEqual((await publish({ application: taggedSource })).images, reused.images);

const multi = {
...single, name: 'multi', 'multi-platform': true,
platforms: ['linux/amd64', 'linux/arm64'],
images: [`${repository}@${sourceDigest}`, `${repository}@${indexDigest}`],
};
const mixed = await publish({ application: single, multi });
assert.equal(mixed.requiresBuildx, 'true');
assert.deepEqual(Object.keys(mixed.images), ['application', 'multi']);
assert.deepEqual(mixed.images.application, reused.images.application);
assert.deepEqual(mixed.images.multi, {
...multi, digest: indexDigest,
images: single.tags.map(tag => `${repository}:${tag}@${indexDigest}`),
});
assert.deepEqual(mixed.calls.map(call => call.slice(0, 4)), [
['docker', 'buildx', 'imagetools', 'create'],
['docker', 'buildx', 'imagetools', 'inspect'],
]);

const tagOnly = await publish({ application: { ...single, images: [`${repository}:test`] } });
assert.equal(tagOnly.requiresBuildx, 'true');
assert.equal(tagOnly.images.application.digest, indexDigest);
assert.deepEqual(tagOnly.calls, [['docker', 'buildx', 'imagetools', 'inspect', `${repository}:test`]]);
const clone = await publish({ application: { ...single, 'multi-platform': true } });
assert.equal(clone.images.application.digest, indexDigest);
assert.equal(clone.calls.length, 2);

for (const invalid of [null, [], { application: null }, { application: { ...single, images: [] } }]) {
await assert.rejects(publish(invalid));
}
await assert.rejects(publish({ application: { ...single, digest: indexDigest } }), /Conflicting digest/);
for (const tag of ['bad tag', 'bad@tag', '-invalid', 'a'.repeat(129)]) {
await assert.rejects(publish({ application: { ...single, tags: [tag] } }), /Invalid tag/);
}
for (const source of [
`other.example.com/test/application@${sourceDigest}`, `${repository}@sha256:invalid`,
`${repository}:@${sourceDigest}`, `${repository}:bad tag@${sourceDigest}`,
]) {
await assert.rejects(publish({ application: { ...single, images: [source] } }), /Invalid immutable source/);
}

build-original-tag:
name: Arrange - Build original tag
uses: $/.github/workflows/docker-build-images.yml
Expand Down
75 changes: 75 additions & 0 deletions .github/workflows/__test-action-docker-setup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,81 @@ on: # yamllint disable-line rule:truthy
permissions: {}

jobs:
tests-registry-only:
name: Test registry authentication without a Docker daemon
runs-on: ubuntu-latest
permissions:
contents: read
env:
DOCKER_HOST: unix:///tmp/ci-github-container-no-daemon.sock
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false

- name: Act - Authenticate without initializing Docker or Buildx
id: registry-only
uses: $/actions/docker/setup
with:
oci-registry: ghcr.io
oci-registry-username: ${{ github.repository_owner }}
oci-registry-password: ${{ github.token }}
setup-docker: false
setup-buildx: false
docker-version: "0.0.0"

- name: Assert - Registry-only CLI reuse and installation fallback
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
with:
script: |
const assert = require('node:assert/strict');
const { stdout } = await exec.getExecOutput('ruby', [
'-rjson', '-ryaml', '-e',
'puts JSON.generate(YAML.safe_load(File.read(ARGV[0])))',
'actions/docker/setup/action.yml',
]);
const action = JSON.parse(stdout);
const script = action.runs.steps.find(step => step.id === 'detect-docker').with.script;
const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor;
for (const dockerPath of ['/usr/bin/docker', '']) {
const outputs = {};
await new AsyncFunction('process', 'io', 'core', 'exec', script)(
{ env: { SETUP_DOCKER: 'false', EXPECTED_DOCKER_VERSION: 'test-version' } },
{ which: async () => dockerPath },
{ info() {}, setOutput: (name, value) => { outputs[name] = value; } },
{ getExecOutput: async () => { assert.fail('Registry-only setup must not contact the daemon'); } },
);
assert.deepEqual(outputs, dockerPath ? {} : { 'docker-install-version': 'test-version' });
}

- name: Assert - Registry-only outputs
env:
PUSH_REGISTRY: ${{ steps.registry-only.outputs.push-registry }}
BUILDX_NAME: ${{ steps.registry-only.outputs.buildx-name }}
run: |
test "$PUSH_REGISTRY" = "ghcr.io"
test -z "$BUILDX_NAME"
if docker info >/dev/null 2>&1; then
echo "::error::Test requires an unreachable Docker daemon"
exit 1
fi

- name: Act - Reject invalid registry credentials
id: denied
continue-on-error: true
uses: $/actions/docker/setup
with:
oci-registry: ghcr.io
oci-registry-username: ${{ github.repository_owner }}
oci-registry-password: invalid-test-credential
setup-docker: false
setup-buildx: false

- name: Assert - Authentication failure propagates
env:
LOGIN_OUTCOME: ${{ steps.denied.outcome }}
run: test "$LOGIN_OUTCOME" = "failure"

tests:
name: Test for "docker/setup" action
runs-on: ubuntu-latest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,12 @@ jobs:
};
}

function createScenario({ name, imageNames, platforms, attest }) {
function createScenario({ name, imageNames, platforms, attest, mixed = false }) {
return {
name,
attest,
images: JSON.stringify(imageNames.map(imageName => createImageDefinition(imageName, platforms))),
images: JSON.stringify(imageNames.map((imageName, index) =>
createImageDefinition(imageName, mixed && index === 1 ? ['linux/amd64', 'linux/arm64'] : platforms))),
verify_images: JSON.stringify(imageNames.map(imageName => `${imageName}:${tag}`)),
package_names: JSON.stringify(imageNames),
};
Expand All @@ -85,7 +86,8 @@ jobs:
attest: true,
}),
createScenario({
name: 'multiple images - attested',
name: 'mixed platforms - attested',
mixed: true,
imageNames: [
`${imageNamePrefix}-multi-image-attested-a`,
`${imageNamePrefix}-multi-image-attested-b`,
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docker-build-images.yml
Original file line number Diff line number Diff line change
Expand Up @@ -487,8 +487,7 @@ jobs:
permissions:
contents: read
packages: write
id-token: write # Needed for signing and attesting images
attestations: write # Needed for attesting images
id-token: write # Needed for signing images
needs: [prepare-variables, build-images]
runs-on: ${{ fromJson(inputs.runs-on) }}
outputs:
Expand Down Expand Up @@ -617,6 +616,7 @@ jobs:
oci-registry-username: ${{ inputs.oci-registry-username }}
oci-registry-password: ${{ secrets.oci-registry-password }} # zizmor: ignore[secrets-outside-env]
built-images: ${{ needs.publish-manifests.outputs.built-images }}
setup-docker: false
setup-buildx: false

- uses: $/actions/docker/attest-image
Expand Down
4 changes: 2 additions & 2 deletions actions/docker/create-images-manifests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
## Overview

Action to create built images manifests.
It uses the Docker Buildx plugin to create manifests for the built images.
It requires the Docker Buildx plugin to be installed and configured.
It reuses immutable single-platform build digests without inspecting tags.
It configures Docker Buildx when manifest creation or tag inspection is required.
It supports creating manifests for multiple images and platforms at once.

<!-- overview:end -->
Expand Down
81 changes: 64 additions & 17 deletions actions/docker/create-images-manifests/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name: "Docker - Create images manifests"
description: |
Action to create built images manifests.
It uses the Docker Buildx plugin to create manifests for the built images.
It requires the Docker Buildx plugin to be installed and configured.
It reuses immutable single-platform build digests without inspecting tags.
It configures Docker Buildx when manifest creation or tag inspection is required.
It supports creating manifests for multiple images and platforms at once.
author: hoverkraft
branding:
Expand Down Expand Up @@ -96,19 +96,79 @@ outputs:
runs:
using: "composite"
steps:
- id: prepare-images
name: Validate images and resolve publication tooling
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_BUILT_IMAGES: ${{ inputs.built-images }}
with:
script: |
const builtImages = JSON.parse(process.env.INPUT_BUILT_IMAGES || '');
if (!builtImages || Array.isArray(builtImages) || typeof builtImages !== 'object') {
throw new Error('"built-images" must be a JSON object');
}

const tagPattern = /^[\w][\w.-]{0,127}$/;
let requiresBuildx = false;
for (const [name, image] of Object.entries(builtImages)) {
if (!image || typeof image !== 'object' || Array.isArray(image)) {
throw new Error(`Invalid built image "${name}"`);
}
for (const field of ['registry', 'repository']) {
if (typeof image[field] !== 'string' || !image[field].trim()) {
throw new Error(`Missing "${field}" for "${name}"`);
}
}
for (const field of ['images', 'tags']) {
if (!Array.isArray(image[field]) || !image[field].length ||
image[field].some(value => typeof value !== 'string' || !value.trim())) {
throw new Error(`Expected non-empty "${field}" for "${name}"`);
}
}
if (image.tags.some(tag => !tagPattern.test(tag))) {
throw new Error(`Invalid tag for "${name}"`);
}

const previousDigest = image.digest;
delete image.digest;
if (!image['multi-platform'] && Array.isArray(image.platforms) &&
image.platforms.length === 1 && image.images.length === 1) {
const source = image.images[0];
const [reference, digest] = source.split('@');
const repository = `${image.registry}/${image.repository}`;
const sourceTag = reference.startsWith(`${repository}:`) ? reference.slice(repository.length + 1) : '';
if (source.includes('@')) {
if (source.split('@').length !== 2 || !/^sha256:[a-f0-9]{64}$/.test(digest) ||
(reference !== repository && !tagPattern.test(sourceTag))) {
throw new Error(`Invalid immutable source for "${name}": ${source}`);
}
if (previousDigest !== undefined && previousDigest !== digest) {
throw new Error(`Conflicting digest for "${name}"`);
}
image.digest = digest;
}
}
requiresBuildx ||= !image.digest;
}

core.setOutput('built-images', JSON.stringify(builtImages));
core.setOutput('requires-buildx', String(requiresBuildx));

- id: docker-setup
uses: $/actions/docker/setup
with:
oci-registry: ${{ inputs.oci-registry }}
oci-registry-username: ${{ inputs.oci-registry-username }}
oci-registry-password: ${{ inputs.oci-registry-password }}
built-images: ${{ inputs.built-images }}
setup-docker: ${{ steps.prepare-images.outputs.requires-buildx }}
setup-buildx: ${{ steps.prepare-images.outputs.requires-buildx }}

- id: create-images-manifests
name: Create images manifests and push
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
INPUT_BUILT_IMAGES: ${{ inputs.built-images }}
INPUT_BUILT_IMAGES: ${{ steps.prepare-images.outputs.built-images }}
with:
script: |
const builtImagesInput = process.env.INPUT_BUILT_IMAGES || "";
Expand All @@ -119,13 +179,6 @@ runs:
throw new Error(`"built-images" input is not a valid JSON: ${error}`);
}

// Helper function to validate image data
function validateImage(builtImage) {
if (!builtImage.images || builtImage.images.length === 0) {
throw new Error(`No images found for "${builtImage.name}"`);
}
}

// Helper function to create multiarch manifest
async function createMultiarchManifest(builtImage, imagesWithTags) {
const platformArgs = builtImage.platforms.flatMap(platform => ["--platform", platform]);
Expand Down Expand Up @@ -230,12 +283,6 @@ runs:
new Promise((resolve) => setTimeout(resolve, delayMs));

const getImageDigest = async function(image) {
// Check if the image already has a digest
if (image.match(/@/)) {
core.debug(`Image "${image}" already has a digest, skipping inspection.`);
return image;
}

const inspectImageArgs = ["buildx", "imagetools", "inspect", image];
const inspectImageCommand = `docker ${inspectImageArgs.join(" ")}`;
core.debug(`Inspecting image "${image}" with command: "${inspectImageCommand}"`);
Expand Down Expand Up @@ -305,7 +352,7 @@ runs:

await Promise.all(Object.keys(builtImages).map(async (imageName) => {
const builtImage = builtImages[imageName];
const digest = await getImageDigest(builtImage.images[0]);
const digest = builtImage.digest || await getImageDigest(builtImage.images[0]);

// Update built image with the digest
builtImage.digest = digest;
Expand Down
Loading
Loading