File: create_test.go

package info (click to toggle)
apptainer 1.4.5-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 12,780 kB
  • sloc: sh: 3,329; ansic: 1,706; awk: 414; python: 103; makefile: 54
file content (781 lines) | stat: -rw-r--r-- 23,070 bytes parent folder | download | duplicates (2)
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
// Copyright (c) Contributors to the Apptainer project, established as
//   Apptainer a Series of LF Projects LLC.
//   For website terms of use, trademark policy, privacy policy and other
//   project policies see https://lfprojects.org/policies
// Copyright (c) 2018-2020, 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.

package env

import (
	"bytes"
	"reflect"
	"strings"
	"testing"

	"github.com/opencontainers/runtime-spec/specs-go"

	"github.com/apptainer/apptainer/pkg/sylog"

	"github.com/apptainer/apptainer/internal/pkg/runtime/engine/config/oci"
	"github.com/apptainer/apptainer/internal/pkg/runtime/engine/config/oci/generate"
	"github.com/apptainer/apptainer/internal/pkg/test"
)

//nolint:maintidx
func TestSetContainerEnv(t *testing.T) {
	test.DropPrivilege(t)
	defer test.ResetPrivilege(t)

	tt := []struct {
		name            string
		cleanEnv        bool
		homeDest        string
		env             []string
		processEnv      map[string]string
		resultEnv       []string
		apptainerEnv    map[string]string
		outputNeeded    []string
		outputNotNeeded []string
		disabled        bool
	}{
		{
			name:     "no APPTAINERENV_",
			homeDest: "/home/tester",
			env: []string{
				"LD_LIBRARY_PATH=/.singularity.d/libs",
				"HOME=/home/john",
				"SOME_INVALID_VAR:test",
				"APPTAINERENV_=invalid",
				"PS1=test",
				"TERM=xterm-256color",
				"PATH=/usr/games:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
				"LANG=C",
				"APPTAINER_CONTAINER=/tmp/lolcow.sif",
				"PWD=/tmp",
				"LC_ALL=C",
				"APPTAINER_NAME=lolcow.sif",
			},
			resultEnv: []string{
				"PS1=test",
				"TERM=xterm-256color",
				"LANG=C",
				"PWD=/tmp",
				"LC_ALL=C",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNeeded: []string{
				"Can't process environment variable SOME_INVALID_VAR:test",
				"Not forwarding APPTAINER_CONTAINER environment variable",
				"Not forwarding APPTAINER_NAME environment variable",
			},
		},
		{
			name:     "exclude PATH",
			homeDest: "/home/tester",
			env: []string{
				"LD_LIBRARY_PATH=/.singularity.d/libs",
				"HOME=/home/john",
				"PS1=test",
				"SOCIOPATH=VolanDeMort",
				"TERM=xterm-256color",
				"PATH=/usr/games:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
				"LANG=C",
				"APPTAINERENV_LD_LIBRARY_PATH=/my/custom/libs",
				"APPTAINER_CONTAINER=/tmp/lolcow.sif",
				"PWD=/tmp",
				"LC_ALL=C",
				"APPTAINER_NAME=lolcow.sif",
			},
			resultEnv: []string{
				"PS1=test",
				"SOCIOPATH=VolanDeMort",
				"TERM=xterm-256color",
				"LANG=C",
				"PWD=/tmp",
				"LC_ALL=C",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"LD_LIBRARY_PATH": "/my/custom/libs",
			},
			outputNeeded: []string{
				"Not forwarding APPTAINER_CONTAINER environment variable",
				"Not forwarding APPTAINER_NAME environment variable",
			},
		},
		{
			name:     "special PATH envs",
			homeDest: "/home/tester",
			env: []string{
				"LD_LIBRARY_PATH=/.singularity.d/libs",
				"HOME=/home/john",
				"APPTAINERENV_APPEND_PATH=/sylabs/container",
				"PS1=test",
				"TERM=xterm-256color",
				"APPTAINERENV_PATH=/my/path",
				"PATH=/usr/games:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
				"LANG=C",
				"APPTAINER_CONTAINER=/tmp/lolcow.sif",
				"PWD=/tmp",
				"LC_ALL=C",
				"APPTAINERENV_PREPEND_PATH=/foo/bar",
				"APPTAINER_NAME=lolcow.sif",
			},
			resultEnv: []string{
				"PS1=test",
				"TERM=xterm-256color",
				"LANG=C",
				"PWD=/tmp",
				"LC_ALL=C",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"SING_USER_DEFINED_PREPEND_PATH": "/foo/bar",
				"SING_USER_DEFINED_PATH":         "/my/path",
				"SING_USER_DEFINED_APPEND_PATH":  "/sylabs/container",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_APPEND_PATH as SING_USER_DEFINED_APPEND_PATH environment variable",
				"Forwarding APPTAINERENV_PATH as SING_USER_DEFINED_PATH environment variable",
				"APPTAINERENV_PREPEND_PATH as SING_USER_DEFINED_PREPEND_PATH environment variable",
				"Not forwarding APPTAINER_CONTAINER environment variable",
				"Not forwarding APPTAINER_NAME environment variable",
			},
		},
		{
			name:     "clean envs",
			cleanEnv: true,
			homeDest: "/home/tester",
			env: []string{
				"LD_LIBRARY_PATH=/.singularity.d/libs",
				"HOME=/home/john",
				"PS1=test",
				"TERM=xterm-256color",
				"PATH=/usr/games:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
				"LANG=C",
				"APPTAINER_CONTAINER=/tmp/lolcow.sif",
				"PWD=/tmp",
				"LC_ALL=C",
				"APPTAINER_NAME=lolcow.sif",
				"APPTAINERENV_FOO=VAR",
				"CLEANENV=TRUE",
			},
			resultEnv: []string{
				"LANG=C",
				"TERM=xterm-256color",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"FOO": "VAR",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_FOO as FOO environment variable",
				"Not forwarding APPTAINER_CONTAINER environment variable",
				"Not forwarding APPTAINER_NAME environment variable",
			},
		},
		{
			name:     "always pass keys",
			cleanEnv: true,
			homeDest: "/home/tester",
			env: []string{
				"LD_LIBRARY_PATH=/.singularity.d/libs",
				"HOME=/home/john",
				"PS1=test",
				"TERM=xterm-256color",
				"PATH=/usr/games:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
				"LANG=C",
				"APPTAINER_CONTAINER=/tmp/lolcow.sif",
				"PWD=/tmp",
				"LC_ALL=C",
				"http_proxy=http_proxy",
				"https_proxy=https_proxy",
				"no_proxy=no_proxy",
				"all_proxy=all_proxy",
				"ftp_proxy=ftp_proxy",
				"HTTP_PROXY=http_proxy",
				"HTTPS_PROXY=https_proxy",
				"NO_PROXY=no_proxy",
				"ALL_PROXY=all_proxy",
				"FTP_PROXY=ftp_proxy",
				"APPTAINER_NAME=lolcow.sif",
				"APPTAINERENV_FOO=VAR",
				"CLEANENV=TRUE",
			},
			resultEnv: []string{
				"LANG=C",
				"TERM=xterm-256color",
				"http_proxy=http_proxy",
				"https_proxy=https_proxy",
				"no_proxy=no_proxy",
				"all_proxy=all_proxy",
				"ftp_proxy=ftp_proxy",
				"HTTP_PROXY=http_proxy",
				"HTTPS_PROXY=https_proxy",
				"NO_PROXY=no_proxy",
				"ALL_PROXY=all_proxy",
				"FTP_PROXY=ftp_proxy",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"FOO": "VAR",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_FOO as FOO environment variable",
				"Not forwarding APPTAINER_CONTAINER environment variable",
				"Not forwarding APPTAINER_NAME environment variable",
				"Forwarding TERM environment variable",
				"Forwarding http_proxy environment variable",
				"Forwarding https_proxy environment variable",
				"Forwarding no_proxy environment variable",
				"Forwarding all_proxy environment variable",
				"Forwarding ftp_proxy environment variable",
				"Forwarding HTTP_PROXY environment variable",
				"Forwarding HTTPS_PROXY environment variable",
				"Forwarding NO_PROXY environment variable",
				"Forwarding ALL_PROXY environment variable",
				"Forwarding FTP_PROXY environment variable",
				"Forwarding TERM environment variable",
			},
		},
		{
			name:     "APPTAINERENV_PATH",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_PATH=/my/path",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"SING_USER_DEFINED_PATH": "/my/path",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_PATH as SING_USER_DEFINED_PATH environment variable",
			},
		},
		{
			name:     "APPTAINERENV_LANG with cleanenv",
			cleanEnv: true,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_LANG=en",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"LANG": "en",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_LANG as LANG environment variable",
			},
		},
		{
			name:     "APPTAINERENV_HOME",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_HOME=/my/home",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{},
			outputNeeded: []string{
				"Overriding HOME environment variable with APPTAINERENV_HOME is not permitted",
			},
		},
		{
			name:     "APPTAINERENV_LD_LIBRARY_PATH",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_LD_LIBRARY_PATH=/my/libs",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"LD_LIBRARY_PATH": "/my/libs",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_LD_LIBRARY_PATH as LD_LIBRARY_PATH environment variable",
			},
		},
		{
			name:     "APPTAINERENV_LD_LIBRARY_PATH with cleanenv",
			cleanEnv: true,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_LD_LIBRARY_PATH=/my/libs",
			},
			resultEnv: []string{
				"LANG=C",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"LD_LIBRARY_PATH": "/my/libs",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_LD_LIBRARY_PATH as LD_LIBRARY_PATH environment variable",
			},
		},
		{
			name:     "APPTAINERENV_HOST after HOST",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"HOST=myhost",
				"APPTAINERENV_HOST=myhostenv",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"HOST": "myhostenv",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_HOST as HOST environment variable",
				"Environment variable HOST already has value [myhostenv], will not forward new value [myhost] from parent process environment",
			},
		},
		{
			name:     "APPTAINERENV_HOST before HOST",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_HOST=myhostenv",
				"HOST=myhost",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"HOST": "myhostenv",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_HOST as HOST environment variable",
				"Environment variable HOST already has value [myhostenv], will not forward new value [myhost] from parent process environment",
			},
		},
		// test permutations of named environment variable with
		// differing and no prefix -- confirm precedence

		{
			name:     "ENV precedence - first - with conflicts - different values",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_PRECEDENCE=first",
				"SINGULARITYENV_PRECEDENCE=second",
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=fifth",
			},
			processEnv: map[string]string{
				"PRECEDENCE": "third",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"PRECEDENCE": "first",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_PRECEDENCE as PRECEDENCE environment variable",
				"Skipping environment variable [SINGULARITYENV_PRECEDENCE=second], PRECEDENCE is already overridden with different value [first]",
				"Environment variable PRECEDENCE already has value [first], will not forward new value [fifth] from parent process environment",
			},
		},
		{
			name:     "ENV precedence - second - with conflicts - different values",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"SINGULARITYENV_PRECEDENCE=second",
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=fifth",
			},
			processEnv: map[string]string{
				"PRECEDENCE": "third",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"PRECEDENCE": "second",
			},
			outputNeeded: []string{
				"Environment variable SINGULARITYENV_PRECEDENCE is set, but APPTAINERENV_PRECEDENCE is preferred",
				"Forwarding SINGULARITYENV_PRECEDENCE as PRECEDENCE environment variable",
				"Environment variable PRECEDENCE already has value [second], will not forward new value [fifth] from parent process environment",
			},
		},
		{
			disabled: true,
			name:     "ENV precedence - third - with conflicts - different values",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=fifth",
			},
			processEnv: map[string]string{
				"PRECEDENCE": "third",
			},
			resultEnv: []string{
				"PRECEDENCE=third",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNeeded: []string{},
		},
		{
			name:     "ENV precedence - fourth - with conflicts - different values",
			cleanEnv: true,
			homeDest: "/home/tester",
			env: []string{
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=fifth",
			},
			resultEnv: []string{
				"LANG=C",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{},
			outputNeeded: []string{},
		},
		{
			name:     "ENV precedence - first - with conflicts - same values",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_PRECEDENCE=precedence",
				"SINGULARITYENV_PRECEDENCE=precedence",
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=precedence",
			},
			processEnv: map[string]string{
				"PRECEDENCE": "precedence",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"PRECEDENCE": "precedence",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_PRECEDENCE as PRECEDENCE environment variable",
				"Skipping environment variable [SINGULARITYENV_PRECEDENCE=precedence], PRECEDENCE is already overridden with the same value",
				"Environment variable PRECEDENCE already has duplicate value [precedence], will not forward from parent process environment",
			},
		},
		{
			name:     "ENV precedence - second - with conflicts - same values",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"SINGULARITYENV_PRECEDENCE=precedence",
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=precedence",
			},
			processEnv: map[string]string{
				"PRECEDENCE": "precedence",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"PRECEDENCE": "precedence",
			},
			outputNeeded: []string{
				"Environment variable SINGULARITYENV_PRECEDENCE is set, but APPTAINERENV_PRECEDENCE is preferred",
				"Forwarding SINGULARITYENV_PRECEDENCE as PRECEDENCE environment variable",
				"Environment variable PRECEDENCE already has duplicate value [precedence], will not forward from parent process environment",
			},
		},
		{
			name:     "ENV precedence - third - with conflicts - same values",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=precedence",
			},
			processEnv: map[string]string{
				"PRECEDENCE": "precedence",
			},
			resultEnv: []string{
				"PRECEDENCE=precedence",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNeeded: []string{
				"Forwarding PRECEDENCE environment variable",
			},
		},
		{
			name:     "ENV precedence - fourth - with conflicts - same values",
			cleanEnv: true,
			homeDest: "/home/tester",
			env: []string{
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=precedence",
			},
			resultEnv: []string{
				"LANG=C",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{},
			outputNeeded: []string{},
		},
		{
			name:     "ENV precedence - first - with no conflicts",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_PRECEDENCE=first",
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"PRECEDENCE": "first",
			},
			outputNeeded: []string{
				"Forwarding APPTAINERENV_PRECEDENCE as PRECEDENCE environment variable",
			},
		},
		{
			name:     "ENV precedence - second - with no conflicts",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"SINGULARITYENV_PRECEDENCE=second",
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{
				"PRECEDENCE": "second",
			},
			outputNeeded: []string{
				"Environment variable SINGULARITYENV_PRECEDENCE is set, but APPTAINERENV_PRECEDENCE is preferred",
				"Forwarding SINGULARITYENV_PRECEDENCE as PRECEDENCE environment variable",
			},
		},
		{
			name:     "ENV precedence - third - with no conflicts",
			cleanEnv: false,
			homeDest: "/home/tester",
			env:      []string{
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
			},
			processEnv: map[string]string{
				"PRECEDENCE": "third",
			},
			resultEnv: []string{
				"PRECEDENCE=third",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{},
			outputNeeded: []string{},
		},
		{
			name:     "ENV precedence - fourth - with no conflicts",
			cleanEnv: true,
			homeDest: "/home/tester",
			env:      []string{
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
			},
			resultEnv: []string{
				"LANG=C",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			apptainerEnv: map[string]string{},
			outputNeeded: []string{},
		},
		{
			name:     "ENV precedence - fifth/last - with no conflicts",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				// third precedence is environment variables initialized via --env, or --env-file
				// fourth precedence is result of "clean env" flag option
				"PRECEDENCE=fifth",
			},
			resultEnv: []string{
				"PRECEDENCE=fifth",
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNeeded: []string{
				"Forwarding PRECEDENCE environment variable",
			},
		},
		{
			name:     "suppress the info message when both legacy and new env coexist",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"SINGULARITYENV_PS1=true",
				"APPTAINERENV_PS1=true",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNotNeeded: []string{
				"Environment variable SINGULARITYENV_PS1 is set, but APPTAINERENV_PS1 is preferred",
			},
		},
		{
			name:     "should print info message if only legacy env exists",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"SINGULARITYENV_PS1=true",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNeeded: []string{
				"Environment variable SINGULARITYENV_PS1 is set, but APPTAINERENV_PS1 is preferred",
			},
		},
		{
			name:     "should not print info message if only new env exists",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"APPTAINERENV_PS1=true",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNotNeeded: []string{
				"Environment variable SINGULARITYENV_PS1 is set, but APPTAINERENV_PS1 is preferred",
			},
		},
		{
			name:     "should print warning message if legacy and new env vars have different values",
			cleanEnv: false,
			homeDest: "/home/tester",
			env: []string{
				"SINGULARITYENV_PS1=true",
				"APPTAINERENV_PS1=false",
			},
			resultEnv: []string{
				"HOME=/home/tester",
				"PATH=" + DefaultPath,
			},
			outputNeeded: []string{
				"SINGULARITYENV_PS1 and APPTAINERENV_PS1 have different values, using the latter",
			},
			outputNotNeeded: []string{
				"Environment variable SINGULARITYENV_PS1 is set, but APPTAINERENV_PS1 is preferred",
			},
		},
	}
	for _, tc := range tt {
		if tc.disabled {
			continue
		}
		t.Run(tc.name, func(t *testing.T) {
			ociConfig := &oci.Config{}
			generator := generate.New(&ociConfig.Spec)
			if nil != tc.processEnv {
				// add vars for --env or --env-file
				generator.Config.Process = &specs.Process{}
				for k, v := range tc.processEnv {
					generator.SetProcessEnv(k, v)
				}
			}
			output := bytes.Buffer{}
			var senv map[string]string
			func() {
				oldWriter := sylog.SetWriter(&output)
				oldLevel := sylog.GetLevel()
				sylog.SetLevel(int(sylog.DebugLevel), true)
				defer func() {
					oldWriter.Write(output.Bytes())
					sylog.SetWriter(oldWriter)
					sylog.SetLevel(oldLevel, true)
				}()
				senv = SetContainerEnv(generator, tc.env, tc.cleanEnv, tc.homeDest)
			}()
			for _, requiredOutput := range tc.outputNeeded {
				if !strings.Contains(output.String(), requiredOutput) {
					t.Errorf("Did not find required output: [%s]", requiredOutput)
				}
			}
			for _, notNeededOutput := range tc.outputNotNeeded {
				if strings.Contains(output.String(), notNeededOutput) {
					t.Errorf("[%s] should not exist in the output", notNeededOutput)
				}
			}
			if !equal(t, ociConfig.Process.Env, tc.resultEnv) {
				t.Fatalf("unexpected envs:\n want: %v\ngot: %v", tc.resultEnv, ociConfig.Process.Env)
			}
			if tc.apptainerEnv != nil && !reflect.DeepEqual(senv, tc.apptainerEnv) {
				t.Fatalf("unexpected apptainer env:\n want: %v\ngot: %v", tc.apptainerEnv, senv)
			}
		})
	}
}

// equal tells whether a and b contain the same elements in the
// same order. A nil argument is equivalent to an empty slice.
func equal(_ *testing.T, a, b []string) bool {
	if len(a) != len(b) {
		return false
	}
	for i, v := range a {
		if c := strings.Compare(v, b[i]); c != 0 {
			return false
		}
	}
	return true
}