fix: conform to stricter printf usage in Go 1.24 (#16330)

mafredri · web-flow · commit 9520da338e4a · 2025-01-29T18:06:22.000+02:00
diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -977,7 +977,7 @@ func TestAgent_FileTransferBlocked(t *testing.T) {
 		isErr := strings.Contains(errorMessage, agentssh.BlockedFileTransferErrorMessage) ||
 			strings.Contains(errorMessage, "EOF") ||
 			strings.Contains(errorMessage, "Process exited with status 65")
-		require.True(t, isErr, fmt.Sprintf("Message: "+errorMessage))
+		require.True(t, isErr, "Message: "+errorMessage)
 	}
 
 	t.Run("SFTP", func(t *testing.T) {
diff --git a/cli/gitssh.go b/cli/gitssh.go
@@ -91,7 +91,7 @@ func (r *RootCmd) gitssh() *serpent.Command {
 				if xerrors.As(err, &exitErr) && exitErr.ExitCode() == 255 {
 					_, _ = fmt.Fprintln(inv.Stderr,
 						"\n"+pretty.Sprintf(
-							cliui.DefaultStyles.Wrap,
+							cliui.DefaultStyles.Wrap, "%s",
 							"Coder authenticates with "+pretty.Sprint(cliui.DefaultStyles.Field, "git")+
 								" using the public key below. All clones with SSH are authenticated automatically 🪄.")+"\n",
 					)
diff --git a/cli/login.go b/cli/login.go
@@ -209,7 +209,7 @@ func (r *RootCmd) login() *serpent.Command {
 
 			// nolint: nestif
 			if !hasFirstUser {
-				_, _ = fmt.Fprintf(inv.Stdout, Caret+"Your Coder deployment hasn't been set up!\n")
+				_, _ = fmt.Fprint(inv.Stdout, Caret+"Your Coder deployment hasn't been set up!\n")
 
 				if username == "" {
 					if !isTTYIn(inv) {
diff --git a/cli/logout.go b/cli/logout.go
@@ -68,7 +68,7 @@ func (r *RootCmd) logout() *serpent.Command {
 				errorString := strings.TrimRight(errorStringBuilder.String(), "\n")
 				return xerrors.New("Failed to log out.\n" + errorString)
 			}
-			_, _ = fmt.Fprintf(inv.Stdout, Caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")
+			_, _ = fmt.Fprint(inv.Stdout, Caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")
 			return nil
 		},
 	}
diff --git a/cli/publickey.go b/cli/publickey.go
@@ -45,14 +45,14 @@ func (r *RootCmd) publickey() *serpent.Command {
 				return xerrors.Errorf("create codersdk client: %w", err)
 			}
 
-			cliui.Infof(inv.Stdout,
+			cliui.Info(inv.Stdout,
 				"This is your public key for using "+pretty.Sprint(cliui.DefaultStyles.Field, "git")+" in "+
 					"Coder. All clones with SSH will be authenticated automatically 🪄.",
 			)
-			cliui.Infof(inv.Stdout, pretty.Sprint(cliui.DefaultStyles.Code, strings.TrimSpace(key.PublicKey))+"\n")
-			cliui.Infof(inv.Stdout, "Add to GitHub and GitLab:")
-			cliui.Infof(inv.Stdout, "> https://github.com/settings/ssh/new")
-			cliui.Infof(inv.Stdout, "> https://gitlab.com/-/profile/keys")
+			cliui.Info(inv.Stdout, pretty.Sprint(cliui.DefaultStyles.Code, strings.TrimSpace(key.PublicKey))+"\n")
+			cliui.Info(inv.Stdout, "Add to GitHub and GitLab:")
+			cliui.Info(inv.Stdout, "> https://github.com/settings/ssh/new")
+			cliui.Info(inv.Stdout, "> https://gitlab.com/-/profile/keys")
 
 			return nil
 		},
diff --git a/cli/server.go b/cli/server.go
@@ -513,7 +513,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
 			}
 
 			accessURL := vals.AccessURL.String()
-			cliui.Infof(inv.Stdout, lipgloss.NewStyle().
+			cliui.Info(inv.Stdout, lipgloss.NewStyle().
 				Border(lipgloss.DoubleBorder()).
 				Align(lipgloss.Center).
 				Padding(0, 3).
diff --git a/cli/templateversionarchive.go b/cli/templateversionarchive.go
@@ -76,7 +76,7 @@ func (r *RootCmd) setArchiveTemplateVersion(archive bool) *serpent.Command {
 			for _, version := range versions {
 				if version.Archived == archive {
 					_, _ = fmt.Fprintln(
-						inv.Stdout, fmt.Sprintf("Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" already "+pastVerb),
+						inv.Stdout, "Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" already "+pastVerb,
 					)
 					continue
 				}
@@ -87,7 +87,7 @@ func (r *RootCmd) setArchiveTemplateVersion(archive bool) *serpent.Command {
 				}
 
 				_, _ = fmt.Fprintln(
-					inv.Stdout, fmt.Sprintf("Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" "+pastVerb+" at "+cliui.Timestamp(time.Now())),
+					inv.Stdout, "Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" "+pastVerb+" at "+cliui.Timestamp(time.Now()),
 				)
 			}
 			return nil
diff --git a/coderd/healthcheck/workspaceproxy.go b/coderd/healthcheck/workspaceproxy.go
@@ -100,9 +100,9 @@ func (r *WorkspaceProxyReport) Run(ctx context.Context, opts *WorkspaceProxyRepo
 	for _, err := range errs {
 		switch r.Severity {
 		case health.SeverityWarning, health.SeverityOK:
-			r.Warnings = append(r.Warnings, health.Messagef(health.CodeProxyUnhealthy, err))
+			r.Warnings = append(r.Warnings, health.Messagef(health.CodeProxyUnhealthy, "%s", err))
 		case health.SeverityError:
-			r.appendError(*health.Errorf(health.CodeProxyUnhealthy, err))
+			r.appendError(*health.Errorf(health.CodeProxyUnhealthy, "%s", err))
 		}
 	}
 }
diff --git a/coderd/httpapi/httpapi_test.go b/coderd/httpapi/httpapi_test.go
@@ -143,15 +143,15 @@ func TestWebsocketCloseMsg(t *testing.T) {
 		t.Parallel()
 
 		msg := strings.Repeat("d", 255)
-		trunc := httpapi.WebsocketCloseSprintf(msg)
+		trunc := httpapi.WebsocketCloseSprintf("%s", msg)
 		assert.Equal(t, len(trunc), 123)
 	})
 
 	t.Run("TruncateMultiByteCharacters", func(t *testing.T) {
 		t.Parallel()
 
 		msg := strings.Repeat("こんにちは", 10)
-		trunc := httpapi.WebsocketCloseSprintf(msg)
+		trunc := httpapi.WebsocketCloseSprintf("%s", msg)
 		assert.Equal(t, len(trunc), 123)
 	})
 }
diff --git a/enterprise/cli/proxyserver.go b/enterprise/cli/proxyserver.go
@@ -205,7 +205,7 @@ func (r *RootCmd) proxyServer() *serpent.Command {
 			httpClient.Transport = headerTransport
 
 			accessURL := cfg.AccessURL.String()
-			cliui.Infof(inv.Stdout, lipgloss.NewStyle().
+			cliui.Info(inv.Stdout, lipgloss.NewStyle().
 				Border(lipgloss.DoubleBorder()).
 				Align(lipgloss.Center).
 				Padding(0, 3).
diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -78,7 +78,7 @@ func (s *server) Plan(
 
 	e := s.executor(sess.WorkDirectory, database.ProvisionerJobTimingStagePlan)
 	if err := e.checkMinVersion(ctx); err != nil {
-		return provisionersdk.PlanErrorf(err.Error())
+		return provisionersdk.PlanErrorf("%s", err.Error())
 	}
 	logTerraformEnvVars(sess)
 
@@ -113,7 +113,6 @@ func (s *server) Plan(
 	initTimings.ingest(createInitTimingsEvent(timingInitStart))
 
 	err = e.init(ctx, killCtx, sess)
-
 	if err != nil {
 		initTimings.ingest(createInitTimingsEvent(timingInitErrored))
 
@@ -168,7 +167,7 @@ func (s *server) Plan(
 		request.Metadata.GetWorkspaceTransition() == proto.WorkspaceTransition_DESTROY,
 	)
 	if err != nil {
-		return provisionersdk.PlanErrorf(err.Error())
+		return provisionersdk.PlanErrorf("%s", err.Error())
 	}
 
 	// Prepend init timings since they occur prior to plan timings.
@@ -189,7 +188,7 @@ func (s *server) Apply(
 
 	e := s.executor(sess.WorkDirectory, database.ProvisionerJobTimingStageApply)
 	if err := e.checkMinVersion(ctx); err != nil {
-		return provisionersdk.ApplyErrorf(err.Error())
+		return provisionersdk.ApplyErrorf("%s", err.Error())
 	}
 	logTerraformEnvVars(sess)
 
diff --git a/pty/ptytest/ptytest.go b/pty/ptytest/ptytest.go
@@ -252,6 +252,7 @@ func (e *outExpecter) Peek(ctx context.Context, n int) []byte {
 	return slices.Clone(out)
 }
 
+//nolint:govet // We don't care about conforming to ReadRune() (rune, int, error).
 func (e *outExpecter) ReadRune(ctx context.Context) rune {
 	e.t.Helper()
 
diff --git a/vpn/tunnel.go b/vpn/tunnel.go
@@ -71,7 +71,7 @@ func NewTunnel(
 		return nil, err
 	}
 	t := &Tunnel{
-		// nolint: govet // safe to copy the locks here because we haven't started the speaker
+		//nolint:govet // safe to copy the locks here because we haven't started the speaker
 		speaker:         *(s),
 		ctx:             ctx,
 		logger:          logger,

Original file line number	Diff line number	Diff line change
`@@ -977,7 +977,7 @@ func TestAgent_FileTransferBlocked(t *testing.T) {`
`977`	`977`	`isErr := strings.Contains(errorMessage, agentssh.BlockedFileTransferErrorMessage) \|\|`
`978`	`978`	`strings.Contains(errorMessage, "EOF") \|\|`
`979`	`979`	`strings.Contains(errorMessage, "Process exited with status 65")`
`980`		`- require.True(t, isErr, fmt.Sprintf("Message: "+errorMessage))`
	`980`	`+ require.True(t, isErr, "Message: "+errorMessage)`
`981`	`981`	`}`
`982`	`982`
`983`	`983`	`t.Run("SFTP", func(t *testing.T) {`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ func (r RootCmd) gitssh() serpent.Command {`
`91`	`91`	`if xerrors.As(err, &exitErr) && exitErr.ExitCode() == 255 {`
`92`	`92`	`_, _ = fmt.Fprintln(inv.Stderr,`
`93`	`93`	`"\n"+pretty.Sprintf(`
`94`		`- cliui.DefaultStyles.Wrap,`
	`94`	`+ cliui.DefaultStyles.Wrap, "%s",`
`95`	`95`	`"Coder authenticates with "+pretty.Sprint(cliui.DefaultStyles.Field, "git")+`
`96`	`96`	`" using the public key below. All clones with SSH are authenticated automatically 🪄.")+"\n",`
`97`	`97`	`)`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ func (r RootCmd) logout() serpent.Command {`
`68`	`68`	`errorString := strings.TrimRight(errorStringBuilder.String(), "\n")`
`69`	`69`	`return xerrors.New("Failed to log out.\n" + errorString)`
`70`	`70`	`}`
`71`		`- _, _ = fmt.Fprintf(inv.Stdout, Caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")`
	`71`	`+ _, _ = fmt.Fprint(inv.Stdout, Caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")`
`72`	`72`	`return nil`
`73`	`73`	`},`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -513,7 +513,7 @@ func (r RootCmd) Server(newAPI func(context.Context, coderd.Options) (*coderd.`
`513`	`513`	`}`
`514`	`514`
`515`	`515`	`accessURL := vals.AccessURL.String()`
`516`		`- cliui.Infof(inv.Stdout, lipgloss.NewStyle().`
	`516`	`+ cliui.Info(inv.Stdout, lipgloss.NewStyle().`
`517`	`517`	`Border(lipgloss.DoubleBorder()).`
`518`	`518`	`Align(lipgloss.Center).`
`519`	`519`	`Padding(0, 3).`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ func (r RootCmd) setArchiveTemplateVersion(archive bool) serpent.Command {`
`76`	`76`	`for _, version := range versions {`
`77`	`77`	`if version.Archived == archive {`
`78`	`78`	`_, _ = fmt.Fprintln(`
`79`		`- inv.Stdout, fmt.Sprintf("Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" already "+pastVerb),`
	`79`	`+ inv.Stdout, "Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" already "+pastVerb,`
`80`	`80`	`)`
`81`	`81`	`continue`
`82`	`82`	`}`
`@@ -87,7 +87,7 @@ func (r RootCmd) setArchiveTemplateVersion(archive bool) serpent.Command {`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`_, _ = fmt.Fprintln(`
`90`		`- inv.Stdout, fmt.Sprintf("Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" "+pastVerb+" at "+cliui.Timestamp(time.Now())),`
	`90`	`+ inv.Stdout, "Version "+pretty.Sprint(cliui.DefaultStyles.Keyword, version.Name)+" "+pastVerb+" at "+cliui.Timestamp(time.Now()),`
`91`	`91`	`)`
`92`	`92`	`}`
`93`	`93`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -100,9 +100,9 @@ func (r WorkspaceProxyReport) Run(ctx context.Context, opts WorkspaceProxyRepo`
`100`	`100`	`for _, err := range errs {`
`101`	`101`	`switch r.Severity {`
`102`	`102`	`case health.SeverityWarning, health.SeverityOK:`
`103`		`- r.Warnings = append(r.Warnings, health.Messagef(health.CodeProxyUnhealthy, err))`
	`103`	`+ r.Warnings = append(r.Warnings, health.Messagef(health.CodeProxyUnhealthy, "%s", err))`
`104`	`104`	`case health.SeverityError:`
`105`		`- r.appendError(*health.Errorf(health.CodeProxyUnhealthy, err))`
	`105`	`+ r.appendError(*health.Errorf(health.CodeProxyUnhealthy, "%s", err))`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`	`}`