Merge commit '406106aa376469ad0b95b81cc729511269498b2d' into feat/testing-framework

Author: ldmonster

.github/workflows/test.yml

@@ -1,15 +1,12 @@
 name: Test
-
 on:
   pull_request:
     types: [opened]
   push:
-    branches-ignore: [ main ]
-
+    branches-ignore: [main]
 env:
-  GO_VERSION: '1.24'
-  GOLANGCI_LINT_VERSION: 'v2.1'
-
+  GO_VERSION: '1.26.1'
+  GOLANGCI_LINT_VERSION: 'v2.11.4'
 jobs:
   # Check if there is any dirty change for go mod tidy
   go-mod:
@@ -24,7 +21,6 @@ jobs:
           go mod tidy
           git diff --exit-code go.mod
           git diff --exit-code go.sum
-
   go-test:
     needs: go-mod
     runs-on: ubuntu-latest
@@ -34,7 +30,6 @@ jobs:
         with:
           go-version: ${{ env.GO_VERSION }}
       - run: go test ./... -race
-
   golangci-lint:
     needs: go-test
     runs-on: ubuntu-latest
@@ -46,7 +41,6 @@ jobs:
       - uses: golangci/golangci-lint-action@v8
         with:
           version: ${{ env.GOLANGCI_LINT_VERSION }}
-
   detect-modules: # ref: https://github.com/golangci/golangci-lint-action/tree/main
     needs: [golangci-lint, go-test, go-mod]
     runs-on: ubuntu-latest
@@ -65,8 +59,7 @@ jobs:
           name: go_work
           path: go.work
       - id: set-modules
-        run: echo "modules=$(go list -m -json | jq -s '.' | jq -c '[.[].Dir]')" >> $GITHUB_OUTPUT
-
+        run: echo "modules=$(go work edit -json | jq -c '[.Use[].DiskPath]')" >> $GITHUB_OUTPUT
   go-mod-examples:
     needs: [detect-modules]
     runs-on: ubuntu-latest
@@ -86,7 +79,6 @@ jobs:
           git diff --exit-code go.mod
           git diff --exit-code go.sum
         working-directory: ${{ matrix.modules }}
-
   go-test-examples:
     needs: [detect-modules, go-mod-examples]
     runs-on: ubuntu-latest
@@ -105,7 +97,6 @@ jobs:
           name: go_work
       - run: go test ./...
         working-directory: ${{ matrix.modules }}
-
   golangci-lint-examples:
     needs: [detect-modules, go-test-examples]
     runs-on: ubuntu-latest

.golangci.yaml

@@ -67,6 +67,20 @@ linters:
       checks:
         - all
         - '-QF1008' # not need to fix; we understand how to call nested structs
+    revive:
+      rules:
+        - name: var-naming # waiting for package name will be fixed (incorrect naming)
+          severity: warning
+          disabled: false
+          exclude: [""]
+          arguments:
+            - ["ID"] # AllowList
+            - ["VM"] # DenyList
+            - - skip-initialism-name-checks: false
+                upper-case-const: false
+                skip-package-name-checks: true
+                skip-package-name-collision-with-go-std: false
+                extra-bad-package-names: []
   exclusions:
     generated: lax
     presets:

Makefile

@@ -1,31 +1,8 @@
-GO=$(shell which go)
-GIT=$(shell which git)
-GOLANGCI_LINT=$(shell which golangci-lint)
-
-.PHONY: go-check
-go-check:
-	$(call error-if-empty,$(GO),go)
-
-.PHONY: git-check
-git-check:
-	$(call error-if-empty,$(GIT),git)
-
-.PHONY: golangci-lint-check
-golangci-lint-check:
-	$(call error-if-empty,$(GIT),git)
 
 .PHONY: go-module-version
 go-module-version: go-check git-check
 	@echo "go get $(shell $(GO) list ./pkg/app)@$(shell $(GIT) rev-parse HEAD)"
 
-.PHONY: test
-test: go-check
-	@$(GO) test --race --cover ./...
-
-.PHONY: lint
-lint: golangci-lint-check
-	@$(GOLANGCI_LINT) run ./... --fix
-
 .PHONY: examples
 examples: go-check examples-mod examples-test examples-lint
 	@echo "Running examples tests and linting"
@@ -46,12 +23,106 @@ examples-test: go-check
 	done
 
 .PHONY: examples-lint
-examples-lint: golangci-lint-check
+examples-lint: golangci-lint
 	@for dir in $$(find . -mindepth 2 -name go.mod | sed -r 's/(.*)(go.mod)/\1/g'); do \
 		echo "Running linter in $${dir}"; \
 		cd $(CURDIR)/$${dir} && $(GOLANGCI_LINT) run ./... --fix && cd $(CURDIR); \
 	done
 
+.PHONY: lint
+lint: golangci-lint ## Run linter.
+	@$(GOLANGCI_LINT) run --fix
+
+.PHONY: test
+test: go-check
+	@$(GO) test --race --cover ./...
+
+## Run all generate-* jobs in bulk.
+.PHONY: generate
+generate: update-workflows-go-version update-workflows-golangci-lint-version
+
+
+##@ Dependencies
+
+WHOAMI ?= $(shell whoami)
+
+## Location to install dependencies to
+LOCALBIN ?= $(shell pwd)/bin
+$(LOCALBIN):
+	mkdir -p $(LOCALBIN)
+
+## Tool Binaries
+GO=$(shell which go)
+GIT=$(shell which git)
+GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
+YQ = $(LOCALBIN)/yq
+
+## TODO: remap in yaml file (version.yaml or smthng)
+## Tool Versions
+# GO_BUILDER_VERSION must be without 'v' prefix
+GO_BUILDER_VERSION = 1.26.1
+GOLANGCI_LINT_VERSION = v2.11.4
+YQ_VERSION ?= v4.50.1
+
+
+.PHONY: update-workflows-go-version
+update-workflows-go-version: yq
+	for file in $$(find .github/workflows -name "*.yaml" -o -name "*.yml"); do \
+		if grep -q "actions/setup-go" $$file; then \
+			$(YQ) -i '(.env.GO_VERSION) = "$(GO_BUILDER_VERSION)"' $$file; \
+		fi; \
+	done
+	echo "Updated go-version in workflow files to $(GO_BUILDER_VERSION)"
+
+.PHONY: update-workflows-golangci-lint-version
+update-workflows-golangci-lint-version: yq
+	for file in $$(find .github/workflows -name "*.yaml" -o -name "*.yml"); do \
+		if grep -q "golangci/golangci-lint-action" $$file; then \
+			$(YQ) -i '(.env.GOLANGCI_LINT_VERSION) = "$(GOLANGCI_LINT_VERSION)"' $$file; \
+		fi; \
+	done
+	echo "Updated golangci-lint version in workflow files to $(GOLANGCI_LINT_VERSION)"
+
+## Installed tools check
+
+.PHONY: go-check
+go-check:
+	$(call error-if-empty,$(GO),go)
+
+.PHONY: git-check
+git-check:
+	$(call error-if-empty,$(GIT),git)
+
+## Tool installations
+
+.PHONY: golangci-lint
+golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
+$(GOLANGCI_LINT): $(LOCALBIN)
+	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+.PHONY: yq
+yq: $(YQ) ## Download yq locally if necessary.
+$(YQ): $(LOCALBIN)
+	$(call go-install-tool,$(YQ),github.com/mikefarah/yq/v4,$(YQ_VERSION))
+
+
+# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
+# $1 - target path with name of binary
+# $2 - package url which can be installed
+# $3 - specific version of package
+define go-install-tool
+@[ -f "$(1)-$(3)" ] || { \
+set -e; \
+package=$(2)@$(3) ;\
+echo "Downloading $${package}" ;\
+rm -f $(1) || true ;\
+GOBIN=$(LOCALBIN) GOTOOLCHAIN=$(GO_TOOLCHAIN_AUTOINSTALL_VERSION) go install $${package} ;\
+mv $(1) $(1)-$(3) ;\
+} ;\
+ln -sf $(1)-$(3) $(1)
+endef
+
+
 define error-if-empty
 @if [[ -z $(1) ]]; then echo "$(2) not installed"; false; fi
-endef
+endef