-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathmain.go
More file actions
574 lines (512 loc) · 24.9 KB
/
main.go
File metadata and controls
574 lines (512 loc) · 24.9 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
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
package main
import (
"flag"
"fmt"
"log/slog"
"os"
"path/filepath"
"strings"
"github.com/richardartoul/gobuildcache/pkg/backends"
"github.com/richardartoul/gobuildcache/pkg/locking"
)
// Global flags
var (
debug bool
printStats bool
backendType string
lockingType string
lockDir string
cacheDir string
s3Bucket string
s3Prefix string
gcsBucket string
gcsPrefix string
errorRate float64
compression bool
asyncBackend bool
readOnly bool
)
func main() {
// Check if we have a subcommand
if len(os.Args) > 1 && !strings.HasPrefix(os.Args[1], "-") {
subcommand := os.Args[1]
switch subcommand {
case "clear":
runClearCommand()
return
case "clear-local":
runClearLocalCommand()
return
case "clear-remote":
runClearRemoteCommand()
return
case "help", "-h", "--help":
printHelp()
return
default:
fmt.Fprintf(os.Stderr, "Unknown subcommand: %s\n\n", subcommand)
printHelp()
os.Exit(1)
}
}
// No subcommand or starts with -, run the server
runServerCommand()
}
func runServerCommand() {
// Get defaults from environment variables.
// All variables support both GOBUILDCACHE_<KEY> and <KEY> forms, with prefixed taking precedence.
var (
serverFlags = flag.NewFlagSet("server", flag.ExitOnError)
debugDefault = getEnvBoolWithPrefix("DEBUG", false)
printStatsDefault = getEnvBoolWithPrefix("PRINT_STATS", true)
backendDefault = getEnvWithPrefix("BACKEND_TYPE", getEnv("BACKEND", "disk"))
lockTypeDefault = getEnvWithPrefix("LOCK_TYPE", "fslock")
lockDirDefault = getEnvWithPrefix("LOCK_DIR", filepath.Join(os.TempDir(), "gobuildcache", "locks"))
cacheDirDefault = getEnvWithPrefix("CACHE_DIR", filepath.Join(os.TempDir(), "gobuildcache", "cache"))
s3BucketDefault = getEnvWithPrefix("S3_BUCKET", "")
s3PrefixDefault = getEnvWithPrefix("S3_PREFIX", "gobuildcache/")
gcsBucketDefault = getEnvWithPrefix("GCS_BUCKET", "")
gcsPrefixDefault = getEnvWithPrefix("GCS_PREFIX", "gobuildcache/")
errorRateDefault = getEnvFloatWithPrefix("ERROR_RATE", 0.0)
compressionDefault = getEnvBoolWithPrefix("COMPRESSION", true)
asyncBackendDefault = getEnvBoolWithPrefix("ASYNC_BACKEND", true)
readOnlyDefault = getEnvBoolWithPrefix("READ_ONLY", false)
)
serverFlags.BoolVar(&debug, "debug", debugDefault, "Enable debug logging to stderr (env: DEBUG)")
serverFlags.BoolVar(&printStats, "stats", printStatsDefault, "Print cache statistics on exit (env: PRINT_STATS)")
serverFlags.StringVar(&backendType, "backend", backendDefault, "Backend type: disk (local only), s3, gcs (env: BACKEND_TYPE)")
serverFlags.StringVar(&lockingType, "lock-type", lockTypeDefault, "Locking type: memory (in-memory), fslock (filesystem) (env: LOCK_TYPE)")
serverFlags.StringVar(&lockDir, "lock-dir", lockDirDefault, "Lock directory for fslock (env: LOCK_DIR)")
serverFlags.StringVar(&cacheDir, "cache-dir", cacheDirDefault, "Local cache directory (env: CACHE_DIR)")
serverFlags.StringVar(&s3Bucket, "s3-bucket", s3BucketDefault, "S3 bucket name (required for s3 backend) (env: S3_BUCKET)")
serverFlags.StringVar(&s3Prefix, "s3-prefix", s3PrefixDefault, "S3 key prefix (optional) (env: S3_PREFIX)")
serverFlags.StringVar(&gcsBucket, "gcs-bucket", gcsBucketDefault, "GCS bucket name (required for gcs backend) (env: GCS_BUCKET)")
serverFlags.StringVar(&gcsPrefix, "gcs-prefix", gcsPrefixDefault, "GCS object prefix (optional) (env: GCS_PREFIX)")
serverFlags.Float64Var(&errorRate, "error-rate", errorRateDefault, "Error injection rate (0.0-1.0) for testing error handling (env: ERROR_RATE)")
serverFlags.BoolVar(&compression, "compression", compressionDefault, "Enable LZ4 compression for backend storage (env: COMPRESSION)")
serverFlags.BoolVar(&asyncBackend, "async-backend", asyncBackendDefault, "Enable async backend writer for non-blocking PUT operations (env: ASYNC_BACKEND)")
serverFlags.BoolVar(&readOnly, "read-only", readOnlyDefault, "Read-only mode: allow cache reads but skip writes (env: READ_ONLY)")
serverFlags.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage: %s [flags]\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, "Run the Go build cache server.\n\n")
fmt.Fprintf(os.Stderr, "Flags (can also be set via environment variables):\n")
serverFlags.PrintDefaults()
fmt.Fprintf(os.Stderr, "\nEnvironment Variables:\n")
fmt.Fprintf(os.Stderr, " All variables support both GOBUILDCACHE_<KEY> and <KEY> forms.\n")
fmt.Fprintf(os.Stderr, " The prefixed version takes precedence if both are set.\n\n")
fmt.Fprintf(os.Stderr, " DEBUG Enable debug logging (true/false)\n")
fmt.Fprintf(os.Stderr, " PRINT_STATS Print cache statistics on exit (true/false)\n")
fmt.Fprintf(os.Stderr, " BACKEND_TYPE Backend type (disk, s3, gcs)\n")
fmt.Fprintf(os.Stderr, " LOCK_TYPE Deduplication type (memory, fslock)\n")
fmt.Fprintf(os.Stderr, " LOCK_DIR Lock directory for fslock\n")
fmt.Fprintf(os.Stderr, " CACHE_DIR Local cache directory\n")
fmt.Fprintf(os.Stderr, " S3_BUCKET S3 bucket name\n")
fmt.Fprintf(os.Stderr, " S3_PREFIX S3 key prefix\n")
fmt.Fprintf(os.Stderr, " GCS_BUCKET GCS bucket name\n")
fmt.Fprintf(os.Stderr, " GCS_PREFIX GCS object prefix\n")
fmt.Fprintf(os.Stderr, " COMPRESSION Enable LZ4 compression (true/false)\n")
fmt.Fprintf(os.Stderr, " ASYNC_BACKEND Enable async backend writer (true/false)\n")
fmt.Fprintf(os.Stderr, " READ_ONLY Read-only mode: allow reads, skip writes (true/false)\n")
fmt.Fprintf(os.Stderr, "\nNote: Command-line flags take precedence over environment variables.\n")
fmt.Fprintf(os.Stderr, "\nExamples:\n")
fmt.Fprintf(os.Stderr, " # Run with disk backend using flags:\n")
fmt.Fprintf(os.Stderr, " %s -cache-dir=/var/cache/go\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Run with S3 backend using flags:\n")
fmt.Fprintf(os.Stderr, " %s -backend=s3 -s3-bucket=my-cache-bucket\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Run with GCS backend using flags:\n")
fmt.Fprintf(os.Stderr, " %s -backend=gcs -gcs-bucket=my-cache-bucket\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Run with environment variables (prefixed form):\n")
fmt.Fprintf(os.Stderr, " GOBUILDCACHE_BACKEND_TYPE=s3 GOBUILDCACHE_S3_BUCKET=my-cache-bucket %s\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Run with environment variables (unprefixed form, also supported):\n")
fmt.Fprintf(os.Stderr, " BACKEND_TYPE=s3 S3_BUCKET=my-cache-bucket %s\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " BACKEND_TYPE=gcs GCS_BUCKET=my-cache-bucket %s\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Mix environment variables and flags (flags override env):\n")
fmt.Fprintf(os.Stderr, " GOBUILDCACHE_BACKEND_TYPE=s3 %s -s3-bucket=my-cache-bucket -debug\n", os.Args[0])
}
serverFlags.Parse(os.Args[1:])
runServer()
}
func runClearCommand() {
// Get defaults from environment variables.
// All variables support both GOBUILDCACHE_<KEY> and <KEY> forms, with prefixed taking precedence.
var (
clearFlags = flag.NewFlagSet("clear", flag.ExitOnError)
debugDefault = getEnvBoolWithPrefix("DEBUG", false)
backendDefault = getEnvWithPrefix("BACKEND_TYPE", getEnv("BACKEND", "disk"))
cacheDirDefault = getEnvWithPrefix("CACHE_DIR", filepath.Join(os.TempDir(), "gobuildcache", "cache"))
s3BucketDefault = getEnvWithPrefix("S3_BUCKET", "")
s3PrefixDefault = getEnvWithPrefix("S3_PREFIX", "")
gcsBucketDefault = getEnvWithPrefix("GCS_BUCKET", "")
gcsPrefixDefault = getEnvWithPrefix("GCS_PREFIX", "")
)
clearFlags.BoolVar(&debug, "debug", debugDefault, "Enable debug logging to stderr (env: DEBUG)")
clearFlags.StringVar(&backendType, "backend", backendDefault, "Backend type: disk (local only), s3, gcs (env: BACKEND_TYPE)")
clearFlags.StringVar(&cacheDir, "cache-dir", cacheDirDefault, "Local cache directory (env: CACHE_DIR)")
clearFlags.StringVar(&s3Bucket, "s3-bucket", s3BucketDefault, "S3 bucket name (required for s3 backend) (env: S3_BUCKET)")
clearFlags.StringVar(&s3Prefix, "s3-prefix", s3PrefixDefault, "S3 key prefix (optional) (env: S3_PREFIX)")
clearFlags.StringVar(&gcsBucket, "gcs-bucket", gcsBucketDefault, "GCS bucket name (required for gcs backend) (env: GCS_BUCKET)")
clearFlags.StringVar(&gcsPrefix, "gcs-prefix", gcsPrefixDefault, "GCS object prefix (optional) (env: GCS_PREFIX)")
clearFlags.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage: %s clear [flags]\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, "Clear all entries from the cache.\n\n")
fmt.Fprintf(os.Stderr, "Flags (can also be set via environment variables):\n")
clearFlags.PrintDefaults()
fmt.Fprintf(os.Stderr, "\nEnvironment Variables:\n")
fmt.Fprintf(os.Stderr, " All variables support both GOBUILDCACHE_<KEY> and <KEY> forms.\n")
fmt.Fprintf(os.Stderr, " The prefixed version takes precedence if both are set.\n\n")
fmt.Fprintf(os.Stderr, " DEBUG Enable debug logging (true/false)\n")
fmt.Fprintf(os.Stderr, " PRINT_STATS Print cache statistics on exit (true/false)\n")
fmt.Fprintf(os.Stderr, " BACKEND_TYPE Backend type (disk, s3, gcs)\n")
fmt.Fprintf(os.Stderr, " CACHE_DIR Local cache directory\n")
fmt.Fprintf(os.Stderr, " S3_BUCKET S3 bucket name\n")
fmt.Fprintf(os.Stderr, " S3_PREFIX S3 key prefix\n")
fmt.Fprintf(os.Stderr, " GCS_BUCKET GCS bucket name\n")
fmt.Fprintf(os.Stderr, " GCS_PREFIX GCS object prefix\n")
fmt.Fprintf(os.Stderr, " S3_TMP_DIR Local temp directory for S3 backend\n")
fmt.Fprintf(os.Stderr, "\nNote: Command-line flags take precedence over environment variables.\n")
fmt.Fprintf(os.Stderr, "\nExamples:\n")
fmt.Fprintf(os.Stderr, " # Clear disk cache using flags:\n")
fmt.Fprintf(os.Stderr, " %s clear -cache-dir=/var/cache/go\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear S3 cache using flags:\n")
fmt.Fprintf(os.Stderr, " %s clear -backend=s3 -s3-bucket=my-cache-bucket\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear GCS cache using flags:\n")
fmt.Fprintf(os.Stderr, " %s clear -backend=gcs -gcs-bucket=my-cache-bucket\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear using environment variables:\n")
fmt.Fprintf(os.Stderr, " GOBUILDCACHE_BACKEND_TYPE=s3 GOBUILDCACHE_S3_BUCKET=my-cache-bucket %s clear\n", os.Args[0])
}
clearFlags.Parse(os.Args[2:])
runClear()
}
func runClearLocalCommand() {
// Get defaults from environment variables.
// All variables support both GOBUILDCACHE_<KEY> and <KEY> forms, with prefixed taking precedence.
var (
clearLocalFlags = flag.NewFlagSet("clear-local", flag.ExitOnError)
debugDefault = getEnvBoolWithPrefix("DEBUG", false)
cacheDirDefault = getEnvWithPrefix("CACHE_DIR", filepath.Join(os.TempDir(), "gobuildcache", "cache"))
)
clearLocalFlags.BoolVar(&debug, "debug", debugDefault, "Enable debug logging to stderr (env: DEBUG)")
clearLocalFlags.StringVar(&cacheDir, "cache-dir", cacheDirDefault, "Local cache directory (env: CACHE_DIR)")
clearLocalFlags.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage: %s clear-local [flags]\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, "Clear only the local filesystem cache directory.\n\n")
fmt.Fprintf(os.Stderr, "Flags (can also be set via environment variables):\n")
clearLocalFlags.PrintDefaults()
fmt.Fprintf(os.Stderr, "\nEnvironment Variables:\n")
fmt.Fprintf(os.Stderr, " All variables support both GOBUILDCACHE_<KEY> and <KEY> forms.\n")
fmt.Fprintf(os.Stderr, " The prefixed version takes precedence if both are set.\n\n")
fmt.Fprintf(os.Stderr, " DEBUG Enable debug logging (true/false)\n")
fmt.Fprintf(os.Stderr, " CACHE_DIR Local cache directory\n")
fmt.Fprintf(os.Stderr, "\nNote: Command-line flags take precedence over environment variables.\n")
fmt.Fprintf(os.Stderr, "\nExamples:\n")
fmt.Fprintf(os.Stderr, " # Clear local cache using default directory:\n")
fmt.Fprintf(os.Stderr, " %s clear-local\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear local cache using custom directory:\n")
fmt.Fprintf(os.Stderr, " %s clear-local -cache-dir=/var/cache/go\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear using environment variables:\n")
fmt.Fprintf(os.Stderr, " GOBUILDCACHE_CACHE_DIR=/var/cache/go %s clear-local\n", os.Args[0])
}
clearLocalFlags.Parse(os.Args[2:])
// Clear the local cache directory
if err := clearLocalCache(cacheDir); err != nil {
fmt.Fprintf(os.Stderr, "Error clearing local cache: %v\n", err)
os.Exit(1)
}
fmt.Fprintf(os.Stdout, "Local cache cleared successfully\n")
}
func runClearRemoteCommand() {
// Get defaults from environment variables.
// All variables support both GOBUILDCACHE_<KEY> and <KEY> forms, with prefixed taking precedence.
var (
clearRemoteFlags = flag.NewFlagSet("clear-remote", flag.ExitOnError)
debugDefault = getEnvBoolWithPrefix("DEBUG", false)
backendDefault = getEnvWithPrefix("BACKEND_TYPE", getEnv("BACKEND", "disk"))
s3BucketDefault = getEnvWithPrefix("S3_BUCKET", "")
s3PrefixDefault = getEnvWithPrefix("S3_PREFIX", "")
gcsBucketDefault = getEnvWithPrefix("GCS_BUCKET", "")
gcsPrefixDefault = getEnvWithPrefix("GCS_PREFIX", "")
)
clearRemoteFlags.BoolVar(&debug, "debug", debugDefault, "Enable debug logging to stderr (env: DEBUG)")
clearRemoteFlags.StringVar(&backendType, "backend", backendDefault, "Backend type: disk, s3, gcs (env: BACKEND_TYPE)")
clearRemoteFlags.StringVar(&s3Bucket, "s3-bucket", s3BucketDefault, "S3 bucket name (required for s3 backend) (env: S3_BUCKET)")
clearRemoteFlags.StringVar(&s3Prefix, "s3-prefix", s3PrefixDefault, "S3 key prefix (optional) (env: S3_PREFIX)")
clearRemoteFlags.StringVar(&gcsBucket, "gcs-bucket", gcsBucketDefault, "GCS bucket name (required for gcs backend) (env: GCS_BUCKET)")
clearRemoteFlags.StringVar(&gcsPrefix, "gcs-prefix", gcsPrefixDefault, "GCS object prefix (optional) (env: GCS_PREFIX)")
clearRemoteFlags.Usage = func() {
fmt.Fprintf(os.Stderr, "Usage: %s clear-remote [flags]\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, "Clear only the remote backend cache (e.g., S3).\n\n")
fmt.Fprintf(os.Stderr, "Flags (can also be set via environment variables):\n")
clearRemoteFlags.PrintDefaults()
fmt.Fprintf(os.Stderr, "\nEnvironment Variables:\n")
fmt.Fprintf(os.Stderr, " All variables support both GOBUILDCACHE_<KEY> and <KEY> forms.\n")
fmt.Fprintf(os.Stderr, " The prefixed version takes precedence if both are set.\n\n")
fmt.Fprintf(os.Stderr, " DEBUG Enable debug logging (true/false)\n")
fmt.Fprintf(os.Stderr, " BACKEND_TYPE Backend type (disk, s3, gcs)\n")
fmt.Fprintf(os.Stderr, " S3_BUCKET S3 bucket name\n")
fmt.Fprintf(os.Stderr, " S3_PREFIX S3 key prefix\n")
fmt.Fprintf(os.Stderr, " GCS_BUCKET GCS bucket name\n")
fmt.Fprintf(os.Stderr, " GCS_PREFIX GCS object prefix\n")
fmt.Fprintf(os.Stderr, "\nNote: Command-line flags take precedence over environment variables.\n")
fmt.Fprintf(os.Stderr, "\nExamples:\n")
fmt.Fprintf(os.Stderr, " # Clear S3 cache using flags:\n")
fmt.Fprintf(os.Stderr, " %s clear-remote -backend=s3 -s3-bucket=my-cache-bucket\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear GCS cache using flags:\n")
fmt.Fprintf(os.Stderr, " %s clear-remote -backend=gcs -gcs-bucket=my-cache-bucket\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear S3 cache with prefix:\n")
fmt.Fprintf(os.Stderr, " %s clear-remote -backend=s3 -s3-bucket=my-cache-bucket -s3-prefix=myproject/\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, " # Clear using environment variables:\n")
fmt.Fprintf(os.Stderr, " GOBUILDCACHE_BACKEND_TYPE=s3 GOBUILDCACHE_S3_BUCKET=my-cache-bucket %s clear-remote\n", os.Args[0])
}
clearRemoteFlags.Parse(os.Args[2:])
// Create backend
backend, err := createBackend()
if err != nil {
fmt.Fprintf(os.Stderr, "Error creating backend: %v\n", err)
os.Exit(1)
}
defer backend.Close()
// Clear the backend (remote storage)
if err := backend.Clear(); err != nil {
fmt.Fprintf(os.Stderr, "Error clearing backend cache: %v\n", err)
os.Exit(1)
}
fmt.Fprintf(os.Stdout, "Remote cache cleared successfully\n")
}
func printHelp() {
fmt.Fprintf(os.Stderr, "Usage: %s [command] [flags]\n\n", os.Args[0])
fmt.Fprintf(os.Stderr, "A remote caching server for Go builds.\n\n")
fmt.Fprintf(os.Stderr, "Commands:\n")
fmt.Fprintf(os.Stderr, " (no command) Run the cache server (default)\n")
fmt.Fprintf(os.Stderr, " clear Clear both local and remote cache entries\n")
fmt.Fprintf(os.Stderr, " clear-local Clear only local cache directory\n")
fmt.Fprintf(os.Stderr, " clear-remote Clear only remote backend cache\n")
fmt.Fprintf(os.Stderr, " help Show this help message\n\n")
fmt.Fprintf(os.Stderr, "Configuration:\n")
fmt.Fprintf(os.Stderr, " Flags can be set via command-line arguments or environment variables.\n")
fmt.Fprintf(os.Stderr, " Command-line flags take precedence over environment variables.\n\n")
fmt.Fprintf(os.Stderr, "Run '%s [command] -h' for more information about a command.\n", os.Args[0])
}
func runServer() {
// Create backend
backend, err := createBackend()
if err != nil {
fmt.Fprintf(os.Stderr, "Error creating cache backend: %v\n", err)
os.Exit(1)
}
defer backend.Close()
lockingGroup, err := createLockingGroup()
if err != nil {
fmt.Fprintf(os.Stderr, "Error creating lock group: %v\n", err)
os.Exit(1)
}
if readOnly && debug {
fmt.Fprintf(os.Stderr, "[INFO] Read-only mode enabled: cache reads allowed, writes skipped\n")
}
prog, err := NewCacheProg(backend, lockingGroup, cacheDir, debug, printStats, compression, readOnly)
if err != nil {
fmt.Fprintf(os.Stderr, "Error creating cache program: %v\n", err)
os.Exit(1)
}
if err := prog.Run(); err != nil {
fmt.Fprintf(os.Stderr, "Error running cache program: %v\n", err)
os.Exit(1)
}
}
func runClear() {
// Create backend
backend, err := createBackend()
if err != nil {
fmt.Fprintf(os.Stderr, "Error creating cache backend: %v\n", err)
os.Exit(1)
}
defer backend.Close()
// Clear the backend (remote storage)
if err := backend.Clear(); err != nil {
fmt.Fprintf(os.Stderr, "Error clearing backend cache: %v\n", err)
os.Exit(1)
}
// Clear the local cache directory
if err := clearLocalCache(cacheDir); err != nil {
fmt.Fprintf(os.Stderr, "Error clearing local cache: %v\n", err)
os.Exit(1)
}
fmt.Fprintf(os.Stdout, "Cache cleared successfully\n")
}
// clearLocalCache removes all entries from the local cache directory.
func clearLocalCache(cacheDir string) error {
// Remove the entire directory and recreate it
// os.RemoveAll is idempotent - it doesn't error if path doesn't exist
if err := os.RemoveAll(cacheDir); err != nil {
return fmt.Errorf("failed to remove cache directory: %w", err)
}
// Recreate the directory
if err := os.MkdirAll(cacheDir, 0755); err != nil {
return fmt.Errorf("failed to recreate cache directory: %w", err)
}
return nil
}
func createBackend() (backends.Backend, error) {
backendType = strings.ToLower(backendType)
var backend backends.Backend
var err error
switch backendType {
case "disk":
// Use no-op backend - local caching is handled by server.go
backend = backends.NewNoop()
case "s3":
if s3Bucket == "" {
return nil, fmt.Errorf("S3 bucket is required for S3 backend (set via -s3-bucket flag or S3_BUCKET env var)")
}
awsCfg, cfgErr := resolveS3Config()
if cfgErr != nil {
return nil, cfgErr
}
backend, err = backends.NewS3(s3Bucket, s3Prefix, awsCfg)
case "gcs":
if gcsBucket == "" {
return nil, fmt.Errorf("GCS bucket is required for GCS backend (set via -gcs-bucket flag or GCS_BUCKET env var)")
}
backend, err = backends.NewGCS(gcsBucket, gcsPrefix)
default:
return nil, fmt.Errorf("unknown backend type: %s (supported: disk, s3, gcs)", backendType)
}
if err != nil {
return nil, err
}
// Wrap with error backend if error rate is configured
if errorRate > 0 {
backend = backends.NewError(backend, errorRate)
fmt.Fprintf(os.Stderr, "[INFO] Error injection enabled with rate: %.2f%%\n", errorRate*100)
}
// Wrap with async backend if enabled
if asyncBackend {
// Create logger for async backend
logLevel := slog.LevelInfo
if debug {
logLevel = slog.LevelDebug
}
logger := slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
Level: logLevel,
}))
backend = backends.NewAsyncBackendWriter(backend, logger)
if debug {
fmt.Fprintf(os.Stderr, "[INFO] Async backend writer enabled\n")
}
}
// Wrap with debug backend if debug mode is enabled
if debug {
backend = backends.NewDebug(backend)
}
return backend, nil
}
// resolveS3Config reads AWS configuration from environment variables using the
// GOBUILDCACHE_ prefix convention, falling back to standard AWS env vars.
// Using GOBUILDCACHE_-prefixed vars (e.g., GOBUILDCACHE_AWS_REGION instead of
// AWS_REGION) allows users to provide AWS config to gobuildcache without those
// values being inherited by other processes in the same environment, such as
// test binaries spawned by go test.
func resolveS3Config() (backends.S3Config, error) {
cfg := backends.S3Config{
Region: getEnvWithPrefix("AWS_REGION", ""),
AccessKeyID: getEnvWithPrefix("AWS_ACCESS_KEY_ID", ""),
SecretAccessKey: getEnvWithPrefix("AWS_SECRET_ACCESS_KEY", ""),
SessionToken: getEnvWithPrefix("AWS_SESSION_TOKEN", ""),
}
// Validate that credentials are either both set or both unset.
if cfg.AccessKeyID != "" && cfg.SecretAccessKey == "" {
return backends.S3Config{}, fmt.Errorf("GOBUILDCACHE_AWS_ACCESS_KEY_ID (or AWS_ACCESS_KEY_ID) is set but GOBUILDCACHE_AWS_SECRET_ACCESS_KEY (or AWS_SECRET_ACCESS_KEY) is not; both must be provided together")
}
if cfg.AccessKeyID == "" && cfg.SecretAccessKey != "" {
return backends.S3Config{}, fmt.Errorf("GOBUILDCACHE_AWS_SECRET_ACCESS_KEY (or AWS_SECRET_ACCESS_KEY) is set but GOBUILDCACHE_AWS_ACCESS_KEY_ID (or AWS_ACCESS_KEY_ID) is not; both must be provided together")
}
return cfg, nil
}
func createLockingGroup() (locking.Group, error) {
lockingType = strings.ToLower(lockingType)
switch lockingType {
case "memory", "":
// Default: in-memory singleflight
return locking.NewMemLock(), nil
case "fslock", "fs":
// Filesystem-backed deduplication
group, err := locking.NewFlockGroup(lockDir)
if err != nil {
return nil, fmt.Errorf("failed to create fslock group: %w", err)
}
return group, nil
case "noop":
// No deduplication (useful for testing)
return locking.NewNoOpGroup(), nil
default:
return nil, fmt.Errorf("unknown locking type: %s (supported: memory, fslock, noop)", lockingType)
}
}
// getEnv gets an environment variable or returns a default value.
func getEnv(key, defaultValue string) string {
if value := os.Getenv(key); value != "" {
return value
}
return defaultValue
}
// getEnvWithPrefix gets an environment variable, checking for GOBUILDCACHE_ prefix first.
// This allows users to use either GOBUILDCACHE_<KEY> or <KEY> for configuration.
// The prefixed version takes precedence if set.
func getEnvWithPrefix(key, defaultValue string) string {
// Check for GOBUILDCACHE_ prefixed version first
if value := os.Getenv("GOBUILDCACHE_" + key); value != "" {
return value
}
// Fall back to unprefixed version
return getEnv(key, defaultValue)
}
// getEnvBool gets a boolean environment variable or returns a default value.
// Accepts: true, false, 1, 0, yes, no (case insensitive).
func getEnvBool(key string, defaultValue bool) bool {
value := strings.ToLower(os.Getenv(key))
if value == "" {
return defaultValue
}
return value == "true" || value == "1" || value == "yes"
}
// getEnvBoolWithPrefix gets a boolean environment variable, checking for GOBUILDCACHE_ prefix first.
// This allows users to use either GOBUILDCACHE_<KEY> or <KEY> for configuration.
// The prefixed version takes precedence if set, but falls back to unprefixed if the prefixed value is invalid.
func getEnvBoolWithPrefix(key string, defaultValue bool) bool {
prefixedKey := "GOBUILDCACHE_" + key
if value := strings.ToLower(os.Getenv(prefixedKey)); value != "" {
if value == "true" || value == "1" || value == "yes" {
return true
}
if value == "false" || value == "0" || value == "no" {
return false
}
// Invalid prefixed value, fall through to unprefixed
}
return getEnvBool(key, defaultValue)
}
// getEnvFloat gets a float64 environment variable or returns a default value.
func getEnvFloat(key string, defaultValue float64) float64 {
value := os.Getenv(key)
if value == "" {
return defaultValue
}
var f float64
if _, err := fmt.Sscanf(value, "%f", &f); err != nil {
return defaultValue
}
return f
}
// getEnvFloatWithPrefix gets a float64 environment variable, checking for GOBUILDCACHE_ prefix first.
// This allows users to use either GOBUILDCACHE_<KEY> or <KEY> for configuration.
// The prefixed version takes precedence if set, but falls back to unprefixed if the prefixed value is invalid.
func getEnvFloatWithPrefix(key string, defaultValue float64) float64 {
prefixedKey := "GOBUILDCACHE_" + key
if value := os.Getenv(prefixedKey); value != "" {
var f float64
if _, err := fmt.Sscanf(value, "%f", &f); err == nil {
return f
}
// Invalid prefixed value, fall through to unprefixed
}
return getEnvFloat(key, defaultValue)
}