Format code with golines (#475)

.toolbox.mk

@@ -11,7 +11,9 @@ $(TB_LOCALBIN):
 ## Tool Binaries
 TB_DEEPCOPY_GEN ?= $(TB_LOCALBIN)/deepcopy-gen
 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_MOCKGEN ?= $(TB_LOCALBIN)/mockgen
 TB_OAPI_CODEGEN ?= $(TB_LOCALBIN)/oapi-codegen
@@ -20,8 +22,12 @@ TB_SEMVER ?= $(TB_LOCALBIN)/semver
 ## Tool Versions
 # renovate: packageName=k8s.io/code-generator/cmd/deepcopy-gen
 TB_DEEPCOPY_GEN_VERSION ?= v0.32.0
+# renovate: packageName=mvdan.cc/gofumpt
+TB_GOFUMPT_VERSION ?= v0.7.0
 # renovate: packageName=github.com/golangci/golangci-lint/cmd/golangci-lint
 TB_GOLANGCI_LINT_VERSION ?= v1.62.2
+# renovate: packageName=github.com/segmentio/golines
+TB_GOLINES_VERSION ?= v0.12.2
 # renovate: packageName=github.com/goreleaser/goreleaser/v2
 TB_GORELEASER_VERSION ?= v2.5.0
 # renovate: packageName=go.uber.org/mock/mockgen
@@ -40,10 +46,18 @@ $(TB_DEEPCOPY_GEN): $(TB_LOCALBIN)
 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
+.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)
@@ -67,7 +81,9 @@ tb.reset:
 	@rm -f \
 		$(TB_LOCALBIN)/deepcopy-gen \
 		$(TB_LOCALBIN)/ginkgo \
+		$(TB_LOCALBIN)/gofumpt \
 		$(TB_LOCALBIN)/golangci-lint \
+		$(TB_LOCALBIN)/golines \
 		$(TB_LOCALBIN)/goreleaser \
 		$(TB_LOCALBIN)/mockgen \
 		$(TB_LOCALBIN)/oapi-codegen \
@@ -78,7 +94,9 @@ tb.reset:
 tb.update: tb.reset
 	toolbox makefile --renovate -f $(TB_LOCALDIR)/Makefile \
 		k8s.io/code-generator/cmd/[email protected]/kubernetes/code-generator \
+		mvdan.cc/[email protected]/mvdan/gofumpt \
 		github.com/golangci/golangci-lint/cmd/golangci-lint \
+		github.com/segmentio/golines \
 		github.com/goreleaser/goreleaser/v2 \
 		go.uber.org/mock/[email protected]/uber-go/mock \
 		github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen \

Makefile

@@ -14,6 +14,9 @@ generate: tb.deepcopy-gen
 	@touch ./tmp/deepcopy-gen-boilerplate.go.txt
 	$(TB_DEEPCOPY_GEN) --go-header-file ./tmp/deepcopy-gen-boilerplate.go.txt --bounding-dirs ./pkg/types
 
+fmt: tb.golines tb.gofumpt
+	$(TB_GOLINES) --base-formatter="$(TB_GOFUMPT)" --max-len=120 --write-output .
+
 # Run tests
 test: generate lint test-ci
 

cmd/run.go

@@ -50,7 +50,8 @@ func init() {
 	doCmd.PersistentFlags().Bool(config.FlagContinueOnError, false, "If enabled, the synchronisation task "+
 		"will not fail on single errors, but will log the errors and continue.")
 
-	doCmd.PersistentFlags().Int(config.FlagApiPort, 8080, "Sync API Port, the API endpoint will be started to enable remote triggering; if 0 port API is disabled.")
+	doCmd.PersistentFlags().
+		Int(config.FlagApiPort, 8080, "Sync API Port, the API endpoint will be started to enable remote triggering; if 0 port API is disabled.")
 	doCmd.PersistentFlags().String(config.FlagApiUsername, "", "Sync API username")
 	doCmd.PersistentFlags().String(config.FlagApiPassword, "", "Sync API password")
 	doCmd.PersistentFlags().String(config.FlagApiDarkMode, "", "API UI in dark mode")
@@ -70,20 +71,24 @@ func init() {
 	doCmd.PersistentFlags().Bool(config.FlagFeatureFilters, true, "Enable filters sync feature")
 
 	doCmd.PersistentFlags().String(config.FlagOriginURL, "", "Origin instance url")
-	doCmd.PersistentFlags().String(config.FlagOriginWebURL, "", "Origin instance web url used in the web interface (default: <origin-url>)")
+	doCmd.PersistentFlags().
+		String(config.FlagOriginWebURL, "", "Origin instance web url used in the web interface (default: <origin-url>)")
 	doCmd.PersistentFlags().String(config.FlagOriginApiPath, "/control", "Origin instance API path")
 	doCmd.PersistentFlags().String(config.FlagOriginUsername, "", "Origin instance username")
 	doCmd.PersistentFlags().String(config.FlagOriginPassword, "", "Origin instance password")
 	doCmd.PersistentFlags().String(config.FlagOriginCookie, "", "If Set, uses a cookie for authentication")
 	doCmd.PersistentFlags().Bool(config.FlagOriginISV, false, "Enable Origin instance InsecureSkipVerify")
 
 	doCmd.PersistentFlags().String(config.FlagReplicaURL, "", "Replica instance url")
-	doCmd.PersistentFlags().String(config.FlagReplicaWebURL, "", "Replica instance web url used in the web interface (default: <replica-url>)")
+	doCmd.PersistentFlags().
+		String(config.FlagReplicaWebURL, "", "Replica instance web url used in the web interface (default: <replica-url>)")
 	doCmd.PersistentFlags().String(config.FlagReplicaApiPath, "/control", "Replica instance API path")
 	doCmd.PersistentFlags().String(config.FlagReplicaUsername, "", "Replica instance username")
 	doCmd.PersistentFlags().String(config.FlagReplicaPassword, "", "Replica instance password")
 	doCmd.PersistentFlags().String(config.FlagReplicaCookie, "", "If Set, uses a cookie for authentication")
 	doCmd.PersistentFlags().Bool(config.FlagReplicaISV, false, "Enable Replica instance InsecureSkipVerify")
-	doCmd.PersistentFlags().Bool(config.FlagReplicaAutoSetup, false, "Enable automatic setup of new AdguardHome instances. This replaces the setup wizard.")
-	doCmd.PersistentFlags().String(config.FlagReplicaInterfaceName, "", "Optional change the interface name of the replica if it differs from the master")
+	doCmd.PersistentFlags().
+		Bool(config.FlagReplicaAutoSetup, false, "Enable automatic setup of new AdguardHome instances. This replaces the setup wizard.")
+	doCmd.PersistentFlags().
+		String(config.FlagReplicaInterfaceName, "", "Optional change the interface name of the replica if it differs from the master")
 }

openapi/main.go

@@ -20,7 +20,9 @@ func main() {
 	}
 	log.Printf("Patching schema version %s\n", version)
 
-	resp, err := http.Get(fmt.Sprintf("https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/%s/openapi/openapi.yaml", version))
+	resp, err := http.Get(
+		fmt.Sprintf("https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/%s/openapi/openapi.yaml", version),
+	)
 	if err != nil {
 		log.Fatalln(err)
 	}

pkg/client/client.go

@@ -166,7 +166,10 @@ func (cl *client) Stats() (*model.Stats, error) {
 
 func (cl *client) QueryLog(limit int) (*model.QueryLog, error) {
 	ql := &model.QueryLog{}
-	err := cl.doGet(cl.client.R().EnableTrace().SetResult(ql), fmt.Sprintf(`querylog?limit=%d&response_status="all"`, limit))
+	err := cl.doGet(
+		cl.client.R().EnableTrace().SetResult(ql),
+		fmt.Sprintf(`querylog?limit=%d&response_status="all"`, limit),
+	)
 	return ql, err
 }
 
@@ -260,7 +263,10 @@ func (cl *client) UpdateFilter(whitelist bool, f model.Filter) error {
 
 func (cl *client) RefreshFilters(whitelist bool) error {
 	cl.log.With("whitelist", whitelist).Info("Refresh filter")
-	return cl.doPost(cl.client.R().EnableTrace().SetBody(&model.FilterRefreshRequest{Whitelist: utils.Ptr(whitelist)}), "/filtering/refresh")
+	return cl.doPost(
+		cl.client.R().EnableTrace().SetBody(&model.FilterRefreshRequest{Whitelist: utils.Ptr(whitelist)}),
+		"/filtering/refresh",
+	)
 }
 
 func (cl *client) ToggleProtection(enable bool) error {
@@ -309,7 +315,10 @@ func (cl *client) AddClient(client *model.Client) error {
 
 func (cl *client) UpdateClient(client *model.Client) error {
 	cl.log.With("name", *client.Name).Info("Update client settings")
-	return cl.doPost(cl.client.R().EnableTrace().SetBody(&model.ClientUpdate{Name: client.Name, Data: client}), "/clients/update")
+	return cl.doPost(
+		cl.client.R().EnableTrace().SetBody(&model.ClientUpdate{Name: client.Name, Data: client}),
+		"/clients/update",
+	)
 }
 
 func (cl *client) DeleteClient(client *model.Client) error {
@@ -324,7 +333,8 @@ func (cl *client) QueryLogConfig() (*model.QueryLogConfigWithIgnored, error) {
 }
 
 func (cl *client) SetQueryLogConfig(qlc *model.QueryLogConfigWithIgnored) error {
-	cl.log.With("enabled", *qlc.Enabled, "interval", *qlc.Interval, "anonymizeClientIP", *qlc.AnonymizeClientIp).Info("Set query log config")
+	cl.log.With("enabled", *qlc.Enabled, "interval", *qlc.Interval, "anonymizeClientIP", *qlc.AnonymizeClientIp).
+		Info("Set query log config")
 	return cl.doPut(cl.client.R().EnableTrace().SetBody(qlc), "/querylog/config/update")
 }
 

pkg/client/client_test.go

@@ -137,7 +137,14 @@ var _ = Describe("Client", func() {
 
 	Context("Setup", func() {
 		It("should add setup the instance", func() {
-			ts, cl = ClientPost("/install/configure", fmt.Sprintf(`{"web":{"ip":"0.0.0.0","port":3000,"status":"","can_autofix":false},"dns":{"ip":"0.0.0.0","port":53,"status":"","can_autofix":false},"username":"%s","password":"%s"}`, username, password))
+			ts, cl = ClientPost(
+				"/install/configure",
+				fmt.Sprintf(
+					`{"web":{"ip":"0.0.0.0","port":3000,"status":"","can_autofix":false},"dns":{"ip":"0.0.0.0","port":53,"status":"","can_autofix":false},"username":"%s","password":"%s"}`,
+					username,
+					password,
+				),
+			)
 			err := cl.Setup()
 			Ω(err).ShouldNot(HaveOccurred())
 		})
@@ -303,7 +310,10 @@ var _ = Describe("Client", func() {
 			Ω(*qlc.Interval).Should(Equal(model.QueryLogConfigInterval(90)))
 		})
 		It("should set QueryLogConfig", func() {
-			ts, cl = ClientPut("/querylog/config/update", `{"anonymize_client_ip":true,"enabled":true,"interval":123,"ignored":["foo.bar"]}`)
+			ts, cl = ClientPut(
+				"/querylog/config/update",
+				`{"anonymize_client_ip":true,"enabled":true,"interval":123,"ignored":["foo.bar"]}`,
+			)
 
 			var interval model.QueryLogConfigInterval = 123
 			err := cl.SetQueryLogConfig(&model.QueryLogConfigWithIgnored{

pkg/client/model/model-functions.go

@@ -442,7 +442,9 @@ func (c *DNSConfig) Sanitize(l *zap.SugaredLogger) {
 	// https://github.com/AdguardTeam/AdGuardHome/issues/6820
 	if c.UsePrivatePtrResolvers != nil && *c.UsePrivatePtrResolvers &&
 		(c.LocalPtrUpstreams == nil || len(*c.LocalPtrUpstreams) == 0) {
-		l.Warn("disabling replica 'Use private reverse DNS resolvers' as no 'Private reverse DNS servers' are configured on origin")
+		l.Warn(
+			"disabling replica 'Use private reverse DNS resolvers' as no 'Private reverse DNS servers' are configured on origin",
+		)
 		c.UsePrivatePtrResolvers = utils.Ptr(false)
 	}
 }

pkg/client/model/model_test.go

@@ -242,7 +242,10 @@ var _ = Describe("Types", func() {
 			})
 			It("should return 3 one replicas if urls are different", func() {
 				cfg.Replica = &types.AdGuardInstance{URL: url, APIPath: apiPath}
-				cfg.Replicas = []types.AdGuardInstance{{URL: url + "1", APIPath: apiPath}, {URL: url, APIPath: apiPath + "1"}}
+				cfg.Replicas = []types.AdGuardInstance{
+					{URL: url + "1", APIPath: apiPath},
+					{URL: url, APIPath: apiPath + "1"},
+				}
 				r := cfg.UniqueReplicas()
 				Ω(r).Should(HaveLen(3))
 			})
@@ -311,8 +314,14 @@ var _ = Describe("Types", func() {
 				cl2 *model.Client
 			)
 			BeforeEach(func() {
-				cl1 = &model.Client{Name: utils.Ptr("foo"), BlockedServicesSchedule: &model.Schedule{TimeZone: utils.Ptr("UTC")}}
-				cl2 = &model.Client{Name: utils.Ptr("foo"), BlockedServicesSchedule: &model.Schedule{TimeZone: utils.Ptr("Local")}}
+				cl1 = &model.Client{
+					Name:                    utils.Ptr("foo"),
+					BlockedServicesSchedule: &model.Schedule{TimeZone: utils.Ptr("UTC")},
+				}
+				cl2 = &model.Client{
+					Name:                    utils.Ptr("foo"),
+					BlockedServicesSchedule: &model.Schedule{TimeZone: utils.Ptr("Local")},
+				}
 			})
 
 			It("should equal if only timezone differs on empty blocked service schedule", func() {

pkg/sync/action-general.go

@@ -105,7 +105,8 @@ var (
 			return ac.client.SetCustomRules(ac.origin.filters.UserRules)
 		}
 
-		if !utils.PtrEquals(ac.origin.filters.Enabled, rf.Enabled) || !utils.PtrEquals(ac.origin.filters.Interval, rf.Interval) {
+		if !utils.PtrEquals(ac.origin.filters.Enabled, rf.Enabled) ||
+			!utils.PtrEquals(ac.origin.filters.Interval, rf.Interval) {
 			return ac.client.ToggleFiltering(*ac.origin.filters.Enabled, *ac.origin.filters.Interval)
 		}
 		return nil
@@ -236,7 +237,14 @@ var (
 	}
 )
 
-func syncFilterType(rl *zap.SugaredLogger, of *[]model.Filter, rFilters *[]model.Filter, whitelist bool, replica client.Client, continueOnError bool) error {
+func syncFilterType(
+	rl *zap.SugaredLogger,
+	of *[]model.Filter,
+	rFilters *[]model.Filter,
+	whitelist bool,
+	replica client.Client,
+	continueOnError bool,
+) error {
 	fa, fu, fd := model.MergeFilters(rFilters, of)
 
 	for _, f := range fd {

pkg/sync/http.go

@@ -42,14 +42,23 @@ func (w *worker) handleRoot(c *gin.Context) {
 		"Build":      version.Build,
 		"SyncStatus": w.status(),
 		"Stats": map[string]interface{}{
-			"Labels":            getLast24Hours(),
-			"DNS":               dns,
-			"Blocked":           blocked,
-			"BlockedPercentage": fmt.Sprintf("%.2f", (float64(*total.NumBlockedFiltering)*100.0)/float64(*total.NumDnsQueries)),
-			"Malware":           malware,
-			"MalwarePercentage": fmt.Sprintf("%.2f", (float64(*total.NumReplacedSafebrowsing)*100.0)/float64(*total.NumDnsQueries)),
-			"Adult":             adult,
-			"AdultPercentage":   fmt.Sprintf("%.2f", (float64(*total.NumReplacedParental)*100.0)/float64(*total.NumDnsQueries)),
+			"Labels":  getLast24Hours(),
+			"DNS":     dns,
+			"Blocked": blocked,
+			"BlockedPercentage": fmt.Sprintf(
+				"%.2f",
+				(float64(*total.NumBlockedFiltering)*100.0)/float64(*total.NumDnsQueries),
+			),
+			"Malware": malware,
+			"MalwarePercentage": fmt.Sprintf(
+				"%.2f",
+				(float64(*total.NumReplacedSafebrowsing)*100.0)/float64(*total.NumDnsQueries),
+			),
+			"Adult": adult,
+			"AdultPercentage": fmt.Sprintf(
+				"%.2f",
+				(float64(*total.NumReplacedParental)*100.0)/float64(*total.NumDnsQueries),
+			),
 
 			"TotalDNS":     total.NumDnsQueries,
 			"TotalBlocked": total.NumBlockedFiltering,

pkg/sync/stats.go

@@ -72,7 +72,13 @@ func safeStats(stats *[]int) []int {
 	return *stats
 }
 
-func graphLines(t *model.Stats, s metrics.OverallStats, baseColor []int, altColors [][]int, dataCB func(s *model.Stats) []int) []line {
+func graphLines(
+	t *model.Stats,
+	s metrics.OverallStats,
+	baseColor []int,
+	altColors [][]int,
+	dataCB func(s *model.Stats) []int,
+) []line {
 	g := &graph{
 		total: line{
 			Fill:  true,

pkg/sync/sync.go

@@ -172,7 +172,8 @@ func (w *worker) sync() {
 	}
 
 	if versions.IsNewerThan(versions.MinAgh, o.status.Version) {
-		sl.With("error", err, "version", o.status.Version).Errorf("Origin AdGuard Home version must be >= %s", versions.MinAgh)
+		sl.With("error", err, "version", o.status.Version).
+			Errorf("Origin AdGuard Home version must be >= %s", versions.MinAgh)
 		return
 	}
 
@@ -280,12 +281,14 @@ func (w *worker) syncTo(l *zap.SugaredLogger, o *origin, replica types.AdGuardIn
 	rl.With("version", replicaStatus.Version).Info("Connected to replica")
 
 	if versions.IsNewerThan(versions.MinAgh, replicaStatus.Version) {
-		rl.With("error", err, "version", replicaStatus.Version).Errorf("Replica AdGuard Home version must be >= %s", versions.MinAgh)
+		rl.With("error", err, "version", replicaStatus.Version).
+			Errorf("Replica AdGuard Home version must be >= %s", versions.MinAgh)
 		return
 	}
 
 	if o.status.Version != replicaStatus.Version {
-		rl.With("originVersion", o.status.Version, "replicaVersion", replicaStatus.Version).Warn("Versions do not match")
+		rl.With("originVersion", o.status.Version, "replicaVersion", replicaStatus.Version).
+			Warn("Versions do not match")
 	}
 
 	ac := &actionContext{
@@ -308,7 +311,11 @@ func (w *worker) syncTo(l *zap.SugaredLogger, o *origin, replica types.AdGuardIn
 	rl.Info("Sync done")
 }
 
-func (w *worker) statusWithSetup(rl *zap.SugaredLogger, replica types.AdGuardInstance, rc client.Client) (*model.ServerStatus, error) {
+func (w *worker) statusWithSetup(
+	rl *zap.SugaredLogger,
+	replica types.AdGuardInstance,
+	rc client.Client,
+) (*model.ServerStatus, error) {
 	rs, err := rc.Status()
 	if err != nil {
 		if replica.AutoSetup && errors.Is(err, client.ErrSetupNeeded) {