Format code and fix go vet (#2696)

* run go fix ./... Signed-off-by: Tiago Peczenyj <[email protected]> * run make fmt Signed-off-by: Tiago Peczenyj <[email protected]> * fix go vet ./... issues * Update README.md Reorder imports with the rules defined in the Makefile as if we run `make fmt` * run gofumpt -w . * update Makefile to use gofumpt instead gofmt * increment makefile * format test * format tests Signed-off-by: Tiago Peczenyj <[email protected]> --------- Signed-off-by: Tiago Peczenyj <[email protected]> Co-authored-by: ofekshenawa <[email protected]>
redis · Sep 20, 2023 · e8ad794 · e8ad794
1 parent 1a7d2f4
commit e8ad794
Show file tree

Hide file tree

Showing 28 changed files with 42 additions and 85 deletions.
diff --git a/Makefile b/Makefile
@@ -19,7 +19,7 @@ testdeps: testdata/redis/src/redis-server
 bench: testdeps
 	go test ./... -test.run=NONE -test.bench=. -test.benchmem
 
-.PHONY: all test testdeps bench
+.PHONY: all test testdeps bench fmt
 
 testdata/redis:
 	mkdir -p $@
@@ -29,7 +29,7 @@ testdata/redis/src/redis-server: testdata/redis
 	cd $< && make all
 
 fmt:
-	gofmt -w -s ./
+	gofumpt -w ./
 	goimports -w  -local github.com/redis/go-redis ./
 
 go_mod_tidy:

diff --git a/README.md b/README.md
@@ -69,8 +69,9 @@ go get github.com/redis/go-redis/v9
 ```go
 import (
     "context"
-    "github.com/redis/go-redis/v9"
     "fmt"
+
+    "github.com/redis/go-redis/v9"
 )
 
 var ctx = context.Background()
@@ -125,8 +126,9 @@ go-redis also supports connecting via the [redis uri specification](https://gith
 ```go
 import (
     "context"
-    "github.com/redis/go-redis/v9"
     "fmt"
+
+    "github.com/redis/go-redis/v9"
 )
 
 var ctx = context.Background()

diff --git a/cluster_test.go b/cluster_test.go
@@ -13,6 +13,7 @@ import (
 
 	. "github.com/bsm/ginkgo/v2"
 	. "github.com/bsm/gomega"
+
 	"github.com/redis/go-redis/v9"
 	"github.com/redis/go-redis/v9/internal/hashtag"
 )
@@ -1457,7 +1458,7 @@ var _ = Describe("ClusterClient timeout", func() {
 })
 
 var _ = Describe("ClusterClient ParseURL", func() {
-	var cases = []struct {
+	cases := []struct {
 		test string
 		url  string
 		o    *redis.ClusterOptions // expected value

diff --git a/command.go b/command.go
@@ -4324,7 +4324,6 @@ func (cmd *FunctionStatsCmd) readDuration(rd *proto.Reader) (time.Duration, erro
 }
 
 func (cmd *FunctionStatsCmd) readCommand(rd *proto.Reader) ([]string, error) {
-
 	n, err := rd.ReadArrayLen()
 	if err != nil {
 		return nil, err
@@ -4341,6 +4340,7 @@ func (cmd *FunctionStatsCmd) readCommand(rd *proto.Reader) ([]string, error) {
 
 	return command, nil
 }
+
 func (cmd *FunctionStatsCmd) readRunningScripts(rd *proto.Reader) ([]RunningScript, bool, error) {
 	n, err := rd.ReadArrayLen()
 	if err != nil {

diff --git a/commands.go b/commands.go
@@ -609,7 +609,8 @@ func (info LibraryInfo) Validate() error {
 
 // Hello Set the resp protocol used.
 func (c statefulCmdable) Hello(ctx context.Context,
-	ver int, username, password, clientName string) *MapStringInterfaceCmd {
+	ver int, username, password, clientName string,
+) *MapStringInterfaceCmd {
 	args := make([]interface{}, 0, 7)
 	args = append(args, "hello", ver)
 	if password != "" {

diff --git a/commands_test.go b/commands_test.go
@@ -232,7 +232,6 @@ var _ = Describe("Commands", func() {
 		})
 
 		It("should ClientSetInfo", func() {
-
 			pipe := client.Pipeline()
 
 			// Test setting the libName
@@ -413,7 +412,6 @@ var _ = Describe("Commands", func() {
 		})
 
 		It("should filter commands by ACL category", func() {
-
 			filter := &redis.FilterBy{
 				ACLCat: "admin",
 			}
@@ -580,7 +578,6 @@ var _ = Describe("Commands", func() {
 			n, err = client.Exists(ctx, "key").Result()
 			Expect(err).NotTo(HaveOccurred())
 			Expect(n).To(Equal(int64(0)))
-
 		})
 
 		It("should Keys", func() {
@@ -727,7 +724,6 @@ var _ = Describe("Commands", func() {
 		})
 
 		It("should PExpireTime", func() {
-
 			// The command returns -1 if the key exists but has no associated expiration time.
 			// The command returns -2 if the key does not exist.
 			pExpireTime := client.PExpireTime(ctx, "key")
@@ -966,7 +962,6 @@ var _ = Describe("Commands", func() {
 		})
 
 		It("should ExpireTime", func() {
-
 			// The command returns -1 if the key exists but has no associated expiration time.
 			// The command returns -2 if the key does not exist.
 			expireTimeCmd := client.ExpireTime(ctx, "key")
@@ -988,7 +983,6 @@ var _ = Describe("Commands", func() {
 		})
 
 		It("should TTL", func() {
-
 			// The command returns -1 if the key exists but has no associated expire
 			// The command returns -2 if the key does not exist.
 			ttl := client.TTL(ctx, "key")
@@ -2042,7 +2036,6 @@ var _ = Describe("Commands", func() {
 		})
 
 		It("should ACL LOG", func() {
-
 			err := client.Do(ctx, "acl", "setuser", "test", ">test", "on", "allkeys", "+get").Err()
 			Expect(err).NotTo(HaveOccurred())
 
@@ -2073,7 +2066,6 @@ var _ = Describe("Commands", func() {
 			limitedLogEntries, err := client.ACLLog(ctx, 2).Result()
 			Expect(err).NotTo(HaveOccurred())
 			Expect(len(limitedLogEntries)).To(Equal(2))
-
 		})
 
 		It("should ACL LOG RESET", func() {
@@ -2087,7 +2079,6 @@ var _ = Describe("Commands", func() {
 			Expect(err).NotTo(HaveOccurred())
 			Expect(len(logEntries)).To(Equal(0))
 		})
-
 	})
 
 	Describe("hashes", func() {
@@ -2699,7 +2690,6 @@ var _ = Describe("Commands", func() {
 			Expect(err).NotTo(HaveOccurred())
 			Expect(key).To(Equal("list2"))
 			Expect(val).To(Equal([]string{"a", "b", "c", "d"}))
-
 		})
 
 		It("should BLMPopBlocks", func() {
@@ -2721,15 +2711,15 @@ var _ = Describe("Commands", func() {
 			case <-done:
 				Fail("BLMPop is not blocked")
 			case <-time.After(time.Second):
-				//ok
+				// ok
 			}
 
 			_, err := client.LPush(ctx, "list_list", "a").Result()
 			Expect(err).NotTo(HaveOccurred())
 
 			select {
 			case <-done:
-				//ok
+				// ok
 			case <-time.After(time.Second):
 				Fail("BLMPop is still blocked")
 			}
@@ -4184,7 +4174,6 @@ var _ = Describe("Commands", func() {
 		})
 
 		It("should ZMPop", func() {
-
 			err := client.ZAdd(ctx, "zset", redis.Z{Score: 1, Member: "one"}).Err()
 			Expect(err).NotTo(HaveOccurred())
 			err = client.ZAdd(ctx, "zset", redis.Z{Score: 2, Member: "two"}).Err()
@@ -4256,11 +4245,9 @@ var _ = Describe("Commands", func() {
 				Score:  6,
 				Member: "six",
 			}}))
-
 		})
 
 		It("should BZMPop", func() {
-
 			err := client.ZAdd(ctx, "zset", redis.Z{Score: 1, Member: "one"}).Err()
 			Expect(err).NotTo(HaveOccurred())
 			err = client.ZAdd(ctx, "zset", redis.Z{Score: 2, Member: "two"}).Err()
@@ -4360,15 +4347,15 @@ var _ = Describe("Commands", func() {
 			case <-done:
 				Fail("BZMPop is not blocked")
 			case <-time.After(time.Second):
-				//ok
+				// ok
 			}
 
 			err := client.ZAdd(ctx, "list_list", redis.Z{Score: 1, Member: "one"}).Err()
 			Expect(err).NotTo(HaveOccurred())
 
 			select {
 			case <-done:
-				//ok
+				// ok
 			case <-time.After(time.Second):
 				Fail("BZMPop is still blocked")
 			}
@@ -6928,7 +6915,6 @@ var _ = Describe("Commands", func() {
 
 			close(started)
 		})
-
 	})
 
 	Describe("SlowLogGet", func() {
@@ -6949,7 +6935,6 @@ var _ = Describe("Commands", func() {
 			Expect(len(result)).NotTo(BeZero())
 		})
 	})
-
 })
 
 type numberStruct struct {

diff --git a/doctests/lpush_lrange_test.go b/doctests/lpush_lrange_test.go
@@ -5,10 +5,11 @@ package example_commands_test
 import (
 	"context"
 	"fmt"
+
 	"github.com/redis/go-redis/v9"
 )
 
-func ExampleLPushLRange() {
+func ExampleClient_LPush_and_lrange() {
 	ctx := context.Background()
 
 	rdb := redis.NewClient(&redis.Options{

diff --git a/doctests/set_get_test.go b/doctests/set_get_test.go
@@ -5,10 +5,11 @@ package example_commands_test
 import (
 	"context"
 	"fmt"
+
 	"github.com/redis/go-redis/v9"
 )
 
-func ExampleSetGet() {
+func ExampleClient_Set_and_get() {
 	ctx := context.Background()
 
 	rdb := redis.NewClient(&redis.Options{

diff --git a/example/del-keys-without-ttl/main.go b/example/del-keys-without-ttl/main.go
@@ -6,8 +6,9 @@ import (
 	"sync"
 	"time"
 
-	"github.com/redis/go-redis/v9"
 	"go.uber.org/zap"
+
+	"github.com/redis/go-redis/v9"
 )
 
 func main() {

diff --git a/extra/redisotel/metrics.go b/extra/redisotel/metrics.go
@@ -6,10 +6,11 @@ import (
 	"net"
 	"time"
 
-	"github.com/redis/go-redis/v9"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/metric"
+
+	"github.com/redis/go-redis/v9"
 )
 
 // InstrumentMetrics starts reporting OpenTelemetry Metrics.

diff --git a/extra/redisprometheus/collector.go b/extra/redisprometheus/collector.go
@@ -29,12 +29,12 @@ var _ prometheus.Collector = (*Collector)(nil)
 // The given namespace and subsystem are used to build the fully qualified metric name,
 // i.e. "{namespace}_{subsystem}_{metric}".
 // The provided metrics are:
-//   * pool_hit_total
-//   * pool_miss_total
-//   * pool_timeout_total
-//   * pool_conn_total_current
-//   * pool_conn_idle_current
-//   * pool_conn_stale_total
+//   - pool_hit_total
+//   - pool_miss_total
+//   - pool_timeout_total
+//   - pool_conn_total_current
+//   - pool_conn_idle_current
+//   - pool_conn_stale_total
 func NewCollector(namespace, subsystem string, getter StatGetter) *Collector {
 	return &Collector{
 		getter: getter,

diff --git a/internal/customvet/checks/setval/setval.go b/internal/customvet/checks/setval/setval.go
@@ -4,6 +4,7 @@ import (
 	"go/ast"
 	"go/token"
 	"go/types"
+
 	"golang.org/x/tools/go/analysis"
 )
 

diff --git a/internal/customvet/checks/setval/setval_test.go b/internal/customvet/checks/setval/setval_test.go
@@ -3,8 +3,9 @@ package setval_test
 import (
 	"testing"
 
-	"github.com/redis/go-redis/internal/customvet/checks/setval"
 	"golang.org/x/tools/go/analysis/analysistest"
+
+	"github.com/redis/go-redis/internal/customvet/checks/setval"
 )
 
 func Test(t *testing.T) {

diff --git a/internal/customvet/main.go b/internal/customvet/main.go
@@ -1,8 +1,9 @@
 package main
 
 import (
-	"github.com/redis/go-redis/internal/customvet/checks/setval"
 	"golang.org/x/tools/go/analysis/multichecker"
+
+	"github.com/redis/go-redis/internal/customvet/checks/setval"
 )
 
 func main() {

diff --git a/internal/pool/conn_check.go b/internal/pool/conn_check.go
@@ -1,5 +1,4 @@
 //go:build linux || darwin || dragonfly || freebsd || netbsd || openbsd || solaris || illumos
-// +build linux darwin dragonfly freebsd netbsd openbsd solaris illumos
 
 package pool
 

diff --git a/internal/pool/conn_check_dummy.go b/internal/pool/conn_check_dummy.go
@@ -1,5 +1,4 @@
 //go:build !linux && !darwin && !dragonfly && !freebsd && !netbsd && !openbsd && !solaris && !illumos
-// +build !linux,!darwin,!dragonfly,!freebsd,!netbsd,!openbsd,!solaris,!illumos
 
 package pool
 

diff --git a/internal/pool/conn_check_test.go b/internal/pool/conn_check_test.go
@@ -1,5 +1,4 @@
 //go:build linux || darwin || dragonfly || freebsd || netbsd || openbsd || solaris || illumos
-// +build linux darwin dragonfly freebsd netbsd openbsd solaris illumos
 
 package pool
 

diff --git a/internal/util/safe.go b/internal/util/safe.go
@@ -1,5 +1,4 @@
 //go:build appengine
-// +build appengine
 
 package util
 

diff --git a/internal/util/unsafe.go b/internal/util/unsafe.go
@@ -1,5 +1,4 @@
 //go:build !appengine
-// +build !appengine
 
 package util
 

diff --git a/main_test.go b/main_test.go
@@ -36,8 +36,10 @@ const (
 	sentinelPort3      = "9128"
 )
 
-var redisPort = "6380"
-var redisAddr = ":" + redisPort
+var (
+	redisPort = "6380"
+	redisAddr = ":" + redisPort
+)
 
 var (
 	sentinelAddrs = []string{":" + sentinelPort1, ":" + sentinelPort2, ":" + sentinelPort3}

diff --git a/options_test.go b/options_test.go
@@ -1,5 +1,4 @@
 //go:build go1.7
-// +build go1.7
 
 package redis
 

diff --git a/probabilistic.go b/probabilistic.go
@@ -310,6 +310,7 @@ func NewBFInfoCmd(ctx context.Context, args ...interface{}) *BFInfoCmd {
 func (cmd *BFInfoCmd) SetVal(val BFInfo) {
 	cmd.val = val
 }
+
 func (cmd *BFInfoCmd) String() string {
 	return cmdString(cmd, cmd.val)
 }