Release 4.0 merge master

.codecov.yml

@@ -0,0 +1,10 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  status:
+    project:
+      default:
+        # Allow the coverage to drop by 3%
+        threshold: 3%
+    patch: off

.dockerignore

@@ -0,0 +1 @@
+.gitignore

.gitignore

@@ -7,3 +7,5 @@ backupmeta
 *.ngo
 *.coverprofile
 coverage.txt
+docker/data/
+docker/logs/

.golangci.yml

@@ -9,7 +9,8 @@ issues:
       text: "Potential HTTP request made with variable url"
       linters:
         - gosec
-    - path: .go
-      text: "Use of weak random number generator"
+    # TODO Remove it.
+    - path: split_client.go
+      text: "SA1019:"
       linters:
-        - gosec
+        - staticcheck

LICENSE.md

@@ -186,7 +186,7 @@ Apache License
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {}
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -198,4 +198,4 @@ Apache License
    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.
+   limitations under the License.

Makefile

@@ -12,25 +12,28 @@ LDFLAGS += -X "$(BR_PKG)/pkg/utils.BRBuildTS=$(shell date -u '+%Y-%m-%d %I:%M:%S
 LDFLAGS += -X "$(BR_PKG)/pkg/utils.BRGitHash=$(shell git rev-parse HEAD)"
 LDFLAGS += -X "$(BR_PKG)/pkg/utils.BRGitBranch=$(shell git rev-parse --abbrev-ref HEAD)"
 
-all: check test build
+ifeq ("$(WITH_RACE)", "1")
+	RACEFLAG = -race
+endif
 
-release:
-	GO111MODULE=on go build -ldflags '$(LDFLAGS)' -o bin/br
+all: check test build
 
 build:
-	GO111MODULE=on go build -ldflags '$(LDFLAGS)' -race -o bin/br
+	GO111MODULE=on go build -ldflags '$(LDFLAGS)' ${RACEFLAG} -o bin/br
 
 build_for_integration_test:
 	GO111MODULE=on go test -c -cover -covermode=count \
 		-coverpkg=$(BR_PKG)/... \
 		-o bin/br.test
 	# build key locker
-	GO111MODULE=on go build -race -o bin/locker tests/br_key_locked/*.go
+	GO111MODULE=on go build ${RACEFLAG} -o bin/locker tests/br_key_locked/*.go
 	# build gc
-	GO111MODULE=on go build -race -o bin/gc tests/br_z_gc_safepoint/*.go
+	GO111MODULE=on go build ${RACEFLAG} -o bin/gc tests/br_z_gc_safepoint/*.go
+	# build rawkv client
+	GO111MODULE=on go build ${RACEFLAG} -o bin/rawkv tests/br_rawkv/*.go
 
 test:
-	GO111MODULE=on go test -race -tags leak ./...
+	GO111MODULE=on go test ${RACEFLAG} -tags leak ./...
 
 testcover:
 	GO111MODULE=on retool do overalls \
@@ -46,6 +49,7 @@ integration_test: build build_for_integration_test
 	@which bin/pd-server
 	@which bin/pd-ctl
 	@which bin/go-ycsb
+	@which bin/minio
 	@which bin/br
 	tests/run.sh
 
@@ -71,6 +75,12 @@ static:
 		--disable interfacer \
 		--disable goimports \
 		--disable gofmt \
+		--disable wsl \
+		--disable funlen \
+		--disable whitespace \
+		--disable gocognit \
+		--disable godox \
+		--disable gomnd \
 		$$($(PACKAGE_DIRECTORIES))
 
 lint:

README.md

@@ -36,6 +36,41 @@ Notice BR supports building with Go version `Go >= 1.13`
 
 When BR is built successfully, you can find binary in the `bin` directory.
 
+## Quick start
+
+```sh
+# Start TiDB cluster
+docker-compose -f docker-compose.yaml rm -s -v && \
+docker-compose -f docker-compose.yaml build && \
+docker-compose -f docker-compose.yaml up --remove-orphans
+
+# Attach to control container to run BR
+docker exec -it br_control_1 bash
+
+# Load testing data to TiDB
+go-ycsb load mysql -p workload=core \
+    -p mysql.host=tidb -p mysql.port=4000 -p mysql.user=root \
+    -p recordcount=100000 -p threadcount=100
+
+# How many rows do we get? 100000 rows.
+mysql -uroot -htidb -P4000 -E -e "SELECT COUNT(*) FROM test.usertable"
+
+# Build BR and backup!
+make release && \
+bin/br backup full --pd pd0:2379 --storage "local:///data/backup/full" \
+    --log-file "/logs/br_backup.log"
+
+# Let's drop database.
+mysql -uroot -htidb -P4000 -E -e "DROP DATABASE test; SHOW DATABASES;"
+
+# Restore!
+bin/br restore full --pd pd0:2379 --storage "local:///data/backup/full" \
+    --log-file "/logs/br_restore.log"
+
+# How many rows do we get again? Expected to be 100000 rows.
+mysql -uroot -htidb -P4000 -E -e "SELECT COUNT(*) FROM test.usertable"
+```
+
 ## Contributing
 
 Contributions are welcomed and greatly appreciated. See [CONTRIBUTING](./CONTRIBUTING.md)