Add golanglint-ci for static checking (#13)

* Add golanglint-ci for static checking
* update delete-artifact action to latest version

Author: ranyodh

.github/workflows/PR.yml

@@ -11,13 +11,13 @@ on:
 jobs:
   vet:
     uses: ./.github/workflows/vet.yml
-  check-generated-code:
-    uses: ./.github/workflows/check-generated-code.yml
   unit-test:
     uses: ./.github/workflows/unit.yml
+  lint:
+    uses: ./.github/workflows/lint.yml
   build:
     if: ${{ always() && contains(join(needs.*.result, ','), 'success') }} # if all `needs` jobs are successful
-    needs: [vet, check-generated-code, unit-test]
+    needs: [vet, unit-test, lint]
     secrets: inherit
     uses: ./.github/workflows/build.yml
   cleanup:

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
           env-file: .github/development.env
 
       - name: Setup Go ${{ env.GO_VERSION }}
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ env.GO_VERSION }}
 
@@ -31,7 +31,7 @@ jobs:
         run: docker save ${{ env.REGISTRY }}/${{ env.ORG }}/${{ env.IMAGE }}:dev -o /tmp/${{ env.IMAGE }}.tar
 
       - name: Upload image artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ env.IMAGE }}
           retention-days: 1

.github/workflows/check-generated-code.yml

@@ -18,7 +18,6 @@ jobs:
           env-file: .github/development.env
 
       - name: Delete artifacts
-        uses: geekyeggo/delete-artifact@v4
+        uses: geekyeggo/delete-artifact@v5
         with:
           name: ${{ env.IMAGE }}
-          token: ${{ secrets.PAT_CI_BOUNDLESS }}

.github/workflows/cleanup.yml

@@ -0,0 +1,21 @@
+name: golangci-lint
+
+on:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.61.0

.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
           env-file: .github/development.env
 
       - name: Setup Go ${{ env.GO_VERSION }}
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ env.GO_VERSION }}
 

.github/workflows/unit.yml

@@ -18,7 +18,7 @@ jobs:
           env-file: .github/development.env
 
       - name: Setup Go ${{ env.GO_VERSION }}
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ env.GO_VERSION }}
 

.github/workflows/vet.yml

@@ -0,0 +1,14 @@
+linters:
+  # Disable all linters.
+  # Default: false
+  disable-all: true
+  # Enable specific linter
+  # https://golangci-lint.run/usage/linters/#enabled-by-default
+  enable:
+    - bodyclose
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused

.golangci.yml

@@ -1,10 +1,9 @@
 MAIN:=cmd/main.go
 
 # LDFLAGS
-VERSION:=
-#VERSION := $(shell git tag --sort=committerdate | tail -1)
-COMMIT := $(shell git rev-parse HEAD)
-DATE := $(shell date -u '+%Y-%m-%d')
+VERSION ?= dev
+COMMIT ?= $(shell git rev-parse HEAD)
+DATE ?= $(shell date -u '+%Y-%m-%d')
 
 LDFLAGS := "-X 'main.version=${VERSION}' \
 			-X 'main.commit=${COMMIT}' \
@@ -18,7 +17,7 @@ help: ## Display this help.
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
 .PHONY: all
-all: fmt vet build ## Do all the things
+all: fmt vet lint build ## Do all the things
 
 .PHONY: print-%
 print-%:
@@ -28,7 +27,7 @@ print-%:
 
 .PHONY: buf
 buf: ## Run buf lint and breaking change checks
-	@buf generate
+	@go run github.com/bufbuild/buf/cmd/[email protected] generate
 
 .PHONY: build
 build: ## Build the binary
@@ -80,12 +79,18 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	@go vet ${MAIN}
 
+.PHONY: lint
+lint: ## Run golangci-lint against code.
+	@go run github.com/golangci/golangci-lint/cmd/[email protected] run
+
 ##@ Dependencies
 .PHONY: download
 download:
 	@echo "Download go.mod dependencies"
 	@go mod download
 
+
+
 .PHONY: install-tools
 install-tools: download
 	@echo "Install tools from tools/tools.go"

Makefile

@@ -56,7 +56,7 @@ make install-tools
 **buf cli**
 
 ```bash
-curl https://github.com/bufbuild/buf/releases/download/v1.35.1/buf-Linux-x86_64 -o buf
+curl https://github.com/bufbuild/buf/releases/download/v1.43.0/buf-Linux-x86_64 -o buf
 chmod +x buf
 sudo mv buf /usr/local/bin
 ```

README.md

@@ -16,11 +16,12 @@ const (
 	dexKeysURL   = "http://authentication-dex:5556/dex/keys"
 
 	dexClientName = "mke-dashboard"
-
-	// userInfoCtxKey is the key used to store the user information in the request context.
-	userInfoCtxKey = "userInfoKey"
 )
 
+// userInfoCtxKey is the key used to store the user information in the request context.
+
+type userInfoKey struct{}
+
 // user contains the user information extracted from the ID token claims.
 type user struct {
 	email  string
@@ -57,7 +58,7 @@ func authenticationMiddleware() runtime.Middleware {
 			log.Debug().Msg("Authenticated user: " + u.email)
 
 			// Attach user information to the request context for next middlewares to use
-			ctx := context.WithValue(r.Context(), userInfoCtxKey, u)
+			ctx := context.WithValue(r.Context(), userInfoKey{}, u)
 
 			next(w, r.WithContext(ctx), pathParams)
 		}

internal/middlewares/authn.go

@@ -41,7 +41,7 @@ func authorizationMiddleware() runtime.Middleware {
 			log.Debug().Msg("Authorizing request")
 
 			// get user info from the context
-			u := r.Context().Value(userInfoCtxKey)
+			u := r.Context().Value(userInfoKey{})
 			if u == nil {
 				log.Error().Err(fmt.Errorf("failed to get user info from context"))
 				http.Error(w, "Internal Server Error", http.StatusInternalServerError)

internal/middlewares/authz.go

@@ -21,8 +21,17 @@ const (
 func LoadTLSConfig(certDir string) (*tls.Config, error) {
 	log.Info().Msgf("Loading TLS configuration from %s", certDir)
 	ca, err := readFile(path.Join(certDir, caCertFile))
+	if err != nil {
+		return nil, fmt.Errorf("unable to read CA crt from file %s: %w", path.Join(certDir, caCertFile), err)
+	}
 	cert, err := readFile(path.Join(certDir, certFile))
+	if err != nil {
+		return nil, fmt.Errorf("unable to read client crt from file %s: %w", path.Join(certDir, certFile), err)
+	}
 	key, err := readFile(path.Join(certDir, keyFile))
+	if err != nil {
+		return nil, fmt.Errorf("unable to read client key from file %s: %w", path.Join(certDir, keyFile), err)
+	}
 
 	cPool := x509.NewCertPool()
 	if !cPool.AppendCertsFromPEM(ca) {