Skip to content

Commit d04bf7d

Browse files
authored
tarball: use correct file extension for zstd/uncompressed (#2382)
1 parent 4d13d53 commit d04bf7d

2 files changed

Lines changed: 145 additions & 2 deletions

File tree

‎pkg/v1/tarball/write.go‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"github.com/google/go-containerregistry/pkg/name"
2929
v1 "github.com/google/go-containerregistry/pkg/v1"
3030
"github.com/google/go-containerregistry/pkg/v1/partial"
31+
"github.com/google/go-containerregistry/pkg/v1/types"
3132
)
3233

3334
// WriteToFile writes in the compressed format to a tarball, on disk.
@@ -184,7 +185,7 @@ func writeImagesToTar(imageToTags map[v1.Image][]string, m []byte, size int64, w
184185

185186
// gunzip expects certain file extensions:
186187
// https://www.gnu.org/software/gzip/manual/html_node/Overview.html
187-
layerFiles[i] = fmt.Sprintf("%s.tar.gz", hex)
188+
layerFiles[i] = hex + layerExtension(l)
188189

189190
if _, ok := seenLayerDigests[hex]; ok {
190191
continue
@@ -244,7 +245,7 @@ func calculateManifest(imageToTags map[v1.Image][]string) (m Manifest, err error
244245

245246
// gunzip expects certain file extensions:
246247
// https://www.gnu.org/software/gzip/manual/html_node/Overview.html
247-
layerFiles[i] = fmt.Sprintf("%s.tar.gz", hex)
248+
layerFiles[i] = hex + layerExtension(l)
248249

249250
// Add to LayerSources if it's a foreign layer.
250251
desc, err := partial.BlobDescriptor(img, d)
@@ -463,3 +464,16 @@ func calculateSingleFileInTarSize(in int64) (out int64) {
463464
out += 512
464465
return out
465466
}
467+
468+
func layerExtension(l v1.Layer) string {
469+
mt, _ := l.MediaType()
470+
switch mt {
471+
case types.OCILayerZStd:
472+
return ".tar.zst"
473+
case types.OCIUncompressedLayer, types.OCIUncompressedRestrictedLayer, types.DockerUncompressedLayer:
474+
return ".tar"
475+
default:
476+
// historically, only gzip compressed tar was supported, so this is the fallback
477+
return ".tar.gz"
478+
}
479+
}

‎pkg/v1/tarball/write_test.go‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"github.com/google/go-containerregistry/pkg/name"
2929
v1 "github.com/google/go-containerregistry/pkg/v1"
3030
"github.com/google/go-containerregistry/pkg/v1/compare"
31+
"github.com/google/go-containerregistry/pkg/v1/empty"
3132
"github.com/google/go-containerregistry/pkg/v1/mutate"
3233
"github.com/google/go-containerregistry/pkg/v1/random"
3334
"github.com/google/go-containerregistry/pkg/v1/tarball"
@@ -578,3 +579,131 @@ func (rc *tokenReleasingReadCloser) Close() error {
578579
}
579580
return err
580581
}
582+
583+
func TestWriteDynamicExtensions(t *testing.T) {
584+
// Make a tempfile for tarball writes.
585+
fp, err := os.CreateTemp("", "")
586+
if err != nil {
587+
t.Fatalf("Error creating temp file.")
588+
}
589+
t.Log(fp.Name())
590+
defer fp.Close()
591+
defer os.Remove(fp.Name())
592+
593+
// Create layers with different media types
594+
gzipLayer, err := random.Layer(128, types.OCILayer)
595+
if err != nil {
596+
t.Fatalf("random.Layer (gzip): %v", err)
597+
}
598+
zstdLayer, err := random.Layer(128, types.OCILayerZStd)
599+
if err != nil {
600+
t.Fatalf("random.Layer (zstd): %v", err)
601+
}
602+
tarLayer, err := random.Layer(128, types.OCIUncompressedLayer)
603+
if err != nil {
604+
t.Fatalf("random.Layer (tar): %v", err)
605+
}
606+
607+
gzipDigest, err := gzipLayer.Digest()
608+
if err != nil {
609+
t.Fatal(err)
610+
}
611+
zstdDigest, err := zstdLayer.Digest()
612+
if err != nil {
613+
t.Fatal(err)
614+
}
615+
tarDigest, err := tarLayer.Digest()
616+
if err != nil {
617+
t.Fatal(err)
618+
}
619+
620+
// Append layers to an empty image
621+
img, err := mutate.Append(empty.Image, mutate.Addendum{Layer: gzipLayer}, mutate.Addendum{Layer: zstdLayer}, mutate.Addendum{Layer: tarLayer})
622+
if err != nil {
623+
t.Fatalf("mutate.Append: %v", err)
624+
}
625+
626+
tag, err := name.NewTag("gcr.io/foo/bar:latest", name.StrictValidation)
627+
if err != nil {
628+
t.Fatalf("Error creating test tag: %v", err)
629+
}
630+
631+
if err := tarball.WriteToFile(fp.Name(), tag, img); err != nil {
632+
t.Fatalf("Unexpected error writing tarball: %v", err)
633+
}
634+
635+
// 1. Verify files in tar archive have correct names
636+
_, err = fp.Seek(0, io.SeekStart)
637+
if err != nil {
638+
t.Fatalf("Seek to start of file: %v", err)
639+
}
640+
641+
expectedFiles := map[string]bool{
642+
gzipDigest.Hex + ".tar.gz": false,
643+
zstdDigest.Hex + ".tar.zst": false,
644+
tarDigest.Hex + ".tar": false,
645+
}
646+
647+
var manifestContent []byte
648+
649+
r := tar.NewReader(fp)
650+
for {
651+
hdr, err := r.Next()
652+
if err != nil {
653+
if errors.Is(err, io.EOF) {
654+
break
655+
}
656+
t.Fatalf("Get tar header: %v", err)
657+
}
658+
if _, ok := expectedFiles[hdr.Name]; ok {
659+
expectedFiles[hdr.Name] = true
660+
}
661+
if hdr.Name == "manifest.json" {
662+
manifestContent, err = io.ReadAll(r)
663+
if err != nil {
664+
t.Fatalf("reading manifest.json: %v", err)
665+
}
666+
}
667+
}
668+
669+
for filename, found := range expectedFiles {
670+
if !found {
671+
t.Errorf("Expected to find file %q in tarball, but it was not found", filename)
672+
}
673+
}
674+
675+
// 2. Verify manifest.json contains correct file names
676+
if len(manifestContent) == 0 {
677+
t.Fatal("manifest.json not found or empty")
678+
}
679+
680+
var manifest []struct {
681+
Config string `json:"Config"`
682+
RepoTags []string `json:"RepoTags"`
683+
Layers []string `json:"Layers"`
684+
}
685+
if err := json.Unmarshal(manifestContent, &manifest); err != nil {
686+
t.Fatalf("unmarshalling manifest: %v", err)
687+
}
688+
689+
if len(manifest) != 1 {
690+
t.Fatalf("expected 1 entry in manifest, got %d", len(manifest))
691+
}
692+
693+
mEntry := manifest[0]
694+
expectedLayers := []string{
695+
gzipDigest.Hex + ".tar.gz",
696+
zstdDigest.Hex + ".tar.zst",
697+
tarDigest.Hex + ".tar",
698+
}
699+
700+
if len(mEntry.Layers) != len(expectedLayers) {
701+
t.Fatalf("expected %d layers in manifest, got %d", len(expectedLayers), len(mEntry.Layers))
702+
}
703+
704+
for i, wantLayer := range expectedLayers {
705+
if got := mEntry.Layers[i]; got != wantLayer {
706+
t.Errorf("layer %d: got manifest layer name %q, want %q", i, got, wantLayer)
707+
}
708+
}
709+
}

0 commit comments

Comments
 (0)