cherry pick pingcap#838 to release-4.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
ti-srebot · Mar 10, 2021 · a4b4e7e · a4b4e7e
1 parent cdfda3e
commit a4b4e7e
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 6 deletions.
diff --git a/Makefile b/Makefile
@@ -111,10 +111,11 @@ build_for_integration_test:
 	) || (make failpoint-disable && exit 1)
 	@make failpoint-disable
 
+test: export ARGS=$$($(PACKAGES))
 test:
 	$(PREPARE_MOD)
 	@make failpoint-enable
-	$(GOTEST) $(RACEFLAG) -tags leak $$($(PACKAGES)) || ( make failpoint-disable && exit 1 )
+	$(GOTEST) $(RACEFLAG) -tags br_test,leak $(ARGS) || ( make failpoint-disable && exit 1 )
 	@make failpoint-disable
 
 testcover: tools
@@ -188,7 +189,7 @@ static: prepare tools
 	@#   exhaustivestruct - Protobuf structs have hidden fields, like "XXX_NoUnkeyedLiteral"
 	@#         exhaustive - no need to check exhaustiveness of enum switch statements
 	@#              gosec - too many false positive
-	CGO_ENABLED=0 tools/bin/golangci-lint run --enable-all --deadline 120s \
+	CGO_ENABLED=0 tools/bin/golangci-lint run --enable-all --build-tags br_test --deadline 120s \
 		--disable gochecknoglobals \
 		--disable goimports \
 		--disable gofmt \

diff --git a/pkg/mock/backend.go b/pkg/mock/backend.go
diff --git a/pkg/mock/dummy.go b/pkg/mock/dummy.go
@@ -0,0 +1,5 @@
+// Copyright 2021 PingCAP, Inc. Licensed under Apache-2.0.
+
+// This file avoids mock being an empty package when `-tags br_test` is not provided.
+
+package mock
diff --git a/pkg/mock/glue.go b/pkg/mock/glue.go
diff --git a/pkg/mock/glue_checkpoint.go b/pkg/mock/glue_checkpoint.go
diff --git a/pkg/mock/importer.go b/pkg/mock/importer.go
diff --git a/pkg/mock/mock_cluster.go b/pkg/mock/mock_cluster.go
@@ -1,5 +1,7 @@
 // Copyright 2020 PingCAP, Inc. Licensed under Apache-2.0.
 
+//+build br_test
+
 package mock
 
 import (

diff --git a/pkg/mock/mock_cluster_test.go b/pkg/mock/mock_cluster_test.go
@@ -1,5 +1,7 @@
 // Copyright 2020 PingCAP, Inc. Licensed under Apache-2.0.
 
+//+build br_test
+
 package mock_test
 
 import (

diff --git a/pkg/mock/s3iface.go b/pkg/mock/s3iface.go
diff --git a/pkg/mock/storage.go b/pkg/mock/storage.go
diff --git a/tests/README.md b/tests/README.md
@@ -1,8 +1,38 @@
-This folder contains all tests which relies on external processes such as TiDB.
+# Unit tests
 
 Unit tests (the `*_test.go` files inside the source directory) should *never* rely on external
 programs.
 
+Run `make test` to execute all unit tests.
+
+To run a specific test, pass `ARGS` into `make test` like
+
+```sh
+make test ARGS='github.com/pingcap/br/pkg/cdclog --test.v --check.v --check.f TestColumn'
+#               ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#                which package to test            more extra test flags
+```
+
+You can also run unit tests directly via `go test` like:
+
+```sh
+make failpoint-enable
+
+go test -tags br_test github.com/pingcap/br/pkg/cdclog --test.v --check.v --check.f TestColumn
+#       ^~~~~~~~~~~~~
+
+make failpoint-disable
+```
+
+but note that:
+
+* the build-tag `br_test` must be enabled (this workarounds the lack of test-dependencies in go.mod)
+* failpoints must be toggled manually
+
+# Integration tests
+
+This folder contains all tests which relies on external processes such as TiDB.
+
 ## Preparations
 
 1. The following 9 executables must be copied or linked into these locations:
@@ -39,7 +69,6 @@ If you have docker installed, you can skip step 1 and step 2 by running
 
 ## Running
 
-Run `make test` to execute the unit tests.
 Run `make integration_test` to execute the integration tests. This command will
 
 1. Build `br`