pkg,cdc: do not use log package (#3902)

pingcap · Dec 17, 2021 · 2ed0236 · 2ed0236
1 parent 84acdbc
commit 2ed0236
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 10 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -3,6 +3,7 @@ linters:
     - unconvert
     - unparam
     - revive
+    - depguard
 
 linters-settings:
   revive:
@@ -28,3 +29,14 @@ linters-settings:
       - name: superfluous-else
       - name: modifies-parameter
       - name: unreachable-code
+
+  depguard:
+    list-type: blacklist
+    include-go-root: false
+    packages:
+      - log
+      - github.com/juju/errors
+    packages-with-error-message:
+      # specify an error message to output when a blacklisted package is used
+      - log: "logging is allowed only by pingcap/log"
+      - github.com/juju/errors: "error handling is allowed only by pingcap/errors"
diff --git a/cdc/puller/frontier/list.go b/cdc/puller/frontier/list.go
@@ -16,11 +16,12 @@ package frontier
 import (
 	"bytes"
 	"fmt"
-	"log"
 	"math"
 	"strings"
 
 	_ "unsafe" // required by go:linkname
+
+	"github.com/pingcap/log"
 )
 
 const (

diff --git a/cdc/scheduler/util/table_set.go b/cdc/scheduler/util/table_set.go
@@ -14,8 +14,7 @@
 package util
 
 import (
-	"log"
-
+	"github.com/pingcap/log"
 	"github.com/pingcap/ticdc/cdc/model"
 	"go.uber.org/zap"
 )

diff --git a/cdc/sink/codec/canal.go b/cdc/sink/codec/canal.go
@@ -16,12 +16,12 @@ package codec
 import (
 	"context"
 	"fmt"
-	"log"
 	"strconv"
 	"strings"
 
 	"github.com/golang/protobuf/proto" // nolint:staticcheck
 	"github.com/pingcap/errors"
+	"github.com/pingcap/log"
 	"github.com/pingcap/ticdc/cdc/model"
 	"github.com/pingcap/ticdc/pkg/config"
 	cerror "github.com/pingcap/ticdc/pkg/errors"

diff --git a/cdc/sink/common/flow_control.go b/cdc/sink/common/flow_control.go
@@ -14,12 +14,12 @@
 package common
 
 import (
-	"log"
 	"sync"
 	"sync/atomic"
 
 	"github.com/edwingeng/deque"
 	"github.com/pingcap/errors"
+	"github.com/pingcap/log"
 	cerrors "github.com/pingcap/ticdc/pkg/errors"
 	"go.uber.org/zap"
 )

diff --git a/pkg/context/context.go b/pkg/context/context.go
@@ -15,9 +15,9 @@ package context
 
 import (
 	"context"
-	"log"
 	"time"
 
+	"github.com/pingcap/log"
 	"github.com/pingcap/ticdc/cdc/kv"
 	"github.com/pingcap/ticdc/cdc/model"
 	"github.com/pingcap/ticdc/cdc/processor/pipeline/system"

diff --git a/pkg/context/context_test.go b/pkg/context/context_test.go
@@ -129,7 +129,7 @@ func TestThrowPanic(t *testing.T) {
 	t.Parallel()
 	defer func() {
 		panicMsg := recover()
-		require.Equal(t, panicMsg, "an error has escaped, please report a bug{error 26 0  mock error}")
+		require.Equal(t, panicMsg, "an error has escaped, please report a bug")
 	}()
 	stdCtx := context.Background()
 	ctx := NewContext(stdCtx, &GlobalVars{})

diff --git a/pkg/etcd/etcdkey.go b/pkg/etcd/etcdkey.go
@@ -14,9 +14,9 @@
 package etcd
 
 import (
-	"log"
 	"strings"
 
+	"github.com/pingcap/log"
 	cerror "github.com/pingcap/ticdc/pkg/errors"
 )
 

diff --git a/pkg/orchestrator/util/key_utils.go b/pkg/orchestrator/util/key_utils.go
@@ -14,8 +14,9 @@
 package util
 
 import (
-	"log"
 	"strings"
+
+	"github.com/pingcap/log"
 )
 
 // EtcdKey represents a complete key in Etcd.

diff --git a/tests/mq_protocol_tests/cases/case_date_time.go b/tests/mq_protocol_tests/cases/case_date_time.go
@@ -15,9 +15,9 @@ package cases
 
 import (
 	"errors"
-	"log"
 	"time"
 
+	"github.com/pingcap/log"
 	"github.com/pingcap/ticdc/tests/mq_protocol_tests/framework"
 	"github.com/pingcap/ticdc/tests/mq_protocol_tests/framework/avro"
 	"github.com/pingcap/ticdc/tests/mq_protocol_tests/framework/canal"