Merge pull request #659 from jetstack/linter_fix

inteon · web-flow · commit 4e2402ce339c · 2025-06-10T13:52:34.000+02:00
golangci-lint spelling linter fixes
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -7,14 +7,12 @@ linters:
     rules:
       - linters:
           - bodyclose
-          - dupword
           - errcheck
           - errchkjson
           - forbidigo
           - gocritic
           - gosec
           - govet
-          - misspell
           - musttag
           - nilerr
           - noctx
diff --git a/api/datareading.go b/api/datareading.go
@@ -15,7 +15,7 @@ type DataReadingsPost struct {
 
 // DataReading is the output of a DataGatherer.
 type DataReading struct {
-	// ClusterID is optional as it can be infered from the agent
+	// ClusterID is optional as it can be inferred from the agent
 	// token when using basic authentication.
 	ClusterID     string      `json:"cluster_id,omitempty"`
 	DataGatherer  string      `json:"data-gatherer"`
diff --git a/cmd/root.go b/cmd/root.go
@@ -43,7 +43,7 @@ func init() {
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
 // If the root command or sub-command returns an error, the error message will
-// will be logged and the process will exit with status 1.
+// be logged and the process will exit with status 1.
 func Execute() {
 	logs.AddFlags(rootCmd.PersistentFlags())
 	ctx := klog.NewContext(context.Background(), klog.Background())
diff --git a/pkg/agent/config.go b/pkg/agent/config.go
@@ -350,7 +350,7 @@ func InitAgentCmdFlags(c *cobra.Command, cfg *AgentCmdFlags) {
 }
 
 // TLSPKMode controls how to authenticate to TLSPK / Jetstack Secure. Only one
-// TLSPKMode may be provided if using using those backends.
+// TLSPKMode may be provided if using those backends.
 type TLSPKMode string
 
 const (
@@ -738,11 +738,11 @@ func validateCredsAndCreateClient(log logr.Logger, flagCredentialsPath, flagClie
 		var creds client.Credentials
 
 		if flagClientID != "" && flagCredentialsPath != "" {
-			errs = multierror.Append(errs, fmt.Errorf("--client-id and --credentials-file cannot be used simultanously"))
+			errs = multierror.Append(errs, fmt.Errorf("--client-id and --credentials-file cannot be used simultaneously"))
 			break
 		}
 		if flagPrivateKeyPath != "" && flagCredentialsPath != "" {
-			errs = multierror.Append(errs, fmt.Errorf("--private-key-path and --credentials-file cannot be used simultanously"))
+			errs = multierror.Append(errs, fmt.Errorf("--private-key-path and --credentials-file cannot be used simultaneously"))
 			break
 		}
 		if flagClientID == "" && flagPrivateKeyPath == "" && flagCredentialsPath == "" {
diff --git a/pkg/agent/config_test.go b/pkg/agent/config_test.go
@@ -634,7 +634,7 @@ func Test_ValidateAndCombineConfig(t *testing.T) {
 		assert.Equal(t, true, got.MachineHubMode)
 	})
 
-	t.Run("machinehub + venafi-cloud-keypair-auth should work simultanously", func(t *testing.T) {
+	t.Run("machinehub + venafi-cloud-keypair-auth should work simultaneously", func(t *testing.T) {
 		t.Setenv("POD_NAMESPACE", "venafi")
 		t.Setenv("KUBECONFIG", withFile(t, fakeKubeconfig))
 		privKeyPath := withFile(t, fakePrivKeyPEM)
diff --git a/pkg/agent/run.go b/pkg/agent/run.go
@@ -111,7 +111,7 @@ func Run(cmd *cobra.Command, args []string) (returnErr error) {
 		}
 
 		// Health check endpoint. Since we haven't figured a good way of knowning
-		// what "ready" means for the agent, we just return 200 OK inconditionally.
+		// what "ready" means for the agent, we just return 200 OK unconditionally.
 		// The goal is to satisfy some Kubernetes distributions, like OpenShift,
 		// that require a liveness and health probe to be present for each pod.
 		log.Info("Healthz endpoints enabled", "path", "/healthz")
diff --git a/pkg/client/client_venconn_test.go b/pkg/client/client_venconn_test.go
@@ -300,6 +300,8 @@ func run_TestVenConnClient_PostDataReadingsWithOptions(ctx context.Context, rest
 //	sub-test-has-special-chars-and-is-also-super-super-super-super-
 //
 // Only the last part of the test name is used.
+//
+// nolint:dupword
 func testNameToNamespace(t testing.TB) string {
 	regex := regexp.MustCompile("[^a-zA-Z0-9-]")
 
diff --git a/pkg/datagatherer/k8s/dynamic.go b/pkg/datagatherer/k8s/dynamic.go
@@ -473,7 +473,7 @@ func RemoveUnstructuredKeys(excludeKeys []*regexp.Regexp, obj *unstructured.Unst
 		return
 	}
 
-	// The field may be nil since yaml.Unmarshal's omitempty might not be set on
+	// The field may be nil since yaml.Unmarshal's omitempty might not be set
 	// on this struct field.
 	if annotsRaw == nil {
 		return
diff --git a/pkg/internal/cyberark/identity/advance_authentication_test.go b/pkg/internal/cyberark/identity/advance_authentication_test.go
@@ -24,7 +24,7 @@ func Test_IdentityAdvanceAuthentication(t *testing.T) {
 				MechanismID:     successMechanismID,
 				SessionID:       successSessionID,
 				TenantID:        "foo",
-				PersistantLogin: true,
+				PersistentLogin: true,
 			},
 
 			expectedError: nil,
@@ -37,7 +37,7 @@ func Test_IdentityAdvanceAuthentication(t *testing.T) {
 				MechanismID:     successMechanismID,
 				SessionID:       successSessionID,
 				TenantID:        "foo",
-				PersistantLogin: true,
+				PersistentLogin: true,
 			},
 
 			expectedError: fmt.Errorf(`got a failure response from request to advance authentication: message="Authentication (login or challenge) has failed. Please try again or contact your system administrator.", error="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:55555555555555555555555555555555"`),
@@ -50,7 +50,7 @@ func Test_IdentityAdvanceAuthentication(t *testing.T) {
 				MechanismID:     successMechanismID,
 				SessionID:       successSessionID,
 				TenantID:        "foo",
-				PersistantLogin: true,
+				PersistentLogin: true,
 			},
 
 			expectedError: fmt.Errorf(`got a failure response from request to advance authentication: message="Authentication (login or challenge) has failed. Please try again or contact your system administrator.", error="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:55555555555555555555555555555555"`),
@@ -63,7 +63,7 @@ func Test_IdentityAdvanceAuthentication(t *testing.T) {
 				MechanismID:     "foo",
 				SessionID:       successSessionID,
 				TenantID:        "foo",
-				PersistantLogin: true,
+				PersistentLogin: true,
 			},
 
 			expectedError: fmt.Errorf(`got a failure response from request to advance authentication: message="Authentication (login or challenge) has failed. Please try again or contact your system administrator.", error="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:55555555555555555555555555555555"`),
@@ -76,20 +76,20 @@ func Test_IdentityAdvanceAuthentication(t *testing.T) {
 				MechanismID:     successMechanismID,
 				SessionID:       "foo",
 				TenantID:        "foo",
-				PersistantLogin: true,
+				PersistentLogin: true,
 			},
 
 			expectedError: fmt.Errorf(`got a failure response from request to advance authentication: message="Authentication (login or challenge) has failed. Please try again or contact your system administrator.", error="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:55555555555555555555555555555555"`),
 		},
-		"persistant login not set": {
+		"persistent login not set": {
 			username: successUser,
 			password: []byte(successPassword),
 			advanceBody: advanceAuthenticationRequestBody{
 				Action:          ActionAnswer,
 				MechanismID:     successMechanismID,
 				SessionID:       successSessionID,
 				TenantID:        "foo",
-				PersistantLogin: false,
+				PersistentLogin: false,
 			},
 
 			expectedError: fmt.Errorf("got unexpected status code 403 Forbidden from request to advance authentication in CyberArk Identity API"),
diff --git a/pkg/internal/cyberark/identity/identity.go b/pkg/internal/cyberark/identity/identity.go
@@ -156,9 +156,9 @@ type advanceAuthenticationRequestBody struct {
 	// get the Identity API URL, but we set it anyway to be explicit.
 	TenantID string `json:"TenantId"`
 
-	// PersistantLogin is documented to "[indicate] whether the session should persist after the user
+	// PersistentLogin is documented to "[indicate] whether the session should persist after the user
 	// closes the browser"; for service-to-service auth which we're trying to do, we set this to true.
-	PersistantLogin bool `json:"PersistantLogin"`
+	PersistentLogin bool `json:"PersistentLogin"`
 }
 
 // advanceAuthenticationResponseResult is the specific information returned for a successful AdvanceAuthentication call
@@ -370,7 +370,7 @@ func (c *Client) doStartAuthentication(ctx context.Context, username string) (ad
 	response.MechanismID = mechanism.MechanismID
 	response.SessionID = startAuthResponse.Result.SessionID
 	response.TenantID = c.subdomain
-	response.PersistantLogin = true
+	response.PersistentLogin = true
 
 	return response, nil
 }
diff --git a/pkg/internal/cyberark/identity/mock.go b/pkg/internal/cyberark/identity/mock.go
@@ -189,11 +189,11 @@ func (mis *mockIdentityServer) handleAdvanceAuthentication(w http.ResponseWriter
 	// Important: The actual server will return 200 OK even if the login fails.
 	// Most failure responses should copy that.
 
-	if !advanceBody.PersistantLogin {
+	if !advanceBody.PersistentLogin {
 		// this is something we enforce but wouldn't actually be an error from
 		// a real server, so we return a different error here
 		w.WriteHeader(http.StatusForbidden)
-		_, _ = w.Write([]byte(`expected PersistantLogin to be true`))
+		_, _ = w.Write([]byte(`expected PersistentLogin to be true`))
 		return
 	}
 
diff --git a/pkg/internal/cyberark/identity/start_authentication_test.go b/pkg/internal/cyberark/identity/start_authentication_test.go
@@ -88,8 +88,8 @@ func Test_IdentityStartAuthentication(t *testing.T) {
 				t.Errorf("expected advanceAuthenticationRequestBody.Action to be %s but got %s", ActionAnswer, advanceBody.Action)
 			}
 
-			if !advanceBody.PersistantLogin {
-				t.Error("expected advanceAuthenticationRequestBody.PersistantLogin to be true but it wasn't")
+			if !advanceBody.PersistentLogin {
+				t.Error("expected advanceAuthenticationRequestBody.PersistentLogin to be true but it wasn't")
 			}
 
 		})

Original file line number	Diff line number	Diff line change
`@@ -350,7 +350,7 @@ func InitAgentCmdFlags(c cobra.Command, cfg AgentCmdFlags) {`
`350`	`350`	`}`
`351`	`351`
`352`	`352`	`// TLSPKMode controls how to authenticate to TLSPK / Jetstack Secure. Only one`
`353`		`-// TLSPKMode may be provided if using using those backends.`
	`353`	`+// TLSPKMode may be provided if using those backends.`
`354`	`354`	`type TLSPKMode string`
`355`	`355`
`356`	`356`	`const (`
`@@ -738,11 +738,11 @@ func validateCredsAndCreateClient(log logr.Logger, flagCredentialsPath, flagClie`
`738`	`738`	`var creds client.Credentials`
`739`	`739`
`740`	`740`	`if flagClientID != "" && flagCredentialsPath != "" {`
`741`		`- errs = multierror.Append(errs, fmt.Errorf("--client-id and --credentials-file cannot be used simultanously"))`
	`741`	`+ errs = multierror.Append(errs, fmt.Errorf("--client-id and --credentials-file cannot be used simultaneously"))`
`742`	`742`	`break`
`743`	`743`	`}`
`744`	`744`	`if flagPrivateKeyPath != "" && flagCredentialsPath != "" {`
`745`		`- errs = multierror.Append(errs, fmt.Errorf("--private-key-path and --credentials-file cannot be used simultanously"))`
	`745`	`+ errs = multierror.Append(errs, fmt.Errorf("--private-key-path and --credentials-file cannot be used simultaneously"))`
`746`	`746`	`break`
`747`	`747`	`}`
`748`	`748`	`if flagClientID == "" && flagPrivateKeyPath == "" && flagCredentialsPath == "" {`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ func Run(cmd *cobra.Command, args []string) (returnErr error) {`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`// Health check endpoint. Since we haven't figured a good way of knowning`
`114`		`- // what "ready" means for the agent, we just return 200 OK inconditionally.`
	`114`	`+ // what "ready" means for the agent, we just return 200 OK unconditionally.`
`115`	`115`	`// The goal is to satisfy some Kubernetes distributions, like OpenShift,`
`116`	`116`	`// that require a liveness and health probe to be present for each pod.`
`117`	`117`	`log.Info("Healthz endpoints enabled", "path", "/healthz")`
Original file line number	Diff line number	Diff line change
`@@ -473,7 +473,7 @@ func RemoveUnstructuredKeys(excludeKeys []regexp.Regexp, obj unstructured.Unst`
`473`	`473`	`return`
`474`	`474`	`}`
`475`	`475`
`476`		`- // The field may be nil since yaml.Unmarshal's omitempty might not be set on`
	`476`	`+ // The field may be nil since yaml.Unmarshal's omitempty might not be set`
`477`	`477`	`// on this struct field.`
`478`	`478`	`if annotsRaw == nil {`
`479`	`479`	`return`