From 774e2efce877a09e80782ff5f94bcf584f6f8f30 Mon Sep 17 00:00:00 2001
From: Nick DeLuca <nickdeluca08@gmail.com>
Date: Mon, 5 Aug 2024 10:13:17 -0700
Subject: [PATCH] chore(lint): Update local make lint to match CI (#1991)

* chore(lint): Update local make lint to match CI

This updates the `make lint` behavior to match the command being
run in CI.

In addition, we refactor the make lint command to use docker in order to
to ease cross platform install, use a local build cache that integrates
with make clean, use the same version file, and encapsulate the logic in
its own make include.

We also remove the old lint logic as to not introduce a duplicate target
and avoid confusion from a difference in behavior.

While solutions like act for running github actions locally work, it is
not as straightfoward, is slower, and uses the local git repository
instead of a clone (though I am not sure how the checkout step works
within act).

* fix(lint): Use shared timeout with .golangci.yml

Instead of using a local and different timeout in the lint makefile
target we can rely on golangci to load this configuration from
.golangci.yml instead and share this setting with CI.

* fix(lint): Fix golangci-lint cache mount path

This uses the correct cache dir default of ~/.cache enabling use
of cache between lint calls.

* fix(lint): Fix lint caching

This includes a couple fixes - 1) It adds support for full caching of go
mod and go build, speeding up the lint process quite a bit.  And 2) does
not mix lint cache with make clean files -- the docker container creates
root owned files that cause make clean to error and we choose not to
require make clean to run with higher permissions.  The cache must be
deleted manually.
---
 .gitignore    |  3 +++
 Makefile      | 11 +++--------
 build/lint.mk | 45 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 51 insertions(+), 8 deletions(-)
 create mode 100644 build/lint.mk

diff --git a/.gitignore b/.gitignore
index a2a2088c2e..e647197ef8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,6 +31,9 @@ out
 # Ignore build cache dir
 build/.cache
 
+# Ignore make lint cache
+build/.golangci-lint
+
 # Ignore installed binaires
 build/bin
 
diff --git a/Makefile b/Makefile
index 83202ee0e5..73363ee32a 100644
--- a/Makefile
+++ b/Makefile
@@ -101,6 +101,8 @@ include $(BUILD_DIR)/deps.mk
 include $(BUILD_DIR)/proto.mk
 include $(BUILD_DIR)/proto-deps.mk
 
+include $(BUILD_DIR)/lint.mk
+
 #export GO111MODULE = on
 # process build tags
 build_tags = netgo
@@ -229,13 +231,6 @@ link-check:
 	@$(GO_BIN) get -u github.com/raviqqe/liche@f57a5d1c5be4856454cb26de155a65a4fd856ee3
 	liche -r . --exclude "^http://127.*|^https://riot.im/app*|^http://kava-testnet*|^https://testnet-dex*|^https://kava3.data.kava.io*|^https://ipfs.io*|^https://apps.apple.com*|^https://kava.quicksync.io*"
 
-
-lint:
-	golangci-lint run
-	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" | xargs gofmt -d -s
-	$(GO_BIN) mod verify
-.PHONY: lint
-
 format:
 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -name '*.pb.go' | xargs gofmt -w -s
 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -name '*.pb.go' | xargs misspell -w
@@ -356,4 +351,4 @@ update-kvtool:
 	git submodule update
 	cd tests/e2e/kvtool && make install
 
-.PHONY: all build-linux install clean build test test-cli test-all test-rest test-basic test-fuzz start-remote-sims
+.PHONY: all build-linux install build test test-cli test-all test-rest test-basic test-fuzz start-remote-sims
diff --git a/build/lint.mk b/build/lint.mk
new file mode 100644
index 0000000000..905ee22dee
--- /dev/null
+++ b/build/lint.mk
@@ -0,0 +1,45 @@
+################################################################################
+###                             Required Variables                           ###
+################################################################################
+ifndef DOCKER
+$(error DOCKER not set)
+endif
+
+ifndef BUILD_DIR
+$(error BUILD_DIR not set)
+endif
+
+################################################################################
+###                             Lint Settings                                ###
+################################################################################
+
+LINT_FROM_REV ?= $(shell git merge-base origin/master HEAD)
+
+GOLANGCI_VERSION ?= $(shell cat .golangci-version)
+GOLANGCI_IMAGE_TAG ?= golangci/golangci-lint:$(GOLANGCI_VERSION)
+
+GOLANGCI_DIR ?= $(CURDIR)/$(BUILD_DIR)/.golangci-lint
+
+GOLANGCI_CACHE_DIR ?= $(GOLANGCI_DIR)/$(GOLANGCI_VERSION)-cache
+GOLANGCI_MOD_CACHE_DIR ?= $(GOLANGCI_DIR)/go-mod
+
+################################################################################
+###                             Lint Target                                  ###
+################################################################################
+
+.PHONY: lint
+lint: $(GOLANGCI_CACHE_DIR) $(GOLANGCI_MOD_CACHE_DIR)
+	@echo "Running lint from rev $(LINT_FROM_REV), use LINT_FROM_REV var to override."
+	$(DOCKER) run -t --rm \
+		-v $(GOLANGCI_CACHE_DIR):/root/.cache \
+		-v $(GOLANGCI_MOD_CACHE_DIR):/go/pkg/mod \
+		-v $(CURDIR):/app \
+		-w /app \
+		$(GOLANGCI_IMAGE_TAG) \
+		golangci-lint run -v --new-from-rev $(LINT_FROM_REV)
+
+$(GOLANGCI_CACHE_DIR):
+	@mkdir -p $@
+
+$(GOLANGCI_MOD_CACHE_DIR):
+	@mkdir -p $@