refactor ci; add mockery

Author: moukoublen

.github/workflows/go.yml renamed to .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Go
+name: CI
 
 on:
   push:
@@ -40,21 +40,27 @@ jobs:
         restore-keys: |
           ci-tools-${{ runner.os }}-${{ runner.arch }}
 
-    - name: go mod verify
-      run: go mod verify
-
-    - name: version of make
-      run: make --version
-
-    - name: env
-      run: make env
-
     - name: Install Tools
       if: steps.cache-tools.outputs.cache-hit != 'true'
       run: make tools
 
-    - name: Checks
-      run: make checks
+    - name: env
+      run: |
+        make --version
+        echo ''
+        make env
+
+    - name: ci-gen-n-format
+      run: make ci-gen-n-format
+
+    - name: ci-mod
+      run: make ci-mod
+
+    - name: staticcheck
+      run: make staticcheck
+
+    - name: golangci-lint
+      run: make golangci-lint-github-actions
 
     - name: Build
       run: make build

.mockery.yml

@@ -0,0 +1,14 @@
+# https://vektra.github.io/mockery/latest/configuration/
+
+packages:
+  github.com/moukoublen/goboilerplate:
+    config:
+      all: true
+      recursive: true
+      exclude: [vendor]
+      with-expecter: true
+      filename: mock_{{ .InterfaceName | snakecase }}_test.go
+      mockname: Mock{{ .InterfaceName | firstUpper }}
+      dir: "{{ .InterfaceDir }}"
+      #outpkg: "mocks"
+      inpackage: true

Makefile

@@ -166,3 +166,11 @@ checks: vet staticcheck gofumpt goimports golangci-lint-github-actions
 .PHONY: run
 run: $(TOOLS_BIN)/gojq
 	$(GO_EXEC) run -mod=vendor ./cmd/goboilerplate | $(TOOLS_BIN)/gojq
+
+.PHONY: ci-format
+ci-format: goimports gofumpt
+	./scripts/git-check-dirty
+
+.PHONY: ci-mod
+ci-mod: mod
+	./scripts/git-check-dirty

doc.go

@@ -0,0 +1 @@
+package goboilerplate

go.mod

@@ -26,6 +26,7 @@ require (
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/objx v0.5.2 // indirect
 	golang.org/x/sys v0.25.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -45,6 +45,8 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
 github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
 github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
+github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

internal/httpx/mock_inner_client_test.go

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+
+set -e
+
+# https://git-scm.com/docs/git-status
+
+if [ -n "$(git status --porcelain)" ]; then
+  echo "new or modified files"
+  echo ""
+
+  git status --short --branch --untracked-files=all --ahead-behind
+  exit 1
+fi

internal/mock_daemon_config_option_test.go

@@ -82,27 +82,11 @@ $(TOOLS_BIN)/goimports: $(TOOLS_DB)/goimports.$(GOIMPORTS_VER).$(GO_VER).ver
 
 .PHONY: goimports
 goimports: $(TOOLS_BIN)/goimports
-	@echo '$(TOOLS_BIN)/goimports -l `$(GO_FILES)`'
-	@if [[ -n "$$($(TOOLS_BIN)/goimports -l `$(GO_FILES)` | tee /dev/stderr)" ]]; then \
-		echo 'goimports errors'; \
-		echo ''; \
-		echo -e "\e[0;34m→\e[0m To display the needed changes run:"; \
-		echo '    make goimports.display'; \
-		echo ''; \
-		echo -e "\e[0;34m→\e[0m To fix them run:"; \
-		echo '    make goimports.fix'; \
-		echo ''; \
-		exit 1; \
-	fi
-	@echo ''
+	$(TOOLS_BIN)/goimports -w `$(GO_FILES)`
 
 .PHONY: goimports.display
 goimports.display: $(TOOLS_BIN)/goimports
-	$(TOOLS_BIN)/goimports -d `$(GO_FOLDERS)`
-
-.PHONY: goimports.fix
-goimports.fix: $(TOOLS_BIN)/goimports
-	$(TOOLS_BIN)/goimports -w `$(GO_FOLDERS)`
+	$(TOOLS_BIN)/goimports -d `$(GO_FILES)`
 ## </goimports>
 
 ## <gofumpt>
@@ -114,53 +98,21 @@ $(TOOLS_BIN)/gofumpt: $(TOOLS_DB)/gofumpt.$(GOFUMPT_VER).$(GO_VER).ver
 
 .PHONY: gofumpt
 gofumpt: $(TOOLS_BIN)/gofumpt
-	@echo '$(TOOLS_BIN)/gofumpt -l `$(GO_FOLDERS)`'
-	@if [[ -n "$$($(TOOLS_BIN)/gofumpt -l `$(GO_FOLDERS)` | tee /dev/stderr)" ]]; then \
-		echo 'gofumpt errors'; \
-		echo ''; \
-		echo -e "\e[0;34m→\e[0m To display the needed changes run:"; \
-		echo '    make gofumpt.display'; \
-		echo ''; \
-		echo -e "\e[0;34m→\e[0m To fix them run:"; \
-		echo '    make gofumpt.fix'; \
-		echo ''; \
-		exit 1; \
-	fi
-	@echo ''
+	$(TOOLS_BIN)/gofumpt -w `$(GO_FILES)`
 
 .PHONY: gofumpt.display
 gofumpt.display:
-	$(TOOLS_BIN)/gofumpt -d `$(GO_FOLDERS)`
-
-.PHONY: gofumpt.fix
-gofumpt.fix:
-	$(TOOLS_BIN)/gofumpt -w `$(GO_FOLDERS)`
+	$(TOOLS_BIN)/gofumpt -d `$(GO_FILES)`
 ## </gofumpt>
 
 ## <gofmt>
 .PHONY: gofmt
 gofmt:
-	@echo 'gofmt -l `$(GO_FOLDERS)`'
-	@if [[ -n "$$(gofmt -l `$(GO_FOLDERS)` | tee /dev/stderr)" ]]; then \
-		echo 'gofmt errors'; \
-		echo ''; \
-		echo -e "\e[0;34m→\e[0m To display the needed changes run:"; \
-		echo '    make gofmt.display'; \
-		echo ''; \
-		echo -e "\e[0;34m→\e[0m To fix them run:"; \
-		echo '    make gofmt.fix'; \
-		echo ''; \
-		exit 1; \
-	fi
-	@echo ''
+	gofmt -w `$(GO_FILES)`
 
 .PHONY: gofmt.display
 gofmt.display:
-	gofmt -d `$(GO_FOLDERS)`
-
-.PHONY: gofmt.fix
-gofmt.fix:
-	gofmt -w `$(GO_FOLDERS)`
+	gofmt -d `$(GO_FILES)`
 ## </gofmt>
 
 ## <gojq>
@@ -186,6 +138,19 @@ air: $(TOOLS_BIN)/air
 	@exec $(TOOLS_BIN)/air -c .air.toml
 ## </air>
 
+## <mockery>
+# https://github.com/vektra/mockery/releases
+MOCKERY_CMD:=github.com/vektra/mockery/v2
+MOCKERY_VER:=v2.45.1
+$(TOOLS_BIN)/mockery: $(TOOLS_DB)/mockery.$(MOCKERY_VER).$(GO_VER).ver
+	$(call go_install,air,$(MOCKERY_CMD),$(MOCKERY_VER))
+
+.PHONY: mockery
+mockery: $(TOOLS_BIN)/mockery
+	grep --recursive --files-with-matches '// Code generated by mockery' . | grep -v 'scripts/tools.mk' | grep -v 'bin/mockery' | xargs rm || true
+	mockery --config=.mockery.yml
+## </mockery>
+
 ## <protobuf>
 # https://github.com/protocolbuffers/protobuf/releases
 PROTOC_VER:=v27.3