Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 48e0897

Browse files
nalindnalind
committedMay 9, 2023
copy.Options: add an InstancePlatforms field
Add an InstancePlatforms field to the copy.Options structure. When asked to copy only a specific subset of instances, combine the Instances list with the instances which match the platforms given in the InstancePlatforms list, returning an error if we're unable to find an instance which matches any of the InstancePlatforms. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
1 parent bf1176f commit 48e0897

File tree

4 files changed

+214
-5
lines changed

4 files changed

+214
-5
lines changed
 

‎copy/copy.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import (
2323
"github.com/containers/image/v5/types"
2424
encconfig "github.com/containers/ocicrypt/config"
2525
digest "github.com/opencontainers/go-digest"
26+
imgspecv1 "github.com/opencontainers/image-spec/specs-go/v1"
2627
"github.com/sirupsen/logrus"
2728
"golang.org/x/exp/slices"
2829
"golang.org/x/sync/semaphore"
@@ -91,8 +92,9 @@ type Options struct {
9192
PreserveDigests bool
9293
// manifest MIME type of image set by user. "" is default and means use the autodetection to the manifest MIME type
9394
ForceManifestMIMEType string
94-
ImageListSelection ImageListSelection // set to either CopySystemImage (the default), CopyAllImages, or CopySpecificImages to control which instances we copy when the source reference is a list; ignored if the source reference is not a list
95-
Instances []digest.Digest // if ImageListSelection is CopySpecificImages, copy only these instances and the list itself
95+
ImageListSelection ImageListSelection // set to either CopySystemImage (the default), CopyAllImages, or CopySpecificImages to control which instances we copy when the source reference is a list; ignored if the source reference is not a list
96+
Instances []digest.Digest // if ImageListSelection is CopySpecificImages, copy only these instances, instances matching the InstancePlatforms list, and the list itself
97+
InstancePlatforms []imgspecv1.Platform // if ImageListSelection is CopySpecificImages, copy only matching instances, instances listed in the Instances list, and the list itself
9698
// Give priority to pulling gzip images if multiple images are present when configured to OptionalBoolTrue,
9799
// prefers the best compression if this is configured as OptionalBoolFalse. Choose automatically (and the choice may change over time)
98100
// if this is set to OptionalBoolUndefined (which is the default behavior, and recommended for most callers).

‎copy/multiple.go

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ import (
1010
"github.com/containers/image/v5/docker/reference"
1111
"github.com/containers/image/v5/internal/image"
1212
internalManifest "github.com/containers/image/v5/internal/manifest"
13+
"github.com/containers/image/v5/internal/set"
1314
"github.com/containers/image/v5/manifest"
1415
"github.com/containers/image/v5/signature"
16+
"github.com/containers/image/v5/types"
17+
digest "github.com/opencontainers/go-digest"
1518
imgspecv1 "github.com/opencontainers/image-spec/specs-go/v1"
1619
"github.com/sirupsen/logrus"
17-
"golang.org/x/exp/slices"
1820
)
1921

2022
// copyMultipleImages copies some or all of an image list's instances, using
@@ -89,15 +91,19 @@ func (c *copier) copyMultipleImages(ctx context.Context, policyContext *signatur
8991
// Copy each image, or just the ones we want to copy, in turn.
9092
instanceDigests := updatedList.Instances()
9193
imagesToCopy := len(instanceDigests)
94+
var specificImages *set.Set[digest.Digest]
9295
if options.ImageListSelection == CopySpecificImages {
93-
imagesToCopy = len(options.Instances)
96+
if specificImages, err = determineSpecificImages(options, updatedList); err != nil {
97+
return nil, err
98+
}
99+
imagesToCopy = specificImages.Size()
94100
}
95101
c.Printf("Copying %d of %d images in list\n", imagesToCopy, len(instanceDigests))
96102
updates := make([]manifest.ListUpdate, len(instanceDigests))
97103
instancesCopied := 0
98104
for i, instanceDigest := range instanceDigests {
99105
if options.ImageListSelection == CopySpecificImages &&
100-
!slices.Contains(options.Instances, instanceDigest) {
106+
!specificImages.Contains(instanceDigest) {
101107
update, err := updatedList.Instance(instanceDigest)
102108
if err != nil {
103109
return nil, err
@@ -196,3 +202,30 @@ func (c *copier) copyMultipleImages(ctx context.Context, policyContext *signatur
196202

197203
return manifestList, nil
198204
}
205+
206+
// determineSpecificImages returns a set of images to copy based on the
207+
// Instances and InstancePlatforms fields of the passed-in options structure
208+
func determineSpecificImages(options *Options, updatedList internalManifest.List) (*set.Set[digest.Digest], error) {
209+
// Start with the instances that were listed by digest.
210+
specificImages := set.New[digest.Digest]()
211+
for _, instanceDigest := range options.Instances {
212+
specificImages.Add(instanceDigest)
213+
}
214+
if len(options.InstancePlatforms) > 0 {
215+
// Choose the best match for each platform we were asked to
216+
// also copy, and add it to the set of instances to copy.
217+
for _, platform := range options.InstancePlatforms {
218+
platformContext := types.SystemContext{
219+
OSChoice: platform.OS,
220+
ArchitectureChoice: platform.Architecture,
221+
VariantChoice: platform.Variant,
222+
}
223+
instanceDigest, err := updatedList.ChooseInstanceByCompression(&platformContext, options.PreferGzipInstances)
224+
if err != nil {
225+
return nil, fmt.Errorf("While choosing the instance for platform spec %v: %w", platform, err)
226+
}
227+
specificImages.Add(instanceDigest)
228+
}
229+
}
230+
return specificImages, nil
231+
}

‎copy/multiple_test.go

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
package copy
2+
3+
import (
4+
"io/ioutil"
5+
"strings"
6+
"testing"
7+
8+
internalManifest "github.com/containers/image/v5/internal/manifest"
9+
digest "github.com/opencontainers/go-digest"
10+
imgspecv1 "github.com/opencontainers/image-spec/specs-go/v1"
11+
"github.com/stretchr/testify/assert"
12+
"github.com/stretchr/testify/require"
13+
)
14+
15+
func TestDetermineSpecificImages(t *testing.T) {
16+
testCases := []struct {
17+
id string
18+
fixture string
19+
instanceDigests []digest.Digest
20+
instancePlatforms []imgspecv1.Platform
21+
expected []digest.Digest
22+
expectedErrIncludes string
23+
}{
24+
{
25+
id: "no inputs no outputs",
26+
fixture: "../manifest/fixtures/v2list.manifest.json",
27+
},
28+
{
29+
id: "instances only out of order",
30+
fixture: "../manifest/fixtures/v2list.manifest.json",
31+
instanceDigests: []digest.Digest{
32+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
33+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
34+
},
35+
expected: []digest.Digest{
36+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
37+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
38+
},
39+
},
40+
{
41+
id: "instances only in order",
42+
fixture: "../manifest/fixtures/v2list.manifest.json",
43+
instanceDigests: []digest.Digest{
44+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
45+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
46+
},
47+
expected: []digest.Digest{
48+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
49+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
50+
},
51+
},
52+
{
53+
id: "platforms only in order",
54+
fixture: "../manifest/fixtures/v2list.manifest.json",
55+
instancePlatforms: []imgspecv1.Platform{
56+
{
57+
OS: "linux",
58+
Architecture: "ppc64le",
59+
},
60+
{
61+
OS: "linux",
62+
Architecture: "s390x",
63+
},
64+
},
65+
expected: []digest.Digest{
66+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
67+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
68+
},
69+
},
70+
{
71+
id: "platforms only out of order",
72+
fixture: "../manifest/fixtures/v2list.manifest.json",
73+
instancePlatforms: []imgspecv1.Platform{
74+
{
75+
OS: "linux",
76+
Architecture: "s390x",
77+
},
78+
{
79+
OS: "linux",
80+
Architecture: "ppc64le",
81+
},
82+
},
83+
expected: []digest.Digest{
84+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
85+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
86+
},
87+
},
88+
{
89+
id: "mixed without duplicates",
90+
fixture: "../manifest/fixtures/v2list.manifest.json",
91+
instancePlatforms: []imgspecv1.Platform{
92+
{
93+
OS: "linux",
94+
Architecture: "s390x",
95+
},
96+
},
97+
instanceDigests: []digest.Digest{
98+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
99+
},
100+
expected: []digest.Digest{
101+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
102+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
103+
},
104+
},
105+
{
106+
id: "mixed with duplicates",
107+
fixture: "../manifest/fixtures/v2list.manifest.json",
108+
instancePlatforms: []imgspecv1.Platform{
109+
{
110+
OS: "linux",
111+
Architecture: "ppc64le",
112+
},
113+
{
114+
OS: "linux",
115+
Architecture: "s390x",
116+
},
117+
},
118+
instanceDigests: []digest.Digest{
119+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
120+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
121+
},
122+
expected: []digest.Digest{
123+
"sha256:7820f9a86d4ad15a2c4f0c0e5479298df2aa7c2f6871288e2ef8546f3e7b6783",
124+
"sha256:e4c0df75810b953d6717b8f8f28298d73870e8aa2a0d5e77b8391f16fdfbbbe2",
125+
},
126+
},
127+
{
128+
id: "no such platform",
129+
fixture: "../manifest/fixtures/v2list.manifest.json",
130+
instancePlatforms: []imgspecv1.Platform{
131+
{
132+
OS: "windows",
133+
Architecture: "amd64",
134+
},
135+
{
136+
OS: "darwin",
137+
Architecture: "arm64",
138+
},
139+
},
140+
expectedErrIncludes: "no image found in manifest list for",
141+
},
142+
}
143+
for _, tc := range testCases {
144+
t.Run(tc.id, func(t *testing.T) {
145+
listBlob, err := ioutil.ReadFile(tc.fixture)
146+
require.NoErrorf(t, err, "unexpected error reading fixture %q", tc.fixture)
147+
list, err := internalManifest.ListFromBlob(listBlob, internalManifest.GuessMIMEType(listBlob))
148+
require.NoErrorf(t, err, "unexpected error parsing fixture %q", tc.fixture)
149+
options := Options{
150+
Instances: tc.instanceDigests,
151+
InstancePlatforms: tc.instancePlatforms,
152+
}
153+
specific, err := determineSpecificImages(&options, list)
154+
if err != nil && tc.expectedErrIncludes != "" {
155+
if strings.Contains(err.Error(), tc.expectedErrIncludes) {
156+
// okay
157+
return
158+
}
159+
}
160+
require.NoErrorf(t, err, "unexpected error selecting instances")
161+
var selected []digest.Digest
162+
for _, instanceDigest := range list.Instances() {
163+
if specific.Contains(instanceDigest) {
164+
selected = append(selected, instanceDigest)
165+
}
166+
}
167+
assert.Equalf(t, tc.expected, selected, "given instance list %#v and platforms list %#v", tc.instanceDigests, tc.instancePlatforms)
168+
})
169+
}
170+
}

‎internal/set/set.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,7 @@ func (s *Set[E]) Empty() bool {
4444
func (s *Set[E]) Values() []E {
4545
return maps.Keys(s.m)
4646
}
47+
48+
func (s Set[E]) Size() int {
49+
return len(s.m)
50+
}

0 commit comments

Comments
 (0)
Please sign in to comment.