fix(Makefile): adapt Makefile and golangci lint

Makefile

@@ -1,85 +1,114 @@
+EXECUTABLE=prometheus-fail2ban-exporter
+VERSION?=$(shell git describe --abbrev=0)+hash.$(shell git rev-parse --short HEAD)
+
+# Destination directory and prefix to place the compiled binaries, documentaions
+# and other files.
 DESTDIR?=
 PREFIX?=/usr/local
-EXECUTABLE?=prometheus-fail2ban-exporter
 
+# CONTAINER_RUNTIME
+# The CONTAINER_RUNTIME variable will be used to specified the path to a
+# container runtime. This is needed to start and run a container image.
 CONTAINER_RUNTIME?=$(shell which podman)
 
-# List make commands
+# PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_NAME
-.PHONY: ls
+# Defines the name of the new container to be built using several variables.
-ls:
+PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_NAME:=git.cryptic.systems
-	cat Makefile | grep "^[a-zA-Z#].*" | cut -d ":" -f 1 | sed s';#;\n#;'g
+PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_USER:=volker.raschek
 
-# Run project tests
+PROM_FAIL2BAN_EXP_IMAGE_NAMESPACE?=${PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_USER}
-.PHONY: test
+PROM_FAIL2BAN_EXP_IMAGE_NAME:=${EXECUTABLE}
-test:
+PROM_FAIL2BAN_EXP_IMAGE_VERSION?=latest
-	GONOSUMDB=${GONOSUMDB} \
+PROM_FAIL2BAN_EXP_IMAGE_FULLY_QUALIFIED=${PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_NAME}/${PROM_FAIL2BAN_EXP_IMAGE_NAMESPACE}/${PROM_FAIL2BAN_EXP_IMAGE_NAME}:${PROM_FAIL2BAN_EXP_IMAGE_VERSION}
-	GOPROXY=${GOPROXY} \
-		go test ./... -v -race
 
-# Look for "suspicious constructs" in source code
+# BIN
-.PHONY: vet
+# ==============================================================================
-vet:
+prometheus-fail2ban-exporter:
-	GONOSUMDB=${GONOSUMDB} \
+	CGO_ENABLED=0 \
-	GOPROXY=${GOPROXY} \
+	GOPROXY=$(shell go env GOPROXY) \
-		go vet ./...
+		go build -ldflags "-X 'main.version=${VERSION}' -X 'main.date=$(shell date --rfc-3339=seconds )'" -o ${@} main.go
 
-# Format code
+# CLEAN
-.PHONY: fmt
+# ==============================================================================
-fmt:
+PHONY+=clean
-	GONOSUMDB=${GONOSUMDB} \
+clean:
-	GOPROXY=${GOPROXY} \
+	rm --force --recursive prometheus-fail2ban-exporter
-		go mod tidy
 
-	GONOSUMDB=${GONOSUMDB} \
+# TESTS
-	GOPROXY=${GOPROXY} \
+# ==============================================================================
-		go fmt ./...
+PHONY+=test/unit
+test/unit:
+	CGO_ENABLED=0 \
+	GOPROXY=$(shell go env GOPROXY) \
+		go test -v -p 1 -coverprofile=coverage.txt -covermode=count -timeout 1200s ./pkg/...
 
-# Check for unformatted go code
+PHONY+=test/integration
-.PHONY: check/fmt
+test/integration:
-check/fmt:
+	CGO_ENABLED=0 \
-	test -z $(shell gofmt -l .)
+	GOPROXY=$(shell go env GOPROXY) \
+		go test -v -p 1 -count=1 -timeout 1200s ./it/...
 
-# Build project
+PHONY+=test/coverage
-.PHONY: build
+test/coverage: test/unit
-build:
+	CGO_ENABLED=0 \
-	CGO_ENABLED=0
+	GOPROXY=$(shell go env GOPROXY) \
-	GONOSUMDB=${GONOSUMDB} \
+		go tool cover -html=coverage.txt
-	GOPROXY=${GOPROXY} \
-		go build \
-			-ldflags "\
-				-X main.version=${shell git describe --tags} \
-				-X main.commit=${shell git rev-parse HEAD} \
-				-X main.date=${shell date --iso-8601=seconds} \
-				-X main.builtBy=manual \
-			" \
-			-trimpath \
-			-o ${EXECUTABLE} \
-			exporter.go
 
-# build container-image
+# GOLANGCI-LINT
-.PHONY: build/container-image
+# ==============================================================================
-build/container-image:
+PHONY+=golangci-lint
+golangci-lint:
+	golangci-lint run --concurrency=$(shell nproc)
+
+# INSTALL
+# ==============================================================================
+PHONY+=uninstall
+install: prometheus-fail2ban-exporter
+	install --directory ${DESTDIR}/etc/bash_completion.d
+	./prometheus-fail2ban-exporter completion bash > ${DESTDIR}/etc/bash_completion.d/${EXECUTABLE}
+
+	install --directory ${DESTDIR}${PREFIX}/bin
+	install --mode 0755 ${EXECUTABLE} ${DESTDIR}${PREFIX}/bin/${EXECUTABLE}
+
+	install --directory ${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE}
+	install --mode 0644 LICENSE ${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE}/LICENSE
+
+# UNINSTALL
+# ==============================================================================
+PHONY+=uninstall
+uninstall:
+	-rm --force --recursive \
+		${DESTDIR}/etc/bash_completion.d/${EXECUTABLE} \
+		${DESTDIR}${PREFIX}/bin/${EXECUTABLE} \
+		${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE}
+
+# BUILD CONTAINER IMAGE
+# ==============================================================================
+PHONY+=container-image/build
+container-image/build:
 	${CONTAINER_RUNTIME} build \
-		--tag ${EXECUTABLE} \
+		--build-arg VERSION=${VERSION} \
+		--file Dockerfile \
+		--no-cache \
+		--pull \
+		--tag ${PROM_FAIL2BAN_EXP_IMAGE_FULLY_QUALIFIED} \
 		.
 
-.PHONY: install
+# DELETE CONTAINER IMAGE
-install: build
+# ==============================================================================
-	mkdir --parents ${DESTDIR}/usr/lib/systemd/system
+PHONY:=container-image/delete
-	sed -e "s/EXECUTABLE/${EXECUTABLE}/gm" systemd/systemd.service > ${DESTDIR}/usr/lib/systemd/system/${EXECUTABLE}.service
+container-image/delete:
-	chmod 0644 ${DESTDIR}/usr/lib/systemd/system/${EXECUTABLE}.service
+	- ${CONTAINER_RUNTIME} image rm ${PROM_FAIL2BAN_EXP_IMAGE_FULLY_QUALIFIED}
 
-	install -D --mode 0755 --target-directory ${DESTDIR}${PREFIX}/bin ${EXECUTABLE}
+# PUSH CONTAINER IMAGE
+# ==============================================================================
+PHONY+=container-image/push
+container-image/push:
+	echo ${PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_PASSWORD} | ${CONTAINER_RUNTIME} login ${PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_NAME} --username ${PROM_FAIL2BAN_EXP_IMAGE_REGISTRY_USER} --password-stdin
+	${CONTAINER_RUNTIME} push ${PROM_FAIL2BAN_EXP_IMAGE_FULLY_QUALIFIED}
 
-# NOTE: Set restrict file permissions by default to protect optional basic auth credentials
+# PHONY
-	install -D --mode 0600 env ${DESTDIR}/etc/conf.d/${EXECUTABLE}
+# ==============================================================================
-
+# Declare the contents of the PHONY variable as phony.  We keep that information
-	install -D --mode 0755 --target-directory ${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE} LICENSE
+# in a variable so we can use it in if_changed.
-
+.PHONY: ${PHONY}
-.PHONY: uninstall
-uninstall:
-	-rm --recursive --force \
-		${DESTDIR}${PREFIX}/bin/${EXECUTABLE} \
-		${DESTDIR}/usr/lib/systemd/system/${EXECUTABLE}.service \
-		${DESTDIR}/etc/conf.d/${EXECUTABLE} \
-		${DESTDIR}${PREFIX}/share/licenses/${EXECUTABLE}/LICENSE

cfg/cfg.go

@@ -74,7 +74,7 @@ func validateFlags(cliCtx *kong.Context) {
 		}
 	}
 	if !flagsValid {
-		cliCtx.PrintUsage(false)
+		_ = cliCtx.PrintUsage(false)
 		fmt.Println()
 		for i := 0; i < len(messages); i++ {
 			fmt.Println(messages[i])

collector/f2b/collector.go

@@ -50,7 +50,7 @@ func (c *Collector) Collect(ch chan<- prometheus.Metric) {
 			os.Exit(1)
 		}
 	} else {
-		defer s.Close()
+		defer func() { _ = s.Close() }()
 	}
 
 	c.collectServerUpMetric(ch, s)