422 lines
13 KiB
Go
422 lines
13 KiB
Go
package distribution
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"os"
|
|
"strings"
|
|
"sync"
|
|
"testing"
|
|
|
|
"github.com/containerd/containerd/content"
|
|
"github.com/containerd/containerd/content/local"
|
|
"github.com/containerd/containerd/errdefs"
|
|
"github.com/containerd/containerd/remotes"
|
|
"github.com/docker/distribution"
|
|
"github.com/docker/distribution/manifest/manifestlist"
|
|
"github.com/docker/distribution/manifest/ocischema"
|
|
"github.com/docker/distribution/manifest/schema1"
|
|
"github.com/docker/distribution/manifest/schema2"
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
digest "github.com/opencontainers/go-digest"
|
|
specs "github.com/opencontainers/image-spec/specs-go/v1"
|
|
"github.com/pkg/errors"
|
|
"gotest.tools/v3/assert"
|
|
"gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
type mockManifestGetter struct {
|
|
manifests map[digest.Digest]distribution.Manifest
|
|
gets int
|
|
}
|
|
|
|
func (m *mockManifestGetter) Get(ctx context.Context, dgst digest.Digest, options ...distribution.ManifestServiceOption) (distribution.Manifest, error) {
|
|
m.gets++
|
|
manifest, ok := m.manifests[dgst]
|
|
if !ok {
|
|
return nil, distribution.ErrManifestUnknown{Tag: dgst.String()}
|
|
}
|
|
return manifest, nil
|
|
}
|
|
|
|
type memoryLabelStore struct {
|
|
mu sync.Mutex
|
|
labels map[digest.Digest]map[string]string
|
|
}
|
|
|
|
// Get returns all the labels for the given digest
|
|
func (s *memoryLabelStore) Get(dgst digest.Digest) (map[string]string, error) {
|
|
s.mu.Lock()
|
|
labels := s.labels[dgst]
|
|
s.mu.Unlock()
|
|
return labels, nil
|
|
}
|
|
|
|
// Set sets all the labels for a given digest
|
|
func (s *memoryLabelStore) Set(dgst digest.Digest, labels map[string]string) error {
|
|
s.mu.Lock()
|
|
if s.labels == nil {
|
|
s.labels = make(map[digest.Digest]map[string]string)
|
|
}
|
|
s.labels[dgst] = labels
|
|
s.mu.Unlock()
|
|
return nil
|
|
}
|
|
|
|
// Update replaces the given labels for a digest,
|
|
// a key with an empty value removes a label.
|
|
func (s *memoryLabelStore) Update(dgst digest.Digest, update map[string]string) (map[string]string, error) {
|
|
s.mu.Lock()
|
|
defer s.mu.Unlock()
|
|
|
|
labels, ok := s.labels[dgst]
|
|
if !ok {
|
|
labels = map[string]string{}
|
|
}
|
|
for k, v := range update {
|
|
labels[k] = v
|
|
}
|
|
|
|
s.labels[dgst] = labels
|
|
|
|
return labels, nil
|
|
}
|
|
|
|
type testingContentStoreWrapper struct {
|
|
ContentStore
|
|
errorOnWriter error
|
|
errorOnCommit error
|
|
}
|
|
|
|
func (s *testingContentStoreWrapper) Writer(ctx context.Context, opts ...content.WriterOpt) (content.Writer, error) {
|
|
if s.errorOnWriter != nil {
|
|
return nil, s.errorOnWriter
|
|
}
|
|
|
|
w, err := s.ContentStore.Writer(ctx, opts...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if s.errorOnCommit != nil {
|
|
w = &testingContentWriterWrapper{w, s.errorOnCommit}
|
|
}
|
|
return w, nil
|
|
}
|
|
|
|
type testingContentWriterWrapper struct {
|
|
content.Writer
|
|
err error
|
|
}
|
|
|
|
func (w *testingContentWriterWrapper) Commit(ctx context.Context, size int64, dgst digest.Digest, opts ...content.Opt) error {
|
|
if w.err != nil {
|
|
// The contract for `Commit` is to always close.
|
|
// Since this is returning early before hitting the real `Commit`, we should close it here.
|
|
w.Close()
|
|
return w.err
|
|
}
|
|
return w.Writer.Commit(ctx, size, dgst, opts...)
|
|
}
|
|
|
|
func TestManifestStore(t *testing.T) {
|
|
ociManifest := &specs.Manifest{}
|
|
serialized, err := json.Marshal(ociManifest)
|
|
assert.NilError(t, err)
|
|
dgst := digest.Canonical.FromBytes(serialized)
|
|
|
|
setupTest := func(t *testing.T) (specs.Descriptor, *mockManifestGetter, *manifestStore, content.Store, func(*testing.T)) {
|
|
root, err := os.MkdirTemp("", strings.Replace(t.Name(), "/", "_", -1))
|
|
assert.NilError(t, err)
|
|
defer func() {
|
|
if t.Failed() {
|
|
os.RemoveAll(root)
|
|
}
|
|
}()
|
|
|
|
cs, err := local.NewLabeledStore(root, &memoryLabelStore{})
|
|
assert.NilError(t, err)
|
|
|
|
mg := &mockManifestGetter{manifests: make(map[digest.Digest]distribution.Manifest)}
|
|
store := &manifestStore{local: cs, remote: mg}
|
|
desc := specs.Descriptor{Digest: dgst, MediaType: specs.MediaTypeImageManifest, Size: int64(len(serialized))}
|
|
|
|
return desc, mg, store, cs, func(t *testing.T) {
|
|
assert.Check(t, os.RemoveAll(root))
|
|
}
|
|
}
|
|
|
|
ctx := context.Background()
|
|
|
|
m, _, err := distribution.UnmarshalManifest(specs.MediaTypeImageManifest, serialized)
|
|
assert.NilError(t, err)
|
|
|
|
writeManifest := func(t *testing.T, cs ContentStore, desc specs.Descriptor, opts ...content.Opt) {
|
|
ingestKey := remotes.MakeRefKey(ctx, desc)
|
|
w, err := cs.Writer(ctx, content.WithDescriptor(desc), content.WithRef(ingestKey))
|
|
assert.NilError(t, err)
|
|
defer func() {
|
|
if err := w.Close(); err != nil {
|
|
t.Log(err)
|
|
}
|
|
if t.Failed() {
|
|
if err := cs.Abort(ctx, ingestKey); err != nil {
|
|
t.Log(err)
|
|
}
|
|
}
|
|
}()
|
|
|
|
_, err = w.Write(serialized)
|
|
assert.NilError(t, err)
|
|
|
|
err = w.Commit(ctx, desc.Size, desc.Digest, opts...)
|
|
assert.NilError(t, err)
|
|
|
|
}
|
|
|
|
// All tests should end up with no active ingest
|
|
checkIngest := func(t *testing.T, cs content.Store, desc specs.Descriptor) {
|
|
ingestKey := remotes.MakeRefKey(ctx, desc)
|
|
_, err := cs.Status(ctx, ingestKey)
|
|
assert.Check(t, errdefs.IsNotFound(err), err)
|
|
}
|
|
|
|
t.Run("no remote or local", func(t *testing.T) {
|
|
desc, _, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
|
|
_, err = store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
// This error is what our digest getter returns when it doesn't know about the manifest
|
|
assert.Error(t, err, distribution.ErrManifestUnknown{Tag: dgst.String()}.Error())
|
|
})
|
|
|
|
t.Run("no local cache", func(t *testing.T) {
|
|
desc, mg, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
|
|
mg.manifests[desc.Digest] = m
|
|
|
|
m2, err := store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 1))
|
|
|
|
i, err := cs.Info(ctx, desc.Digest)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.Equal(i.Digest, desc.Digest))
|
|
|
|
// Now check again, this should not hit the remote
|
|
m2, err = store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 1))
|
|
})
|
|
|
|
t.Run("with local cache", func(t *testing.T) {
|
|
desc, mg, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
|
|
// first add the manifest to the coontent store
|
|
writeManifest(t, cs, desc)
|
|
|
|
// now do the get
|
|
m2, err := store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 0))
|
|
|
|
i, err := cs.Info(ctx, desc.Digest)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.Equal(i.Digest, desc.Digest))
|
|
})
|
|
|
|
// This is for the case of pull by digest where we don't know the media type of the manifest until it's actually pulled.
|
|
t.Run("unknown media type", func(t *testing.T) {
|
|
t.Run("no cache", func(t *testing.T) {
|
|
desc, mg, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
|
|
mg.manifests[desc.Digest] = m
|
|
desc.MediaType = ""
|
|
|
|
m2, err := store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 1))
|
|
})
|
|
|
|
t.Run("with cache", func(t *testing.T) {
|
|
t.Run("cached manifest has media type", func(t *testing.T) {
|
|
desc, mg, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
|
|
writeManifest(t, cs, desc)
|
|
desc.MediaType = ""
|
|
|
|
m2, err := store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 0))
|
|
})
|
|
|
|
t.Run("cached manifest has no media type", func(t *testing.T) {
|
|
desc, mg, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
|
|
desc.MediaType = ""
|
|
writeManifest(t, cs, desc)
|
|
|
|
m2, err := store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 0))
|
|
})
|
|
})
|
|
})
|
|
|
|
// Test that if there is an error with the content store, for whatever
|
|
// reason, that doesn't stop us from getting the manifest.
|
|
//
|
|
// Also makes sure the ingests are aborted.
|
|
t.Run("error persisting manifest", func(t *testing.T) {
|
|
t.Run("error on writer", func(t *testing.T) {
|
|
desc, mg, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
mg.manifests[desc.Digest] = m
|
|
|
|
csW := &testingContentStoreWrapper{ContentStore: store.local, errorOnWriter: errors.New("random error")}
|
|
store.local = csW
|
|
|
|
m2, err := store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 1))
|
|
|
|
_, err = cs.Info(ctx, desc.Digest)
|
|
// Nothing here since we couldn't persist
|
|
assert.Check(t, errdefs.IsNotFound(err), err)
|
|
})
|
|
|
|
t.Run("error on commit", func(t *testing.T) {
|
|
desc, mg, store, cs, teardown := setupTest(t)
|
|
defer teardown(t)
|
|
mg.manifests[desc.Digest] = m
|
|
|
|
csW := &testingContentStoreWrapper{ContentStore: store.local, errorOnCommit: errors.New("random error")}
|
|
store.local = csW
|
|
|
|
m2, err := store.Get(ctx, desc)
|
|
checkIngest(t, cs, desc)
|
|
assert.NilError(t, err)
|
|
assert.Check(t, cmp.DeepEqual(m, m2, cmpopts.IgnoreUnexported(ocischema.DeserializedManifest{})))
|
|
assert.Check(t, cmp.Equal(mg.gets, 1))
|
|
|
|
_, err = cs.Info(ctx, desc.Digest)
|
|
// Nothing here since we couldn't persist
|
|
assert.Check(t, errdefs.IsNotFound(err), err)
|
|
})
|
|
})
|
|
}
|
|
|
|
func TestDetectManifestBlobMediaType(t *testing.T) {
|
|
type testCase struct {
|
|
json []byte
|
|
expected string
|
|
}
|
|
cases := map[string]testCase{
|
|
"mediaType is set": {[]byte(`{"mediaType": "bananas"}`), "bananas"},
|
|
"oci manifest": {[]byte(`{"config": {}}`), specs.MediaTypeImageManifest},
|
|
"schema1": {[]byte(`{"fsLayers": []}`), schema1.MediaTypeManifest},
|
|
"oci index fallback": {[]byte(`{}`), specs.MediaTypeImageIndex},
|
|
// Make sure we prefer mediaType
|
|
"mediaType and config set": {[]byte(`{"mediaType": "bananas", "config": {}}`), "bananas"},
|
|
"mediaType and fsLayers set": {[]byte(`{"mediaType": "bananas", "fsLayers": []}`), "bananas"},
|
|
}
|
|
|
|
for name, tc := range cases {
|
|
t.Run(name, func(t *testing.T) {
|
|
mt, err := detectManifestBlobMediaType(tc.json)
|
|
assert.NilError(t, err)
|
|
assert.Equal(t, mt, tc.expected)
|
|
})
|
|
}
|
|
|
|
}
|
|
|
|
func TestDetectManifestBlobMediaTypeInvalid(t *testing.T) {
|
|
type testCase struct {
|
|
json []byte
|
|
expected string
|
|
}
|
|
cases := map[string]testCase{
|
|
"schema 1 mediaType with manifests": {
|
|
[]byte(`{"mediaType": "` + schema1.MediaTypeManifest + `","manifests":[]}`),
|
|
`media-type: "application/vnd.docker.distribution.manifest.v1+json" should not have "manifests" or "layers"`,
|
|
},
|
|
"schema 1 mediaType with layers": {
|
|
[]byte(`{"mediaType": "` + schema1.MediaTypeManifest + `","layers":[]}`),
|
|
`media-type: "application/vnd.docker.distribution.manifest.v1+json" should not have "manifests" or "layers"`,
|
|
},
|
|
"schema 2 mediaType with manifests": {
|
|
[]byte(`{"mediaType": "` + schema2.MediaTypeManifest + `","manifests":[]}`),
|
|
`media-type: "application/vnd.docker.distribution.manifest.v2+json" should not have "manifests" or "fsLayers"`,
|
|
},
|
|
"schema 2 mediaType with fsLayers": {
|
|
[]byte(`{"mediaType": "` + schema2.MediaTypeManifest + `","fsLayers":[]}`),
|
|
`media-type: "application/vnd.docker.distribution.manifest.v2+json" should not have "manifests" or "fsLayers"`,
|
|
},
|
|
"oci manifest mediaType with manifests": {
|
|
[]byte(`{"mediaType": "` + specs.MediaTypeImageManifest + `","manifests":[]}`),
|
|
`media-type: "application/vnd.oci.image.manifest.v1+json" should not have "manifests" or "fsLayers"`,
|
|
},
|
|
"manifest list mediaType with fsLayers": {
|
|
[]byte(`{"mediaType": "` + manifestlist.MediaTypeManifestList + `","fsLayers":[]}`),
|
|
`media-type: "application/vnd.docker.distribution.manifest.list.v2+json" should not have "config", "layers", or "fsLayers"`,
|
|
},
|
|
"index mediaType with layers": {
|
|
[]byte(`{"mediaType": "` + specs.MediaTypeImageIndex + `","layers":[]}`),
|
|
`media-type: "application/vnd.oci.image.index.v1+json" should not have "config", "layers", or "fsLayers"`,
|
|
},
|
|
"index mediaType with config": {
|
|
[]byte(`{"mediaType": "` + specs.MediaTypeImageIndex + `","config":{}}`),
|
|
`media-type: "application/vnd.oci.image.index.v1+json" should not have "config", "layers", or "fsLayers"`,
|
|
},
|
|
"config and manifests": {
|
|
[]byte(`{"config":{}, "manifests":[]}`),
|
|
`media-type: cannot determine`,
|
|
},
|
|
"layers and manifests": {
|
|
[]byte(`{"layers":[], "manifests":[]}`),
|
|
`media-type: cannot determine`,
|
|
},
|
|
"layers and fsLayers": {
|
|
[]byte(`{"layers":[], "fsLayers":[]}`),
|
|
`media-type: cannot determine`,
|
|
},
|
|
"fsLayers and manifests": {
|
|
[]byte(`{"fsLayers":[], "manifests":[]}`),
|
|
`media-type: cannot determine`,
|
|
},
|
|
"config and fsLayers": {
|
|
[]byte(`{"config":{}, "fsLayers":[]}`),
|
|
`media-type: cannot determine`,
|
|
},
|
|
}
|
|
|
|
for name, tc := range cases {
|
|
t.Run(name, func(t *testing.T) {
|
|
mt, err := detectManifestBlobMediaType(tc.json)
|
|
assert.Error(t, err, tc.expected)
|
|
assert.Equal(t, mt, "")
|
|
})
|
|
}
|
|
|
|
}
|