-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathbuild_test.go
More file actions
394 lines (355 loc) · 9.76 KB
/
build_test.go
File metadata and controls
394 lines (355 loc) · 9.76 KB
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
package cmd
import (
"os"
"testing"
"github.com/spf13/cobra"
)
func TestBuildCommandFlags(t *testing.T) {
tests := []struct {
name string
args []string
wantFlag string
wantVal interface{}
}{
{
name: "in-flight-checksums flag default",
args: []string{},
wantFlag: "in-flight-checksums",
wantVal: false,
},
{
name: "in-flight-checksums flag enabled",
args: []string{"--in-flight-checksums"},
wantFlag: "in-flight-checksums",
wantVal: true,
},
{
name: "in-flight-checksums flag explicitly disabled",
args: []string{"--in-flight-checksums=false"},
wantFlag: "in-flight-checksums",
wantVal: false,
},
{
name: "slsa-require-attestation flag default",
args: []string{},
wantFlag: "slsa-require-attestation",
wantVal: false,
},
{
name: "slsa-require-attestation flag enabled",
args: []string{"--slsa-require-attestation"},
wantFlag: "slsa-require-attestation",
wantVal: true,
},
{
name: "slsa-require-attestation flag explicitly disabled",
args: []string{"--slsa-require-attestation=false"},
wantFlag: "slsa-require-attestation",
wantVal: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Create a new build command for each test
cmd := &cobra.Command{
Use: "build",
Run: func(cmd *cobra.Command, args []string) {
// No-op for testing
},
}
// Add the build flags
addBuildFlags(cmd)
// Set the args and parse
cmd.SetArgs(tt.args)
err := cmd.Execute()
if err != nil {
t.Fatalf("failed to execute command: %v", err)
}
// Check if the flag exists
flag := cmd.Flags().Lookup(tt.wantFlag)
if flag == nil {
t.Fatalf("flag %s not found", tt.wantFlag)
}
// Get the flag value
val, err := cmd.Flags().GetBool(tt.wantFlag)
if err != nil {
t.Fatalf("failed to get flag value: %v", err)
}
if val != tt.wantVal {
t.Errorf("expected flag %s to be %v, got %v", tt.wantFlag, tt.wantVal, val)
}
})
}
}
func TestInFlightChecksumsEnvironmentVariable(t *testing.T) {
tests := []struct {
name string
envValue string
flagValue string
flagSet bool
expected bool
}{
{
name: "env var enabled, no flag",
envValue: "true",
expected: true,
},
{
name: "env var disabled, no flag",
envValue: "false",
expected: false,
},
{
name: "no env var, no flag",
envValue: "",
expected: false,
},
{
name: "env var enabled, flag explicitly disabled",
envValue: "true",
flagValue: "false",
flagSet: true,
expected: false, // Flag should override
},
{
name: "env var disabled, flag explicitly enabled",
envValue: "false",
flagValue: "true",
flagSet: true,
expected: true, // Flag should override
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Set environment variable using t.Setenv for proper cleanup
if tt.envValue != "" {
t.Setenv(EnvvarEnableInFlightChecksums, tt.envValue)
}
// Create test command
cmd := &cobra.Command{
Use: "build",
Run: func(cmd *cobra.Command, args []string) {},
}
addBuildFlags(cmd)
// Set flag if specified
if tt.flagSet {
err := cmd.Flags().Set("in-flight-checksums", tt.flagValue)
if err != nil {
t.Fatalf("failed to set flag: %v", err)
}
}
// Test the actual logic from getBuildOpts
inFlightChecksumsDefault := os.Getenv(EnvvarEnableInFlightChecksums) == "true"
inFlightChecksums, err := cmd.Flags().GetBool("in-flight-checksums")
if err != nil {
t.Fatalf("failed to get flag: %v", err)
}
// If flag wasn't explicitly set, use environment variable
if !cmd.Flags().Changed("in-flight-checksums") {
inFlightChecksums = inFlightChecksumsDefault
}
if inFlightChecksums != tt.expected {
t.Errorf("expected in-flight checksums to be %v, got %v", tt.expected, inFlightChecksums)
}
})
}
}
func TestBuildCommandHelpText(t *testing.T) {
cmd := &cobra.Command{
Use: "build",
Run: func(cmd *cobra.Command, args []string) {
// No-op for testing
},
}
addBuildFlags(cmd)
// Check that the in-flight-checksums flag is documented
flag := cmd.Flags().Lookup("in-flight-checksums")
if flag == nil {
t.Fatal("in-flight-checksums flag not found")
}
expectedUsage := "Enable checksumming of cache artifacts to prevent TOCTU attacks"
if flag.Usage != expectedUsage {
t.Errorf("expected flag usage to be %q, got %q", expectedUsage, flag.Usage)
}
// Verify it's a boolean flag
if flag.Value.Type() != "bool" {
t.Errorf("expected flag type to be bool, got %s", flag.Value.Type())
}
// Verify default value
if flag.DefValue != "false" {
t.Errorf("expected default value to be false, got %s", flag.DefValue)
}
}
func TestGetBuildOptsWithInFlightChecksums(t *testing.T) {
tests := []struct {
name string
inFlightChecksumsFlag bool
expectInFlightChecksums bool
}{
{
name: "in-flight checksums disabled",
inFlightChecksumsFlag: false,
expectInFlightChecksums: false,
},
{
name: "in-flight checksums enabled",
inFlightChecksumsFlag: true,
expectInFlightChecksums: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cmd := &cobra.Command{
Use: "build",
Run: func(cmd *cobra.Command, args []string) {
// No-op for testing
},
}
addBuildFlags(cmd)
// Set the flag value
err := cmd.Flags().Set("in-flight-checksums", "false")
if tt.inFlightChecksumsFlag {
err = cmd.Flags().Set("in-flight-checksums", "true")
}
if err != nil {
t.Fatalf("failed to set flag: %v", err)
}
// Test getBuildOpts function
opts, localCache := getBuildOpts(cmd)
// We can't directly test the WithInFlightChecksums option since it's internal,
// but we can verify the function doesn't error and returns options
if opts == nil {
t.Error("expected build options but got nil")
}
if localCache == nil {
t.Error("expected local cache but got nil")
}
// The actual verification of the in-flight checksums option would need
// to be done through integration tests or by exposing the option state
})
}
}
func TestParseSLSAConfig(t *testing.T) {
tests := []struct {
name string
envVerification string
envSourceURI string
envRequireAttestation string
flagVerification *bool
flagSourceURI *string
flagRequireAttestation *bool
wantConfig bool
wantRequireAttestation bool
wantError bool
}{
{
name: "verification disabled",
wantConfig: false,
},
{
name: "verification enabled via env, no source URI",
envVerification: "true",
wantError: true,
},
{
name: "verification enabled via env with source URI",
envVerification: "true",
envSourceURI: "https://github.com/gitpod-io/leeway",
wantConfig: true,
},
{
name: "require attestation via env",
envVerification: "true",
envSourceURI: "https://github.com/gitpod-io/leeway",
envRequireAttestation: "true",
wantConfig: true,
wantRequireAttestation: true,
},
{
name: "require attestation via flag overrides env",
envVerification: "true",
envSourceURI: "https://github.com/gitpod-io/leeway",
envRequireAttestation: "false",
flagRequireAttestation: boolPtr(true),
wantConfig: true,
wantRequireAttestation: true,
},
{
name: "flag disables require attestation",
envVerification: "true",
envSourceURI: "https://github.com/gitpod-io/leeway",
envRequireAttestation: "true",
flagRequireAttestation: boolPtr(false),
wantConfig: true,
wantRequireAttestation: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Set environment variables
if tt.envVerification != "" {
t.Setenv(EnvvarSLSACacheVerification, tt.envVerification)
}
if tt.envSourceURI != "" {
t.Setenv(EnvvarSLSASourceURI, tt.envSourceURI)
}
if tt.envRequireAttestation != "" {
t.Setenv(EnvvarSLSARequireAttestation, tt.envRequireAttestation)
}
// Create test command
cmd := &cobra.Command{
Use: "build",
Run: func(cmd *cobra.Command, args []string) {},
}
addBuildFlags(cmd)
// Set flags if specified
if tt.flagVerification != nil {
if err := cmd.Flags().Set("slsa-cache-verification", boolToString(*tt.flagVerification)); err != nil {
t.Fatalf("failed to set verification flag: %v", err)
}
}
if tt.flagSourceURI != nil {
if err := cmd.Flags().Set("slsa-source-uri", *tt.flagSourceURI); err != nil {
t.Fatalf("failed to set source URI flag: %v", err)
}
}
if tt.flagRequireAttestation != nil {
if err := cmd.Flags().Set("slsa-require-attestation", boolToString(*tt.flagRequireAttestation)); err != nil {
t.Fatalf("failed to set require attestation flag: %v", err)
}
}
// Test parseSLSAConfig
config, err := parseSLSAConfig(cmd)
if tt.wantError {
if err == nil {
t.Error("expected error but got none")
}
return
}
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if tt.wantConfig {
if config == nil {
t.Fatal("expected config but got nil")
}
if config.RequireAttestation != tt.wantRequireAttestation {
t.Errorf("expected RequireAttestation=%v, got %v", tt.wantRequireAttestation, config.RequireAttestation)
}
} else {
if config != nil {
t.Errorf("expected nil config but got %+v", config)
}
}
})
}
}
func boolPtr(b bool) *bool {
return &b
}
func boolToString(b bool) string {
if b {
return "true"
}
return "false"
}