feat: making updates to linting, docs and hooks

benjivesterby · benjivesterby · commit d4ef23bde86d · 2024-11-15T10:21:34.000-05:00
diff --git a/.cz.yaml b/.cz.yaml
@@ -0,0 +1,48 @@
+commitizen:
+  name: cz_customize
+  customize:
+    message_template: "{{change_type}}:{% if show_message %} {{message}}{% endif %}"
+    example: 'feature: this feature enable customize through config file'
+    schema: "<type>: <body>"
+    schema_pattern: "(feature|bug fix):(\\s.*)"
+    bump_pattern: "^(break|new|fix|hotfix)"
+    commit_parser: "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?"
+    changelog_pattern: "^(feature|bug fix)?(!)?"
+    change_type_map:
+      feature: Feat
+      bug fix: Fix
+    bump_map:
+      break: MAJOR
+      new: MINOR
+      fix: PATCH
+      hotfix: PATCH
+    change_type_order: ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"]
+    info_path: cz_customize_info.txt
+    info: This is customized info
+    questions:
+    - type: list
+      name: change_type
+      choices:
+      - value: feat
+        name: 'feat: A new feature.'
+      - value: fix
+        name: 'fix: A bug fix.'
+      - value: refactor
+        name: 'refactor: A code change that neither fixes a bug nor adds a feature.'
+      - value: perf
+        name: 'perf: A code change that improves performance.'
+      - value: test
+        name: 'test: Adding missing tests or correcting existing tests.'
+      - value: docs
+        name: 'docs: Documentation only changes.'
+      - value: chore
+        name: 'chore: Changes that don''t modify src or test files.'
+      - value: cicd
+        name: 'cicd: Changes to CI/CD configuration files and scripts.'
+      message: Select the type of change you are committing
+    - type: input
+      name: message
+      message: Body.
+    - type: confirm
+      name: show_message
+      message: Do you want to add body message in commit?
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,13 +14,33 @@ repos:
             '--exclude-files',
             '(_test\.go$|/testdata/)',
             ]
-  -   repo: https://github.com/sqlfluff/sqlfluff 
-      rev: 3.2.4
-      hooks:
-      -   id: sqlfluff-fix
+  - repo: https://github.com/mrtazz/checkmake.git
+    rev: 0.2.2
+    hooks:
+    -   id: checkmake
   -   repo: https://github.com/pre-commit/pre-commit-hooks
       rev: v5.0.0
       hooks:
       -   id: check-json
       -   id: check-merge-conflict
       -   id: check-yaml
+      -   id: end-of-file-fixer
+      -   id: check-symlinks
+  - repo: https://github.com/markdownlint/markdownlint
+    rev: v0.12.0
+    hooks:
+    -   id: markdownlint
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v3.30.1
+    hooks:
+      - id: commitizen
+      - id: commitizen-branch
+        stages: [push]
+  - repo: local
+    hooks:
+      - id: makefile
+        name: Run Makefile Lint
+        entry: make
+        args: [pre-commit]
+        language: system
+        pass_filenames: false
diff --git a/.secrets.baseline b/.secrets.baseline
@@ -1,5 +1,5 @@
 {
-  "version": "1.1.2",
+  "version": "1.5.0",
   "plugins_used": [
     {
       "name": "ArtifactoryDetector"
@@ -72,10 +72,18 @@
     {
       "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
     },
+    {
+      "path": "detect_secrets.filters.common.is_baseline_file",
+      "filename": ".secrets.baseline"
+    },
     {
       "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
       "min_level": 2
     },
+    {
+      "path": "detect_secrets.filters.gibberish.should_exclude_secret",
+      "limit": 3.7
+    },
     {
       "path": "detect_secrets.filters.heuristic.is_indirect_reference"
     },
@@ -99,8 +107,14 @@
     },
     {
       "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    },
+    {
+      "path": "detect_secrets.filters.regex.should_exclude_file",
+      "pattern": [
+        "(_test\\.go/testdata/)"
+      ]
     }
   ],
   "results": {},
-  "generated_at": "2021-12-19T18:30:03Z"
+  "generated_at": "2024-11-15T15:19:50Z"
 }
diff --git a/Makefile b/Makefile
@@ -5,35 +5,29 @@ all: build tidy lint fmt test
 # ------------------------------------------------------------------------
 env=CGO_ENABLED=1
 op= op run --env-file="./.env" -- 
+SHELL := $(shell which bash)
+fuzzsh=https://raw.githubusercontent.com/devnw/workflows/refs/heads/main/fuzz.sh
+
+pre-commit: update upgrade tidy fmt lint build test
 
 test: 
 	CGO_ENABLED=1 go test -v -cover -failfast -race ./...
 
 fuzz:
-	@fuzzTime=$${FUZZ_TIME:-10}; \
-	files=$$(grep -r --include='**_test.go' --files-with-matches 'func Fuzz' .); \
-	for file in $$files; do \
-		funcs=$$(grep -o 'func Fuzz\w*' $$file | sed 's/func //'); \
-		for func in $$funcs; do \
-			echo "Fuzzing $$func in $$file"; \
-			parentDir=$$(dirname $$file); \
-			go test $$parentDir -run=$$func -fuzz=$$func -fuzztime=$${fuzzTime}s; \
-			if [ $$? -ne 0 ]; then \
-				echo "Fuzzing $$func in $$file failed"; \
-				exit 1; \
-			fi; \
-		done; \
-	done
+	curl -fsSL $(fuzzsh) | $(SHELL)
 
 bench:
 	go test -bench=. -benchmem ./...
 
 test-all: test fuzz
 
-lint: 
+fmt: 
+	nixfmt flake.nix
 	goimports -w .
+	gofmt -s -w .
+
+lint: 
 	golangci-lint run
-	pre-commit run --all-files	
 
 gomod2nix:
 	gomod2nix generate
@@ -51,17 +45,11 @@ upgrade:
 update:
 	git submodule update --recursive
 
-fmt:
-	gofmt -s -w .
-
 tidy: fmt
 	go mod tidy
 
 release: 
-	if [ -z "$(tag)" ]; then \
-		echo "tag is required"; \
-		exit 1; \
-	fi
+	if [ -z "$(tag)" ]; then echo "tag is required"; exit 1; fi
 	git tag -a ${tag} -m "${tag}"
 	git push origin ${tag}
 
@@ -102,4 +90,4 @@ FORCE:
 # Phony targets
 #-------------------------------------------------------------------------
 
-.PHONY: build test lint fuzz
+.PHONY: build test lint fuzz all clean FORCE
diff --git a/README.md b/README.md
@@ -1,12 +1,10 @@
-# Bridgekeeper - What is your (Re)Quest?
-
-## HTTP Request Limiter and Retrier
+# Bridgekeeper - HTTP Request Limiter and Retrier
 
 [![Build & Test](https://github.com/devnw/bridgekeeper/actions/workflows/build.yml/badge.svg)](https://github.com/devnw/bridgekeeper/actions/workflows/build.yml)
 [![Go Reference](https://pkg.go.dev/badge/go.devnw.com/bk/v2.svg)](https://pkg.go.dev/go.devnw.com/bk)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-### Using Bridgekeeper
+## Using Bridgekeeper
 
 ```go
 go get -u go.devnw.com/bk/v2@latest
@@ -29,6 +27,7 @@ go get -u go.devnw.com/bk/v2@latest
         log.Fatal(err)
     }
 ```
+
 ### HTTP Round Tripper Example
 
 ```go
diff --git a/bk.go b/bk.go
@@ -109,7 +109,7 @@ func (k *Keeper) handleRequest(req *requestWrapper) {
 
 	// Execute a call against the endpoint handling any potential panics from
 	// the http client
-	resp, err := k.execute(req)
+	resp, err := k.execute(req) //nolint:bodyclose // upstream responsibility
 	if resp == nil {
 		select {
 		case <-req.ctx.Done():
diff --git a/bk_mocks_test.go b/bk_mocks_test.go
@@ -24,7 +24,7 @@ func (client *httpclient) RoundTrip(r *http.Request) (*http.Response, error) {
 	return client.Do(r)
 }
 
-func (client *httpclient) Do(r *http.Request) (*http.Response, error) {
+func (client *httpclient) Do(*http.Request) (*http.Response, error) {
 	if client.delay > 0 {
 		time.Sleep(client.delay)
 	}
@@ -46,8 +46,8 @@ func (client *httpclient) Do(r *http.Request) (*http.Response, error) {
 
 type fakeReadCloser struct{}
 
-func (rc *fakeReadCloser) Read(p []byte) (n int, err error) { return 0, io.EOF }
-func (rc *fakeReadCloser) Close() error                     { return nil }
+func (rc *fakeReadCloser) Read([]byte) (int, error) { return 0, io.EOF }
+func (rc *fakeReadCloser) Close() error             { return nil }
 
 type badclient struct {
 	panic       bool
@@ -63,7 +63,7 @@ func (client *badclient) RoundTrip(r *http.Request) (*http.Response, error) {
 	return client.Do(r)
 }
 
-func (client *badclient) Do(r *http.Request) (*http.Response, error) {
+func (client *badclient) Do(*http.Request) (*http.Response, error) {
 	if client.panic {
 		panic("panic")
 	}
@@ -75,11 +75,7 @@ type tstruct struct {
 	error bool
 }
 
-func (t *tstruct) correct(err error, paniced bool) error {
-	if paniced {
-		return errors.New("unexpected panic")
-	}
-
+func (t *tstruct) correct(err error, _ bool) error {
 	if t.error && err == nil {
 		return errors.New("expected error but success instead")
 	}
diff --git a/bk_test.go b/bk_test.go
@@ -14,7 +14,7 @@ type tcase struct {
 	success tstruct
 }
 
-func cases(t *testing.T, req func() *http.Request) map[string]tcase {
+func cases(_ *testing.T, req func() *http.Request) map[string]tcase {
 	return map[string]tcase{
 		"ValidWValidClient": {
 			&httpclient{
diff --git a/bk_test_rt.go b/bk_test_rt.go
diff --git a/flake.nix b/flake.nix
@@ -55,6 +55,8 @@
           automake
           act
           gcc
+          ruby
+          commitizen
 
           python
 
diff --git a/go.mod b/go.mod
@@ -2,6 +2,6 @@ module go.devnw.com/bk/v2
 
 go 1.23
 
-retract v2.0.1
+retract v2.0.1 // retracted because of botched release
 
-retract v2.0.0
+retract v2.0.0 // retracted because of botched release

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "version": "1.1.2",`
	`2`	`+ "version": "1.5.0",`
`3`	`3`	`"plugins_used": [`
`4`	`4`	`{`
`5`	`5`	`"name": "ArtifactoryDetector"`
`@@ -72,10 +72,18 @@`
`72`	`72`	`{`
`73`	`73`	`"path": "detect_secrets.filters.allowlist.is_line_allowlisted"`
`74`	`74`	`},`
	`75`	`+ {`
	`76`	`+ "path": "detect_secrets.filters.common.is_baseline_file",`
	`77`	`+ "filename": ".secrets.baseline"`
	`78`	`+ },`
`75`	`79`	`{`
`76`	`80`	`"path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",`
`77`	`81`	`"min_level": 2`
`78`	`82`	`},`
	`83`	`+ {`
	`84`	`+ "path": "detect_secrets.filters.gibberish.should_exclude_secret",`
	`85`	`+ "limit": 3.7`
	`86`	`+ },`
`79`	`87`	`{`
`80`	`88`	`"path": "detect_secrets.filters.heuristic.is_indirect_reference"`
`81`	`89`	`},`
`@@ -99,8 +107,14 @@`
`99`	`107`	`},`
`100`	`108`	`{`
`101`	`109`	`"path": "detect_secrets.filters.heuristic.is_templated_secret"`
	`110`	`+ },`
	`111`	`+ {`
	`112`	`+ "path": "detect_secrets.filters.regex.should_exclude_file",`
	`113`	`+ "pattern": [`
	`114`	`+ "(_test\\.go/testdata/)"`
	`115`	`+ ]`
`102`	`116`	`}`
`103`	`117`	`],`
`104`	`118`	`"results": {},`
`105`		`- "generated_at": "2021-12-19T18:30:03Z"`
	`119`	`+ "generated_at": "2024-11-15T15:19:50Z"`
`106`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ func (client httpclient) RoundTrip(r http.Request) (*http.Response, error) {`
`24`	`24`	`return client.Do(r)`
`25`	`25`	`}`
`26`	`26`
`27`		`-func (client httpclient) Do(r http.Request) (*http.Response, error) {`
	`27`	`+func (client httpclient) Do(http.Request) (*http.Response, error) {`
`28`	`28`	`if client.delay > 0 {`
`29`	`29`	`time.Sleep(client.delay)`
`30`	`30`	`}`
`@@ -46,8 +46,8 @@ func (client httpclient) Do(r http.Request) (*http.Response, error) {`
`46`	`46`
`47`	`47`	`type fakeReadCloser struct{}`
`48`	`48`
`49`		`-func (rc *fakeReadCloser) Read(p []byte) (n int, err error) { return 0, io.EOF }`
`50`		`-func (rc *fakeReadCloser) Close() error { return nil }`
	`49`	`+func (rc *fakeReadCloser) Read([]byte) (int, error) { return 0, io.EOF }`
	`50`	`+func (rc *fakeReadCloser) Close() error { return nil }`
`51`	`51`
`52`	`52`	`type badclient struct {`
`53`	`53`	`panic bool`
`@@ -63,7 +63,7 @@ func (client badclient) RoundTrip(r http.Request) (*http.Response, error) {`
`63`	`63`	`return client.Do(r)`
`64`	`64`	`}`
`65`	`65`
`66`		`-func (client badclient) Do(r http.Request) (*http.Response, error) {`
	`66`	`+func (client badclient) Do(http.Request) (*http.Response, error) {`
`67`	`67`	`if client.panic {`
`68`	`68`	`panic("panic")`
`69`	`69`	`}`
`@@ -75,11 +75,7 @@ type tstruct struct {`
`75`	`75`	`error bool`
`76`	`76`	`}`
`77`	`77`
`78`		`-func (t *tstruct) correct(err error, paniced bool) error {`
`79`		`- if paniced {`
`80`		`- return errors.New("unexpected panic")`
`81`		`- }`
`82`		`-`
	`78`	`+func (t *tstruct) correct(err error, _ bool) error {`
`83`	`79`	`if t.error && err == nil {`
`84`	`80`	`return errors.New("expected error but success instead")`
`85`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ type tcase struct {`
`14`	`14`	`success tstruct`
`15`	`15`	`}`
`16`	`16`
`17`		`-func cases(t testing.T, req func() http.Request) map[string]tcase {`
	`17`	`+func cases(_ testing.T, req func() http.Request) map[string]tcase {`
`18`	`18`	`return map[string]tcase{`
`19`	`19`	`"ValidWValidClient": {`
`20`	`20`	`&httpclient{`