pkg/cli (debug-zip): add dry-run mode for debug zip uploads

Introduce a `--dry-run` flag to the debug zip upload command. This
allows us to simulate the upload process without performing actual
uploads. The dry-run mode is used only for debugging/testing. This flag
is hidden from the help text

Release note: None

Author: arjunmahishi

pkg/cli/debug.go

@@ -1574,6 +1574,9 @@ func init() {
 	f.Lookup("log-format").Hidden = true
 	f.StringVar(&debugZipUploadOpts.gcpProjectID, "gcp-project-id",
 		defaultGCPProjectID, "GCP project ID to use to send debug.zip logs to GCS")
+	// --dry-run is a hidden flag that is only meant to be used for testing and diagnostics
+	f.BoolVar(&debugZipUploadOpts.dryRun, "dry-run", false, "run in dry-run mode without making any actual uploads")
+	f.Lookup("dry-run").Hidden = true
 
 	f = debugDecodeKeyCmd.Flags()
 	f.Var(&decodeKeyOptions.encoding, "encoding", "key argument encoding")

pkg/cli/zip_upload.go

@@ -124,6 +124,7 @@ var debugZipUploadOpts = struct {
 	from, to             timestampValue
 	logFormat            string
 	maxConcurrentUploads int
+	dryRun               bool
 }{
 	maxConcurrentUploads: system.NumCPU() * 4,
 }
@@ -217,6 +218,10 @@ func runDebugZipUpload(cmd *cobra.Command, args []string) error {
 		artifactsToUpload = debugZipUploadOpts.include
 	}
 
+	if debugZipUploadOpts.dryRun {
+		fmt.Println("DRY RUN MODE: No actual uploads will be performed")
+	}
+
 	// run the upload functions for each artifact type. This can run sequentially.
 	// All the concurrency is contained within the upload functions.
 	for _, artType := range artifactsToUpload {
@@ -238,6 +243,10 @@ func validateZipUploadReadiness() error {
 		artifactsToUpload = zipArtifactTypes
 	)
 
+	if debugZipUploadOpts.dryRun {
+		return nil
+	}
+
 	if len(debugZipUploadOpts.include) > 0 {
 		artifactsToUpload = debugZipUploadOpts.include
 	}
@@ -896,6 +905,11 @@ func startWriterPool(
 // writing to GCS. The concurrency has to be handled by the caller.
 // This function implements the logUploadFunc signature.
 var gcsLogUpload = func(ctx context.Context, sig logUploadSig) (int, error) {
+	data := bytes.Join(sig.logLines, []byte("\n"))
+	if debugZipUploadOpts.dryRun {
+		return len(data), nil
+	}
+
 	gcsClient, closeGCSClient, err := newGCSClient(ctx)
 	if err != nil {
 		return 0, err
@@ -910,7 +924,6 @@ var gcsLogUpload = func(ctx context.Context, sig logUploadSig) (int, error) {
 	retryOpts := base.DefaultRetryOptions()
 	retryOpts.MaxRetries = zipUploadRetries
 
-	data := bytes.Join(sig.logLines, []byte("\n"))
 	for retry := retry.Start(retryOpts); retry.Next(); {
 		objectWriter := gcsClient.Bucket(ddArchiveBucketName).Object(filename).NewWriter(ctx)
 		w := gzip.NewWriter(objectWriter)
@@ -1137,6 +1150,10 @@ func makeDDTag(key, value string) string {
 // There is also some error handling logic in this function. This is a variable so that
 // we can mock this function in the tests.
 var doUploadReq = func(req *http.Request) ([]byte, error) {
+	if debugZipUploadOpts.dryRun {
+		return []byte("{}"), nil
+	}
+
 	resp, err := http.DefaultClient.Do(req)
 	if err != nil {
 		return nil, err