format code with golines

bakito · bakito · commit f89fe8d8a52a · 2024-12-23T09:42:04.000+01:00
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -9,7 +9,6 @@ linters:
   - durationcheck
   - errcheck
   - errorlint
-  - exportloopref
   - gci
   - gofmt
   - gofumpt
diff --git a/.toolbox.mk b/.toolbox.mk
@@ -10,29 +10,41 @@ $(TB_LOCALBIN):
 
 ## Tool Binaries
 TB_GINKGO ?= $(TB_LOCALBIN)/ginkgo
+TB_GOFUMPT ?= $(TB_LOCALBIN)/gofumpt
 TB_GOLANGCI_LINT ?= $(TB_LOCALBIN)/golangci-lint
+TB_GOLINES ?= $(TB_LOCALBIN)/golines
 TB_GORELEASER ?= $(TB_LOCALBIN)/goreleaser
 TB_HELM_DOCS ?= $(TB_LOCALBIN)/helm-docs
 TB_MOCKGEN ?= $(TB_LOCALBIN)/mockgen
 TB_SEMVER ?= $(TB_LOCALBIN)/semver
 
 ## Tool Versions
-TB_GINKGO_VERSION ?= v2.20.2
-TB_GOLANGCI_LINT_VERSION ?= v1.61.0
-TB_GORELEASER_VERSION ?= v2.3.2
+TB_GINKGO_VERSION ?= v2.22.1
+TB_GOFUMPT_VERSION ?= v0.7.0
+TB_GOLANGCI_LINT_VERSION ?= v1.62.2
+TB_GOLINES_VERSION ?= v0.12.2
+TB_GORELEASER_VERSION ?= v2.5.0
 TB_HELM_DOCS_VERSION ?= v1.14.2
-TB_MOCKGEN_VERSION ?= v0.4.0
+TB_MOCKGEN_VERSION ?= v0.5.0
 TB_SEMVER_VERSION ?= v1.1.3
 
 ## Tool Installer
 .PHONY: tb.ginkgo
 tb.ginkgo: $(TB_GINKGO) ## Download ginkgo locally if necessary.
 $(TB_GINKGO): $(TB_LOCALBIN)
 	test -s $(TB_LOCALBIN)/ginkgo || GOBIN=$(TB_LOCALBIN) go install github.com/onsi/ginkgo/v2/ginkgo@$(TB_GINKGO_VERSION)
+.PHONY: tb.gofumpt
+tb.gofumpt: $(TB_GOFUMPT) ## Download gofumpt locally if necessary.
+$(TB_GOFUMPT): $(TB_LOCALBIN)
+	test -s $(TB_LOCALBIN)/gofumpt || GOBIN=$(TB_LOCALBIN) go install mvdan.cc/gofumpt@$(TB_GOFUMPT_VERSION)
 .PHONY: tb.golangci-lint
 tb.golangci-lint: $(TB_GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
 $(TB_GOLANGCI_LINT): $(TB_LOCALBIN)
 	test -s $(TB_LOCALBIN)/golangci-lint || GOBIN=$(TB_LOCALBIN) go install github.com/golangci/golangci-lint/cmd/golangci-lint@$(TB_GOLANGCI_LINT_VERSION)
+.PHONY: tb.golines
+tb.golines: $(TB_GOLINES) ## Download golines locally if necessary.
+$(TB_GOLINES): $(TB_LOCALBIN)
+	test -s $(TB_LOCALBIN)/golines || GOBIN=$(TB_LOCALBIN) go install github.com/segmentio/golines@$(TB_GOLINES_VERSION)
 .PHONY: tb.goreleaser
 tb.goreleaser: $(TB_GORELEASER) ## Download goreleaser locally if necessary.
 $(TB_GORELEASER): $(TB_LOCALBIN)
@@ -55,7 +67,9 @@ $(TB_SEMVER): $(TB_LOCALBIN)
 tb.reset:
 	@rm -f \
 		$(TB_LOCALBIN)/ginkgo \
+		$(TB_LOCALBIN)/gofumpt \
 		$(TB_LOCALBIN)/golangci-lint \
+		$(TB_LOCALBIN)/golines \
 		$(TB_LOCALBIN)/goreleaser \
 		$(TB_LOCALBIN)/helm-docs \
 		$(TB_LOCALBIN)/mockgen \
@@ -66,7 +80,9 @@ tb.reset:
 tb.update: tb.reset
 	toolbox makefile -f $(TB_LOCALDIR)/Makefile \
 		github.com/onsi/ginkgo/v2/ginkgo \
+		mvdan.cc/gofumpt@github.com/mvdan/gofumpt \
 		github.com/golangci/golangci-lint/cmd/golangci-lint \
+		github.com/segmentio/golines \
 		github.com/goreleaser/goreleaser/v2 \
 		github.com/norwoodj/helm-docs/cmd/helm-docs \
 		go.uber.org/mock/mockgen@github.com/uber-go/mock \
diff --git a/Makefile b/Makefile
@@ -1,14 +1,16 @@
 # Include toolbox tasks
 include ./.toolbox.mk
 
-# Run go fmt against code
-fmt: tb.golangci-lint
-	$(TB_GOLANG_CI_LINT) run --fix
+lint: tb.golangci-lint
+	$(TB_GOLANGCI_LINT) run --fix
 
 # Run go mod tidy
 tidy:
 	go mod tidy
 
+fmt: tb.golines tb.gofumpt
+	$(TB_GOLINES) --base-formatter="$(TB_GOFUMPT)" --max-len=120 --write-output .
+
 # Run tests
 test: mocks tidy fmt helm-lint test-cover
 # Run coverage tests
diff --git a/main.go b/main.go
@@ -69,7 +69,12 @@ func main() {
 	_ = setupRouter(coreClient, ssc, cfg, sealer).Run(fmt.Sprintf(":%d", cfg.Web.Port))
 }
 
-func setupRouter(coreClient corev1.CoreV1Interface, ssClient ssClient.BitnamiV1alpha1Interface, cfg *config.Config, sealer seal.Sealer) *gin.Engine {
+func setupRouter(
+	coreClient corev1.CoreV1Interface,
+	ssClient ssClient.BitnamiV1alpha1Interface,
+	cfg *config.Config,
+	sealer seal.Sealer,
+) *gin.Engine {
 	indexHTML, err := renderIndexHTML(cfg)
 	if err != nil {
 		log.Fatalf("Could not render the index html template: %s", err.Error())
diff --git a/main_test.go b/main_test.go
@@ -87,7 +87,9 @@ var _ = Describe("Main", func() {
 			req, _ := http.NewRequest("GET", "/api/secrets", nil)
 			router.ServeHTTP(w, req)
 			Ω(w.Code).Should(Equal(http.StatusOK))
-			Ω(w.Body.String()).Should(Equal(fmt.Sprintf(`{"secrets":[{"namespace":"%s","name":"%s"}]}`, namespace, name)))
+			Ω(
+				w.Body.String(),
+			).Should(Equal(fmt.Sprintf(`{"secrets":[{"namespace":"%s","name":"%s"}]}`, namespace, name)))
 		})
 
 		It("list sealed secrets only for given namespaces", func() {
@@ -114,7 +116,9 @@ var _ = Describe("Main", func() {
 			req, _ := http.NewRequest("GET", "/api/secrets", nil)
 			router.ServeHTTP(w, req)
 			Ω(w.Code).Should(Equal(http.StatusOK))
-			Ω(w.Body.String()).Should(Equal(fmt.Sprintf(`{"secrets":[{"namespace":"%s","name":"%s"},{"namespace":"%s","name":"%s"}]}`, "a", name, "b", name)))
+			Ω(
+				w.Body.String(),
+			).Should(Equal(fmt.Sprintf(`{"secrets":[{"namespace":"%s","name":"%s"},{"namespace":"%s","name":"%s"}]}`, "a", name, "b", name)))
 		})
 
 		It("get secret from namespace by name", func() {
diff --git a/pkg/config/filter_test.go b/pkg/config/filter_test.go
@@ -90,7 +90,9 @@ var _ = Describe("Filter", func() {
 			Ω(secretData["metadata"]).ShouldNot(HaveKey("resourceVersion"))
 			Ω(secretData["metadata"]).ShouldNot(HaveKey("selfLink"))
 			Ω(secretData["metadata"]).ShouldNot(HaveKey("uid"))
-			Ω(SubMap(secretData, "metadata", "annotations")).ShouldNot(HaveKey("kubectl.kubernetes.io/last-applied-configuration"))
+			Ω(
+				SubMap(secretData, "metadata", "annotations"),
+			).ShouldNot(HaveKey("kubectl.kubernetes.io/last-applied-configuration"))
 			Ω(SubMap(secretData, "metadata", "annotations")).Should(HaveKey("foo"))
 		})
 	})
diff --git a/pkg/config/types.go b/pkg/config/types.go
@@ -28,7 +28,9 @@ func parse(f *flags) (*Config, error) {
 	}
 
 	if *f.kubesealArgs != "" {
-		log.Println("Argument 'kubeseal-arguments' is deprecated use (sealed-secrets-service-name, sealed-secrets-service-namespace or sealed-secrets-cert-url).")
+		log.Println(
+			"Argument 'kubeseal-arguments' is deprecated use (sealed-secrets-service-name, sealed-secrets-service-namespace or sealed-secrets-cert-url).",
+		)
 	}
 	if *f.webExternalURL != "" {
 		log.Println("Argument 'web-external-url' is deprecated use (web-context).")
@@ -145,18 +147,54 @@ type flags struct {
 
 func newFlags() *flags {
 	return &flags{
-		disableLoadSecrets:            flag.Bool("disable-load-secrets", false, "Disable the loading of existing secrets"),
-		enableWebLogs:                 flag.Bool("enable-web-logs", false, "Enable web logs"),
-		includeNamespaces:             flag.String("include-namespaces", "", "Optional space separated list if namespaces to be included in the sealed secret search"),
-		kubesealArgs:                  flag.String("kubeseal-arguments", "", "Deprecated use (sealed-secrets-service-name, sealed-secrets-service-namespace or sealed-secrets-cert-url)"),
-		sealedSecretsServiceName:      flag.String("sealed-secrets-service-name", "sealed-secrets", "Name of the sealed secrets service"),
-		sealedSecretsServiceNamespace: flag.String("sealed-secrets-service-namespace", "sealed-secrets", "Namespace of the sealed secrets service"),
-		sealedSecretsCertURL:          flag.String("sealed-secrets-cert-url", "", "URL sealed secrets certificate (required if sealed secrets is not reachable with in cluster service)"),
-		initialSecretFile:             flag.String("initial-secret-file", "", "Define a file with the initial secret to be displayed. If empty, defaults are used."),
-		webExternalURL:                flag.String("web-external-url", "", "Deprecated use (web-context)"),
-		webContext:                    flag.String("web-context", "/", "The context the application is running on. (for example, if it is served via a reverse proxy)"),
-		printVersion:                  flag.Bool("version", false, "Print version information and exit"),
-		port:                          flag.Int("port", 8080, "Define the port to run the application on. (default: 8080)"),
-		config:                        flag.String("config", "", "Define the config file"),
+		disableLoadSecrets: flag.Bool(
+			"disable-load-secrets",
+			false,
+			"Disable the loading of existing secrets",
+		),
+		enableWebLogs: flag.Bool("enable-web-logs", false, "Enable web logs"),
+		includeNamespaces: flag.String(
+			"include-namespaces",
+			"",
+			"Optional space separated list if namespaces to be included in the sealed secret search",
+		),
+		kubesealArgs: flag.String(
+			"kubeseal-arguments",
+			"",
+			"Deprecated use (sealed-secrets-service-name, sealed-secrets-service-namespace or sealed-secrets-cert-url)",
+		),
+		sealedSecretsServiceName: flag.String(
+			"sealed-secrets-service-name",
+			"sealed-secrets",
+			"Name of the sealed secrets service",
+		),
+		sealedSecretsServiceNamespace: flag.String(
+			"sealed-secrets-service-namespace",
+			"sealed-secrets",
+			"Namespace of the sealed secrets service",
+		),
+		sealedSecretsCertURL: flag.String(
+			"sealed-secrets-cert-url",
+			"",
+			"URL sealed secrets certificate (required if sealed secrets is not reachable with in cluster service)",
+		),
+		initialSecretFile: flag.String(
+			"initial-secret-file",
+			"",
+			"Define a file with the initial secret to be displayed. If empty, defaults are used.",
+		),
+		webExternalURL: flag.String("web-external-url", "", "Deprecated use (web-context)"),
+		webContext: flag.String(
+			"web-context",
+			"/",
+			"The context the application is running on. (for example, if it is served via a reverse proxy)",
+		),
+		printVersion: flag.Bool("version", false, "Print version information and exit"),
+		port: flag.Int(
+			"port",
+			8080,
+			"Define the port to run the application on. (default: 8080)",
+		),
+		config: flag.String("config", "", "Define the config file"),
 	}
 }
diff --git a/pkg/handler/handler_test.go b/pkg/handler/handler_test.go
@@ -65,7 +65,9 @@ var _ = Describe("Handler ", func() {
 				h.Version(c)
 
 				Ω(recorder.Code).Should(Equal(http.StatusOK))
-				Ω(recorder.Body.String()).Should(Equal(fmt.Sprintf(`{"build":"%v","version":"%v"}`, version.Build, version.Version)))
+				Ω(
+					recorder.Body.String(),
+				).Should(Equal(fmt.Sprintf(`{"build":"%v","version":"%v"}`, version.Build, version.Version)))
 				Ω(recorder.Header().Get("Content-Type")).Should(Equal("application/json; charset=utf-8"))
 			})
 		})
diff --git a/pkg/handler/kubeseal.go b/pkg/handler/kubeseal.go
@@ -55,7 +55,10 @@ func contextNegotiate(c *gin.Context, code int, config gin.Negotiate) {
 		c.TOML(code, data)
 
 	default:
-		c.AbortWithError(http.StatusNotAcceptable, errors.New("the accepted formats are not offered by the server")) //nolint: errcheck
+		_ = c.AbortWithError(
+			http.StatusNotAcceptable,
+			errors.New("the accepted formats are not offered by the server"),
+		)
 	}
 }
 
diff --git a/pkg/handler/raw_test.go b/pkg/handler/raw_test.go
@@ -55,7 +55,9 @@ var _ = Describe("Handler ", func() {
 			h.Raw(c)
 
 			Ω(recorder.Code).Should(Equal(http.StatusUnprocessableEntity))
-			Ω(recorder.Body.String()).Should(Equal(`{"error":"invalid character 'o' in literal false (expecting 'a')"}`))
+			Ω(
+				recorder.Body.String(),
+			).Should(Equal(`{"error":"invalid character 'o' in literal false (expecting 'a')"}`))
 			Ω(recorder.Header().Get("Content-Type")).Should(Equal("application/json; charset=utf-8"))
 		})
 
diff --git a/pkg/handler/secrets.go b/pkg/handler/secrets.go
@@ -21,7 +21,10 @@ import (
 )
 
 // BuildClients build the  k82 clients
-func BuildClients(clientConfig clientcmd.ClientConfig, disableLoadSecrets bool) (corev1.CoreV1Interface, ssClient.BitnamiV1alpha1Interface, error) {
+func BuildClients(
+	clientConfig clientcmd.ClientConfig,
+	disableLoadSecrets bool,
+) (corev1.CoreV1Interface, ssClient.BitnamiV1alpha1Interface, error) {
 	if disableLoadSecrets {
 		return nil, nil, nil
 	}
@@ -52,7 +55,11 @@ type SecretsHandler struct {
 }
 
 // NewHandler creates a new secret handler.
-func NewHandler(coreClient corev1.CoreV1Interface, ssCl ssClient.BitnamiV1alpha1Interface, cfg *config.Config) *SecretsHandler {
+func NewHandler(
+	coreClient corev1.CoreV1Interface,
+	ssCl ssClient.BitnamiV1alpha1Interface,
+	cfg *config.Config,
+) *SecretsHandler {
 	inMap := make(map[string]bool)
 	for _, n := range cfg.IncludeNamespaces {
 		inMap[n] = true
@@ -209,5 +216,5 @@ func encodeSecret(secret *v1.Secret, outputFormat string) ([]byte, error) {
 
 type Secret struct {
 	Namespace string `json:"namespace" yaml:"namespace"`
-	Name      string `json:"name" yaml:"name"`
+	Name      string `json:"name"      yaml:"name"`
 }
diff --git a/pkg/handler/validate_test.go b/pkg/handler/validate_test.go
@@ -71,7 +71,9 @@ var _ = Describe("Handler ", func() {
 			h.Validate(c)
 
 			Ω(recorder.Code).Should(Equal(http.StatusConflict))
-			Ω(recorder.Body.String()).Should(Equal("validate can't be used with CertURL (http://sealed-secrets/v1/cert.pem)"))
+			Ω(
+				recorder.Body.String(),
+			).Should(Equal("validate can't be used with CertURL (http://sealed-secrets/v1/cert.pem)"))
 			Ω(recorder.Header().Get("Content-Type")).Should(Equal("text/plain"))
 		})
 	})
diff --git a/pkg/mocks/core/mock.go b/pkg/mocks/core/mock.go
diff --git a/pkg/mocks/seal/mock.go b/pkg/mocks/seal/mock.go
diff --git a/pkg/mocks/ssclient/mock.go b/pkg/mocks/ssclient/mock.go

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,10 @@ func contextNegotiate(c *gin.Context, code int, config gin.Negotiate) {`
`55`	`55`	`c.TOML(code, data)`
`56`	`56`
`57`	`57`	`default:`
`58`		`- c.AbortWithError(http.StatusNotAcceptable, errors.New("the accepted formats are not offered by the server")) //nolint: errcheck`
	`58`	`+ _ = c.AbortWithError(`
	`59`	`+ http.StatusNotAcceptable,`
	`60`	`+ errors.New("the accepted formats are not offered by the server"),`
	`61`	`+ )`
`59`	`62`	`}`
`60`	`63`	`}`
`61`	`64`