address linting issues: update golangci-lint, update deprecated linting settings, fix int -> uint32 potential overflow, fix yaml package requiring yaml struct tags rather than json

Author: d-honeybadger

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ on:
 env:
   # Common versions
   GO_VERSION: '1.23'
-  GOLANGCI_VERSION: 'v1.56.2'
+  GOLANGCI_VERSION: 'v1.64.2'
   DOCKER_BUILDX_VERSION: 'v0.8.2'
 
   # Common users. We can't run a step 'if secrets.AWS_USR != ""' but we can run

.golangci.yml

@@ -1,12 +1,9 @@
 run:
   deadline: 2m
 
-  skip-files:
-  - "zz_generated\\..+\\.go$"
-
 output:
   # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
-  format: colored-line-number
+  formats: colored-line-number
 
 linters-settings:
   errcheck:
@@ -18,14 +15,14 @@ linters-settings:
     # default is false: such cases aren't reported by default.
     check-blank: false
 
-    # [deprecated] comma-separated list of pairs of the form pkg:regex
+    # comma-separated list of pairs of the form pkg:regex
     # the regex is used to ignore names within pkg. (default "fmt:.*").
     # see https://github.com/kisielk/errcheck#the-deprecated-method for details
-    ignore: fmt:.*,io/ioutil:^Read.*
+    exclude-functions: fmt:.*,io/ioutil:^Read.*
 
   govet:
     # report about shadowed variables
-    check-shadowing: false
+    shadow: false
 
   revive:
     # minimal confidence for issues, default is 0.8
@@ -179,6 +176,9 @@ issues:
       - gosec
       - gas
 
+  exclude-files:
+  - "zz_generated\\..+\\.go$"
+
   # Independently from option `exclude` we use default exclude patterns,
   # it can be disabled by this option. To list all
   # excluded by default patterns execute `golangci-lint run --help`.

Makefile

@@ -21,7 +21,7 @@ GO_STATIC_PACKAGES = $(GO_PROJECT)/cmd/provider
 GO_LDFLAGS += -X $(GO_PROJECT)/internal/version.Version=$(VERSION)
 GO_SUBDIRS += cmd internal apis
 GO111MODULE = on
-GOLANGCILINT_VERSION = 1.56.2
+GOLANGCILINT_VERSION = 1.64.2
 RUNNING_IN_CI = true
 -include build/makelib/golang.mk
 

cmd/provider/main.go

@@ -51,7 +51,7 @@ func main() {
 		maxReconcileRate        = app.Flag("max-reconcile-rate", "The maximum number of concurrent reconciliation operations.").Default("1").Int()
 		artifactsHistoryLimit   = app.Flag("artifacts-history-limit", "Each attempt to run the playbook/role generates a set of artifacts on disk. This settings limits how many of these to keep.").Default("10").Int()
 		pollStateMetricInterval = app.Flag("poll-state-metric", "State metric recording interval").Default("5s").Duration()
-		replicasCount           = app.Flag("replicas", "Amount of replicas configured for the provider. When using more than 1 replica, reconciles will be sharded across them based on a modular hash.").Default("1").Int()
+		replicasCount           = app.Flag("replicas", "Amount of replicas configured for the provider. When using more than 1 replica, reconciles will be sharded across them based on a modular hash.").Default("1").Uint32()
 	)
 	kingpin.MustParse(app.Parse(os.Args[1:]))
 

go.mod

@@ -10,13 +10,13 @@ require (
 	github.com/google/uuid v1.6.0
 	github.com/spf13/afero v1.11.0
 	gopkg.in/alecthomas/kingpin.v2 v2.2.6
-	gopkg.in/yaml.v2 v2.4.0
 	gotest.tools/v3 v3.5.1
 	k8s.io/api v0.31.8
 	k8s.io/apimachinery v0.31.8
 	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8
 	sigs.k8s.io/controller-runtime v0.19.7
 	sigs.k8s.io/controller-tools v0.16.5
+	sigs.k8s.io/yaml v1.4.0
 )
 
 require (
@@ -83,6 +83,7 @@ require (
 	google.golang.org/grpc v1.65.0 // indirect
 	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apiextensions-apiserver v0.31.2 // indirect
 	k8s.io/client-go v0.31.2 // indirect
@@ -91,5 +92,4 @@ require (
 	k8s.io/kube-openapi v0.0.0-20240228011516-70dd3763d340 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
-	sigs.k8s.io/yaml v1.4.0 // indirect
 )

internal/controller/ansibleRun/ansibleRun.go

@@ -39,7 +39,6 @@ import (
 	"github.com/crossplane/crossplane-runtime/pkg/statemetrics"
 	"github.com/google/uuid"
 	"github.com/spf13/afero"
-	"gopkg.in/yaml.v2"
 	coordinationv1 "k8s.io/api/coordination/v1"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/equality"
@@ -49,6 +48,7 @@ import (
 	"k8s.io/utils/ptr"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/yaml"
 
 	"github.com/crossplane-contrib/provider-ansible/apis/v1alpha1"
 	"github.com/crossplane-contrib/provider-ansible/internal/ansible"
@@ -109,7 +109,7 @@ type SetupOptions struct {
 	AnsibleRolesPath       string
 	Timeout                time.Duration
 	ArtifactsHistoryLimit  int
-	ReplicasCount          int
+	ReplicasCount          uint32
 	ProviderCtx            context.Context
 	ProviderCancel         context.CancelFunc
 }
@@ -539,11 +539,11 @@ func addBehaviorVars(pc *v1alpha1.ProviderConfig) map[string]string {
 	return behaviorVars
 }
 
-func (c *connector) generateLeaseName(index int) string {
+func (c *connector) generateLeaseName(index uint32) string {
 	return fmt.Sprintf(leaseNameTemplate, index)
 }
 
-func (c *connector) releaseLease(ctx context.Context, kube client.Client, index int) error {
+func (c *connector) releaseLease(ctx context.Context, kube client.Client, index uint32) error {
 	leaseName := c.generateLeaseName(index)
 	ns := "upbound-system"
 
@@ -556,7 +556,7 @@ func (c *connector) releaseLease(ctx context.Context, kube client.Client, index
 
 // Attempts to acquire or renew a lease for the current replica ID
 // Returns an error when unable to obtain the lease
-func (c *connector) acquireLease(ctx context.Context, kube client.Client, index int) error {
+func (c *connector) acquireLease(ctx context.Context, kube client.Client, index uint32) error {
 	lease := &coordinationv1.Lease{}
 	leaseName := c.generateLeaseName(index)
 	leaseDurationSeconds := ptr.To(int32(leaseDurationSeconds))
@@ -613,19 +613,19 @@ func (c *connector) acquireLease(ctx context.Context, kube client.Client, index
 
 // Finds an available shard and acquires a lease for it. Will attempt to obtain one indefinitely.
 // This will also start a background go-routine to renew the lease continuously and release it when the process receives a shutdown signal
-func (c *connector) acquireAndHoldShard(o controller.Options, s SetupOptions) (int, error) {
+func (c *connector) acquireAndHoldShard(o controller.Options, s SetupOptions) (uint32, error) {
 	ctx := s.ProviderCtx
-	currentShard := -1
+	var currentShard uint32
 
 	cfg := ctrl.GetConfigOrDie()
 	kube, err := client.New(cfg, client.Options{})
 	if err != nil {
-		return currentShard, err
+		return 0, err
 	}
 
 AcquireLease:
 	for {
-		for i := 0; i < s.ReplicasCount; i++ {
+		for i := uint32(0); i < s.ReplicasCount; i++ {
 			if err := c.acquireLease(ctx, kube, i); err == nil {
 				currentShard = i
 				o.Logger.Debug("acquired lease", "id", i)

pkg/shardutil/shardutil.go

@@ -9,7 +9,7 @@ import (
 )
 
 // Define a predicate function to filter resources based on consistent hashing
-func IsResourceForShard(targetShard, totalShards int) predicate.Predicate {
+func IsResourceForShard(targetShard, totalShards uint32) predicate.Predicate {
 	return predicate.Funcs{
 		CreateFunc: func(e event.CreateEvent) bool {
 			return isResourceForShardHelper(e.Object, targetShard, totalShards)
@@ -27,13 +27,13 @@ func IsResourceForShard(targetShard, totalShards int) predicate.Predicate {
 }
 
 // Helper function to check if the resource belongs to the current shard
-func isResourceForShardHelper(obj client.Object, targetShard, totalShards int) bool {
+func isResourceForShardHelper(obj client.Object, targetShard, totalShards uint32) bool {
 	// Calculate a hash of the resource name
 	hash := hashString(obj.GetName())
 	// Perform modulo operation to determine the shard
-	shard := hash % uint32(totalShards)
+	shard := hash % totalShards
 	// Check if the shard matches the target shard
-	return int(shard) == targetShard
+	return shard == targetShard
 }
 
 // Helper function to hash a string using FNV-1a