| /* |
| Copyright The containerd Authors. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| */ |
| |
| package client |
| |
| import ( |
| "bytes" |
| "context" |
| "encoding/json" |
| "fmt" |
| "hash/fnv" |
| "io" |
| "math/rand" |
| "os" |
| "path/filepath" |
| "reflect" |
| "runtime" |
| "strings" |
| "sync" |
| "testing" |
| "time" |
| |
| . "github.com/containerd/containerd/v2/client" |
| "github.com/containerd/containerd/v2/core/content" |
| "github.com/containerd/containerd/v2/core/images" |
| "github.com/containerd/containerd/v2/core/images/archive" |
| "github.com/containerd/containerd/v2/core/leases" |
| "github.com/containerd/containerd/v2/core/transfer" |
| tarchive "github.com/containerd/containerd/v2/core/transfer/archive" |
| "github.com/containerd/containerd/v2/core/transfer/image" |
| "github.com/containerd/containerd/v2/pkg/archive/compression" |
| "github.com/containerd/containerd/v2/pkg/archive/tartest" |
| "github.com/containerd/containerd/v2/pkg/namespaces" |
| "github.com/containerd/containerd/v2/pkg/oci" |
| "github.com/containerd/platforms" |
| "github.com/google/uuid" |
| "github.com/stretchr/testify/require" |
| |
| digest "github.com/opencontainers/go-digest" |
| specs "github.com/opencontainers/image-spec/specs-go" |
| ocispec "github.com/opencontainers/image-spec/specs-go/v1" |
| ) |
| |
| // TestExportAndImport exports testImage as a tar stream, |
| // and import the tar stream as a new image. |
| func TestExportAndImport(t *testing.T) { |
| testExportImport(t, testImage) |
| } |
| |
| // TestExportAndImportMultiLayer exports testMultiLayeredImage as a tar stream, |
| // and import the tar stream as a new image. This should ensure that imported |
| // images remain sane, and that the Garbage Collector won't delete part of its |
| // content. |
| func TestExportAndImportMultiLayer(t *testing.T) { |
| testExportImport(t, testMultiLayeredImage) |
| } |
| |
| func testExportImport(t *testing.T, imageName string) { |
| if testing.Short() { |
| t.Skip() |
| } |
| ctx, cancel := testContext(t) |
| defer cancel() |
| |
| client, err := New(address) |
| if err != nil { |
| t.Fatal(err) |
| } |
| defer client.Close() |
| |
| _, err = client.Fetch(ctx, imageName, WithPlatformMatcher(platforms.Default())) |
| if err != nil { |
| t.Fatal(err) |
| } |
| |
| dstFile, err := os.Create(filepath.Join(t.TempDir(), "export-import-test")) |
| require.NoError(t, err) |
| t.Cleanup(func() { |
| dstFile.Close() |
| }) |
| |
| err = client.Export(ctx, dstFile, archive.WithPlatform(platforms.Default()), archive.WithImage(client.ImageService(), imageName)) |
| require.NoError(t, err) |
| |
| client.ImageService().Delete(ctx, imageName) |
| |
| // Seek to beginning of file in preparation for Import() |
| dstFile.Seek(0, 0) |
| |
| opts := []ImportOpt{ |
| WithImageRefTranslator(archive.AddRefPrefix("foo/bar")), |
| } |
| |
| imgrecs, err := client.Import(ctx, dstFile, opts...) |
| require.NoError(t, err, "Import failed: %+v", err) |
| |
| // We need to unpack the image, especially if it's multilayered. |
| for _, img := range imgrecs { |
| image := NewImage(client, img) |
| |
| // TODO: Show unpack status |
| t.Logf("unpacking %s (%s)...", img.Name, img.Target.Digest) |
| err = image.Unpack(ctx, "") |
| require.NoError(t, err, "Error while unpacking image: %+v", err) |
| t.Log("done") |
| } |
| |
| // we're triggering the Garbage Collector to do its job. |
| ls := client.LeasesService() |
| l, err := ls.Create(ctx, leases.WithRandomID(), leases.WithExpiration(time.Hour)) |
| require.NoError(t, err, "Error while creating lease: %+v", err) |
| |
| if err := ls.Delete(ctx, l, leases.SynchronousDelete); err != nil { |
| t.Fatalf("Error while deleting lease: %+v", err) |
| } |
| |
| image, err := client.GetImage(ctx, imageName) |
| require.NoError(t, err) |
| |
| id := t.Name() |
| container, err := client.NewContainer(ctx, id, WithNewSnapshot(id, image), WithNewSpec(oci.WithImageConfig(image))) |
| require.NoError(t, err, "Error while creating container: %+v", err) |
| container.Delete(ctx, WithSnapshotCleanup) |
| |
| for _, imgrec := range imgrecs { |
| if imgrec.Name == testImage { |
| continue |
| } |
| err = client.ImageService().Delete(ctx, imgrec.Name) |
| require.NoError(t, err) |
| } |
| } |
| |
| func TestImport(t *testing.T) { |
| ctx, cancel := testContext(t) |
| defer cancel() |
| |
| tc := tartest.TarContext{} |
| |
| b1, d1 := createContent(256, 1) |
| empty := []byte("{}") |
| version := []byte("1.0") |
| |
| c1, d2 := createConfig(runtime.GOOS, runtime.GOARCH, "test") |
| badConfig, _ := createConfig("foo", "lish", "test") |
| |
| m1, d3, expManifest := createManifest(c1, [][]byte{b1}) |
| |
| importLabels := map[string]string{"foo": "bar"} |
| |
| c2, _ := createConfig(runtime.GOOS, runtime.GOARCH, "test2") |
| m2, d5, _ := createManifest(c2, [][]byte{{1, 2, 3, 4, 5}}) |
| |
| ml1, d6 := createManifestList(m1, m2) |
| |
| checkManifest := func(ctx context.Context, t *testing.T, provider content.Provider, d ocispec.Descriptor, expManifest *ocispec.Manifest) { |
| m, err := images.Manifest(ctx, provider, d, nil) |
| if err != nil { |
| t.Fatalf("unable to read target blob: %+v", err) |
| } |
| |
| if m.Config.Digest != d2 { |
| t.Fatalf("unexpected digest hash %s, expected %s", m.Config.Digest, d2) |
| } |
| |
| if len(m.Layers) != 1 { |
| t.Fatalf("expected 1 layer, has %d", len(m.Layers)) |
| } |
| |
| if m.Layers[0].Digest != d1 { |
| t.Fatalf("unexpected layer hash %s, expected %s", m.Layers[0].Digest, d1) |
| } |
| |
| if expManifest != nil { |
| if !reflect.DeepEqual(m.Layers, expManifest.Layers) { |
| t.Fatalf("DeepEqual on Layers failed: %v vs. %v", m.Layers, expManifest.Layers) |
| } |
| if !reflect.DeepEqual(m.Config, expManifest.Config) { |
| t.Fatalf("DeepEqual on Config failed: %v vs. %v", m.Config, expManifest.Config) |
| } |
| } |
| } |
| |
| for _, tc := range []struct { |
| Name string |
| Writer tartest.WriterToTar |
| Check func(context.Context, *testing.T, *Client, []images.Image) |
| Opts []ImportOpt |
| }{ |
| { |
| Name: "OCI-IndexWithoutAnyManifest", |
| Writer: tartest.TarAll( |
| tc.Dir(ocispec.ImageBlobsDir, 0755), |
| tc.Dir(ocispec.ImageBlobsDir+"/sha256", 0755), |
| tc.File(ocispec.ImageIndexFile, createIndex(ml1, ocispec.MediaTypeImageIndex, "docker.io/library/sparse:ok"), 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d6.Encoded(), ml1, 0644), |
| tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"`+ocispec.ImageLayoutVersion+`"}`), 0644), |
| ), |
| Check: func(ctx context.Context, t *testing.T, client *Client, imgs []images.Image) { |
| checkImages(t, d6, imgs, "docker.io/library/sparse:ok") |
| mfsts, err := images.Children(ctx, client.ContentStore(), imgs[0].Target) |
| if err != nil { |
| t.Fatalf("unexpected error: %v", err) |
| } |
| |
| for _, m := range mfsts { |
| exists, err := content.Exists(ctx, client.ContentStore(), m) |
| if err != nil { |
| t.Fatalf("unexpected error: %v", err) |
| } |
| |
| if exists { |
| t.Fatal("no manifest should be imported") |
| } |
| } |
| }, |
| Opts: []ImportOpt{ |
| WithSkipMissing(), |
| }, |
| }, |
| { |
| Name: "DockerV2.0", |
| Writer: tartest.TarAll( |
| tc.Dir("bd765cd43e95212f7aa2cab51d0a", 0755), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/json", empty, 0644), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/layer.tar", b1, 0644), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/VERSION", version, 0644), |
| tc.File("repositories", []byte(`{"any":{"1":"bd765cd43e95212f7aa2cab51d0a"}}`), 0644), |
| ), |
| }, |
| { |
| Name: "DockerV2.1", |
| Writer: tartest.TarAll( |
| tc.Dir("bd765cd43e95212f7aa2cab51d0a", 0755), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/json", empty, 0644), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/layer.tar", b1, 0644), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/VERSION", version, 0644), |
| tc.File("e95212f7aa2cab51d0abd765cd43.json", c1, 0644), |
| tc.File("manifest.json", []byte(`[{"Config":"e95212f7aa2cab51d0abd765cd43.json","RepoTags":["test-import:notlatest", "another/repo:tag"],"Layers":["bd765cd43e95212f7aa2cab51d0a/layer.tar"]}]`), 0644), |
| ), |
| Check: func(ctx context.Context, t *testing.T, client *Client, imgs []images.Image) { |
| if len(imgs) == 0 { |
| t.Fatalf("no images") |
| } |
| |
| names := []string{ |
| "docker.io/library/test-import:notlatest", |
| "docker.io/another/repo:tag", |
| } |
| |
| checkImages(t, imgs[0].Target.Digest, imgs, names...) |
| checkManifest(ctx, t, client.ContentStore(), imgs[0].Target, nil) |
| }, |
| }, |
| { |
| Name: "DockerV2.1-BadOSArch", |
| Writer: tartest.TarAll( |
| tc.Dir("bd765cd43e95212f7aa2cab51d0a", 0755), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/json", empty, 0644), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/layer.tar", b1, 0644), |
| tc.File("bd765cd43e95212f7aa2cab51d0a/VERSION", version, 0644), |
| tc.File("e95212f7aa2cab51d0abd765cd43.json", badConfig, 0644), |
| tc.File("manifest.json", []byte(`[{"Config":"e95212f7aa2cab51d0abd765cd43.json","RepoTags":["test-import:notlatest", "another/repo:tag"],"Layers":["bd765cd43e95212f7aa2cab51d0a/layer.tar"]}]`), 0644), |
| ), |
| }, |
| { |
| Name: "OCI-BadFormat", |
| Writer: tartest.TarAll( |
| tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"2.0.0"}`), 0644), |
| ), |
| }, |
| { |
| Name: "OCI", |
| Writer: tartest.TarAll( |
| tc.Dir(ocispec.ImageBlobsDir, 0755), |
| tc.Dir(ocispec.ImageBlobsDir+"/sha256", 0755), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d1.Encoded(), b1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d2.Encoded(), c1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d3.Encoded(), m1, 0644), |
| tc.File(ocispec.ImageIndexFile, createIndex(m1, ocispec.MediaTypeImageManifest, "latest", "docker.io/lib/img:ok"), 0644), |
| tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"`+ocispec.ImageLayoutVersion+`"}`), 0644), |
| ), |
| Check: func(ctx context.Context, t *testing.T, client *Client, imgs []images.Image) { |
| names := []string{ |
| "latest", |
| "docker.io/lib/img:ok", |
| } |
| |
| checkImages(t, d3, imgs, names...) |
| checkManifest(ctx, t, client.ContentStore(), imgs[0].Target, expManifest) |
| }, |
| }, |
| { |
| Name: "OCI-Labels", |
| Writer: tartest.TarAll( |
| tc.Dir(ocispec.ImageBlobsDir, 0o755), |
| tc.Dir(ocispec.ImageBlobsDir+"/sha256", 0o755), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d1.Encoded(), b1, 0o644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d2.Encoded(), c1, 0o644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d3.Encoded(), m1, 0o644), |
| tc.File(ocispec.ImageIndexFile, createIndex(m1, "latest", "docker.io/lib/img:ok"), 0o644), |
| tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"`+ocispec.ImageLayoutVersion+`"}`), 0o644), |
| ), |
| Check: func(ctx context.Context, t *testing.T, _ *Client, imgs []images.Image) { |
| for i := range imgs { |
| if !reflect.DeepEqual(imgs[i].Labels, importLabels) { |
| t.Fatalf("DeepEqual on labels failed img.Labels: %+v expected: %+v", imgs[i].Labels, importLabels) |
| } |
| } |
| }, |
| Opts: []ImportOpt{ |
| WithImageLabels(importLabels), |
| WithImageRefTranslator(archive.AddRefPrefix("localhost:5000/myimage")), |
| }, |
| }, |
| { |
| Name: "OCIPrefixName", |
| Writer: tartest.TarAll( |
| tc.Dir(ocispec.ImageBlobsDir, 0755), |
| tc.Dir(ocispec.ImageBlobsDir+"/sha256", 0755), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d1.Encoded(), b1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d2.Encoded(), c1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d3.Encoded(), m1, 0644), |
| tc.File(ocispec.ImageIndexFile, createIndex(m1, ocispec.MediaTypeImageManifest, "latest", "docker.io/lib/img:ok"), 0644), |
| tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"`+ocispec.ImageLayoutVersion+`"}`), 0644), |
| ), |
| Check: func(ctx context.Context, t *testing.T, client *Client, imgs []images.Image) { |
| names := []string{ |
| "localhost:5000/myimage:latest", |
| "docker.io/lib/img:ok", |
| } |
| |
| checkImages(t, d3, imgs, names...) |
| checkManifest(ctx, t, client.ContentStore(), imgs[0].Target, expManifest) |
| }, |
| Opts: []ImportOpt{ |
| WithImageRefTranslator(archive.AddRefPrefix("localhost:5000/myimage")), |
| }, |
| }, |
| { |
| Name: "OCIPrefixName2", |
| Writer: tartest.TarAll( |
| tc.Dir(ocispec.ImageBlobsDir, 0755), |
| tc.Dir(ocispec.ImageBlobsDir+"/sha256", 0755), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d1.Encoded(), b1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d2.Encoded(), c1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d3.Encoded(), m1, 0644), |
| tc.File(ocispec.ImageIndexFile, createIndex(m1, ocispec.MediaTypeImageManifest, "latest", "localhost:5000/myimage:old", "docker.io/lib/img:ok"), 0644), |
| tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"`+ocispec.ImageLayoutVersion+`"}`), 0644), |
| ), |
| Check: func(ctx context.Context, t *testing.T, client *Client, imgs []images.Image) { |
| names := []string{ |
| "localhost:5000/myimage:latest", |
| "localhost:5000/myimage:old", |
| } |
| |
| checkImages(t, d3, imgs, names...) |
| checkManifest(ctx, t, client.ContentStore(), imgs[0].Target, expManifest) |
| }, |
| Opts: []ImportOpt{ |
| WithImageRefTranslator(archive.FilterRefPrefix("localhost:5000/myimage")), |
| }, |
| }, |
| { |
| Name: "OCI-IndexWithMissingManifestDescendants", |
| Writer: tartest.TarAll( |
| tc.Dir(ocispec.ImageBlobsDir, 0755), |
| tc.Dir(ocispec.ImageBlobsDir+"/sha256", 0755), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d1.Encoded(), b1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d2.Encoded(), c1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d3.Encoded(), m1, 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d5.Encoded(), m2, 0644), |
| tc.File(ocispec.ImageIndexFile, createIndex(ml1, ocispec.MediaTypeImageIndex, "docker.io/library/sparse:ok"), 0644), |
| tc.File(ocispec.ImageBlobsDir+"/sha256/"+d6.Encoded(), ml1, 0644), |
| tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"`+ocispec.ImageLayoutVersion+`"}`), 0644), |
| ), |
| Check: func(ctx context.Context, t *testing.T, client *Client, imgs []images.Image) { |
| checkImages(t, d6, imgs, "docker.io/library/sparse:ok") |
| mfsts, err := images.Children(ctx, client.ContentStore(), imgs[0].Target) |
| if err != nil { |
| t.Fatalf("unexpected error: %v", err) |
| } |
| |
| var importedManifest *ocispec.Descriptor |
| var secondManifest *ocispec.Descriptor |
| for _, m := range mfsts { |
| exists, err := content.Exists(ctx, client.ContentStore(), m) |
| if err != nil { |
| t.Fatalf("unexpected error: %v", err) |
| } |
| |
| if exists { |
| if m.Digest == d3 { |
| m := m |
| importedManifest = &m |
| } else if m.Digest == d5 { |
| m := m |
| secondManifest = &m |
| } else { |
| t.Fatalf("imported manifest with unexpected digest: %v", m.Digest) |
| } |
| } |
| } |
| if importedManifest == nil { |
| t.Fatal("the expected manifest was not loaded") |
| } |
| checkManifest(ctx, t, client.ContentStore(), *importedManifest, expManifest) |
| |
| if secondManifest == nil { |
| t.Fatal("the expected manifest was not loaded") |
| } |
| _, _, _, missing, err := images.Check(ctx, client.ContentStore(), *secondManifest, nil) |
| if err != nil { |
| t.Fatalf("unexpected error: %v", err) |
| } |
| |
| if len(missing) != 2 { |
| t.Fatalf("expected 2 missing blobs, got %+v", missing) |
| } |
| |
| }, |
| Opts: []ImportOpt{ |
| WithSkipMissing(), |
| }, |
| }, |
| } { |
| t.Run(tc.Name, func(t *testing.T) { |
| client, err := newClient(t, address) |
| if err != nil { |
| t.Fatal(err) |
| } |
| defer client.Close() |
| |
| ctx := namespaces.WithNamespace(ctx, uuid.New().String()) |
| |
| images, err := client.Import(ctx, tartest.TarFromWriterTo(tc.Writer), tc.Opts...) |
| if err != nil { |
| if tc.Check != nil { |
| t.Errorf("unexpected import error: %+v", err) |
| } |
| return |
| } else if tc.Check == nil { |
| t.Fatalf("expected error on import") |
| } |
| |
| tc.Check(ctx, t, client, images) |
| }) |
| } |
| } |
| |
| func checkImages(t *testing.T, target digest.Digest, actual []images.Image, names ...string) { |
| if len(names) != len(actual) { |
| t.Fatalf("expected %d images, got %d", len(names), len(actual)) |
| } |
| |
| for i, n := range names { |
| if actual[i].Target.Digest != target { |
| t.Fatalf("image(%d) unexpected target %s, expected %s", i, actual[i].Target.Digest, target) |
| } |
| if actual[i].Name != n { |
| t.Fatalf("image(%d) unexpected name %q, expected %q", i, actual[i].Name, n) |
| } |
| |
| if actual[i].Target.MediaType != ocispec.MediaTypeImageManifest && |
| actual[i].Target.MediaType != images.MediaTypeDockerSchema2Manifest && |
| actual[i].Target.MediaType != ocispec.MediaTypeImageIndex { |
| t.Fatalf("image(%d) unexpected media type: %s", i, actual[i].Target.MediaType) |
| } |
| } |
| } |
| |
| func createContent(size int64, seed int64) ([]byte, digest.Digest) { |
| b, err := io.ReadAll(io.LimitReader(rand.New(rand.NewSource(seed)), size)) |
| if err != nil { |
| panic(err) |
| } |
| wb := bytes.NewBuffer(nil) |
| cw, err := compression.CompressStream(wb, compression.Gzip) |
| if err != nil { |
| panic(err) |
| } |
| |
| if _, err := cw.Write(b); err != nil { |
| panic(err) |
| } |
| b = wb.Bytes() |
| return b, digest.FromBytes(b) |
| } |
| |
| func createConfig(osName, archName, author string) ([]byte, digest.Digest) { |
| image := ocispec.Image{ |
| Platform: ocispec.Platform{ |
| OS: osName, |
| Architecture: archName, |
| }, |
| Author: author, |
| } |
| b, _ := json.Marshal(image) |
| |
| return b, digest.FromBytes(b) |
| } |
| |
| func createManifest(config []byte, layers [][]byte) ([]byte, digest.Digest, *ocispec.Manifest) { |
| manifest := ocispec.Manifest{ |
| Versioned: specs.Versioned{ |
| SchemaVersion: 2, |
| }, |
| Config: ocispec.Descriptor{ |
| MediaType: ocispec.MediaTypeImageConfig, |
| Digest: digest.FromBytes(config), |
| Size: int64(len(config)), |
| Annotations: map[string]string{ |
| "ocispec": "manifest.config.descriptor", |
| }, |
| }, |
| } |
| for _, l := range layers { |
| manifest.Layers = append(manifest.Layers, ocispec.Descriptor{ |
| MediaType: ocispec.MediaTypeImageLayer, |
| Digest: digest.FromBytes(l), |
| Size: int64(len(l)), |
| Annotations: map[string]string{ |
| "ocispec": "manifest.layers.descriptor", |
| }, |
| }) |
| } |
| |
| b, _ := json.Marshal(manifest) |
| |
| return b, digest.FromBytes(b), &manifest |
| } |
| |
| func createManifestList(manifests ...[]byte) ([]byte, digest.Digest) { |
| idx := ocispec.Index{ |
| Versioned: specs.Versioned{ |
| SchemaVersion: 2, |
| }, |
| } |
| |
| for _, manifest := range manifests { |
| d := ocispec.Descriptor{ |
| MediaType: ocispec.MediaTypeImageManifest, |
| Digest: digest.FromBytes(manifest), |
| Size: int64(len(manifest)), |
| } |
| idx.Manifests = append(idx.Manifests, d) |
| } |
| |
| b, _ := json.Marshal(idx) |
| |
| return b, digest.FromBytes(b) |
| } |
| |
| func createIndex(manifest []byte, mt string, tags ...string) []byte { |
| idx := ocispec.Index{ |
| Versioned: specs.Versioned{ |
| SchemaVersion: 2, |
| }, |
| } |
| d := ocispec.Descriptor{ |
| MediaType: mt, |
| Digest: digest.FromBytes(manifest), |
| Size: int64(len(manifest)), |
| } |
| |
| if len(tags) == 0 { |
| idx.Manifests = append(idx.Manifests, d) |
| } else { |
| for _, t := range tags { |
| dt := d |
| dt.Annotations = map[string]string{ |
| ocispec.AnnotationRefName: t, |
| } |
| idx.Manifests = append(idx.Manifests, dt) |
| } |
| } |
| |
| b, _ := json.Marshal(idx) |
| |
| return b |
| } |
| |
| func TestTransferImport(t *testing.T) { |
| ctx, cancel := testContext(t) |
| defer cancel() |
| |
| client, err := newClient(t, address) |
| if err != nil { |
| t.Fatal(err) |
| } |
| defer client.Close() |
| |
| for _, testCase := range []struct { |
| // Name is the name of the test |
| Name string |
| |
| // Images is the names of the images to create |
| // [0]: Index name or "" |
| // [1:]: Additional images and manifest to import |
| // Images ending with @ will have digest appended and use the digest of the previously imported image |
| // A space can be used to separate a repo name and tag, only the tag will be set in the imported image |
| Images []string |
| Opts []image.StoreOpt |
| }{ |
| { |
| Name: "Basic", |
| Images: []string{"", "registry.test/basic:latest"}, |
| Opts: []image.StoreOpt{image.WithNamedPrefix("unused", true)}, |
| }, |
| { |
| Name: "IndexRef", |
| Images: []string{"registry.test/index-ref:latest", ""}, |
| }, |
| { |
| Name: "AllRefs", |
| Images: []string{"registry.test/all-refs:index", "registry.test/all-refs:1"}, |
| Opts: []image.StoreOpt{image.WithNamedPrefix("registry.test/all-refs", false)}, |
| }, |
| { |
| Name: "DigestRefs", |
| Images: []string{"registry.test/all-refs:index", "registry.test/all-refs:1", "registry.test/all-refs@"}, |
| Opts: []image.StoreOpt{image.WithDigestRef("registry.test/all-refs", false, false)}, |
| }, |
| { |
| Name: "DigestRefsSkipNamed", |
| Images: []string{"registry.test/all-refs:index", "registry.test/all-refs:1"}, |
| Opts: []image.StoreOpt{image.WithDigestRef("registry.test/all-refs", false, true)}, |
| }, |
| { |
| Name: "DigestOnly", |
| Images: []string{"", "", "imported-image@"}, |
| Opts: []image.StoreOpt{image.WithDigestRef("imported-image", false, true)}, |
| }, |
| { |
| Name: "OverwriteDigestRefs", |
| Images: []string{"registry.test/all-refs:index", "registry.test/all-refs:1", "someimportname@"}, |
| Opts: []image.StoreOpt{image.WithDigestRef("someimportname", true, false)}, |
| }, |
| { |
| Name: "TagOnlyRef", |
| Images: []string{"", "registry.test/myimage thebest"}, |
| Opts: []image.StoreOpt{image.WithNamedPrefix("registry.test/myimage", false)}, |
| }, |
| { |
| Name: "TagOnlyOverwriteDigestRefs", |
| Images: []string{"registry.test/all-refs:index", "registry.test/basename latest", "registry.test/basename@"}, |
| Opts: []image.StoreOpt{image.WithDigestRef("registry.test/basename", true, false)}, |
| }, |
| } { |
| t.Run(testCase.Name, func(t *testing.T) { |
| tc := tartest.TarContext{} |
| files := []tartest.WriterToTar{ |
| tc.Dir(ocispec.ImageBlobsDir, 0755), |
| tc.Dir(ocispec.ImageBlobsDir+"/sha256", 0755), |
| } |
| |
| descs, tws := createImages(tc, testCase.Images...) |
| files = append(files, tws...) |
| |
| files = append(files, tc.File(ocispec.ImageLayoutFile, []byte(`{"imageLayoutVersion":"`+ocispec.ImageLayoutVersion+`"}`), 0644)) |
| |
| r := tartest.TarFromWriterTo(tartest.TarAll(files...)) |
| |
| var idxName string |
| if len(testCase.Images) > 0 { |
| idxName = testCase.Images[0] |
| } |
| |
| is := image.NewStore(idxName, testCase.Opts...) |
| |
| iis := tarchive.NewImageImportStream(r, "") |
| |
| progressTracker := &imagesProgress{} |
| |
| err := client.Transfer(ctx, iis, is, transfer.WithProgress(progressTracker.Progress)) |
| closeErr := r.Close() |
| if err != nil { |
| t.Fatal(err) |
| } |
| if closeErr != nil { |
| t.Fatal(closeErr) |
| } |
| |
| imgs := progressTracker.getImages() |
| if len(descs) != len(imgs) { |
| t.Fatalf("unexpected number of images saved:\n\t(%d) %v\nexpected image map:\n\t(%d) %v", len(imgs), imgs, len(descs), descs) |
| } |
| store := client.ImageService() |
| for _, image := range imgs { |
| desc, ok := descs[image] |
| if !ok { |
| t.Fatalf("saved image %q not found in expected list\nimages saved:\n\t(%d) %v\nexpected image map:\n\t(%d) %v", image, len(progressTracker.images), progressTracker.images, len(descs), descs) |
| } |
| img, err := store.Get(ctx, image) |
| if err != nil { |
| t.Fatalf("error getting image %s: %v", image, err) |
| } |
| if img.Target.Digest != desc.Digest { |
| t.Fatalf("digests don't match for %s: got %s, expected %s", image, img.Target.Digest, desc.Digest) |
| } |
| if img.Target.MediaType != desc.MediaType { |
| t.Fatalf("media type don't match for %s: got %s, expected %s", image, img.Target.MediaType, desc.MediaType) |
| } |
| if img.Target.Size != desc.Size { |
| t.Fatalf("size don't match for %s: got %d, expected %d", image, img.Target.Size, desc.Size) |
| } |
| } |
| }) |
| } |
| } |
| |
| type imagesProgress struct { |
| sync.Mutex |
| images []string |
| } |
| |
| func (ip *imagesProgress) Progress(p transfer.Progress) { |
| ip.Lock() |
| if p.Event == "saved" { |
| ip.images = append(ip.images, p.Name) |
| } |
| ip.Unlock() |
| } |
| |
| func (ip *imagesProgress) getImages() []string { |
| ip.Lock() |
| imgs := ip.images |
| ip.Unlock() |
| return imgs |
| |
| } |
| |
| func createImages(tc tartest.TarContext, imageNames ...string) (descs map[string]ocispec.Descriptor, tw []tartest.WriterToTar) { |
| descs = map[string]ocispec.Descriptor{} |
| idx := ocispec.Index{ |
| Versioned: specs.Versioned{ |
| SchemaVersion: 2, |
| }, |
| } |
| |
| if len(imageNames) > 1 { |
| var lastManifest ocispec.Descriptor |
| |
| for _, image := range imageNames[1:] { |
| if image != "" && image[len(image)-1] == '@' { |
| image = image[:len(image)-1] |
| descs[fmt.Sprintf("%s@%s", image, lastManifest.Digest)] = lastManifest |
| continue |
| } |
| seed := hash64(image) |
| bb, b := createContent(128, seed) |
| tw = append(tw, tc.File(ocispec.ImageBlobsDir+"/sha256/"+b.Encoded(), bb, 0644)) |
| |
| cb, c := createConfig("linux", "amd64", image) |
| tw = append(tw, tc.File(ocispec.ImageBlobsDir+"/sha256/"+c.Encoded(), cb, 0644)) |
| |
| mb, m, _ := createManifest(cb, [][]byte{bb}) |
| tw = append(tw, tc.File(ocispec.ImageBlobsDir+"/sha256/"+m.Encoded(), mb, 0644)) |
| |
| annotations := map[string]string{} |
| if image != "" { |
| if parts := strings.SplitN(image, " ", 2); len(parts) == 2 { |
| annotations[ocispec.AnnotationRefName] = parts[1] |
| image = strings.Join(parts, ":") |
| } else { |
| annotations[images.AnnotationImageName] = image |
| } |
| } |
| |
| md := ocispec.Descriptor{ |
| Digest: m, |
| Size: int64(len(mb)), |
| MediaType: ocispec.MediaTypeImageManifest, |
| Annotations: annotations, |
| } |
| |
| // If image is empty, but has base and digest, still use digest |
| // If image is not a full reference, then add base if provided? |
| if image != "" { |
| descs[image] = md |
| } |
| |
| idx.Manifests = append(idx.Manifests, md) |
| lastManifest = md |
| } |
| } |
| |
| ib, _ := json.Marshal(idx) |
| id := ocispec.Descriptor{ |
| Digest: digest.FromBytes(ib), |
| Size: int64(len(ib)), |
| MediaType: ocispec.MediaTypeImageIndex, |
| } |
| tw = append(tw, tc.File(ocispec.ImageIndexFile, ib, 0644)) |
| |
| var idxName string |
| if len(imageNames) > 0 { |
| idxName = imageNames[0] |
| } |
| if idxName != "" { |
| descs[idxName] = id |
| } |
| |
| return |
| } |
| |
| func hash64(s string) int64 { |
| h := fnv.New64a() |
| h.Write([]byte(s)) |
| return int64(h.Sum64()) |
| } |