WIP: testing docker linter

.github/workflows/main.yml

@@ -24,7 +24,7 @@ env:
 
 jobs:
   ########################
-  # Format, compileation and lint check
+  # Format, compilation, and lint check
   ########################
   lint-check:
     name: Format, compilation and lint check

Makefile

@@ -3,9 +3,10 @@ PKG := github.com/btcsuite/btcwallet
 LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint
 GOACC_PKG := github.com/ory/go-acc
 GOIMPORTS_PKG := golang.org/x/tools/cmd/goimports
+TOOLS_DIR := tools
 
+GOPATH := $(shell go env GOPATH)
 GO_BIN := ${GOPATH}/bin
-LINT_BIN := $(GO_BIN)/golangci-lint
 GOACC_BIN := $(GO_BIN)/go-acc
 
 LINT_COMMIT := v1.46.0
@@ -31,7 +32,10 @@ ifneq ($(workers),)
 LINT_WORKERS = --concurrency=$(workers)
 endif
 
-LINT = $(LINT_BIN) run -v $(LINT_WORKERS)
+DOCKER_TOOLS = docker run \
+  -v $(shell bash -c "go env GOCACHE || (mkdir -p /tmp/go-cache; echo /tmp/go-cache)"):/tmp/build/.cache \
+  -v $(shell bash -c "go env GOMODCACHE || (mkdir -p /tmp/go-modcache; echo /tmp/go-modcache)"):/tmp/build/.modcache \
+  -v $$(pwd):/build btcwallet-tools
 
 GREEN := "\\033[0;32m"
 NC := "\\033[0m"
@@ -104,6 +108,10 @@ unit-race:
 # UTILITIES
 # =========
 
+docker-tools:
+	@$(call print, "Building tools docker image.")
+	docker build -q -t btcwallet-tools $(TOOLS_DIR)
+
 #? fmt: Fix imports and formatting source
 fmt: goimports
 	@$(call print, "Fixing imports.")
@@ -112,9 +120,9 @@ fmt: goimports
 	gofmt -l -w -s $(GOFILES_NOVENDOR)
 
 #? lint: Lint source
-lint: $(LINT_BIN)
+lint: docker-tools
 	@$(call print, "Linting source.")
-	$(LINT)
+	$(DOCKER_TOOLS) golangci-lint run -v $(LINT_WORKERS)
 
 #? clean: Clean source
 clean:

chain/interface.go

@@ -39,6 +39,7 @@ type Interface interface {
 	GetBlock(*chainhash.Hash) (*wire.MsgBlock, error)
 	GetBlockHash(int64) (*chainhash.Hash, error)
 	GetBlockHeader(*chainhash.Hash) (*wire.BlockHeader, error)
+	GetBlockHeight(*chainhash.Hash) (int32, error)
 	IsCurrent() bool
 	FilterBlocks(*FilterBlocksRequest) (*FilterBlocksResponse, error)
 	BlockStamp() (*waddrmgr.BlockStamp, error)

tools/Dockerfile

@@ -0,0 +1,17 @@
+FROM golang:1.19.13-bookworm
+
+RUN apt-get update && apt-get install -y git
+ENV GOCACHE=/tmp/build/.cache
+ENV GOMODCACHE=/tmp/build/.modcache
+
+COPY . /tmp/tools
+
+RUN cd /tmp \
+  && mkdir -p /tmp/build/.cache \
+  && mkdir -p /tmp/build/.modcache \
+  && cd /tmp/tools \
+  && go install -trimpath github.com/golangci/golangci-lint/cmd/[email protected] \
+  && chmod -R 777 /tmp/build/ \
+  && git config --global --add safe.directory /build
+
+WORKDIR /build

tools/check-go-version-dockerfile.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# Function to check if the Dockerfile contains only the specified Go version
+check_go_version() {
+    local dockerfile="$1"
+    local required_go_version="$2"
+
+    # Use grep to find lines with 'FROM golang:'
+    local go_lines=$(grep -i '^FROM golang:' "$dockerfile")
+
+    # Check if all lines have the required Go version
+    if echo "$go_lines" | grep -q -v "$required_go_version"; then
+        echo "Error: $dockerfile does not use Go version $required_go_version exclusively."
+        exit 1
+    else
+        echo "$dockerfile is using Go version $required_go_version."
+    fi
+}
+
+# Check if the target Go version argument is provided
+if [ $# -eq 0 ]; then
+    echo "Usage: $0 <target_go_version>"
+    exit 1
+fi
+
+target_go_version="$1"
+
+# We find target files using the 'find' command in conjunction with the 'read'
+# command. We exclude some directories from the search.
+#
+# We use the 'read' command to help ensure that we correctly handle filenames
+# with spaces, newlines, and special characters. The '-print0' option in 'find'
+# outputs filenames separated by a null character. This allows the 'read'
+# command in the while loop to accurately distinguish each filename. The
+# 'target_files' array is then populated, preserving the integrity of each
+# filename. This approach ensures safe handling of filenames, regardless of
+# their complexity.
+while IFS= read -r -d '' file; do
+    target_files+=("$file")
+done < <(find . \
+    -path ./vendor -prune -o \
+    -type f \
+    \( -name "*.Dockerfile" -o -name "Dockerfile" \) \
+    -print0 \
+)
+
+# Check for the expected Go version in each file.
+for file in "${target_files[@]}"; do
+    check_go_version "$file" "$target_go_version"
+done
+
+
+echo "All Dockerfiles pass the Go version check for Go version $target_go_version."

tools/check-go-version-yaml.sh

@@ -0,0 +1,63 @@
+#!/bin/bash
+
+# Function to check if the YAML file contains the specified Go version after 'GO_VERSION:'
+check_go_version() {
+    local yamlfile="$1"
+    local required_go_version="$2"
+
+    # Use grep to find lines with 'GO_VERSION:'
+    local go_lines=$(grep -i 'GO_VERSION:' "$yamlfile" || true)  # Ignore grep exit status
+
+    # Check if any lines specify the Go version
+    if [ -n "$go_lines" ]; then
+        # Extract the Go version from the file's lines. Example matching strings:
+        # GO_VERSION: "1.21.0"
+        # GO_VERSION: '1.21.0'
+        # GO_VERSION: 1.21.0
+        # GO_VERSION:1.21.0
+        #   GO_VERSION:1.21.0
+        local extracted_go_version=$(echo "$go_lines" | sed -n 's/^[[:space:]]*GO_VERSION:[[:space:]]*\(['\''"]\?\)\?\([0-9]\+\.[0-9]\+\.[0-9]\+\)\(['\''"]\?\)\?/\2/p')
+
+        # Check if the extracted Go version matches the required version
+        if [ "$extracted_go_version" != "$required_go_version" ]; then
+            echo "Error: $yamlfile specifies Go version '$extracted_go_version', but not version '$required_go_version'."
+            exit 1
+        else
+            echo "$yamlfile specifies Go version $required_go_version."
+        fi
+    fi
+}
+
+# Check if the target Go version argument is provided
+if [ $# -eq 0 ]; then
+    echo "Usage: $0 <target_go_version>"
+    exit 1
+fi
+
+target_go_version="$1"
+
+# We find target files using the 'find' command in conjunction with the 'read'
+# command. We exclude some directories from the search.
+#
+# We use the 'read' command to help ensure that we correctly handle filenames
+# with spaces, newlines, and special characters. The '-print0' option in 'find'
+# outputs filenames separated by a null character. This allows the 'read'
+# command in the while loop to accurately distinguish each filename. The
+# 'target_files' array is then populated, preserving the integrity of each
+# filename. This approach ensures safe handling of filenames, regardless of
+# their complexity.
+while IFS= read -r -d '' file; do
+    target_files+=("$file")
+done < <(find . \
+    -path ./vendor -prune -o \
+    -type f \
+    \( -name "*.yaml" -o -name "*.yml" \) \
+    -print0 \
+)
+
+# Check for the expected Go version in each file.
+for file in "${target_files[@]}"; do
+    check_go_version "$file" "$target_go_version"
+done
+
+echo "All YAML files pass the Go version check for Go version $target_go_version."

wallet/mock.go

@@ -42,6 +42,10 @@ func (m *mockChainClient) GetBlockHeader(*chainhash.Hash) (*wire.BlockHeader,
 	return nil, nil
 }
 
+func (m *mockChainClient) GetBlockHeight(*chainhash.Hash) (int32, error) {
+	return 0, nil
+}
+
 func (m *mockChainClient) IsCurrent() bool {
 	return false
 }