feat(registry): add helper functions to pull and tag images #3275

mdelapenya · 2025-09-05T10:43:22Z

What does this PR do?

This PR adds a couple of helper functions to interact with the registry module:

PullImage
TagImage

When pulling images, it will use the same architecture as the image used to run the registry, as it could be using and arm-based image. Important to notice that, when inspecting an image, the field ImageManifestDescriptor response field is only available with containerd integration enabled. This happens on recent installations of Docker Desktop. If that field is nil, the pulled image will use linux as OS and the host's architecture.

Why is it important?

Currently, the registry module does not support these two simple operations.
I've found them useful to have in the library, since most tests that rely on modules/registry will probably need to use them.

Related issues

Supersedes and Closes feat(registry): add helper functions to pull and tag images #3271

Signed-off-by: Alessio Greggi <[email protected]>

…kerClientWithOpts Signed-off-by: Alessio Greggi <[email protected]>

Signed-off-by: Alessio Greggi <[email protected]>

netlify · 2025-09-05T10:43:32Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`c75ad23`
🔍 Latest deploy log	https://app.netlify.com/projects/testcontainers-go/deploys/68bae2e2db295a0008d7ae6d
😎 Deploy Preview	https://deploy-preview-3275--testcontainers-go.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

Pull Request Overview

This PR adds two helper functions to the registry module: PullImage and TagImage, providing convenient methods for pulling images from external registries and tagging local images. These functions complement the existing PushImage functionality to offer a more complete set of registry operations.

Adds PullImage method to download images from external registries with platform matching
Adds TagImage method to tag local images for registry operations
Updates existing code to use testcontainers.NewDockerClientWithOpts for consistency

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
`modules/registry/registry.go`	Implements new `PullImage` and `TagImage` methods, updates Docker client creation in `PushImage`
`modules/registry/registry_test.go`	Adds test for `PullImage` functionality with platform verification
`modules/registry/examples_test.go`	Updates example to demonstrate new pull and tag operations
`docs/modules/registry.md`	Adds documentation for the new helper functions

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

modules/registry/examples_test.go

* main: fix(reaper): remove termSignal override (testcontainers#3261) chore(deps): bump ryuk to v0.13.0, which uses scratch as base image (testcontainers#3274) chore(release): refine release script to update inter-module dependencies (testcontainers#3273) fix(registry): update `WithHtpasswd` to use `os.CreateTemp` instead of `os.Create` with `filepath.Join`. (testcontainers#3272)

…ould be nil The ImageManifestDescriptor is only available with containerd integration enabled. DD is containerd by default on new installations

modules/registry/registry.go

mdelapenya · 2025-09-05T14:05:55Z

@alegrey91 thanks for your great work on this. I was about to merge this but I thought "if tc-go already exposes the docker client, then it's probably not needed to add this to the module". But I've checked the upstream code in the rancher repo, which tells me that users would need it, and because the scope for this feature is narrowed to the module, then it's fine to provide this API at the module level.

In any case, LGTM!

* main: (33 commits) feat(registry): add helper functions to pull and tag images (testcontainers#3275) fix(reaper): remove termSignal override (testcontainers#3261) chore(deps): bump ryuk to v0.13.0, which uses scratch as base image (testcontainers#3274) chore(release): refine release script to update inter-module dependencies (testcontainers#3273) fix(registry): update `WithHtpasswd` to use `os.CreateTemp` instead of `os.Create` with `filepath.Join`. (testcontainers#3272) chore(deps): bump github.com/docker/docker from 28.2.2+incompatible to 28.3.3+incompatible (testcontainers#3270) chore(postgres): use require.NotNil instead of assert.NotNil (testcontainers#3252) fix(nats): use wait for listening port instead of wait for log (testcontainers#3256) chore(deps): bump github.com/go-viper/mapstructure/v2 (testcontainers#3267) fix(postgres): snapshot restore (testcontainers#3264) fix(dockermcpgateway): use duckduckgo instead of brave (testcontainers#3247) feat: add Solace pubsub+ module (testcontainers#3230) feat(options): add WithProvider (testcontainers#3241) chore(deps): bump github/codeql-action from 3.29.2 to 3.29.3 (testcontainers#3237) chore(deps): bump golang.org/x/oauth2 in /modules/weaviate (testcontainers#3240) chore(deps): bump mkdocs-include-markdown-plugin from 7.1.5 to 7.1.6 (testcontainers#3239) chore(deps): bump requests from 2.32.0 to 2.32.4 (testcontainers#3204) feat(mcpgateway): add MCP gateway module (testcontainers#3232) chore(deps): bump golang.org/x/oauth2 in /modules/pulsar (testcontainers#3236) chore(deps): bump golang.org/x/oauth2 in /modules/gcloud (testcontainers#3235) ...

* main: (30 commits) fix: preserve unix socket schema in testcontainers host from properties (testcontainers#3213) feat(registry): add helper functions to pull and tag images (testcontainers#3275) fix(reaper): remove termSignal override (testcontainers#3261) chore(deps): bump ryuk to v0.13.0, which uses scratch as base image (testcontainers#3274) chore(release): refine release script to update inter-module dependencies (testcontainers#3273) fix(registry): update `WithHtpasswd` to use `os.CreateTemp` instead of `os.Create` with `filepath.Join`. (testcontainers#3272) chore(deps): bump github.com/docker/docker from 28.2.2+incompatible to 28.3.3+incompatible (testcontainers#3270) chore(postgres): use require.NotNil instead of assert.NotNil (testcontainers#3252) fix(nats): use wait for listening port instead of wait for log (testcontainers#3256) chore(deps): bump github.com/go-viper/mapstructure/v2 (testcontainers#3267) fix(postgres): snapshot restore (testcontainers#3264) fix(dockermcpgateway): use duckduckgo instead of brave (testcontainers#3247) feat: add Solace pubsub+ module (testcontainers#3230) feat(options): add WithProvider (testcontainers#3241) chore(deps): bump github/codeql-action from 3.29.2 to 3.29.3 (testcontainers#3237) chore(deps): bump golang.org/x/oauth2 in /modules/weaviate (testcontainers#3240) chore(deps): bump mkdocs-include-markdown-plugin from 7.1.5 to 7.1.6 (testcontainers#3239) chore(deps): bump requests from 2.32.0 to 2.32.4 (testcontainers#3204) feat(mcpgateway): add MCP gateway module (testcontainers#3232) chore(deps): bump golang.org/x/oauth2 in /modules/pulsar (testcontainers#3236) ...

* main: (24 commits) chore(deps): bump golang.org/x/sys from 0.32.0 to 0.36.0 (#3282) feat(redpanda): add support for http proxy (#3258) chore(deps): bump github/codeql-action from 3.29.3 to 3.30.3 (#3287) chore(go): bump to Go 1.24 as minimal version (#3298) deps(mongodb): update MongoDB Go Driver to v2 (#3278) chore(deps): bump github.com/shirou/gopsutil/v4 from 4.25.5 to 4.25.6 (#3224) chore(deps): bump mkdocs-include-markdown-plugin from 7.1.6 to 7.1.7 (#3284) docs: clarify no client SDKs in production modules/images, in contributing.md (#3279) chore(deps): bump github.com/docker/go-connections from 0.5.0 to 0.6.0 (#3285) chore(deps): bump tj-actions/changed-files from 46.0.3 to 47.0.0 (#3283) chore(modulegen): detect missing project files after new module creation (#3281) chore(deps): bump github.com/docker/docker in /modules/nebulagraph (#3277) feat(nebulagraph): add NebulaGraph module (#3266) fix: preserve unix socket schema in testcontainers host from properties (#3213) feat(registry): add helper functions to pull and tag images (#3275) fix(reaper): remove termSignal override (#3261) chore(deps): bump ryuk to v0.13.0, which uses scratch as base image (#3274) chore(release): refine release script to update inter-module dependencies (#3273) fix(registry): update `WithHtpasswd` to use `os.CreateTemp` instead of `os.Create` with `filepath.Join`. (#3272) chore(deps): bump github.com/docker/docker from 28.2.2+incompatible to 28.3.3+incompatible (#3270) ...

* main: (22 commits) chore(deps): bump golang.org/x/net from 0.28.0 to 0.38.0 (testcontainers#3299) feat: allow saving specific platforms for an image (testcontainers#3218) chore(deps): bump dario.cat/mergo from 1.0.1 to 1.0.2 (testcontainers#3238) chore(deps): bump golang.org/x/sys from 0.32.0 to 0.36.0 (testcontainers#3282) feat(redpanda): add support for http proxy (testcontainers#3258) chore(deps): bump github/codeql-action from 3.29.3 to 3.30.3 (testcontainers#3287) chore(go): bump to Go 1.24 as minimal version (testcontainers#3298) deps(mongodb): update MongoDB Go Driver to v2 (testcontainers#3278) chore(deps): bump github.com/shirou/gopsutil/v4 from 4.25.5 to 4.25.6 (testcontainers#3224) chore(deps): bump mkdocs-include-markdown-plugin from 7.1.6 to 7.1.7 (testcontainers#3284) docs: clarify no client SDKs in production modules/images, in contributing.md (testcontainers#3279) chore(deps): bump github.com/docker/go-connections from 0.5.0 to 0.6.0 (testcontainers#3285) chore(deps): bump tj-actions/changed-files from 46.0.3 to 47.0.0 (testcontainers#3283) chore(modulegen): detect missing project files after new module creation (testcontainers#3281) chore(deps): bump github.com/docker/docker in /modules/nebulagraph (testcontainers#3277) feat(nebulagraph): add NebulaGraph module (testcontainers#3266) fix: preserve unix socket schema in testcontainers host from properties (testcontainers#3213) feat(registry): add helper functions to pull and tag images (testcontainers#3275) fix(reaper): remove termSignal override (testcontainers#3261) chore(deps): bump ryuk to v0.13.0, which uses scratch as base image (testcontainers#3274) ...

alegrey91 and others added 5 commits September 3, 2025 18:30

feat(modules/registry): add helper functions to pull and tag images

7aac981

Signed-off-by: Alessio Greggi <[email protected]>

refact(modules/registry): move from using NewDockerProvider to NewDoc…

ca6194e

…kerClientWithOpts Signed-off-by: Alessio Greggi <[email protected]>

docs: update registry module doc with examples

1fe3308

Signed-off-by: Alessio Greggi <[email protected]>

chore: use same platform as the registry image

f3d2f41

chore: add a test for pull image

606572e

mdelapenya requested a review from a team as a code owner September 5, 2025 10:43

mdelapenya added the feature New functionality or new behaviors on the existing one label Sep 5, 2025

mdelapenya self-assigned this Sep 5, 2025

mdelapenya requested a review from stevenh September 5, 2025 10:43

mdelapenya requested a review from Copilot September 5, 2025 10:44

Copilot AI reviewed Sep 5, 2025

View reviewed changes

modules/registry/examples_test.go Outdated Show resolved Hide resolved

modules/registry/examples_test.go Outdated Show resolved Hide resolved

mdelapenya added 7 commits September 5, 2025 12:48

chore: typo

1843c01

revert: add debug lines

e1fe14e

revert: add debug lines for storage driver

b9cda97

chore: remove debug

953aa7b

chore: verify the platform considering that ImageManifestDescriptor c…

692425a

…ould be nil The ImageManifestDescriptor is only available with containerd integration enabled. DD is containerd by default on new installations

chore: remove debug

c75ad23

mdelapenya commented Sep 5, 2025

View reviewed changes

modules/registry/registry.go Show resolved Hide resolved

mdelapenya merged commit 906c1aa into testcontainers:main Sep 5, 2025
17 checks passed

mdelapenya deleted the alegrey91/main branch September 5, 2025 14:06

alegrey91 mentioned this pull request Sep 26, 2025

chore: replace registry testcontainer methods with upstream ones kubewarden/sbomscanner#481

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(registry): add helper functions to pull and tag images #3275

feat(registry): add helper functions to pull and tag images #3275

Uh oh!

mdelapenya commented Sep 5, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 5, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mdelapenya commented Sep 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat(registry): add helper functions to pull and tag images #3275

feat(registry): add helper functions to pull and tag images #3275

Uh oh!

Conversation

mdelapenya commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Related issues

Uh oh!

netlify bot commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for testcontainers-go ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mdelapenya commented Sep 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mdelapenya commented Sep 5, 2025 •

edited

Loading

netlify bot commented Sep 5, 2025 •

edited

Loading