Switch to gci, so we can actually auto-group imports (#5493)

We've finally found a tool that enforces groups, not just sorts them!
Awesome.

Unfortunately it doesn't (currently?) remove unused imports, so we also
still want/need `goimports`.
Oh well.

Author: Groxx

.gen/proto/history/v1/service.pb.go

@@ -180,6 +180,11 @@ $(BIN)/mockery: internal/tools/go.mod
 $(BIN)/enumer: internal/tools/go.mod
 	$(call go_build_tool,github.com/dmarkham/enumer)
 
+# organizes imports and reformats
+$(BIN)/gci: internal/tools/go.mod
+	$(call go_build_tool,github.com/daixiang0/gci)
+
+# removes unused imports and reformats
 $(BIN)/goimports: internal/tools/go.mod
 	$(call go_build_tool,golang.org/x/tools/cmd/goimports)
 
@@ -352,10 +357,13 @@ $(BUILD)/lint: $(LINT_SRC) $(BIN)/revive | $(BUILD)
 # if either changes, this will need to change.
 MAYBE_TOUCH_COPYRIGHT=
 
-$(BUILD)/fmt: $(ALL_SRC) $(BIN)/goimports | $(BUILD)
-	$Q echo "goimports..."
-	$Q # use FRESH_ALL_SRC so it won't miss any generated files produced earlier
-	$Q $(BIN)/goimports -local "github.com/uber/cadence" -w $(FRESH_ALL_SRC)
+# use FRESH_ALL_SRC so it won't miss any generated files produced earlier.
+$(BUILD)/fmt: $(ALL_SRC) $(BIN)/goimports $(BIN)/gci | $(BUILD)
+	$Q echo "removing unused imports..."
+	$Q # goimports thrashes on internal/tools, sadly.  just hide it.
+	$Q $(BIN)/goimports -w $(filter-out ./internal/tools/tools.go,$(FRESH_ALL_SRC))
+	$Q echo "grouping imports..."
+	$Q $(BIN)/gci write --section standard --section 'Prefix(github.com/uber/cadence/)' --section default --section blank $(FRESH_ALL_SRC)
 	$Q touch $@
 	$Q $(MAYBE_TOUCH_COPYRIGHT)
 
@@ -386,8 +394,8 @@ endef
 lint: ## (re)run the linter
 	$(call remake,proto-lint lint)
 
-# intentionally not re-making, goimports is slow and it's clear when it's unnecessary
-fmt: $(BUILD)/fmt ## run goimports
+# intentionally not re-making, it's a bit slow and it's clear when it's unnecessary
+fmt: $(BUILD)/fmt ## run gofmt / organize imports / etc
 
 # not identical to the intermediate target, but does provide the same codegen (or more).
 copyright: $(BIN)/copyright | $(BUILD) ## update copyright headers
@@ -463,6 +471,14 @@ release: ## Re-generate generated code and run tests
 	$(MAKE) --no-print-directory go-generate
 	$(MAKE) --no-print-directory test
 
+build: ## Build all packages and all tests (ensures everything compiles)
+	$Q echo 'Building all packages...'
+	$Q go build ./...
+	$Q # "tests" by building and then running `true`, and hides test-success output
+	$Q echo 'Building all tests (~5x slower)...'
+	$Q # intentionally not -race due to !race build tags
+	$Q go test -exec /usr/bin/true ./... >/dev/null
+
 clean: ## Clean build products
 	rm -f $(BINS)
 	rm -Rf $(BUILD)
@@ -472,7 +488,7 @@ clean: ## Clean build products
 
 # v----- not yet cleaned up -----v
 
-.PHONY: git-submodules test bins clean cover cover_ci help
+.PHONY: git-submodules test bins build clean cover cover_ci help
 
 TOOLS_CMD_ROOT=./cmd/tools
 INTEG_TEST_ROOT=./host

.gen/proto/indexer/v1/messages.pb.go

@@ -25,9 +25,8 @@ import (
 	"fmt"
 	"time"
 
-	shared "go.uber.org/cadence/.gen/go/shared"
-
 	"github.com/google/uuid"
+	shared "go.uber.org/cadence/.gen/go/shared"
 	"go.uber.org/cadence/activity"
 	"go.uber.org/cadence/workflow"
 	"go.uber.org/zap"

.gen/proto/matching/v1/service.pb.go

@@ -21,14 +21,14 @@
 package canary
 
 import (
-	"fmt"
-	"sync"
-	"time"
-
 	"crypto/tls"
 	"crypto/x509"
+	"fmt"
 	"io/ioutil"
+	"sync"
+	"time"
 
+	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
 	"go.uber.org/cadence/.gen/go/cadence/workflowserviceclient"
 	"go.uber.org/cadence/compatibility"
 	"go.uber.org/yarpc"
@@ -40,8 +40,6 @@ import (
 	"go.uber.org/zap"
 	"google.golang.org/grpc/credentials"
 
-	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
-
 	"github.com/uber/cadence/common/log/loggerimpl"
 )
 

.gen/proto/shared/v1/error.pb.go

@@ -23,9 +23,9 @@ package admin
 import (
 	"context"
 
+	adminv1 "github.com/uber/cadence-idl/go/proto/admin/v1"
 	"go.uber.org/yarpc"
 
-	adminv1 "github.com/uber/cadence-idl/go/proto/admin/v1"
 	"github.com/uber/cadence/common/types"
 	"github.com/uber/cadence/common/types/mapper/proto"
 )

.gen/proto/shared/v1/history.pb.go

@@ -23,18 +23,16 @@ package client
 import (
 	"time"
 
+	adminv1 "github.com/uber/cadence-idl/go/proto/admin/v1"
+	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
 	"go.uber.org/yarpc/api/transport"
 
 	"github.com/uber/cadence/.gen/go/admin/adminserviceclient"
 	"github.com/uber/cadence/.gen/go/cadence/workflowserviceclient"
 	"github.com/uber/cadence/.gen/go/history/historyserviceclient"
 	"github.com/uber/cadence/.gen/go/matching/matchingserviceclient"
-
-	adminv1 "github.com/uber/cadence-idl/go/proto/admin/v1"
-	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
 	historyv1 "github.com/uber/cadence/.gen/proto/history/v1"
 	matchingv1 "github.com/uber/cadence/.gen/proto/matching/v1"
-
 	"github.com/uber/cadence/client/admin"
 	"github.com/uber/cadence/client/frontend"
 	"github.com/uber/cadence/client/history"

Makefile

@@ -23,9 +23,9 @@ package frontend
 import (
 	"context"
 
+	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
 	"go.uber.org/yarpc"
 
-	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
 	"github.com/uber/cadence/common/types"
 	"github.com/uber/cadence/common/types/mapper/proto"
 )

canary/crosscluster.go

@@ -29,13 +29,12 @@ import (
 	"strings"
 	"syscall"
 
-	"github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql"
-
 	"github.com/urfave/cli"
 
 	"github.com/uber/cadence/common"
 	"github.com/uber/cadence/common/client"
 	"github.com/uber/cadence/common/config"
+	"github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql"
 	"github.com/uber/cadence/common/service"
 	"github.com/uber/cadence/tools/cassandra"
 	"github.com/uber/cadence/tools/sql"

canary/runner.go

@@ -24,13 +24,11 @@ import (
 	"log"
 	"time"
 
+	"github.com/startreedata/pinot-client-go/pinot"
+	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
 	"go.uber.org/cadence/.gen/go/cadence/workflowserviceclient"
 	"go.uber.org/cadence/compatibility"
 
-	apiv1 "github.com/uber/cadence-idl/go/proto/api/v1"
-	"github.com/uber/cadence/common/persistence"
-	"github.com/uber/cadence/service/worker"
-
 	"github.com/uber/cadence/common"
 	"github.com/uber/cadence/common/archiver"
 	"github.com/uber/cadence/common/archiver/provider"
@@ -46,16 +44,15 @@ import (
 	"github.com/uber/cadence/common/messaging/kafka"
 	"github.com/uber/cadence/common/metrics"
 	"github.com/uber/cadence/common/peerprovider/ringpopprovider"
+	"github.com/uber/cadence/common/persistence"
+	pnt "github.com/uber/cadence/common/pinot"
 	"github.com/uber/cadence/common/resource"
 	"github.com/uber/cadence/common/rpc"
 	"github.com/uber/cadence/common/service"
 	"github.com/uber/cadence/service/frontend"
 	"github.com/uber/cadence/service/history"
 	"github.com/uber/cadence/service/matching"
-
-	"github.com/startreedata/pinot-client-go/pinot"
-
-	pnt "github.com/uber/cadence/common/pinot"
+	"github.com/uber/cadence/service/worker"
 )
 
 type (

client/admin/grpcClient.go

@@ -34,12 +34,13 @@ import (
 
 	"github.com/uber/cadence/common"
 	"github.com/uber/cadence/common/config"
-	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra" // needed to load cassandra plugin
 	"github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql"
-	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql/public" // needed to load the default gocql client
 	"github.com/uber/cadence/common/service"
 	"github.com/uber/cadence/testflags"
 	"github.com/uber/cadence/tools/cassandra"
+
+	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra"              // needed to load cassandra plugin
+	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql/public" // needed to load the default gocql client
 )
 
 type ServerSuite struct {

client/clientfactory.go

@@ -25,6 +25,7 @@ import (
 
 	"github.com/uber/cadence/cmd/server/cadence"
 	"github.com/uber/cadence/common/metrics"
+
 	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra"              // needed to load cassandra plugin
 	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql/public" // needed to load the default gocql client
 	_ "github.com/uber/cadence/common/persistence/sql/sqlplugin/mysql"                      // needed to load mysql plugin

client/frontend/grpcClient.go

@@ -23,8 +23,9 @@ package main
 import (
 	"os"
 
-	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql/public" // needed to load the default gocql client
 	"github.com/uber/cadence/tools/cassandra"
+
+	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql/public" // needed to load the default gocql client
 )
 
 func main() {

cmd/server/cadence/cadence.go

@@ -24,11 +24,12 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/uber/cadence/tools/cli"
+
 	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra"              // needed to load cassandra plugin
 	_ "github.com/uber/cadence/common/persistence/nosql/nosqlplugin/cassandra/gocql/public" // needed to load the default gocql client
 	_ "github.com/uber/cadence/common/persistence/sql/sqlplugin/mysql"                      // needed to load mysql plugin
 	_ "github.com/uber/cadence/common/persistence/sql/sqlplugin/postgres"                   // needed to load postgres plugin
-	"github.com/uber/cadence/tools/cli"
 )
 
 // Start using this CLI tool with command

cmd/server/cadence/server.go

@@ -23,9 +23,10 @@ package main
 import (
 	"os"
 
+	"github.com/uber/cadence/tools/sql"
+
 	_ "github.com/uber/cadence/common/persistence/sql/sqlplugin/mysql"    // needed to load mysql plugin
 	_ "github.com/uber/cadence/common/persistence/sql/sqlplugin/postgres" // needed to load postgres plugin
-	"github.com/uber/cadence/tools/sql"
 )
 
 func main() {

cmd/server/cadence/server_test.go

@@ -20,9 +20,7 @@
 
 package archiver
 
-import (
-	"net/url"
-)
+import "net/url"
 
 type (
 	// URI identifies the archival resource to which records are written to and read from.

cmd/server/main.go

@@ -20,9 +20,7 @@
 
 package archiver
 
-import (
-	"github.com/stretchr/testify/mock"
-)
+import "github.com/stretchr/testify/mock"
 
 // MockArchivalMetadata is an autogenerated mock type for the ArchivalMetadata type
 type MockArchivalMetadata struct {

cmd/tools/cassandra/main.go

@@ -20,9 +20,7 @@
 
 package archiver
 
-import (
-	"errors"
-)
+import "errors"
 
 const (
 	// ArchiveNonRetriableErrorMsg is the log message when the Archive() method encounters a non-retriable error

cmd/tools/cli/main.go

@@ -24,10 +24,9 @@ import (
 	"errors"
 	"sync"
 
-	"github.com/uber/cadence/common/archiver/gcloud"
-
 	"github.com/uber/cadence/common/archiver"
 	"github.com/uber/cadence/common/archiver/filestore"
+	"github.com/uber/cadence/common/archiver/gcloud"
 	"github.com/uber/cadence/common/archiver/s3store"
 	"github.com/uber/cadence/common/config"
 )