Watch
1
0
Fork
You've already forked pkg-proxy
1
mirror of https://github.com/git-pkgs/proxy.git synced 2026-11-09 15:49:16 -05:00
pkg-proxy/internal/handler/container_mirror_test.go

452 lines
19 KiB
Go

package handler
import (
"context"
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"net/url"
"strconv"
"strings"
"sync/atomic"
"testing"
"github.com/git-pkgs/registries/fetch"
)
// fakeImageRegistry serves manifests and blobs of a small multi-arch image,
// a single-arch image and a moved tag. It fails with 503 once offline.
type fakeImageRegistry struct {
server *httptest.Server
offline atomic.Bool
manifests map[string]fakeManifest
blobs map[string]string
blobGets atomic.Int32
// tagGets counts GET requests for manifests by tag.
tagGets atomic.Int32
// truncateManifests makes manifest GETs end after a few bytes.
truncateManifests atomic.Bool
// onBlob, if set, runs before a blob is served.
onBlob func(path string)
}
type fakeImage struct {
indexDigest string
amd64Digest string
arm64Digest string
amd64Layer string
arm64Layer string
singleDigest string
singleLayer string
// attestationLayers holds the amd64 and arm64 provenance statements.
attestationLayers []string
}
func newFakeImageRegistry(t *testing.T) (*fakeImageRegistry, fakeImage) {
t.Helper()
const repository = "team/app"
r := &fakeImageRegistry{manifests: make(map[string]fakeManifest), blobs: make(map[string]string)}
var image fakeImage
addBlob := func(content string) string {
digest := sha256Digest([]byte(content))
r.blobs["/v2/"+repository+"/blobs/"+digest] = content
return digest
}
addManifest := func(contentType string, doc any, tags ...string) string {
body, err := json.Marshal(doc)
if err != nil {
t.Fatal(err)
}
digest := sha256Digest(body)
for _, reference := range append(tags, digest) {
r.manifests["/v2/"+repository+"/manifests/"+reference] = fakeManifest{contentType: contentType, body: string(body)}
}
return digest
}
imageManifest := func(platform string) (string, string) {
config := addBlob(`{"architecture":"` + platform + `"}`)
layer := addBlob("layer for " + platform)
digest := addManifest(ociManifestMediaType, map[string]any{
"schemaVersion": 2, "mediaType": ociManifestMediaType,
"config": map[string]any{"mediaType": "application/vnd.oci.image.config.v1+json", "digest": config},
"layers": []map[string]any{
{"mediaType": "application/vnd.oci.image.layer.v1.tar+gzip", "digest": layer},
{"mediaType": "application/vnd.oci.image.layer.nondistributable.v1.tar+gzip", "digest": sha256Digest([]byte("foreign")), "urls": []string{"https://example.invalid/layer"}},
},
})
return digest, layer
}
image.amd64Digest, image.amd64Layer = imageManifest("amd64")
image.arm64Digest, image.arm64Layer = imageManifest("arm64")
attestation := func(platformDigest, platform string) map[string]any {
statement := addBlob("provenance for " + platform)
digest := addManifest(ociManifestMediaType, map[string]any{
"schemaVersion": 2, "mediaType": ociManifestMediaType,
"config": map[string]any{"mediaType": "application/vnd.oci.image.config.v1+json", "digest": addBlob("{}")},
"layers": []map[string]any{{"mediaType": "application/vnd.in-toto+json", "digest": statement}},
})
image.attestationLayers = append(image.attestationLayers, statement)
return map[string]any{
"mediaType": ociManifestMediaType, "digest": digest,
"platform": map[string]string{"os": "unknown", "architecture": "unknown"},
"annotations": map[string]string{
dockerReferenceTypeAnnotation: attestationManifestReference,
dockerReferenceDigestAnnotation: platformDigest,
},
}
}
image.indexDigest = addManifest(ociImageIndexMediaType, map[string]any{
"schemaVersion": 2, "mediaType": ociImageIndexMediaType,
"manifests": []map[string]any{
{"mediaType": ociManifestMediaType, "digest": image.amd64Digest, "platform": map[string]string{"os": "linux", "architecture": "amd64"}},
{"mediaType": ociManifestMediaType, "digest": image.arm64Digest, "platform": map[string]string{"os": "linux", "architecture": "arm64", "variant": "v8"}},
attestation(image.amd64Digest, "amd64"),
attestation(image.arm64Digest, "arm64"),
},
}, "multi")
image.singleDigest, image.singleLayer = imageManifest("single")
r.manifests["/v2/"+repository+"/manifests/single"] = r.manifests["/v2/"+repository+"/manifests/"+image.singleDigest]
r.server = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
if r.offline.Load() {
http.Error(w, "offline", http.StatusServiceUnavailable)
return
}
if doc, ok := r.manifests[req.URL.Path]; ok {
w.Header().Set("Content-Type", doc.contentType)
w.Header().Set("Docker-Content-Digest", sha256Digest([]byte(doc.body)))
if req.Method == http.MethodGet && !strings.Contains(req.URL.Path, "/manifests/sha256:") {
r.tagGets.Add(1)
}
if req.Method == http.MethodGet && r.truncateManifests.Load() {
w.Header().Set("Content-Length", strconv.Itoa(len(doc.body)))
_, _ = io.WriteString(w, doc.body[:4])
return
}
_, _ = io.WriteString(w, doc.body)
return
}
if blob, ok := r.blobs[req.URL.Path]; ok {
if r.onBlob != nil {
r.onBlob(req.URL.Path)
}
r.blobGets.Add(1)
_, _ = io.WriteString(w, blob)
return
}
http.NotFound(w, req)
}))
t.Cleanup(r.server.Close)
return r, image
}
func newMirrorTestProxy(t *testing.T, registry *fakeImageRegistry) *Proxy {
t.Helper()
proxy, _, _, _ := setupTestProxy(t)
proxy.HTTPClient = registry.server.Client()
proxy.Fetcher = fetch.NewFetcher(fetch.WithHTTPClient(registry.server.Client()), fetch.WithMaxRetries(0))
proxy.MetadataTTL = 0
return proxy
}
func pull(t *testing.T, h *ContainerHandler, target, accept string) *httptest.ResponseRecorder {
t.Helper()
request := httptest.NewRequest(http.MethodGet, target, nil)
if accept != "" {
request.Header.Set("Accept", accept)
}
response := httptest.NewRecorder()
h.Routes().ServeHTTP(response, request)
return response
}
func TestMirrorImageThenPullOffline(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
mirrorHandler := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
result, err := mirrorHandler.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{"multi", "single"}}, nil)
if err != nil {
t.Fatalf("MirrorImage: %v", err)
}
if len(result.Warnings) == 0 || !strings.Contains(strings.Join(result.Warnings, "\n"), "non-distributable") {
t.Errorf("warnings = %v, want the skipped foreign layer", result.Warnings)
}
registry.offline.Store(true)
// A fresh handler instance, as after a restart, serves the pull.
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
for _, accept := range []string{dockerManifestAccept, containerdManifestAccept} {
for _, reference := range []string{"multi", image.indexDigest, image.amd64Digest, image.arm64Digest, "single", image.singleDigest} {
if response := pull(t, h, "/team/app/manifests/"+reference, accept); response.Code != http.StatusOK {
t.Errorf("offline manifest %s with %.30q: status %d: %s", reference, accept, response.Code, response.Body.String())
}
}
}
for _, layer := range append([]string{image.amd64Layer, image.arm64Layer, image.singleLayer}, image.attestationLayers...) {
if response := pull(t, h, "/team/app/blobs/"+layer, ""); response.Code != http.StatusOK {
t.Errorf("offline blob %s: status %d", layer, response.Code)
}
}
registry.offline.Store(false)
gets := registry.blobGets.Load()
again, err := mirrorHandler.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{"multi"}}, nil)
if err != nil {
t.Fatalf("second MirrorImage: %v", err)
}
if again.Fetched != 0 || registry.blobGets.Load() != gets {
t.Errorf("second run fetched %d items and %d blobs, want nothing new", again.Fetched, registry.blobGets.Load()-gets)
}
}
func TestMirrorImagePlatformFilter(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
platform, err := ParsePlatform("linux/arm64")
if err != nil {
t.Fatal(err)
}
if _, err := h.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{"multi"}}, []Platform{platform}); err != nil {
t.Fatalf("MirrorImage: %v", err)
}
registry.offline.Store(true)
if response := pull(t, h, "/team/app/blobs/"+image.arm64Layer, ""); response.Code != http.StatusOK {
t.Errorf("arm64 layer status = %d, want 200", response.Code)
}
if response := pull(t, h, "/team/app/blobs/"+image.attestationLayers[1], ""); response.Code != http.StatusOK {
t.Errorf("arm64 attestation status = %d, want 200", response.Code)
}
for _, layer := range []string{image.amd64Layer, image.attestationLayers[0]} {
if response := pull(t, h, "/team/app/blobs/"+layer, ""); response.Code == http.StatusOK {
t.Errorf("amd64 blob %s was mirrored despite the linux/arm64 filter", layer)
}
}
registry.offline.Store(false)
riscv, _ := ParsePlatform("linux/riscv64")
if _, err := h.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{"multi"}}, []Platform{riscv}); err == nil {
t.Error("a filter matching no index entry did not fail")
}
}
func TestMirrorImageMovedTagMirrorsBothTargets(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
result, err := h.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{image.singleDigest, "multi"}}, nil)
if err != nil {
t.Fatalf("MirrorImage: %v", err)
}
if !strings.Contains(strings.Join(result.Warnings, "\n"), "now points to") {
t.Errorf("warnings = %v, want the moved-tag warning", result.Warnings)
}
registry.offline.Store(true)
for _, layer := range []string{image.singleLayer, image.amd64Layer} {
if response := pull(t, h, "/team/app/blobs/"+layer, ""); response.Code != http.StatusOK {
t.Errorf("blob %s status = %d, want 200", layer, response.Code)
}
}
}
func TestMirrorImageNamespaceRouteMatchesContainerdPull(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
named := map[string]string{"internal": registry.server.URL}
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", dockerHubRegistry, named)
host := strings.TrimPrefix(registry.server.URL, "http://")
if _, err := h.MirrorImage(context.Background(), ImageRef{Registry: host, Name: "team/app", References: []string{"single"}}, nil); err != nil {
t.Fatalf("MirrorImage: %v", err)
}
registry.offline.Store(true)
ns := "?" + url.Values{namespaceQueryParam: {host}}.Encode()
if response := pull(t, h, "/team/app/manifests/single"+ns, containerdManifestAccept); response.Code != http.StatusOK {
t.Errorf("containerd ns manifest status = %d: %s", response.Code, response.Body.String())
}
if response := pull(t, h, "/team/app/blobs/"+image.singleLayer+ns, ""); response.Code != http.StatusOK {
t.Errorf("containerd ns blob status = %d", response.Code)
}
if response := pull(t, h, "/upstream/internal/team/app/blobs/"+image.singleLayer, ""); response.Code != http.StatusOK {
t.Errorf("prefix-route blob status = %d", response.Code)
}
if _, err := h.MirrorImage(context.Background(), ImageRef{Registry: "unknown.example", Name: "team/app", References: []string{"single"}}, nil); err == nil {
t.Error("an unconfigured registry host was accepted")
}
}
func TestNormalizeImageRef(t *testing.T) {
tests := []struct {
name string
ref ImageRef
defaultRT string
wantName string
wantErr bool
}{
{name: "docker hub default adds library", ref: ImageRef{Name: "alpine", References: []string{"3.20"}}, defaultRT: dockerHubRegistry, wantName: "library/alpine"},
{name: "docker hub ns adds library", ref: ImageRef{Registry: "hub.docker.com", Name: "alpine", References: []string{"3.20"}}, defaultRT: "https://registry.example", wantName: "library/alpine"},
{name: "other default keeps name", ref: ImageRef{Name: "alpine", References: []string{"3.20"}}, defaultRT: "https://registry.example", wantName: "alpine"},
{name: "path traversal", ref: ImageRef{Name: "../../x", References: []string{"1"}}, defaultRT: dockerHubRegistry, wantErr: true},
{name: "query in tag", ref: ImageRef{Name: "library/alpine", References: []string{"3.20?x#y"}}, defaultRT: dockerHubRegistry, wantErr: true},
{name: "short digest", ref: ImageRef{Name: "library/alpine", References: []string{"sha256:abcd"}}, defaultRT: dockerHubRegistry, wantErr: true},
{name: "no reference", ref: ImageRef{Name: "library/alpine"}, defaultRT: dockerHubRegistry, wantErr: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := normalizeImageRef(tt.ref, tt.defaultRT)
if (err != nil) != tt.wantErr {
t.Fatalf("err = %v, wantErr %v", err, tt.wantErr)
}
if !tt.wantErr && got.Name != tt.wantName {
t.Errorf("name = %q, want %q", got.Name, tt.wantName)
}
})
}
}
func TestMirrorImageKeepsPreviousTagWhenMovedTagIsIncomplete(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
ref := ImageRef{Name: "team/app", References: []string{"single"}}
if _, err := h.MirrorImage(context.Background(), ref, nil); err != nil {
t.Fatalf("first MirrorImage: %v", err)
}
previous := registry.manifests["/v2/team/app/manifests/single"]
// Move the tag to an image whose layer the registry cannot serve.
broken, err := json.Marshal(map[string]any{
"schemaVersion": 2, "mediaType": ociManifestMediaType,
"config": map[string]any{"mediaType": "application/vnd.oci.image.config.v1+json", "digest": image.singleLayer},
"layers": []map[string]any{{"mediaType": "application/vnd.oci.image.layer.v1.tar+gzip", "digest": sha256Digest([]byte("missing layer"))}},
})
if err != nil {
t.Fatal(err)
}
brokenDoc := fakeManifest{contentType: ociManifestMediaType, body: string(broken)}
registry.manifests["/v2/team/app/manifests/single"] = brokenDoc
registry.manifests["/v2/team/app/manifests/"+sha256Digest(broken)] = brokenDoc
missing := sha256Digest([]byte("missing layer"))
if _, err := h.MirrorImage(context.Background(), ref, nil); err == nil || !strings.Contains(err.Error(), missing) {
t.Fatalf("mirroring the incomplete image: err = %v, want a failure naming layer %s", err, missing)
}
registry.offline.Store(true)
response := pull(t, h, "/team/app/manifests/single", dockerManifestAccept)
if response.Code != http.StatusOK {
t.Fatalf("offline tag status = %d: %s", response.Code, response.Body.String())
}
if response.Body.String() != previous.body {
t.Errorf("offline tag points to %s, want the previously mirrored image", sha256Digest(response.Body.Bytes()))
}
}
func TestMirrorImagePlatformFilterAcrossNestedIndex(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
nested := `{"schemaVersion":2,"mediaType":"application/vnd.oci.image.index.v1+json","manifests":[` +
`{"mediaType":"application/vnd.oci.image.manifest.v1+json","digest":"` + image.arm64Digest + `","platform":{"os":"linux","architecture":"arm64"}}]}`
nestedDigest := sha256Digest([]byte(nested))
top := `{"schemaVersion":2,"mediaType":"application/vnd.oci.image.index.v1+json","manifests":[` +
`{"mediaType":"application/vnd.oci.image.manifest.v1+json","digest":"` + image.amd64Digest + `","platform":{"os":"linux","architecture":"amd64"}},` +
`{"mediaType":"application/vnd.oci.image.index.v1+json","digest":"` + nestedDigest + `"}]}`
for _, reference := range []string{"nested", nestedDigest} {
registry.manifests["/v2/team/app/manifests/"+reference] = fakeManifest{contentType: ociImageIndexMediaType, body: nested}
}
for _, reference := range []string{"top", sha256Digest([]byte(top))} {
registry.manifests["/v2/team/app/manifests/"+reference] = fakeManifest{contentType: ociImageIndexMediaType, body: top}
}
amd64, _ := ParsePlatform("linux/amd64")
if _, err := h.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{"top"}}, []Platform{amd64}); err != nil {
t.Fatalf("MirrorImage: %v (a nested index without amd64 must not fail the image)", err)
}
riscv, _ := ParsePlatform("linux/riscv64")
if _, err := h.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{"top"}}, []Platform{riscv}); err == nil {
t.Error("a filter matching nothing in the whole image did not fail")
}
}
func TestMirrorImageRevalidatesUnchangedTagWithHead(t *testing.T) {
registry, _ := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
ref := ImageRef{Name: "team/app", References: []string{"multi"}}
if _, err := h.MirrorImage(context.Background(), ref, nil); err != nil {
t.Fatalf("first MirrorImage: %v", err)
}
gets := registry.tagGets.Load()
if _, err := h.MirrorImage(context.Background(), ref, nil); err != nil {
t.Fatalf("second MirrorImage: %v", err)
}
if extra := registry.tagGets.Load() - gets; extra != 0 {
t.Errorf("second run sent %d GETs for the unchanged tag, want a HEAD only", extra)
}
}
func TestMirrorImageFallsBackWhenTagBodyIsCutOff(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
ref := ImageRef{Name: "team/app", References: []string{"single"}}
if _, err := h.MirrorImage(context.Background(), ref, nil); err != nil {
t.Fatalf("first MirrorImage: %v", err)
}
// Point the tag elsewhere so the HEAD check sends a GET, then cut that
// GET's body short.
registry.manifests["/v2/team/app/manifests/single"] = registry.manifests["/v2/team/app/manifests/"+image.amd64Digest]
registry.truncateManifests.Store(true)
result, err := h.MirrorImage(context.Background(), ref, nil)
if err != nil {
t.Fatalf("MirrorImage with a cut-off body: %v, want the cached tag to be used", err)
}
if !strings.Contains(strings.Join(result.Warnings, "\n"), "stale cache") {
t.Errorf("warnings = %v, want the stale-cache warning", result.Warnings)
}
}
func TestMirrorImageKeepsTagMovedByPullDuringWalk(t *testing.T) {
registry, image := newFakeImageRegistry(t)
proxy := newMirrorTestProxy(t, registry)
h := NewContainerHandlerWithRegistry(proxy, "http://proxy.example", registry.server.URL)
// While the mirror fetches the first layer of "single", the tag moves
// upstream and a client pull caches the new target.
moved := registry.manifests["/v2/team/app/manifests/"+image.amd64Digest]
var once atomic.Bool
registry.onBlob = func(string) {
if once.CompareAndSwap(false, true) {
registry.manifests["/v2/team/app/manifests/single"] = moved
if response := pull(t, h, "/team/app/manifests/single", dockerManifestAccept); response.Code != http.StatusOK {
t.Errorf("client pull during the walk: status %d", response.Code)
}
}
}
result, err := h.MirrorImage(context.Background(), ImageRef{Name: "team/app", References: []string{"single"}}, nil)
if err != nil {
t.Fatalf("MirrorImage: %v", err)
}
if !strings.Contains(strings.Join(result.Warnings, "\n"), "moved") {
t.Errorf("warnings = %v, want the moved-tag warning", result.Warnings)
}
registry.onBlob = nil
registry.offline.Store(true)
if response := pull(t, h, "/team/app/manifests/single", dockerManifestAccept); response.Body.String() != moved.body {
t.Errorf("offline tag points to %s, want the newer target %s", sha256Digest(response.Body.Bytes()), image.amd64Digest)
}
}