/
pull.go
900 lines (829 loc) · 25 KB
/
pull.go
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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
// Copyright (c) 2019-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
// The E2E PULL group tests image pulls of SIF format images (library, oras
// sources). Docker / OCI image pull is tested as part of the DOCKER E2E group.
package pull
import (
"fmt"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strings"
"testing"
"github.com/google/go-containerregistry/pkg/name"
"github.com/google/go-containerregistry/pkg/v1/remote"
"github.com/google/go-containerregistry/pkg/v1/types"
ocisif "github.com/sylabs/oci-tools/pkg/sif"
"github.com/sylabs/sif/v2/pkg/sif"
"github.com/sylabs/singularity/v4/e2e/internal/e2e"
"github.com/sylabs/singularity/v4/e2e/internal/testhelper"
"github.com/sylabs/singularity/v4/internal/pkg/client/oras"
syoras "github.com/sylabs/singularity/v4/internal/pkg/client/oras"
"github.com/sylabs/singularity/v4/internal/pkg/test/tool/require"
"github.com/sylabs/singularity/v4/internal/pkg/util/uri"
"github.com/sylabs/singularity/v4/pkg/image"
"golang.org/x/sys/unix"
)
type ctx struct {
env e2e.TestEnv
}
type testStruct struct {
desc string // case description
srcURI string // source URI for image
library string // use specific library server URI
arch string // architecture to force, if any
platform string // platform to force, if any
force bool // pass --force
createDst bool // create destination file before pull
unauthenticated bool // pass --allow-unauthenticated
setImagePath bool // pass destination path (singularity pull <image path> <source>)
setPullDir bool // pass --dir
oci bool // pass --oci
keepLayers bool // pass --keep-layers
noHTTPS bool // pass --no-https
expectedExitCode int
workDir string
pullDir string
imagePath string
expectedImage string
expectedOCI bool
expectedOCILayers int // number of squashfs layers if OCI-SIF
envVars []string
requirements func(t *testing.T)
}
func (c *ctx) imagePull(t *testing.T, tt testStruct) {
if tt.requirements != nil {
tt.requirements(t)
}
// Use a one-time cache directory specific to this pull. This ensures we are always
// testing an entire pull operation, performing the download into an empty cache.
cacheDir, cleanup := e2e.MakeCacheDir(t, "")
t.Cleanup(func() {
if !t.Failed() {
cleanup(t)
}
})
c.env.UnprivCacheDir = cacheDir
// We use a string rather than a slice of strings to avoid having an empty
// element in the slice, which would cause the command to fail, without
// over-complicating the code.
argv := ""
if tt.arch != "" {
argv += "--arch " + tt.arch + " "
}
if tt.platform != "" {
argv += "--platform " + tt.platform + " "
}
if tt.force {
argv += "--force "
}
if tt.unauthenticated {
argv += "--allow-unauthenticated "
}
if tt.pullDir != "" {
argv += "--dir " + tt.pullDir + " "
}
if tt.library != "" {
argv += "--library " + tt.library + " "
}
if tt.oci {
argv += "--oci "
}
if tt.keepLayers {
argv += "--keep-layers "
}
if tt.noHTTPS {
argv += "--no-https "
}
if tt.imagePath != "" {
argv += tt.imagePath + " "
}
if tt.workDir == "" {
wd, err := os.Getwd()
if err != nil {
t.Fatalf("unable to get working directory: %s", err)
}
tt.workDir = wd
}
argv += tt.srcURI
c.env.RunSingularity(
t,
e2e.WithProfile(e2e.UserProfile),
e2e.WithEnv(tt.envVars),
e2e.WithDir(tt.workDir),
e2e.WithCommand("pull"),
e2e.WithArgs(strings.Split(argv, " ")...),
e2e.ExpectExit(tt.expectedExitCode))
checkPullResult(t, tt)
}
func getImageNameFromURI(imgURI string, oci bool) string {
// XXX(mem): this function should be part of the code, not the test
switch transport, ref := uri.Split(imgURI); {
case ref == "":
return "" // Invalid URI
case transport == "":
imgURI = "library://" + imgURI
}
suffix := "sif"
if oci {
suffix = "oci.sif"
}
return uri.Filename(imgURI, suffix)
}
func (c *ctx) setup(t *testing.T) {
e2e.EnsureImage(t, c.env)
e2e.EnsureOCISIF(t, c.env)
e2e.EnsureORASOCISIF(t, c.env)
e2e.EnsureRegistryOCISIF(t, c.env)
orasInvalidFile, err := e2e.WriteTempFile(c.env.TestDir, "oras_invalid_image-", "Invalid Image Contents")
if err != nil {
t.Fatalf("unable to create src file for push tests: %v", err)
}
// prep local registry with oras generated artifacts
// Note: the image name prevents collisions by using a package specific name
// as the registry is shared between different test packages
orasImages := []struct {
srcPath string
uri string
layerMediaType string
}{
{
srcPath: c.env.ImagePath,
uri: fmt.Sprintf("%s/pull_test_sif:latest", c.env.TestRegistry),
layerMediaType: syoras.SifLayerMediaTypeV1,
},
{
srcPath: c.env.ImagePath,
uri: fmt.Sprintf("%s/pull_test_sif_mediatypeproto:latest", c.env.TestRegistry),
layerMediaType: syoras.SifLayerMediaTypeProto,
},
{
srcPath: orasInvalidFile,
uri: fmt.Sprintf("%s/pull_test_invalid_file:latest", c.env.TestRegistry),
layerMediaType: syoras.SifLayerMediaTypeV1,
},
{
srcPath: c.env.OCISIFPath,
uri: fmt.Sprintf("%s/pull_test_oci-sif:latest", c.env.TestRegistry),
layerMediaType: syoras.SifLayerMediaTypeV1,
},
}
for _, i := range orasImages {
err = orasPushNoCheck(i.srcPath, i.uri, i.layerMediaType)
if err != nil {
t.Fatalf("while prepping registry for oras tests: %v", err)
}
}
}
//nolint:maintidx
func (c ctx) testPullCmd(t *testing.T) {
tests := []testStruct{
//
// library:// URIs
// SCS / Singularity Enterprise & compatible.
//
{
desc: "library non-existent",
srcURI: "library://sylabs/tests/does_not_exist:0",
expectedExitCode: 255,
},
// --allow-unauthenticated tests
{
desc: "library allow-unauthenticated",
srcURI: "library://sylabs/tests/unsigned:1.0.0",
unauthenticated: true,
expectedExitCode: 0,
},
// --force tests
{
desc: "library force existing",
srcURI: "library://alpine:3.11.5",
force: true,
createDst: true,
unauthenticated: true,
expectedExitCode: 0,
},
{
desc: "library force non-existing",
srcURI: "library://alpine:3.11.5",
force: true,
createDst: false,
unauthenticated: true,
expectedExitCode: 0,
},
{
// --force should not have an effect on --allow-unauthenticated=false
desc: "library force allow-unauthenticated",
srcURI: "library://sylabs/tests/unsigned:1.0.0",
force: true,
unauthenticated: false,
expectedExitCode: 0,
},
// test version specifications
{
desc: "library hash",
srcURI: "library://alpine:sha256.03883ca565b32e58fa0a496316d69de35741f2ef34b5b4658a6fec04ed8149a8",
arch: "amd64",
unauthenticated: true,
expectedExitCode: 0,
},
{
desc: "library tag",
srcURI: "library://alpine:latest",
unauthenticated: true,
expectedExitCode: 0,
},
// forced arch and platform equivalent
{
desc: "library non-oci arch",
srcURI: "library://alpine:3.11.5",
arch: "ppc64le",
expectedExitCode: 0,
},
{
desc: "library non-oci platform",
srcURI: "library://alpine:3.11.5",
platform: "linux/ppc64le",
expectedExitCode: 0,
},
// --dir tests
{
desc: "library dir",
srcURI: "library://alpine:3.11.5",
unauthenticated: true,
setPullDir: true,
setImagePath: false,
expectedExitCode: 0,
},
{
// XXX(mem): this specific test is passing both --path and an image path to
// singularity pull. The current behavior is that the code is joining both paths and
// failing to find the image in the expected location indicated by image path
// because image path is absolute, so after joining /tmp/a/b/c and
// /tmp/a/b/image.sif, the code expects to find /tmp/a/b/c/tmp/a/b/image.sif. Since
// the directory /tmp/a/b/c/tmp/a/b does not exist, it fails to create the file
// image.sif in there.
desc: "library dir with image path",
srcURI: "library://alpine:3.11.5",
unauthenticated: true,
setPullDir: true,
setImagePath: true,
expectedExitCode: 255,
},
// default transport should be library
{
desc: "library default transport",
srcURI: "alpine:3.11.5",
force: true,
unauthenticated: true,
expectedExitCode: 0,
},
// pulling with library URI argument
{
desc: "library bad library flag",
srcURI: "library://busybox:1.31.1",
library: "https://bad-library.sylabs.io",
expectedExitCode: 255,
},
{
desc: "library default library flag",
srcURI: "library://busybox:1.31.1",
library: "https://library.sylabs.io",
force: true,
expectedExitCode: 0,
},
// pulling with library URI containing host name and library argument
{
desc: "library URI containing host name and library argument",
srcURI: "library://notlibrary.sylabs.io/library/default/busybox:1.31.1",
library: "https://notlibrary.sylabs.io",
expectedExitCode: 255,
},
// pulling with library URI containing host name
{
desc: "library URI containing bad host name",
srcURI: "library://notlibrary.sylabs.io/library/default/busybox:1.31.1",
expectedExitCode: 255,
},
{
desc: "library URI containing host name",
srcURI: "library://library.sylabs.io/library/default/busybox:1.31.1",
force: true,
expectedExitCode: 0,
},
// pulling an OCI-SIF image from library backing registry
{
desc: "library oci-sif fallback",
srcURI: "library://sylabs/tests/alpine-oci-sif:latest",
// will try library protocol first, should then attempt oci pull
oci: false,
expectedOCI: true,
expectedOCILayers: 1,
expectedExitCode: 0,
requirements: func(t *testing.T) {
require.Arch(t, "amd64")
},
},
{
desc: "library oci-sif direct",
srcURI: "library://sylabs/tests/alpine-oci-sif:latest",
// direct oci pull
oci: true,
expectedOCI: true,
expectedOCILayers: 1,
expectedExitCode: 0,
requirements: func(t *testing.T) {
require.Arch(t, "amd64")
},
},
{
desc: "library oci-sif platform",
srcURI: "library://sylabs/tests/alpine-ppc64le-oci-sif:latest",
// direct oci pull
platform: "linux/ppc64le",
oci: true,
expectedOCI: true,
expectedOCILayers: 1,
expectedExitCode: 0,
},
{
desc: "library oci-sif arch",
srcURI: "library://sylabs/tests/alpine-ppc64le-oci-sif:latest",
// direct oci pull
arch: "ppc64le",
oci: true,
expectedOCI: true,
expectedOCILayers: 1,
expectedExitCode: 0,
},
//
// shub:// URIs
// Singularity Hub (retired) and compatible.
//
// TODO(mem): reenable this; disabled while shub is down
// {
// desc: "image from shub",
// srcURI: "shub://GodloveD/busybox",
// force: true,
// unauthenticated: false,
// expectSuccess: true,
// },
//
// oras:// URIs
// SIF file as ORAS / OCI artifact.
//
// Finalized v1 layer mediaType (3.7 and onward)
{
desc: "oras transport for SIF from registry",
srcURI: "oras://" + c.env.TestRegistry + "/pull_test_sif:latest",
force: true,
unauthenticated: false,
expectedExitCode: 0,
},
// Original/prototype layer mediaType (<3.7)
{
desc: "oras transport for SIF from registry (SifLayerMediaTypeProto)",
srcURI: "oras://" + c.env.TestRegistry + "/pull_test_sif_mediatypeproto:latest",
force: true,
unauthenticated: false,
expectedExitCode: 0,
},
// OCI-SIF
{
desc: "oras pull of oci-sif",
srcURI: "oras://" + c.env.TestRegistry + "/pull_test_oci-sif:latest",
force: true,
expectedOCI: true,
expectedOCILayers: 1,
expectedExitCode: 0,
},
// Invalid (non-SIF) artifacts
{
desc: "oras pull of non SIF file",
srcURI: "oras://" + c.env.TestRegistry + "/pull_test_:latest",
force: true,
expectedExitCode: 255,
},
{
desc: "oras pull of packed dir",
srcURI: "oras://" + c.env.TestRegistry + "/pull_test_invalid_file:latest",
force: true,
expectedExitCode: 255,
},
//
// docker:// URIs
// Standard OCI images, and OCI-SIF single layer squashfs images, in an OCI distribution-spec registry.
//
// pulling a standard OCI image from local registry to a native SIF
{
desc: "docker oci to sif",
srcURI: c.env.TestRegistryImage,
oci: false,
expectedOCI: false,
expectedOCILayers: 1,
noHTTPS: true,
force: true,
expectedExitCode: 0,
},
// pulling a standard OCI image from local registry to an OCI-SIF
{
desc: "docker oci to oci-sif",
srcURI: c.env.TestRegistryImage,
oci: true,
expectedOCI: true,
expectedOCILayers: 1,
noHTTPS: true,
force: true,
expectedExitCode: 0,
},
// pulling an OCI-SIF image from local registry to an OCI-SIF
{
desc: "docker oci-sif to oci-sif",
srcURI: c.env.TestRegistryOCISIF,
oci: true,
expectedOCI: true,
expectedOCILayers: 1,
noHTTPS: true,
force: true,
expectedExitCode: 0,
},
// pulling an OCI-SIF image from local registry to a native SIF (not implemented)
{
desc: "docker oci-sif to sif",
srcURI: c.env.TestRegistryOCISIF,
oci: false,
expectedOCI: false,
noHTTPS: true,
force: true,
expectedExitCode: 255,
},
// pulling an OCI-SIF image from local registry to a multi-layer OCI-SIF
{
desc: "docker oci-sif to multi-layer oci-sif",
srcURI: c.env.TestRegistryLayeredImage,
oci: true,
keepLayers: true,
expectedOCI: true,
expectedOCILayers: 8,
noHTTPS: true,
force: true,
expectedExitCode: 0,
},
}
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
tmpdir, err := os.MkdirTemp(c.env.TestDir, "pull_test.")
if err != nil {
t.Fatalf("Failed to create temporary directory for pull test: %+v", err)
}
t.Cleanup(func() {
if !t.Failed() {
os.RemoveAll(tmpdir)
}
})
if tt.setPullDir {
tt.pullDir, err = os.MkdirTemp(tmpdir, "pull_dir.")
if err != nil {
t.Fatalf("Failed to create temporary directory for pull dir: %+v", err)
}
}
if tt.setImagePath {
tt.imagePath = filepath.Join(tmpdir, "image.sif")
tt.expectedImage = tt.imagePath
} else {
// No explicit image path specified. Will use temp dir as working directory,
// so we pull into a clean location.
tt.workDir = tmpdir
imageName := getImageNameFromURI(tt.srcURI, tt.oci)
tt.expectedImage = filepath.Join(tmpdir, imageName)
// if there's a pullDir, that's where we expect to find the image
if tt.pullDir != "" {
tt.expectedImage = filepath.Join(tt.pullDir, imageName)
}
}
// In order to actually test force, there must already be a file present in
// the expected location
if tt.createDst {
fh, err := os.Create(tt.expectedImage)
if err != nil {
t.Fatalf("failed to create file %q: %+v\n", tt.expectedImage, err)
}
fh.Close()
}
c.imagePull(t, tt)
})
}
}
func checkPullResult(t *testing.T, tt testStruct) {
if tt.expectedExitCode != 0 {
return
}
_, err := os.Stat(tt.expectedImage)
switch err {
case nil:
// PASS
case os.ErrNotExist:
// FAIL
t.Errorf("expecting image at %q, not found: %+v\n", tt.expectedImage, err)
default:
// FAIL
t.Errorf("unable to stat image at %q: %+v\n", tt.expectedImage, err)
}
// image.Init does an architecture check... so we can't call it if we are
// pulling a foreign arch image on purpose.
if tt.arch != "" || tt.platform != "" {
return
}
img, err := image.Init(tt.expectedImage, false)
if err != nil {
t.Fatalf("while checking image: %v", err)
}
defer img.File.Close()
switch img.Type {
case image.SIF:
if tt.expectedOCI {
t.Errorf("Native SIF pulled, but --oci specified")
}
case image.OCISIF:
if !tt.expectedOCI {
t.Errorf("OCI-SIF pulled, but --oci not specified")
}
checkOCISIF(t, tt.expectedImage, tt.expectedOCILayers)
default:
t.Errorf("Unexpected image type %d", img.Type)
}
}
func checkOCISIF(t *testing.T, imgFile string, expectLayers int) {
fi, err := sif.LoadContainerFromPath(imgFile, sif.OptLoadWithFlag(os.O_RDONLY))
if err != nil {
t.Fatalf("while loading SIF: %v", err)
}
defer fi.UnloadContainer()
ix, err := ocisif.ImageIndexFromFileImage(fi)
if err != nil {
t.Fatalf("while obtaining image index: %v", err)
}
idxManifest, err := ix.IndexManifest()
if err != nil {
t.Fatalf("while obtaining index manifest: %v", err)
}
if len(idxManifest.Manifests) != 1 {
t.Fatalf("single manifest expected, found %d manifests", len(idxManifest.Manifests))
}
imageDigest := idxManifest.Manifests[0].Digest
img, err := ix.Image(imageDigest)
if err != nil {
t.Fatalf("while initializing image: %v", err)
}
layers, err := img.Layers()
if err != nil {
t.Fatalf("while fetching image layers: %v", err)
}
if len(layers) != expectLayers {
t.Errorf("expected %d layers, found %d", expectLayers, len(layers))
}
for i, l := range layers {
mt, err := l.MediaType()
if err != nil {
t.Fatalf("while examining layer: %v", err)
}
if mt != "application/vnd.sylabs.image.layer.v1.squashfs" {
t.Errorf("layer %d: unsupported layer mediaType %q", i, mt)
}
}
}
// this is a version of the oras push functionality that does not check that given the
// file is a valid SIF, this allows us to push arbitrary objects to the local registry
// to test the pull validation
// We can also set the layer mediaType - so we can push images with older media types
// to verify that they can still be pulled.
func orasPushNoCheck(path, ref, layerMediaType string) error {
ref = strings.TrimPrefix(ref, "oras://")
ref = strings.TrimPrefix(ref, "//")
// Get reference to image in the remote
ir, err := name.ParseReference(ref,
name.WithDefaultTag(name.DefaultTag),
name.WithDefaultRegistry(name.DefaultRegistry),
)
if err != nil {
return err
}
im, err := oras.NewImageFromSIF(path, types.MediaType(layerMediaType))
if err != nil {
return err
}
return remote.Write(ir, im, remote.WithUserAgent("singularity e2e-test"))
}
func (c ctx) testPullDisableCacheCmd(t *testing.T) {
cacheDir, err := os.MkdirTemp("", "e2e-imgcache-")
if err != nil {
t.Fatalf("failed to create temporary directory: %s", err)
}
t.Cleanup(func() {
if !t.Failed() {
err := os.RemoveAll(cacheDir)
if err != nil {
t.Fatalf("failed to delete temporary directory %s: %s", cacheDir, err)
}
}
})
c.env.UnprivCacheDir = cacheDir
disableCacheTests := []struct {
name string
imagePath string
imageSrc string
platform string
oci bool
noHTTPS bool
}{
{
name: "library native",
imagePath: filepath.Join(c.env.TestDir, "nocache-library.sif"),
imageSrc: "library://alpine:latest",
},
{
name: "library oci-sif",
imagePath: filepath.Join(c.env.TestDir, "nocache-library.oci.sif"),
imageSrc: "library://sylabs/tests/alpine-oci-sif:latest",
platform: "linux/amd64",
oci: true,
},
{
name: "oras",
imagePath: filepath.Join(c.env.TestDir, "nocache-oras.sif"),
imageSrc: "oras://" + c.env.TestRegistry + "/pull_test_sif:latest",
},
{
name: "docker oci-sif",
imagePath: filepath.Join(c.env.TestDir, "nocache-docker.oci.sif"),
imageSrc: c.env.TestRegistryImage,
oci: true,
noHTTPS: true,
},
}
for _, tt := range disableCacheTests {
cmdArgs := []string{"--disable-cache"}
if tt.oci {
cmdArgs = append(cmdArgs, "--oci")
}
if tt.noHTTPS {
cmdArgs = append(cmdArgs, "--no-https")
}
if tt.platform != "" {
cmdArgs = append(cmdArgs, "--platform", tt.platform)
}
cmdArgs = append(cmdArgs, tt.imagePath, tt.imageSrc)
c.env.RunSingularity(
t,
e2e.AsSubtest(tt.name),
e2e.WithProfile(e2e.UserProfile),
e2e.WithCommand("pull"),
e2e.WithArgs(cmdArgs...),
e2e.ExpectExit(0),
e2e.PostRun(func(t *testing.T) {
// Cache entry must not have been created
cacheEntryPath := filepath.Join(cacheDir, "cache")
if _, err := os.Stat(cacheEntryPath); !os.IsNotExist(err) {
t.Errorf("cache created while disabled (%s exists)", cacheEntryPath)
}
// We also need to check the image pulled is in the correct place!
// Issue #5628s
_, err := os.Stat(tt.imagePath)
if os.IsNotExist(err) {
t.Errorf("image does not exist at %s", tt.imagePath)
}
}),
)
}
}
// testPullUmask will run some pull tests with different umasks, and
// ensure the output file has the correct permissions.
func (c ctx) testPullUmask(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
http.ServeFile(w, r, c.env.ImagePath)
}))
defer srv.Close()
umask22Image := "0022-umask-pull"
umask77Image := "0077-umask-pull"
umask27Image := "0027-umask-pull"
umaskTests := []struct {
name string
imagePath string
umask int
expectPerm uint32
force bool
}{
{
name: "0022 umask pull",
imagePath: filepath.Join(c.env.TestDir, umask22Image),
umask: 0o022,
expectPerm: 0o755,
},
{
name: "0077 umask pull",
imagePath: filepath.Join(c.env.TestDir, umask77Image),
umask: 0o077,
expectPerm: 0o700,
},
{
name: "0027 umask pull",
imagePath: filepath.Join(c.env.TestDir, umask27Image),
umask: 0o027,
expectPerm: 0o750,
},
// With the force flag, and override the image. The permission will
// reset to 0666 after every test.
{
name: "0022 umask pull override",
imagePath: filepath.Join(c.env.TestDir, umask22Image),
umask: 0o022,
expectPerm: 0o755,
force: true,
},
{
name: "0077 umask pull override",
imagePath: filepath.Join(c.env.TestDir, umask77Image),
umask: 0o077,
expectPerm: 0o700,
force: true,
},
{
name: "0027 umask pull override",
imagePath: filepath.Join(c.env.TestDir, umask27Image),
umask: 0o027,
expectPerm: 0o750,
force: true,
},
}
// Helper function to get the file mode for a file.
getFilePerm := func(t *testing.T, path string) uint32 {
finfo, err := os.Stat(path)
if err != nil {
t.Fatalf("failed while getting file permission: %s", err)
}
return uint32(finfo.Mode().Perm())
}
// Set a common umask, then reset it back later.
oldUmask := unix.Umask(0o022)
defer unix.Umask(oldUmask)
// TODO: should also check the cache umask.
for _, tc := range umaskTests {
var cmdArgs []string
if tc.force {
cmdArgs = append(cmdArgs, "--force")
}
cmdArgs = append(cmdArgs, tc.imagePath, srv.URL)
c.env.RunSingularity(
t,
e2e.WithProfile(e2e.UserProfile),
e2e.PreRun(func(t *testing.T) {
// Reset the file permission after every pull.
err := os.Chmod(tc.imagePath, 0o666)
if !os.IsNotExist(err) && err != nil {
t.Fatalf("failed chmod-ing file: %s", err)
}
// Set the test umask.
unix.Umask(tc.umask)
}),
e2e.PostRun(func(t *testing.T) {
// Check the file permission.
permOut := getFilePerm(t, tc.imagePath)
if tc.expectPerm != permOut {
t.Fatalf("Unexpected failure: expecting file perm: %o, got: %o", tc.expectPerm, permOut)
}
}),
e2e.WithCommand("pull"),
e2e.WithArgs(cmdArgs...),
e2e.ExpectExit(0),
)
}
}
// E2ETests is the main func to trigger the test suite
func E2ETests(env e2e.TestEnv) testhelper.Tests {
c := ctx{
env: env,
}
np := testhelper.NoParallel
return testhelper.Tests{
// Run pull tests sequentially among themselves, as they perform a lot
// of un-cached pulls which could otherwise lead to hitting rate limits.
"ordered": func(t *testing.T) {
// Setup a test registry to pull from (for oras).
c.setup(t)
t.Run("pull", c.testPullCmd)
t.Run("pullDisableCache", c.testPullDisableCacheCmd)
t.Run("concurrencyConfig", c.testConcurrencyConfig)
t.Run("concurrentPulls", c.testConcurrentPulls)
},
"issue1087": c.issue1087,
// Manipulates umask for the process, so must be run alone to avoid
// causing permission issues for other tests.
"pullUmaskCheck": np(c.testPullUmask),
// Regressions
// Manipulates remotes, so must run alone
"issue5808": np(c.issue5808),
}
}