1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
|
package copy
import (
"context"
"errors"
"fmt"
"testing"
"github.com/containers/image/v5/internal/testing/mocks"
"github.com/containers/image/v5/manifest"
v1 "github.com/opencontainers/image-spec/specs-go/v1"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestOrderedSet(t *testing.T) {
for _, c := range []struct{ input, expected []string }{
{[]string{}, []string{}},
{[]string{"a", "b", "c"}, []string{"a", "b", "c"}},
{[]string{"a", "b", "a", "c"}, []string{"a", "b", "c"}},
} {
os := newOrderedSet()
for _, s := range c.input {
os.append(s)
}
assert.Equal(t, c.expected, os.list, fmt.Sprintf("%#v", c.input))
}
}
func TestDetermineManifestConversion(t *testing.T) {
supportS1S2OCI := []string{
v1.MediaTypeImageManifest,
manifest.DockerV2Schema2MediaType,
manifest.DockerV2Schema1SignedMediaType,
manifest.DockerV2Schema1MediaType,
}
supportS1OCI := []string{
v1.MediaTypeImageManifest,
manifest.DockerV2Schema1SignedMediaType,
manifest.DockerV2Schema1MediaType,
}
supportS1S2 := []string{
manifest.DockerV2Schema2MediaType,
manifest.DockerV2Schema1SignedMediaType,
manifest.DockerV2Schema1MediaType,
}
supportOnlyS1 := []string{
manifest.DockerV2Schema1SignedMediaType,
manifest.DockerV2Schema1MediaType,
}
cases := []struct {
description string
sourceType string
destTypes []string
expected manifestConversionPlan
}{
// Destination accepts anything — no conversion necessary
{
"s1→anything", manifest.DockerV2Schema1SignedMediaType, nil,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema1SignedMediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
},
},
{
"s2→anything", manifest.DockerV2Schema2MediaType, nil,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema2MediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
},
},
// Destination accepts the unmodified original
{
"s1→s1s2", manifest.DockerV2Schema1SignedMediaType, supportS1S2,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema1SignedMediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{manifest.DockerV2Schema2MediaType, manifest.DockerV2Schema1MediaType},
},
},
{
"s2→s1s2", manifest.DockerV2Schema2MediaType, supportS1S2,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema2MediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: supportOnlyS1,
},
},
{
"s1→s1", manifest.DockerV2Schema1SignedMediaType, supportOnlyS1,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema1SignedMediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{manifest.DockerV2Schema1MediaType},
},
},
// text/plain is normalized to s1, and if the destination accepts s1, no conversion happens.
{
"text→s1s2", "text/plain", supportS1S2,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema1SignedMediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{manifest.DockerV2Schema2MediaType, manifest.DockerV2Schema1MediaType},
},
},
{
"text→s1", "text/plain", supportOnlyS1,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema1SignedMediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{manifest.DockerV2Schema1MediaType},
},
},
// Conversion necessary, a preferred format is acceptable
{
"s2→s1", manifest.DockerV2Schema2MediaType, supportOnlyS1,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema1SignedMediaType,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{manifest.DockerV2Schema1MediaType},
},
},
// Conversion necessary, a preferred format is not acceptable
{
"s2→OCI", manifest.DockerV2Schema2MediaType, []string{v1.MediaTypeImageManifest},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{},
},
},
// text/plain is converted if the destination does not accept s1
{
"text→s2", "text/plain", []string{manifest.DockerV2Schema2MediaType},
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema2MediaType,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{},
},
},
// Conversion necessary, try the preferred formats in order.
// We abuse manifest.DockerV2ListMediaType here as a MIME type which is not in supportS1S2OCI,
// but is still recognized by manifest.NormalizedMIMEType and not normalized to s1
{
"special→s2", manifest.DockerV2ListMediaType, supportS1S2OCI,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema2MediaType,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{manifest.DockerV2Schema1SignedMediaType, v1.MediaTypeImageManifest, manifest.DockerV2Schema1MediaType},
},
},
{
"special→s1", manifest.DockerV2ListMediaType, supportS1OCI,
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema1SignedMediaType,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{v1.MediaTypeImageManifest, manifest.DockerV2Schema1MediaType},
},
},
{
"special→OCI", manifest.DockerV2ListMediaType, []string{v1.MediaTypeImageManifest, "other options", "with lower priority"},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{"other options", "with lower priority"},
},
},
}
for _, c := range cases {
res, err := determineManifestConversion(determineManifestConversionInputs{
srcMIMEType: c.sourceType,
destSupportedManifestMIMETypes: c.destTypes,
forceManifestMIMEType: "",
requiresOCIEncryption: false,
cannotModifyManifestReason: "",
})
require.NoError(t, err, c.description)
assert.Equal(t, c.expected, res, c.description)
}
// Whatever the input is, with cannotModifyManifestReason we return "keep the original as is"
for _, c := range cases {
res, err := determineManifestConversion(determineManifestConversionInputs{
srcMIMEType: c.sourceType,
destSupportedManifestMIMETypes: c.destTypes,
forceManifestMIMEType: "",
requiresOCIEncryption: false,
cannotModifyManifestReason: "Preserving digests",
})
require.NoError(t, err, c.description)
assert.Equal(t, manifestConversionPlan{
preferredMIMEType: manifest.NormalizedMIMEType(c.sourceType),
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
}, res, c.description)
}
// With forceManifestMIMEType, the output is always the forced manifest type (in this case oci manifest)
for _, c := range cases {
res, err := determineManifestConversion(determineManifestConversionInputs{
srcMIMEType: c.sourceType,
destSupportedManifestMIMETypes: c.destTypes,
forceManifestMIMEType: v1.MediaTypeImageManifest,
requiresOCIEncryption: false,
cannotModifyManifestReason: "",
})
require.NoError(t, err, c.description)
assert.Equal(t, manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{},
}, res, c.description)
}
// When encryption is required:
for _, c := range []struct {
description string
in determineManifestConversionInputs // with requiresOCIEncryption implied
expected manifestConversionPlan // Or {} to expect a failure
}{
{ // Destination accepts anything - no conversion necessary
"OCI→anything",
determineManifestConversionInputs{
srcMIMEType: v1.MediaTypeImageManifest,
destSupportedManifestMIMETypes: nil,
},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
},
},
{ // Destination accepts anything - need to convert for encryption
"s2→anything",
determineManifestConversionInputs{
srcMIMEType: manifest.DockerV2Schema2MediaType,
destSupportedManifestMIMETypes: nil,
},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{},
},
},
// Destination accepts an encrypted format
{
"OCI→OCI",
determineManifestConversionInputs{
srcMIMEType: v1.MediaTypeImageManifest,
destSupportedManifestMIMETypes: supportS1S2OCI,
},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
},
},
{
"s2→OCI",
determineManifestConversionInputs{
srcMIMEType: manifest.DockerV2Schema2MediaType,
destSupportedManifestMIMETypes: supportS1S2OCI,
},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{},
},
},
// Destination does not accept an encrypted format
{
"OCI→s2",
determineManifestConversionInputs{
srcMIMEType: v1.MediaTypeImageManifest,
destSupportedManifestMIMETypes: supportS1S2,
},
manifestConversionPlan{},
},
{
"s2→s2",
determineManifestConversionInputs{
srcMIMEType: manifest.DockerV2Schema2MediaType,
destSupportedManifestMIMETypes: supportS1S2,
},
manifestConversionPlan{},
},
// Whatever the input is, with cannotModifyManifestReason we return "keep the original as is".
// Still, encryption is necessarily going to fail…
{
"OCI→OCI cannotModifyManifestReason",
determineManifestConversionInputs{
srcMIMEType: v1.MediaTypeImageManifest,
destSupportedManifestMIMETypes: supportS1S2OCI,
cannotModifyManifestReason: "Preserving digests",
},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
},
},
{
"s2→OCI cannotModifyManifestReason",
determineManifestConversionInputs{
srcMIMEType: manifest.DockerV2Schema2MediaType,
destSupportedManifestMIMETypes: supportS1S2OCI,
cannotModifyManifestReason: "Preserving digests",
},
manifestConversionPlan{
preferredMIMEType: manifest.DockerV2Schema2MediaType,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
},
},
// forceManifestMIMEType to a type that supports encryption
{
"OCI→OCI forced",
determineManifestConversionInputs{
srcMIMEType: v1.MediaTypeImageManifest,
destSupportedManifestMIMETypes: supportS1S2OCI,
forceManifestMIMEType: v1.MediaTypeImageManifest,
},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: false,
otherMIMETypeCandidates: []string{},
},
},
{
"s2→OCI forced",
determineManifestConversionInputs{
srcMIMEType: manifest.DockerV2Schema2MediaType,
destSupportedManifestMIMETypes: supportS1S2OCI,
forceManifestMIMEType: v1.MediaTypeImageManifest,
},
manifestConversionPlan{
preferredMIMEType: v1.MediaTypeImageManifest,
preferredMIMETypeNeedsConversion: true,
otherMIMETypeCandidates: []string{},
},
},
// forceManifestMIMEType to a type that does not support encryption
{
"OCI→s2 forced",
determineManifestConversionInputs{
srcMIMEType: v1.MediaTypeImageManifest,
destSupportedManifestMIMETypes: supportS1S2OCI,
forceManifestMIMEType: manifest.DockerV2Schema2MediaType,
},
manifestConversionPlan{},
},
{
"s2→s2 forced",
determineManifestConversionInputs{
srcMIMEType: manifest.DockerV2Schema2MediaType,
destSupportedManifestMIMETypes: supportS1S2OCI,
forceManifestMIMEType: manifest.DockerV2Schema2MediaType,
},
manifestConversionPlan{},
},
} {
in := c.in
in.requiresOCIEncryption = true
res, err := determineManifestConversion(in)
if c.expected.preferredMIMEType != "" {
require.NoError(t, err, c.description)
assert.Equal(t, c.expected, res, c.description)
} else {
assert.Error(t, err, c.description)
}
}
}
// fakeUnparsedImage is an implementation of types.UnparsedImage which only returns itself as a MIME type in Manifest,
// except that "" means “reading the manifest should fail”
type fakeUnparsedImage struct {
mocks.ForbiddenUnparsedImage
mt string
}
func (f fakeUnparsedImage) Manifest(ctx context.Context) ([]byte, string, error) {
if f.mt == "" {
return nil, "", errors.New("Manifest() directed to fail")
}
return nil, f.mt, nil
}
func TestIsMultiImage(t *testing.T) {
// MIME type is available; more or less a smoke test, other cases are handled in manifest.MIMETypeIsMultiImage
for _, c := range []struct {
mt string
expected bool
}{
{manifest.DockerV2ListMediaType, true},
{manifest.DockerV2Schema2MediaType, false},
{v1.MediaTypeImageManifest, false},
{v1.MediaTypeImageIndex, true},
} {
src := fakeUnparsedImage{mocks.ForbiddenUnparsedImage{}, c.mt}
res, err := isMultiImage(context.Background(), src)
require.NoError(t, err)
assert.Equal(t, c.expected, res, c.mt)
}
// Error getting manifest MIME type
src := fakeUnparsedImage{mocks.ForbiddenUnparsedImage{}, ""}
_, err := isMultiImage(context.Background(), src)
assert.Error(t, err)
}
func TestDetermineManifestListConversion(t *testing.T) {
supportS1S2OCI := []string{
v1.MediaTypeImageIndex,
v1.MediaTypeImageManifest,
manifest.DockerV2ListMediaType,
manifest.DockerV2Schema2MediaType,
manifest.DockerV2Schema1SignedMediaType,
manifest.DockerV2Schema1MediaType,
}
supportS1S2 := []string{
manifest.DockerV2ListMediaType,
manifest.DockerV2Schema2MediaType,
manifest.DockerV2Schema1SignedMediaType,
manifest.DockerV2Schema1MediaType,
}
supportOnlyOCI := []string{
v1.MediaTypeImageIndex,
v1.MediaTypeImageManifest,
}
supportOnlyS1 := []string{
manifest.DockerV2Schema1SignedMediaType,
manifest.DockerV2Schema1MediaType,
}
cases := []struct {
description string
sourceType string
destTypes []string
expectedUpdate string
expectedOtherCandidates []string
}{
// Destination accepts anything — try all variants
{"s2→anything", manifest.DockerV2ListMediaType, nil, "", []string{v1.MediaTypeImageIndex}},
{"OCI→anything", v1.MediaTypeImageIndex, nil, "", []string{manifest.DockerV2ListMediaType}},
// Destination accepts the unmodified original
{"s2→s1s2OCI", manifest.DockerV2ListMediaType, supportS1S2OCI, "", []string{v1.MediaTypeImageIndex}},
{"OCI→s1s2OCI", v1.MediaTypeImageIndex, supportS1S2OCI, "", []string{manifest.DockerV2ListMediaType}},
{"s2→s1s2", manifest.DockerV2ListMediaType, supportS1S2, "", []string{}},
{"OCI→OCI", v1.MediaTypeImageIndex, supportOnlyOCI, "", []string{}},
// Conversion necessary, try the preferred formats in order.
{"special→OCI", "unrecognized", supportS1S2OCI, v1.MediaTypeImageIndex, []string{manifest.DockerV2ListMediaType}},
{"special→s2", "unrecognized", supportS1S2, manifest.DockerV2ListMediaType, []string{}},
}
for _, c := range cases {
copier := &copier{}
preferredMIMEType, otherCandidates, err := copier.determineListConversion(c.sourceType, c.destTypes, "")
require.NoError(t, err, c.description)
if c.expectedUpdate == "" {
assert.Equal(t, manifest.NormalizedMIMEType(c.sourceType), preferredMIMEType, c.description)
} else {
assert.Equal(t, c.expectedUpdate, preferredMIMEType, c.description)
}
assert.Equal(t, c.expectedOtherCandidates, otherCandidates, c.description)
}
// With forceManifestMIMEType, the output is always the forced manifest type (in this case OCI index)
for _, c := range cases {
copier := &copier{}
preferredMIMEType, otherCandidates, err := copier.determineListConversion(c.sourceType, c.destTypes, v1.MediaTypeImageIndex)
require.NoError(t, err, c.description)
assert.Equal(t, v1.MediaTypeImageIndex, preferredMIMEType, c.description)
assert.Equal(t, []string{}, otherCandidates, c.description)
}
// The destination doesn’t support list formats at all
copier := &copier{}
_, _, err := copier.determineListConversion(v1.MediaTypeImageIndex, supportOnlyS1, "")
assert.Error(t, err)
}
|