From 5535ee4f432139c05060add756d091be956bc353 Mon Sep 17 00:00:00 2001
From: miampf <miampf@proton.me>
Date: Mon, 25 Mar 2024 13:08:39 +0100
Subject: [PATCH] more logical log formatting with flags and similair

added forgotten flag print

forgotten flag print in info.go
---
 cli/internal/cmd/configfetchmeasurements.go   |  7 +------
 cli/internal/cmd/configgenerate.go            |  6 +-----
 cli/internal/cmd/recover.go                   |  7 +------
 cli/internal/cmd/verify.go                    |  7 +------
 e2e/malicious-join/malicious-join.go          |  6 +-----
 hack/bazel-deps-mirror/upgrade.go             |  6 +-----
 hack/oci-pin/codegen.go                       |  8 +------
 hack/oci-pin/merge.go                         |  7 +------
 image/upload/internal/cmd/info.go             |  7 +------
 .../internal/cmd/measurementsenvelope.go      |  8 +------
 .../upload/internal/cmd/measurementsmerge.go  |  5 +----
 .../upload/internal/cmd/measurementsupload.go | 10 +--------
 image/upload/internal/cmd/uplosi.go           | 14 ++-----------
 internal/api/versionsapi/cli/rm.go            | 21 +++----------------
 internal/constellation/applyinit.go           |  7 +------
 15 files changed, 18 insertions(+), 108 deletions(-)

diff --git a/cli/internal/cmd/configfetchmeasurements.go b/cli/internal/cmd/configfetchmeasurements.go
index 864b0ff88..c4be1ae9c 100644
--- a/cli/internal/cmd/configfetchmeasurements.go
+++ b/cli/internal/cmd/configfetchmeasurements.go
@@ -105,12 +105,7 @@ func runConfigFetchMeasurements(cmd *cobra.Command, _ []string) error {
 	if err := cfm.flags.parse(cmd.Flags()); err != nil {
 		return fmt.Errorf("parsing flags: %w", err)
 	}
-	cfm.log.Debug(fmt.Sprintf(
-		`Using flags:
-  insecure: %t
-  measurements-url: %q
-  signature-url: %q
-`, cfm.flags.insecure, cfm.flags.measurementsURL, cfm.flags.signatureURL))
+	cfm.log.Debug("Using flags", "insecure", cfm.flags.insecure, "measurementsURL", cfm.flags.measurementsURL, "signatureURL", cfm.flags.signatureURL)
 
 	fetcher := attestationconfigapi.NewFetcherWithClient(http.DefaultClient, constants.CDNRepositoryURL)
 	return cfm.configFetchMeasurements(cmd, fileHandler, fetcher)
diff --git a/cli/internal/cmd/configgenerate.go b/cli/internal/cmd/configgenerate.go
index 66a928f59..4fabe40e3 100644
--- a/cli/internal/cmd/configgenerate.go
+++ b/cli/internal/cmd/configgenerate.go
@@ -85,11 +85,7 @@ func runConfigGenerate(cmd *cobra.Command, args []string) error {
 	if err := cg.flags.parse(cmd.Flags()); err != nil {
 		return fmt.Errorf("parsing flags: %w", err)
 	}
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  kubernetes: %q
-  attestation: %q
-`, cg.flags.k8sVersion, cg.flags.attestationVariant))
+	log.Debug("Using flags", "k8sVersion", cg.flags.k8sVersion, "attestationVariant", cg.flags.attestationVariant)
 
 	return cg.configGenerate(cmd, fileHandler, provider, args[0])
 }
diff --git a/cli/internal/cmd/recover.go b/cli/internal/cmd/recover.go
index e32a3ea6a..4541fd08d 100644
--- a/cli/internal/cmd/recover.go
+++ b/cli/internal/cmd/recover.go
@@ -84,12 +84,7 @@ func runRecover(cmd *cobra.Command, _ []string) error {
 	if err := r.flags.parse(cmd.Flags()); err != nil {
 		return err
 	}
-	r.log.Debug(fmt.Sprintf(
-		`Using flags:
-  debug: %t
-  endpoint: %q
-  force: %t`,
-		r.flags.debug, r.flags.endpoint, r.flags.force))
+	r.log.Debug("Using flags", "debug", r.flags.debug, "endpoint", r.flags.endpoint, "force", r.flags.force)
 	return r.recover(cmd, fileHandler, 5*time.Second, &recoverDoer{log: r.log}, newDialer)
 }
 
diff --git a/cli/internal/cmd/verify.go b/cli/internal/cmd/verify.go
index 331e23a80..f80d1128d 100644
--- a/cli/internal/cmd/verify.go
+++ b/cli/internal/cmd/verify.go
@@ -128,12 +128,7 @@ func runVerify(cmd *cobra.Command, _ []string) error {
 	if err := v.flags.parse(cmd.Flags()); err != nil {
 		return err
 	}
-	v.log.Debug(fmt.Sprintf(
-		`Using flags:
-  cluster-id: %q
-  node-endpoint: %q
-  owner-id: %q`,
-		v.flags.clusterID, v.flags.endpoint, v.flags.ownerID))
+	v.log.Debug("Using flags", "clusterID", v.flags.clusterID, "endpoint", v.flags.endpoint, "ownerID", v.flags.ownerID)
 	fetcher := attestationconfigapi.NewFetcher()
 	return v.verify(cmd, verifyClient, formatterFactory, fetcher)
 }
diff --git a/e2e/malicious-join/malicious-join.go b/e2e/malicious-join/malicious-join.go
index 92e4a3309..2ef649771 100644
--- a/e2e/malicious-join/malicious-join.go
+++ b/e2e/malicious-join/malicious-join.go
@@ -172,11 +172,7 @@ func (j *maliciousJoiner) join(ctx context.Context) (*joinproto.IssueJoinTicketR
 		IsControlPlane:     false,
 	}
 	res, err := protoClient.IssueJoinTicket(ctx, req)
-	j.logger.Debug(fmt.Sprintf(
-		`Got join ticket response:
-  ApiServerEndpoint: %q
-  KubernetesVersion: %q
-`, res.ApiServerEndpoint, res.KubernetesVersion))
+	j.logger.Debug("Got join ticket response", "apiServerEndpoint", res.ApiServerEndpoint, "kubernetesVersion", res.KubernetesVersion)
 	if err != nil {
 		return nil, fmt.Errorf("issuing join ticket: %w", err)
 	}
diff --git a/hack/bazel-deps-mirror/upgrade.go b/hack/bazel-deps-mirror/upgrade.go
index bf8b70c30..8729f0aea 100644
--- a/hack/bazel-deps-mirror/upgrade.go
+++ b/hack/bazel-deps-mirror/upgrade.go
@@ -40,11 +40,7 @@ func runUpgrade(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  unauthenticated: %t
-  dry-run: %t
-`, flags.unauthenticated, flags.dryRun))
+	log.Debug("Using flags", "unauthenticated", flags.unauthenticated, "dryRun", flags.dryRun)
 
 	fileHelper, err := bazelfiles.New()
 	if err != nil {
diff --git a/hack/oci-pin/codegen.go b/hack/oci-pin/codegen.go
index f7810009a..774b794da 100644
--- a/hack/oci-pin/codegen.go
+++ b/hack/oci-pin/codegen.go
@@ -45,13 +45,7 @@ func runCodegen(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  identifier: %q
-  repoimage-tag-file: %q
-  oci-path: %q
-  package: %q`,
-		flags.identifier, flags.imageRepoTag, flags.ociPath, flags.pkg))
+	log.Debug("Using flags", "identifier", flags.identifier, "imageRepoTag", flags.imageRepoTag, "ociPath", flags.ociPath, "pkg", flags.pkg)
 
 	registry, prefix, name, tag, err := splitRepoTag(flags.imageRepoTag)
 	if err != nil {
diff --git a/hack/oci-pin/merge.go b/hack/oci-pin/merge.go
index dd94202ae..565d08a35 100644
--- a/hack/oci-pin/merge.go
+++ b/hack/oci-pin/merge.go
@@ -36,12 +36,7 @@ func runMerge(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  input: %v
-  output: %q
-  verbose: %q
-`, flags.inputs, flags.output, flags.logLevel))
+	log.Debug("Using flags", "inputs", flags.inputs, "output", flags.output, "logLevel", flags.logLevel)
 
 	log.Debug(fmt.Sprintf("Merging sum file from %q into %q.", flags.inputs, flags.output))
 
diff --git a/image/upload/internal/cmd/info.go b/image/upload/internal/cmd/info.go
index 86c1d0969..b68db4929 100644
--- a/image/upload/internal/cmd/info.go
+++ b/image/upload/internal/cmd/info.go
@@ -50,12 +50,7 @@ func runInfo(cmd *cobra.Command, args []string) error {
 	}
 
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  region: %q
-  bucket: %q
-  distribution-id: %q
-`, flags.region, flags.bucket, flags.distributionID))
+	log.Debug("Using flags", "region", flags.region, "bucket", flags.bucket, "distributionID", flags.distributionID)
 	info, err := readInfoArgs(args)
 	if err != nil {
 		return err
diff --git a/image/upload/internal/cmd/measurementsenvelope.go b/image/upload/internal/cmd/measurementsenvelope.go
index 5996bd806..70c16a24e 100644
--- a/image/upload/internal/cmd/measurementsenvelope.go
+++ b/image/upload/internal/cmd/measurementsenvelope.go
@@ -54,13 +54,7 @@ func runEnvelopeMeasurements(cmd *cobra.Command, _ []string) error {
 	}
 
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  version: %q
-  csp: %q
-  attestation-variant: %q
-  in: %q
-`, flags.version.Version(), flags.csp, flags.attestationVariant, flags.in))
+	log.Debug("Using flags", "version", flags.version.Version(), "csp", flags.csp, "attestationVariant", flags.attestationVariant, "in", flags.in)
 
 	f, err := os.Open(flags.in)
 	if err != nil {
diff --git a/image/upload/internal/cmd/measurementsmerge.go b/image/upload/internal/cmd/measurementsmerge.go
index 1dd544c59..78b283850 100644
--- a/image/upload/internal/cmd/measurementsmerge.go
+++ b/image/upload/internal/cmd/measurementsmerge.go
@@ -45,10 +45,7 @@ func runMergeMeasurements(cmd *cobra.Command, args []string) error {
 	}
 
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  out: %q
-  verbose: %q`, flags.out, flags.logLevel))
+	log.Debug("Using flags", "out", flags.out, "logLevel", flags.logLevel)
 
 	mergedMeasurements, err := readMeasurementsArgs(args)
 	if err != nil {
diff --git a/image/upload/internal/cmd/measurementsupload.go b/image/upload/internal/cmd/measurementsupload.go
index 041d22c82..720864c78 100644
--- a/image/upload/internal/cmd/measurementsupload.go
+++ b/image/upload/internal/cmd/measurementsupload.go
@@ -53,15 +53,7 @@ func runMeasurementsUpload(cmd *cobra.Command, _ []string) error {
 	}
 
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  measurements: %q
-  signature: %q
-  region: %q
-  bucket: %q
-  distribution-id: %q
-`, flags.measurementsPath, flags.signaturePath, flags.region,
-		flags.bucket, flags.distributionID))
+	log.Debug("Using flags", "measurementsPath", flags.measurementsPath, "signaturePath", flags.signaturePath, "region", flags.region, "bucket", flags.bucket, "distributionID", flags.distributionID)
 
 	uploadC, uploadCClose, err := measurementsuploader.New(cmd.Context(), flags.region, flags.bucket, flags.distributionID, log)
 	if err != nil {
diff --git a/image/upload/internal/cmd/uplosi.go b/image/upload/internal/cmd/uplosi.go
index 3a25c1377..9546a1e3b 100644
--- a/image/upload/internal/cmd/uplosi.go
+++ b/image/upload/internal/cmd/uplosi.go
@@ -59,18 +59,8 @@ func runUplosi(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  raw-image: %q
-  attestation-variant: %q
-  csp: %q
-  version: %q
-  region: %q
-  bucket: %q
-  distribution-id: %q
-`, flags.rawImage, flags.attestationVariant, flags.provider, flags.version.Version(), flags.region,
-		flags.bucket, flags.distributionID))
-
+	log.Debug("Using flags", "raw-image", flags.rawImage, "attestation-variant", flags.attestationVariant, "csp", flags.provider, "ref", flags.version.Ref(), "stream", flags.version.Stream(),
+	"version", flags.version.Version(), "region", flags.region, "bucket", flags.bucket, "distribution-id", flags.distributionID, "out", flags.out, "uplosi-path", flags.uplosiPath)
 	archiveC, archiveCClose, err := archive.New(cmd.Context(), flags.region, flags.bucket, flags.distributionID, log)
 	if err != nil {
 		return err
diff --git a/internal/api/versionsapi/cli/rm.go b/internal/api/versionsapi/cli/rm.go
index 9e75684ca..16a926013 100644
--- a/internal/api/versionsapi/cli/rm.go
+++ b/internal/api/versionsapi/cli/rm.go
@@ -75,24 +75,9 @@ func runRemove(cmd *cobra.Command, _ []string) (retErr error) {
 		return err
 	}
 	log := logger.NewTextLogger(flags.logLevel)
-	log.Debug(fmt.Sprintf(
-		`Parsed flags:
-  all: %t
-  az-location: %q
-  az-resource-group: %q
-  az-subscription: %q
-  bucket: %q
-  distribution-id: %q
-  dryrun: %t
-  gcp-project: %q
-  ref: %q
-  region: %q
-  stream: %q
-  version: %q
-  version-path: %q`,
-		flags.all, flags.azLocation, flags.azResourceGroup, flags.azSubscription,
-		flags.bucket, flags.distributionID, flags.dryrun, flags.gcpProject,
-		flags.ref, flags.region, flags.stream, flags.version, flags.versionPath))
+	log.Debug("Using flags", "all", flags.all, "azLocation", flags.azLocation, "azResourceGroup", flags.azResourceGroup, "azSubscription", flags.azSubscription,
+		"bucket", flags.bucket, "distributionID", flags.distributionID, "dryrun", flags.dryrun, "gcpProject", flags.gcpProject, "ref", flags.ref,
+		"region", flags.region, "stream", flags.stream, "version", flags.version, "versionPath", flags.versionPath)
 
 	log.Debug("Validating flags")
 	if err := flags.validate(); err != nil {
diff --git a/internal/constellation/applyinit.go b/internal/constellation/applyinit.go
index 70e5e95c6..e451e4fd8 100644
--- a/internal/constellation/applyinit.go
+++ b/internal/constellation/applyinit.go
@@ -90,12 +90,7 @@ func (a *Applier) Init(
 	}
 
 	// Perform the RPC
-	a.log.Debug(fmt.Sprintf(
-		`Making initialization call, doer has the following parameters:
-  endpoint: %q
-  req.KmsUri: %q
-  req.StorageUri: %q
-`, doer.endpoint, doer.req.KmsUri, doer.req.StorageUri))
+	a.log.Debug("Initialization call", "endpoint", doer.endpoint, "kmsURI", doer.req.KmsUri, "storageURI", doer.req.StorageUri)
 	a.spinner.Start("Connecting ", false)
 	retrier := retry.NewIntervalRetrier(doer, 30*time.Second, serviceIsUnavailable)
 	if err := retrier.Do(ctx); err != nil {