Merge pull request #115 from bitrise-io/flags

zsolt-marta-bitrise · web-flow · commit 5f016bde7803 · 2025-04-24T09:51:35.000+02:00
feat: ACI-3637 Add timestamps flag for bazel and wait for BES upload
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -12,11 +12,9 @@ linters:
   - paralleltest
   - testpackage
   - mnd
-  - gomnd
   - err113
   - perfsprint
   - varnamelen
   - gci
   - nolintlint
   - cyclop
-  - execinquery # deprecated (since v1.58.0) due to: The repository of the linter has been archived by the owner.
diff --git a/Makefile b/Makefile
@@ -1,10 +1,15 @@
 # Tool versions
-GOLANGCI_LINT_VERSION = v1.60.0
+GOLANGCI_LINT_VERSION = v1.64.8
 
 .PHONY: lint
 lint:					## Runs golangci-lint
 	go run github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION) run --timeout 5m
 
+.PHONY: lint-fix
+lint-fix:					## Runs golangci-lint
+	go run github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION) run --timeout 5m --fix
+
+
 .PHONY: govulncheck
 govulncheck:				## Runs govulncheck
 	go run golang.org/x/vuln/cmd/govulncheck@latest -test ./...
diff --git a/bitrise.yml b/bitrise.yml
@@ -31,7 +31,8 @@ workflows:
         - content: |-
             #!/usr/bin/env bash
 
-            asdf global golang 1.22
+            asdf install golang 1.23.8
+            asdf global golang 1.23.8
     - script:
         title: Install Goreleaser
         inputs:
@@ -469,7 +470,7 @@ step_bundles:
                 #!/bin/bash
                 set -ex
                 
-                asdf install golang 1.21.5
+                asdf install golang 1.23.8
       - script:
           title: Generate dependency matrix
           inputs:
diff --git a/cmd/enableForBazel.go b/cmd/enableForBazel.go
@@ -49,9 +49,11 @@ If the "# [start/end] generated-by-bitrise-build-cache" block is already present
 }
 
 var rbeEnabled bool //nolint:gochecknoglobals
+var timestamps bool //nolint:gochecknoglobals
 
 func init() {
 	enableForBazelCmd.Flags().BoolVar(&rbeEnabled, "with-rbe", false, "Enable Remote Build Execution (RBE)")
+	enableForBazelCmd.Flags().BoolVar(&timestamps, "timestamps", false, "Enable timestamps in build output")
 	enableForCmd.AddCommand(enableForBazelCmd)
 }
 
@@ -101,7 +103,12 @@ func enableForBazelCmdFn(logger log.Logger, homeDirPath string, envProvider func
 	logger.Debugf("isBazelrcExists: %t", isBazelrcExists)
 
 	logger.Infof("(i) Generate ~/.bazelrc")
-	bazelrcBlockContent, err := bazelconfig.GenerateBazelrc(cacheEndpointURL, rbeEndpointURL, authConfig.WorkspaceID, authConfig.AuthToken, cacheConfig)
+	bazelrcBlockContent, err := bazelconfig.GenerateBazelrc(cacheEndpointURL,
+		authConfig.WorkspaceID, authConfig.AuthToken, cacheConfig,
+		bazelconfig.Preferences{
+			RBEEndpointURL:      rbeEndpointURL,
+			IsTimestampsEnabled: timestamps,
+		})
 	if err != nil {
 		return fmt.Errorf("generate bazelrc: %w", err)
 	}
diff --git a/cmd/saveXcodeDerivedDataFiles_test.go b/cmd/saveXcodeDerivedDataFiles_test.go
@@ -1,13 +1,14 @@
 package cmd
 
 import (
-	"context"
 	"testing"
 	"time"
 
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
 
+	"context"
+
 	"github.com/bitrise-io/bitrise-build-cache-cli/internal/config/common"
 	"github.com/bitrise-io/bitrise-build-cache-cli/internal/xcode"
 	xcodeMocks "github.com/bitrise-io/bitrise-build-cache-cli/internal/xcode/mocks"
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/bitrise-io/bitrise-build-cache-cli
 
-go 1.22.3
+go 1.23.8
 
 require (
 	cloud.google.com/go/longrunning v0.6.0
@@ -36,8 +36,6 @@ require (
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect
-	go.uber.org/multierr v1.10.0 // indirect
-	go.uber.org/zap v1.27.0 // indirect
 	golang.org/x/net v0.28.0 // indirect
 	golang.org/x/sys v0.24.0 // indirect
 	golang.org/x/text v0.17.0 // indirect
diff --git a/go.sum b/go.sum
@@ -110,10 +110,6 @@ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
-go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ=
-go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
-go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
-go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
diff --git a/internal/build_cache/kv/download_multi.go b/internal/build_cache/kv/download_multi.go
@@ -33,6 +33,7 @@ func (c *Client) DownloadFileGroupFromBuildCache(ctx context.Context, dd filegro
 		}
 	}
 
+	//nolint: gosec
 	c.logger.TInfof("(i) Downloading %d files, largest is %s",
 		len(dd.Files), humanize.Bytes(uint64(largestFileSize)))
 
@@ -90,13 +91,13 @@ func (c *Client) DownloadFileGroupFromBuildCache(ctx context.Context, dd filegro
 			missingPlusFailed := filesMissing.Load() + filesFailedToDownload.Load()
 			switch {
 			case errors.Is(err, ErrCacheNotFound):
-				if missingPlusFailed < int32(maxLoggedDownloadErrors) {
+				if int(missingPlusFailed) < maxLoggedDownloadErrors {
 					c.logger.Infof("Cache entry not found for file %s (%s)", file.Path, file.Hash)
 				}
 
 				filesMissing.Add(1)
 			case err != nil:
-				if missingPlusFailed < int32(maxLoggedDownloadErrors) {
+				if int(missingPlusFailed) < maxLoggedDownloadErrors {
 					c.logger.Errorf("Failed to download file %s with error: %v", file.Path, err)
 				}
 
@@ -110,6 +111,7 @@ func (c *Client) DownloadFileGroupFromBuildCache(ctx context.Context, dd filegro
 
 	wg.Wait()
 
+	//nolint: gosec
 	c.logger.TInfof("(i) Downloaded: %d files (%s). Missing: %d files. Failed: %d files", filesDownloaded.Load(), humanize.Bytes(uint64(downloadSize.Load())), filesMissing.Load(), filesFailedToDownload.Load())
 
 	stats := DownloadFilesStats{
@@ -126,7 +128,9 @@ func (c *Client) DownloadFileGroupFromBuildCache(ctx context.Context, dd filegro
 	c.logger.Debugf("  Files missing: %d", stats.FilesMissing)
 	c.logger.Debugf("  Files failed to download: %d", stats.FilesFailedToDownload)
 	c.logger.Debugf("  Files skipped (existing): %d", skippedFiles.Load())
+	//nolint: gosec
 	c.logger.Debugf("  Download size: %s", humanize.Bytes(uint64(stats.DownloadSize)))
+	//nolint: gosec
 	c.logger.Debugf("  Largest file size: %s", humanize.Bytes(uint64(stats.LargestFileSize)))
 
 	if maxLoggedDownloadErrors < stats.FilesFailedToDownload+stats.FilesMissing {
diff --git a/internal/build_cache/kv/upload.go b/internal/build_cache/kv/upload.go
@@ -26,6 +26,7 @@ func (c *Client) UploadFileToBuildCache(ctx context.Context, filePath, key strin
 
 	err = c.uploadToBuildCache(ctx, func(ctx context.Context) error {
 		fileSize, err := c.uploadFile(ctx, filePath, key, checksum)
+		//nolint: gosec
 		c.logger.Infof("(i) Uploaded: %s", humanize.Bytes(uint64(fileSize)))
 
 		return err
diff --git a/internal/build_cache/kv/upload_multi.go b/internal/build_cache/kv/upload_multi.go
@@ -93,6 +93,7 @@ func (c *Client) UploadFileGroupToBuildCache(ctx context.Context, dd filegroup.I
 
 	wg.Wait()
 
+	//nolint: gosec
 	c.logger.TInfof("(i) Uploaded %s in %d keys", humanize.Bytes(uint64(stats.UploadSize)), stats.FilesUploaded)
 
 	if stats.FilesFailedToUpload > 0 {
diff --git a/internal/config/bazel/bazel_config.go b/internal/config/bazel/bazel_config.go
@@ -19,16 +19,24 @@ var (
 var bazelrcTemplateText string
 
 type templateInventory struct {
-	CacheEndpointURL string
-	RBEEndpointURL   string
-	WorkspaceID      string
-	AuthToken        string
+	CacheEndpointURL    string
+	RBEEndpointURL      string
+	WorkspaceID         string
+	AuthToken           string
+	IsTimestampsEnabled bool
 	// Metadata
 	CacheConfigMetadata common.CacheConfigMetadata
 }
 
+type Preferences struct {
+	RBEEndpointURL      string
+	IsTimestampsEnabled bool
+}
+
 // Generate bazelrc.
-func GenerateBazelrc(cacheEndpointURL, rbeEndpointURL, workspaceID, authToken string, cacheConfigMetadata common.CacheConfigMetadata) (string, error) {
+func GenerateBazelrc(cacheEndpointURL, workspaceID, authToken string,
+	cacheConfigMetadata common.CacheConfigMetadata,
+	prefs Preferences) (string, error) {
 	// required check
 	if len(authToken) < 1 {
 		return "", fmt.Errorf("generate bazelrc, error: %w", errAuthTokenNotProvided)
@@ -38,17 +46,17 @@ func GenerateBazelrc(cacheEndpointURL, rbeEndpointURL, workspaceID, authToken st
 		return "", fmt.Errorf("generate bazelrc, error: %w", errEndpointURLNotProvided)
 	}
 
-	if len(rbeEndpointURL) < 1 {
-		rbeEndpointURL = ""
+	if len(prefs.RBEEndpointURL) < 1 {
+		prefs.RBEEndpointURL = ""
 	}
 
 	// create inventory
 	inventory := templateInventory{
-		CacheEndpointURL: cacheEndpointURL,
-		RBEEndpointURL:   rbeEndpointURL,
-		WorkspaceID:      workspaceID,
-		AuthToken:        authToken,
-		// Metadata
+		CacheEndpointURL:    cacheEndpointURL,
+		RBEEndpointURL:      prefs.RBEEndpointURL,
+		WorkspaceID:         workspaceID,
+		AuthToken:           authToken,
+		IsTimestampsEnabled: prefs.IsTimestampsEnabled,
 		CacheConfigMetadata: cacheConfigMetadata,
 	}
 
diff --git a/internal/config/bazel/bazel_config_test.go b/internal/config/bazel/bazel_config_test.go
@@ -17,6 +17,7 @@ func TestGenerateBazelrc(t *testing.T) {
 		rbeEndpointURL      string
 		workspaceID         string
 		authToken           string
+		timestamps          bool
 		cacheConfigMetadata common.CacheConfigMetadata
 	}
 	tests := []struct {
@@ -47,6 +48,7 @@ func TestGenerateBazelrc(t *testing.T) {
 			want: `build --remote_cache=grpcs://TESTENDPOINT.bitrise.io
 build --remote_timeout=600s
 build --bes_timeout=2m
+build --bes_upload_mode=wait_for_upload_complete
 build --remote_header=authorization="Bearer 4uth70k3n"
 build --bes_header=authorization="Bearer 4uth70k3n"
 build --remote_header=x-flare-buildtool=bazel
@@ -68,6 +70,7 @@ build --build_event_publish_all_actions
 build --remote_executor=grpcs://RBE.bitrise.io
 build --remote_timeout=600s
 build --bes_timeout=2m
+build --bes_upload_mode=wait_for_upload_complete
 build --remote_header=authorization="Bearer 4uth70k3n"
 build --bes_header=authorization="Bearer 4uth70k3n"
 build --remote_header=x-flare-buildtool=bazel
@@ -98,6 +101,7 @@ build --build_event_publish_all_actions
 build --remote_executor=grpcs://RBE.bitrise.io
 build --remote_timeout=600s
 build --bes_timeout=2m
+build --bes_upload_mode=wait_for_upload_complete
 build --remote_header='x-org-id=W0rkSp4ceID'
 build --bes_header='x-org-id=W0rkSp4ceID'
 build --remote_header=authorization="Bearer 4uth70k3n"
@@ -140,6 +144,7 @@ build --bes_header='x-build-id=BitriseBuildID1'
 build --remote_executor=grpcs://RBE.bitrise.io
 build --remote_timeout=600s
 build --bes_timeout=2m
+build --bes_upload_mode=wait_for_upload_complete
 build --remote_header=authorization="Bearer 4uth70k3n"
 build --bes_header=authorization="Bearer 4uth70k3n"
 build --remote_header=x-flare-buildtool=bazel
@@ -152,14 +157,41 @@ build --bes_header='x-locale=en_US'
 build --bes_header='x-default-charset=UTF-8'
 build --bes_header='x-cpu-cores=4'
 build --bes_header='x-mem-size=1000'
+`,
+		},
+		{
+			name: "With timestamps",
+			args: args{
+				endpointURL: "grpcs://TESTENDPOINT.bitrise.io",
+				authToken:   "4uth70k3n",
+				timestamps:  true,
+			},
+			wantErr: "",
+			want: `build --remote_cache=grpcs://TESTENDPOINT.bitrise.io
+build --remote_timeout=600s
+build --bes_timeout=2m
+build --bes_upload_mode=wait_for_upload_complete
+build --show_timestamps
+build --remote_header=authorization="Bearer 4uth70k3n"
+build --bes_header=authorization="Bearer 4uth70k3n"
+build --remote_header=x-flare-buildtool=bazel
+build --remote_header=x-flare-builduser=
+build --bes_results_url=https://app.bitrise.io/build-cache/invocations/bazel/
+build --bes_backend=grpcs://flare-bes.services.bitrise.io:443
+build --build_event_publish_all_actions
 `,
 		},
 	}
 	for _, tt := range tests { //nolint:varnamelen
 		t.Run(tt.name, func(t *testing.T) {
 			t.Parallel()
 
-			got, err := GenerateBazelrc(tt.args.endpointURL, tt.args.rbeEndpointURL, tt.args.workspaceID, tt.args.authToken, tt.args.cacheConfigMetadata)
+			got, err := GenerateBazelrc(tt.args.endpointURL, tt.args.workspaceID, tt.args.authToken,
+				tt.args.cacheConfigMetadata,
+				Preferences{
+					RBEEndpointURL:      tt.args.rbeEndpointURL,
+					IsTimestampsEnabled: tt.args.timestamps,
+				})
 
 			if tt.wantErr != "" {
 				require.EqualError(t, err, tt.wantErr)
diff --git a/internal/config/bazel/bazelrc.gotemplate b/internal/config/bazel/bazelrc.gotemplate
@@ -4,6 +4,10 @@ build --remote_executor={{ .RBEEndpointURL }}
 {{- end }}
 build --remote_timeout=600s
 build --bes_timeout=2m
+build --bes_upload_mode=wait_for_upload_complete
+{{- if .IsTimestampsEnabled }}
+build --show_timestamps
+{{- end }}
 {{- if .WorkspaceID }}
 build --remote_header='x-org-id={{ .WorkspaceID }}'
 build --bes_header='x-org-id={{ .WorkspaceID }}'
diff --git a/internal/filegroup/file_group_info.go b/internal/filegroup/file_group_info.go
@@ -146,6 +146,7 @@ func CollectFileGroupInfo(cacheDirPath string,
 	dd.Symlinks = fgi.Symlinks
 
 	logger.Infof("(i) Collected %d files and %d directories ", len(dd.Files), len(dd.Directories))
+	//nolint: gosec
 	logger.Debugf("(i) Largest processed file size: %s", humanize.Bytes(uint64(fgi.LargestFileSize)))
 
 	return dd, nil
diff --git a/internal/xcode/metadata.go b/internal/xcode/metadata.go
@@ -227,6 +227,7 @@ func (md *Metadata) Print(logger log.Logger, isDebugLogMode bool) {
 
 		logger.Debugf("  Largest files:")
 		for i, file := range sortedDDFiles {
+			//nolint: gosec
 			logger.Debugf("    %d. %s (%s)", i+1, file.Path, humanize.Bytes(uint64(file.Size)))
 		}
 	}
diff --git a/internal/xcode/metadata_test.go b/internal/xcode/metadata_test.go
@@ -2,7 +2,6 @@ package xcode
 
 import (
 	"os"
-	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -18,13 +17,7 @@ func Test_CreateMetadata(t *testing.T) {
 		outputFile string
 	}
 
-	testRootDir, err := os.MkdirTemp("", "testRootDir")
-	if err != nil {
-		t.Logf("Error creating temp directory: %v", err)
-
-		return
-	}
-	defer os.RemoveAll(testRootDir)
+	testRootDir := t.TempDir()
 
 	testInputFile, err := os.CreateTemp(testRootDir, "test-file.swift")
 	if err != nil {
@@ -66,7 +59,7 @@ func Test_CreateMetadata(t *testing.T) {
 
 				require.Len(t, md.ProjectFiles.Files, 1)
 				fi := md.ProjectFiles.Files[0]
-				require.True(t, strings.Contains(fi.Path, "test-file.swift"))
+				require.Contains(t, fi.Path, "test-file.swift")
 				require.NotEmpty(t, fi.Hash)
 
 				require.NotEmpty(t, md.CacheKey)
