misc: lint and format ci/cd (#196)

Added a CI/CD workflow to lint and format the code.

Author: sudomateo

.github/workflows/lint-fmt.yaml

@@ -0,0 +1,44 @@
+---
+on:
+  pull_request: {}
+
+name: Lint & Format
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v5
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Lint
+        run: make lint
+
+  fmt:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v5
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Format
+        run: make fmt
+
+      - name: Check for Changes
+        run: |
+          if ! git diff --quiet --exit-code; then
+            echo "::error::Code is not formatted. Run 'make fmt' and commit the result."
+            git diff
+            exit 1
+          fi

.golangci.yaml

@@ -0,0 +1,32 @@
+---
+version: "2"
+
+linters:
+  default: standard
+  enable:
+    - godoclint
+    - unparam
+  disable:
+    - errcheck
+  settings:
+    godoclint:
+      default-rule-set: basic
+      rules:
+        - max-len
+      options:
+        max-len:
+          length: 100
+
+formatters:
+  enable:
+    - goimports
+    - golines
+  settings:
+    golines:
+      max-len: 100
+      shorten-comments: true
+  exclusions:
+    generated: disable
+
+run:
+  timeout: 5m

Makefile

@@ -72,3 +72,13 @@ helm-package: helm-set-version
 helm-push: helm-package
 	$(HELM) push $(IMAGE_NAME)-$(patsubst v%,%,$(VERSION)).tgz \
 		$(HELM_CHART_REGISTRY)
+
+.PHONY: fmt
+fmt:
+	@ echo "+ Formatting Go code..."
+	@ go tool -modfile tools/go.mod golangci-lint fmt
+
+.PHONY: lint
+lint:
+	@ echo "+ Running Go linters..."
+	@ go tool -modfile tools/go.mod golangci-lint run

internal/provider/instances_v2.go

@@ -1,6 +1,7 @@
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
 package provider
 
 import (
@@ -55,7 +56,10 @@ func (i *InstancesV2) InstanceExists(ctx context.Context, node *v1.Node) (bool,
 
 // InstanceMetadata populates the metadata for the provided node, notably
 // setting its provider ID.
-func (i *InstancesV2) InstanceMetadata(ctx context.Context, node *v1.Node) (*cloudprovider.InstanceMetadata, error) {
+func (i *InstancesV2) InstanceMetadata(
+	ctx context.Context,
+	node *v1.Node,
+) (*cloudprovider.InstanceMetadata, error) {
 	ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
 	defer cancel()
 
@@ -73,9 +77,12 @@ func (i *InstancesV2) InstanceMetadata(ctx context.Context, node *v1.Node) (*clo
 		return nil, fmt.Errorf("failed viewing oxide instance: %v", err)
 	}
 
-	nics, err := i.client.InstanceNetworkInterfaceList(ctx, oxide.InstanceNetworkInterfaceListParams{
-		Instance: oxide.NameOrId(instanceID),
-	})
+	nics, err := i.client.InstanceNetworkInterfaceList(
+		ctx,
+		oxide.InstanceNetworkInterfaceListParams{
+			Instance: oxide.NameOrId(instanceID),
+		},
+	)
 	if err != nil {
 		return nil, fmt.Errorf("failed listing instance network interfaces: %v", err)
 	}

internal/provider/provider.go

@@ -1,6 +1,7 @@
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
 package provider
 
 import (
@@ -44,7 +45,10 @@ type Oxide struct {
 
 // Initialize creates the Oxide and Kubernetes clients and spawns any additional
 // controllers, if necessary.
-func (o *Oxide) Initialize(clientBuilder cloudprovider.ControllerClientBuilder, stop <-chan struct{}) {
+func (o *Oxide) Initialize(
+	clientBuilder cloudprovider.ControllerClientBuilder,
+	stop <-chan struct{},
+) {
 	kubernetesClient, err := clientBuilder.Client(Name)
 	if err != nil {
 		klog.Fatalf("failed to create kubernetes client: %v", err)

internal/provider/provider_test.go

@@ -1,6 +1,7 @@
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
 package provider
 
 import (
@@ -31,11 +32,20 @@ func TestInstanceIDFromProviderID(t *testing.T) {
 			t.Run(tc.name, func(t *testing.T) {
 				result, err := InstanceIDFromProviderID(tc.providerID)
 				if err != nil {
-					t.Errorf("TestInstanceIDFromProviderID(%s) returned non-nil error %v, want nil error", tc.providerID, err)
+					t.Errorf(
+						"TestInstanceIDFromProviderID(%s) returned non-nil error %v, want nil error",
+						tc.providerID,
+						err,
+					)
 				}
 
 				if result != tc.expected {
-					t.Errorf("TestInstanceIDFromProviderID(%s) returned %s, want %s", tc.providerID, result, tc.expected)
+					t.Errorf(
+						"TestInstanceIDFromProviderID(%s) returned %s, want %s",
+						tc.providerID,
+						result,
+						tc.expected,
+					)
 				}
 			})
 		}
@@ -83,11 +93,19 @@ func TestInstanceIDFromProviderID(t *testing.T) {
 			t.Run(tc.name, func(t *testing.T) {
 				_, err := InstanceIDFromProviderID(tc.providerID)
 				if err == nil {
-					t.Errorf("TestInstanceIDFromProviderID(%s) returned nil error, want non-nil error", tc.providerID)
+					t.Errorf(
+						"TestInstanceIDFromProviderID(%s) returned nil error, want non-nil error",
+						tc.providerID,
+					)
 				}
 
 				if !strings.Contains(err.Error(), tc.errorMsg) {
-					t.Errorf("TestInstanceIDFromProviderID(%s) returned error %v, want %s", tc.providerID, err.Error(), tc.errorMsg)
+					t.Errorf(
+						"TestInstanceIDFromProviderID(%s) returned error %v, want %s",
+						tc.providerID,
+						err.Error(),
+						tc.errorMsg,
+					)
 				}
 			})
 		}