*: enable gci

DEPS.bzl

@@ -473,6 +473,14 @@ def go_deps():
         sum = "h1:0rkFMAbn5KBKNpJyHQ6Prb95vIKanmAe62KxsrN+sqA=",
         version = "v0.0.0-20171016134553-529a34b1c186",
     )
+    go_repository(
+        name = "com_github_daixiang0_gci",
+        build_file_proto_mode = "disable",
+        importpath = "github.com/daixiang0/gci",
+        sum = "h1:+EZ83znNs73C9ZBTM7xhNagMP6gJs5wlptiFiuce5BM=",
+        version = "v0.3.4",
+    )
+
     go_repository(
         name = "com_github_danjacques_gofslock",
         build_file_proto_mode = "disable_global",
@@ -1250,6 +1258,14 @@ def go_deps():
         sum = "h1:5IcZpTvzydCQeHzK4Ef/D5rrSqwxob0t8PQPMybUNFM=",
         version = "v1.1.2",
     )
+    go_repository(
+        name = "com_github_hexops_gotextdiff",
+        build_file_proto_mode = "disable",
+        importpath = "github.com/hexops/gotextdiff",
+        sum = "h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=",
+        version = "v1.0.3",
+    )
+
     go_repository(
         name = "com_github_hpcloud_tail",
         build_file_proto_mode = "disable_global",

br/pkg/lightning/backend/kv/sql2kv.go

@@ -33,7 +33,9 @@ import (
 	"github.com/pingcap/tidb/expression"
 	"github.com/pingcap/tidb/meta/autoid"
 	"github.com/pingcap/tidb/parser/model"
-	"github.com/pingcap/tidb/parser/mysql"
+	"github.com/pingcap/tidb/parser/mysql" //nolint: goimports
+	// Import tidb/planner/core to initialize expression.RewriteAstExpr
+	_ "github.com/pingcap/tidb/planner/core"
 	"github.com/pingcap/tidb/sessionctx/variable"
 	"github.com/pingcap/tidb/table"
 	"github.com/pingcap/tidb/table/tables"
@@ -42,9 +44,6 @@ import (
 	"github.com/pingcap/tidb/util/chunk"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
-
-	// Import tidb/planner/core to initialize expression.RewriteAstExpr
-	_ "github.com/pingcap/tidb/planner/core"
 )
 
 var ExtraHandleColumnInfo = model.NewExtraHandleColInfo()

br/pkg/lightning/backend/local/engine_test.go

@@ -26,10 +26,9 @@ import (
 	"github.com/cockroachdb/pebble"
 	"github.com/cockroachdb/pebble/sstable"
 	"github.com/google/uuid"
+	"github.com/pingcap/tidb/br/pkg/lightning/backend"
 	"github.com/pingcap/tidb/br/pkg/lightning/log"
 	"github.com/stretchr/testify/require"
-
-	"github.com/pingcap/tidb/br/pkg/lightning/backend"
 )
 
 func TestIngestSSTWithClosedEngine(t *testing.T) {

br/pkg/lightning/errormanager/errormanager.go

@@ -25,15 +25,14 @@ import (
 	"github.com/jedib0t/go-pretty/v6/table"
 	"github.com/jedib0t/go-pretty/v6/text"
 	"github.com/pingcap/errors"
-	"go.uber.org/multierr"
-	"go.uber.org/zap"
-	"golang.org/x/sync/errgroup"
-
 	"github.com/pingcap/tidb/br/pkg/lightning/common"
 	"github.com/pingcap/tidb/br/pkg/lightning/config"
 	"github.com/pingcap/tidb/br/pkg/lightning/log"
 	"github.com/pingcap/tidb/br/pkg/redact"
 	"github.com/pingcap/tidb/br/pkg/utils"
+	"go.uber.org/multierr"
+	"go.uber.org/zap"
+	"golang.org/x/sync/errgroup"
 )
 
 const (

br/pkg/lightning/errormanager/errormanager_test.go

@@ -25,12 +25,11 @@ import (
 	"testing"
 
 	"github.com/DATA-DOG/go-sqlmock"
+	"github.com/pingcap/tidb/br/pkg/lightning/config"
 	"github.com/pingcap/tidb/br/pkg/lightning/log"
+	"github.com/pingcap/tidb/br/pkg/utils"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/atomic"
-
-	"github.com/pingcap/tidb/br/pkg/lightning/config"
-	"github.com/pingcap/tidb/br/pkg/utils"
 )
 
 func TestInit(t *testing.T) {

br/pkg/lightning/mydump/charset_convertor.go

@@ -19,10 +19,9 @@ import (
 	"unicode/utf8"
 
 	"github.com/pingcap/errors"
+	"github.com/pingcap/tidb/br/pkg/lightning/config"
 	"golang.org/x/text/encoding"
 	"golang.org/x/text/encoding/simplifiedchinese"
-
-	"github.com/pingcap/tidb/br/pkg/lightning/config"
 )
 
 // CharsetConvertor is used to convert a character set to utf8mb4 encoding.

br/pkg/lightning/mydump/router.go

@@ -7,12 +7,11 @@ import (
 	"strings"
 
 	"github.com/pingcap/errors"
+	"github.com/pingcap/tidb/br/pkg/lightning/config"
+	"github.com/pingcap/tidb/br/pkg/lightning/log"
 	"github.com/pingcap/tidb/util/filter"
 	"github.com/pingcap/tidb/util/slice"
 	"go.uber.org/zap"
-
-	"github.com/pingcap/tidb/br/pkg/lightning/config"
-	"github.com/pingcap/tidb/br/pkg/lightning/log"
 )
 
 type SourceType int

br/pkg/lightning/restore/restore_schema_test.go

@@ -23,10 +23,6 @@ import (
 	"github.com/DATA-DOG/go-sqlmock"
 	"github.com/golang/mock/gomock"
 	"github.com/pingcap/errors"
-	filter "github.com/pingcap/tidb/util/table-filter"
-	"github.com/stretchr/testify/require"
-	"github.com/stretchr/testify/suite"
-
 	"github.com/pingcap/tidb/br/pkg/lightning/backend"
 	"github.com/pingcap/tidb/br/pkg/lightning/checkpoints"
 	"github.com/pingcap/tidb/br/pkg/lightning/config"
@@ -39,6 +35,9 @@ import (
 	"github.com/pingcap/tidb/parser/model"
 	"github.com/pingcap/tidb/parser/mysql"
 	tmock "github.com/pingcap/tidb/util/mock"
+	filter "github.com/pingcap/tidb/util/table-filter"
+	"github.com/stretchr/testify/require"
+	"github.com/stretchr/testify/suite"
 )
 
 type restoreSchemaSuite struct {

br/pkg/restore/rawkv_client_test.go

@@ -12,10 +12,9 @@ import (
 	berrors "github.com/pingcap/tidb/br/pkg/errors"
 	"github.com/pingcap/tidb/br/pkg/restore"
 	"github.com/pingcap/tidb/kv"
+	"github.com/pingcap/tidb/util/codec"
 	"github.com/stretchr/testify/require"
 	"github.com/tikv/client-go/v2/rawkv"
-
-	"github.com/pingcap/tidb/util/codec"
 )
 
 // fakeRawkvClient is a mock for rawkv.client

br/pkg/storage/azblob.go

@@ -12,15 +12,14 @@ import (
 	"path"
 	"strings"
 
-	"github.com/google/uuid"
-	"github.com/spf13/pflag"
-
 	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
 	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
+	"github.com/google/uuid"
 	"github.com/pingcap/errors"
 	backuppb "github.com/pingcap/kvproto/pkg/brpb"
 	"github.com/pingcap/log"
 	berrors "github.com/pingcap/tidb/br/pkg/errors"
+	"github.com/spf13/pflag"
 	"go.uber.org/zap"
 )
 

br/pkg/storage/compress.go

@@ -8,7 +8,6 @@ import (
 	"io"
 
 	"github.com/pingcap/errors"
-
 	berrors "github.com/pingcap/tidb/br/pkg/errors"
 )
 

br/pkg/storage/s3.go

@@ -27,11 +27,10 @@ import (
 	"github.com/pingcap/errors"
 	backuppb "github.com/pingcap/kvproto/pkg/brpb"
 	"github.com/pingcap/log"
-	"github.com/spf13/pflag"
-	"go.uber.org/zap"
-
 	berrors "github.com/pingcap/tidb/br/pkg/errors"
 	"github.com/pingcap/tidb/br/pkg/logutil"
+	"github.com/spf13/pflag"
+	"go.uber.org/zap"
 )
 
 const (

br/pkg/stream/client.go

@@ -10,14 +10,13 @@ import (
 
 	"github.com/gogo/protobuf/proto"
 	"github.com/pingcap/errors"
-	"github.com/pingcap/log"
-	"go.uber.org/zap"
-
 	backuppb "github.com/pingcap/kvproto/pkg/brpb"
+	"github.com/pingcap/log"
 	berrors "github.com/pingcap/tidb/br/pkg/errors"
 	"github.com/pingcap/tidb/br/pkg/redact"
 	"github.com/pingcap/tidb/kv"
 	clientv3 "go.etcd.io/etcd/client/v3"
+	"go.uber.org/zap"
 )
 
 // MetaDataClient is the client for operations over metadata.

br/pkg/stream/integration_test.go

@@ -10,10 +10,9 @@ import (
 	"net/url"
 	"testing"
 
-	berrors "github.com/pingcap/tidb/br/pkg/errors"
-
 	"github.com/pingcap/errors"
 	"github.com/pingcap/log"
+	berrors "github.com/pingcap/tidb/br/pkg/errors"
 	"github.com/pingcap/tidb/br/pkg/logutil"
 	"github.com/pingcap/tidb/br/pkg/storage"
 	"github.com/pingcap/tidb/br/pkg/stream"

br/pkg/task/stream_test.go

@@ -25,7 +25,6 @@ import (
 
 	"github.com/pingcap/errors"
 	backuppb "github.com/pingcap/kvproto/pkg/brpb"
-
 	"github.com/pingcap/kvproto/pkg/metapb"
 	"github.com/pingcap/tidb/br/pkg/conn"
 	"github.com/pingcap/tidb/br/pkg/pdutil"

build/BUILD.bazel

@@ -124,6 +124,7 @@ nogo(
                "//build/linter/durationcheck:durationcheck",
                "//build/linter/exportloopref:exportloopref",
                "//build/linter/gofmt:gofmt",
+               "//build/linter/gci:gci",
                "//build/linter/ineffassign:ineffassign",
                "//build/linter/misspell:misspell",
                "//build/linter/prealloc:prealloc",

build/linter/gci/BUILD.bazel

@@ -0,0 +1,13 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+
+go_library(
+    name = "gci",
+    srcs = ["analysis.go"],
+    importpath = "github.com/pingcap/tidb/build/linter/gci",
+    visibility = ["//visibility:public"],
+    deps = [
+        "@com_github_daixiang0_gci//pkg/configuration",
+        "@com_github_daixiang0_gci//pkg/gci",
+        "@org_golang_x_tools//go/analysis",
+    ],
+)

build/linter/gci/analysis.go

@@ -0,0 +1,65 @@
+// Copyright 2022 PingCAP, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package gci
+
+import (
+	"fmt"
+	"sync"
+
+	"github.com/daixiang0/gci/pkg/configuration"
+	"github.com/daixiang0/gci/pkg/gci"
+	"golang.org/x/tools/go/analysis"
+)
+
+// Analyzer is the analyzer struct of gci.
+var Analyzer = &analysis.Analyzer{
+	Name: "gci",
+	Doc:  "Gci controls golang package import order and makes it always deterministic.",
+	Run:  run,
+}
+
+func run(pass *analysis.Pass) (any, error) {
+	fileNames := make([]string, 0, len(pass.Files))
+	for _, f := range pass.Files {
+		pos := pass.Fset.PositionFor(f.Pos(), false)
+		fileNames = append(fileNames, pos.Filename)
+	}
+	var rawCfg gci.GciStringConfiguration
+	rawCfg.Cfg = configuration.FormatterConfiguration{
+		NoInlineComments: false,
+		NoPrefixComments: false,
+		Debug:            false,
+	}
+	cfg, _ := rawCfg.Parse()
+	var diffs []string
+	var lock sync.Mutex
+	err := gci.DiffFormattedFilesToArray(fileNames, *cfg, &diffs, &lock)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, diff := range diffs {
+		if diff == "" {
+			continue
+		}
+
+		pass.Report(analysis.Diagnostic{
+			Pos:     1,
+			Message: fmt.Sprintf("\n%s", diff),
+		})
+	}
+
+	return nil, nil
+}

build/nogo_config.json

@@ -142,6 +142,18 @@
       ".*failpoint_binding__.go$": "ignore generated code"
     }
   },
+  "gci": {
+    "exclude_files": {
+      "/external/": "no need to vet third party code",
+      ".*_generated\\.go$": "ignore generated code",
+      "/cgo/": "ignore cgo code",
+      ".*\\.pb\\.go$": "generated code",
+      "/rules_go_work-*": "ignore generated code",
+      ".*test_/testmain\\.go$": "ignore generated code",
+      ".*failpoint_binding__.go$": "ignore generated code",
+      "util/printer/printer.go": "ignore util/printer code"
+    }
+  },
   "httpresponse": {
     "exclude_files": {
       "/external/": "no need to vet third party code",

cmd/benchraw/main.go

@@ -30,7 +30,6 @@ import (
 	"github.com/pingcap/tidb/parser/terror"
 	"github.com/tikv/client-go/v2/config"
 	"github.com/tikv/client-go/v2/rawkv"
-
 	"go.uber.org/zap"
 )
 

ddl/serial_test.go

@@ -28,7 +28,6 @@ import (
 	"github.com/pingcap/tidb/config"
 	"github.com/pingcap/tidb/ddl"
 	"github.com/pingcap/tidb/ddl/util"
-	ddlutil "github.com/pingcap/tidb/ddl/util"
 	"github.com/pingcap/tidb/domain"
 	"github.com/pingcap/tidb/errno"
 	"github.com/pingcap/tidb/infoschema"
@@ -726,7 +725,7 @@ func TestCancelJobByErrorCountLimit(t *testing.T) {
 
 	limit := variable.GetDDLErrorCountLimit()
 	tk.MustExec("set @@global.tidb_ddl_error_count_limit = 16")
-	err := ddlutil.LoadDDLVars(tk.Session())
+	err := util.LoadDDLVars(tk.Session())
 	require.NoError(t, err)
 	defer tk.MustExec(fmt.Sprintf("set @@global.tidb_ddl_error_count_limit = %d", limit))
 
@@ -744,7 +743,7 @@ func TestTruncateTableUpdateSchemaVersionErr(t *testing.T) {
 
 	limit := variable.GetDDLErrorCountLimit()
 	tk.MustExec("set @@global.tidb_ddl_error_count_limit = 5")
-	err := ddlutil.LoadDDLVars(tk.Session())
+	err := util.LoadDDLVars(tk.Session())
 	require.NoError(t, err)
 	defer tk.MustExec(fmt.Sprintf("set @@global.tidb_ddl_error_count_limit = %d", limit))
 

ddl/table_split_test.go

@@ -26,10 +26,8 @@ import (
 	"github.com/pingcap/tidb/store/mockstore"
 	"github.com/pingcap/tidb/tablecodec"
 	"github.com/pingcap/tidb/testkit"
-
-	"github.com/tikv/client-go/v2/tikv"
-
 	"github.com/stretchr/testify/require"
+	"github.com/tikv/client-go/v2/tikv"
 )
 
 func TestTableSplit(t *testing.T) {

distsql/select_result_test.go

@@ -24,7 +24,6 @@ import (
 	"github.com/pingcap/tidb/util/execdetails"
 	"github.com/pingcap/tidb/util/mock"
 	"github.com/pingcap/tipb/go-tipb"
-
 	"github.com/stretchr/testify/require"
 )