drand/Makefile at master · proofofplay/drand · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
.PHONY: test test-unit test-unit-boltdb test-unit-memdb test-unit-postgres
.PHONY: test-unit-cover test-unit-boltdb-cover test-unit-memdb-cover test-unit-postgres-cover
.PHONY: coverage coverage-boltdb coverage-memdb coverage-postgres
.PHONY: test-integration test-integration-boltdb test-integration-memdb test-integration-postgres
.PHONY: test-integration-run-demo test-integration-run-demo-boltdb test-integration-run-demo-memdb test-integration-run-demo-postgres
.PHONY: demo demo-boltdb demo-memdb demo-postgres
.PHONY: deploy-local linter install build drand
.PHONY: install_deps_linux install_deps_darwin install_deps_darwin-m

VER_PACKAGE=github.com/drand/drand/v2/common
CLI_PACKAGE=github.com/drand/drand/v2/internal/drand-cli

GIT_REVISION := $(shell git rev-parse --short HEAD)
BUILD_DATE := $(shell date -u +%d/%m/%Y@%H:%M:%S)

ifneq ($(CI),)
SHORTTEST :=
else
SHORTTEST := -short
endif

drand: build

####################  Lint and fmt process ##################

install_lint:
	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.58.1

lint:
	golangci-lint --version
	golangci-lint run --timeout 5m
	golangci-lint run --build-tags memdb --timeout 5m
	golangci-lint run --build-tags postgres --timeout 5m

lint-todo:
	golangci-lint run -E stylecheck -E gosec -E goconst -E godox -E gocritic
	golangci-lint run --build-tags memdb -E stylecheck -E gosec -E goconst -E godox -E gocritic
	golangci-lint run --build-tags postgres -E stylecheck -E gosec -E goconst -E godox -E gocritic

fmt:
	@echo "Checking (& upgrading) formatting of files. (if this fail, re-run until success)"
	@{ \
		files=$$( go fmt ./... ); \
		if [ -n "$$files" ]; then \
		echo "Files not properly formatted: $$files"; \
		exit 1; \
		fi; \
	}

check-modtidy:
	go mod tidy
	git diff --exit-code -- go.mod go.sum

clean:
	go clean

############################################ Test ############################################

test: test-unit test-integration

test-unit:
	go test -failfast $(SHORTTEST) -race -v -tags conn_insecure ./...

test-unit-boltdb: test-unit

test-unit-memdb:
	go test -failfast $(SHORTTEST) -race -v -tags conn_insecure,memdb ./...

test-unit-postgres:
	go test -failfast $(SHORTTEST) -race -v -tags conn_insecure,postgres ./...

test-unit-cover:
	go test -failfast $(SHORTTEST) -tags conn_insecure -v -coverprofile=coverage.txt -covermode=count -coverpkg=all $(go list ./... | grep -v /demo/)

test-unit-boltdb-cover: test-unit-cover

test-unit-memdb-cover:
	go test -failfast $(SHORTTEST) -v -tags conn_insecure,memdb -coverprofile=coverage-memdb.txt -covermode=count -coverpkg=all $(go list ./... | grep -v /demo/)

test-unit-postgres-cover:
	go test -failfast $(SHORTTEST) -v -tags conn_insecure,postgres -coverprofile=coverage-postgres.txt -covermode=count -coverpkg=all $(go list ./... | grep -v /demo/)

test-integration:
	go test -failfast $(SHORTTEST) -race -v -tags conn_insecure,integration ./demo/

test-integration-boltdb: test-integration

test-integration-memdb:
	go test -failfast $(SHORTTEST) -race -v -tags conn_insecure,integration,memdb ./demo/

test-integration-postgres:
	go test -failfast $(SHORTTEST) -race -v -tags conn_insecure,integration,postgres ./demo/

test-integration-run-demo:
	cd demo && go build -tags conn_insecure && ./demo -build -test -debug

test-integration-run-demo-boltdb: test-integration-run-demo

test-integration-run-demo-memdb:
	cd demo && go build  -tags conn_insecure && ./demo -dbtype=memdb -build -test -debug

test-integration-run-demo-postgres:
	cd demo && go build  -tags conn_insecure && ./demo -dbtype=postgres -build -test -debug


coverage:
	go get -v -t -d ./...
	go test -failfast $(SHORTTEST) -v  -tags conn_insecure -covermode=atomic -coverpkg ./... -coverprofile=coverage.txt ./...

coverage-boltdb: coverage

coverage-memdb:
	go get -tags=memdb -v -t -d ./...
	go test -failfast $(SHORTTEST) -v -tags=conn_insecure,memdb -covermode=atomic -coverpkg ./... -coverprofile=coverage-memdb.txt ./...

coverage-postgres:
	go get -tags=postgres -v -t -d ./...
	go test -failfast $(SHORTTEST) -v -tags=conn_insecure,postgres -covermode=atomic -coverpkg ./... -coverprofile=coverage-postgres.txt ./...

demo:
	cd demo && go build -tags conn_insecure && ./demo -build

demo-boltdb: demo

demo-memdb:
	cd demo && go build -tags conn_insecure && ./demo -dbtype=memdb -build

demo-postgres:
	cd demo && go build -tags conn_insecure && ./demo -dbtype=postgres -build

############################################ Build ############################################

build_proto:
	go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.32.0
	go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.0
	cd protobuf && sh ./compile_proto.sh

# create the "drand" binary and install it in $GOBIN
install:
	$(info This is installing drand with TLS enabled.)
	$(info  )
	go install -ldflags "-X $(VER_PACKAGE).COMMIT=$(GIT_REVISION) -X $(VER_PACKAGE).BUILDDATE=$(BUILD_DATE) -X $(CLI_PACKAGE).buildDate=$(BUILD_DATE) -X $(CLI_PACKAGE).gitCommit=$(GIT_REVISION)" ./cmd/drand

# create the "drand" binary in the current folder
build:
	$(info This is building drand with TLS enabled, use 'make build_insecure' to do local tests without TLS.)
	$(info  )
	go build -o drand -mod=readonly -ldflags "-X $(VER_PACKAGE).COMMIT=$(GIT_REVISION) -X $(VER_PACKAGE).BUILDDATE=$(BUILD_DATE) -X $(CLI_PACKAGE).buildDate=$(BUILD_DATE) -X $(CLI_PACKAGE).gitCommit=$(GIT_REVISION)" ./cmd/drand

# create the "drand" binary in the current folder without TLS connections, useful for tests.
build_insecure:
	go build -tags conn_insecure -o drand -mod=readonly -ldflags "-X $(VER_PACKAGE).COMMIT=$(GIT_REVISION) -X $(VER_PACKAGE).BUILDDATE=$(BUILD_DATE) -X $(VER_PACKAGE).BUILDTAGS=insecure -X $(CLI_PACKAGE).buildDate=$(BUILD_DATE) -X $(CLI_PACKAGE).gitCommit=$(GIT_REVISION)" ./cmd/drand

build_all: drand

build_docker_all: build_docker build_docker_dev
build_docker:
	docker build --build-arg gitCommit=$(GIT_REVISION) --build-arg buildDate=$(BUILD_DATE) -t drandorg/go-drand:latest .

build_docker_dev:
	docker build -f internal/test/docker/Dockerfile --build-arg gitCommit=$(GIT_REVISION) --build-arg buildDate=$(BUILD_DATE) -t drandorg/go-drand-dev:latest .
############################################ Deps ############################################

PROTOC_VERSION=25.3
PROTOC_ZIP_LINUX=protoc-$(PROTOC_VERSION)-linux-x86_64.zip
PROTOC_ZIP_DARWIN=protoc-$(PROTOC_VERSION)-osx-x86_64.zip
PROTOC_ZIP_DARWIN_M=protoc-$(PROTOC_VERSION)-osx-aarch_64.zip

install_deps_linux:
	curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v$(PROTOC_VERSION)/$(PROTOC_ZIP_LINUX)
	echo Please provide your machine password to copy to /usr/local
	sudo unzip -o $(PROTOC_ZIP_LINUX) -d /usr/local bin/protoc 'include/*'
	sudo chmod a+x /usr/local/bin/protoc
	rm -f $(PROTOC_ZIP_LINUX)

install_deps_darwin:
	curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v$(PROTOC_VERSION)/$(PROTOC_ZIP_DARWIN)
	echo Please provide your machine password to copy to /usr/local
	sudo unzip -o $(PROTOC_ZIP_DARWIN) -d /usr/local bin/protoc 'include/*'
	sudo chmod a+x /usr/local/bin/protoc
	rm -f $(PROTOC_ZIP_DARWIN)

install_deps_darwin-m:
	curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v$(PROTOC_VERSION)/$(PROTOC_ZIP_DARWIN_M)
	echo Please provide your machine password to copy to /usr/local
	sudo unzip -o $(PROTOC_ZIP_DARWIN_M) -d /usr/local bin/protoc 'include/*'
	sudo chmod a+x /usr/local/bin/protoc
	rm -f $(PROTOC_ZIP_DARWIN_M)