-
Notifications
You must be signed in to change notification settings - Fork 3
/
Makefile
265 lines (227 loc) · 9.31 KB
/
Makefile
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
PROJECT := enduro-sdps
MAKEDIR := hack/make
SHELL := /bin/bash
.DEFAULT_GOAL := help
.PHONY: *
DBG_MAKEFILE ?=
ifeq ($(DBG_MAKEFILE),1)
$(warning ***** starting Makefile for goal(s) "$(MAKECMDGOALS)")
$(warning ***** $(shell date))
else
# If we're not debugging the Makefile, don't echo recipes.
MAKEFLAGS += -s
endif
include hack/make/bootstrap.mk
include hack/make/dep_ent.mk
include hack/make/dep_go_enums.mk
include hack/make/dep_goa.mk
include hack/make/dep_golangci_lint.mk
include hack/make/dep_golines.mk
include hack/make/dep_gomajor.mk
include hack/make/dep_gosec.mk
include hack/make/dep_gotestsum.mk
include hack/make/dep_migrate.mk
include hack/make/dep_mockgen.mk
include hack/make/dep_shfmt.mk
include hack/make/dep_tparse.mk
include hack/make/dep_workflowcheck.mk
# Lazy-evaluated list of tools.
TOOLS = $(ENT) \
$(GO_ENUM) \
$(GOA) \
$(GOLANGCI_LINT) \
$(GOLINES) \
$(GOMAJOR) \
$(GOSEC) \
$(GOTESTSUM) \
$(MIGRATE) \
$(MOCKGEN) \
$(SHFMT) \
$(TPARSE) \
$(WORKFLOWCHECK)
define NEWLINE
endef
IGNORED_PACKAGES := \
github.com/artefactual-sdps/enduro/hack/% \
github.com/artefactual-sdps/enduro/%/fake \
github.com/artefactual-sdps/enduro/internal/api/design \
github.com/artefactual-sdps/enduro/internal/api/gen/% \
github.com/artefactual-sdps/enduro/internal/persistence/ent/db \
github.com/artefactual-sdps/enduro/internal/persistence/ent/db/% \
github.com/artefactual-sdps/enduro/internal/persistence/ent/schema \
github.com/artefactual-sdps/enduro/internal/storage/persistence/ent/db \
github.com/artefactual-sdps/enduro/internal/storage/persistence/ent/db/% \
github.com/artefactual-sdps/enduro/internal/storage/persistence/ent/schema
PACKAGES = $(shell go list ./...)
TEST_PACKAGES = $(filter-out $(IGNORED_PACKAGES),$(PACKAGES))
TEST_IGNORED_PACKAGES = $(filter $(IGNORED_PACKAGES),$(PACKAGES))
export PATH:=$(GOBIN):$(PATH)
db: # @HELP Opens the MySQL shell connected to the enduro development database.
db:
mysql -h127.0.0.1 -P3306 -uroot -proot123 enduro
deps: # @HELP List available module dependency updates.
deps: $(GOMAJOR)
gomajor list
env: # @HELP Print Go env variables.
env:
go env
gen-dashboard-client: # @HELP Generate the Dashboard web client from the OpenAPI spec.
gen-dashboard-client:
rm -rf $(CURDIR)/dashboard/src/openapi-generator
docker container run --rm --user $(shell id -u):$(shell id -g) --volume $(CURDIR):/local openapitools/openapi-generator-cli:v7.1.0 \
generate \
--input-spec /local/internal/api/gen/http/openapi3.yaml \
--generator-name typescript-fetch \
--output /local/dashboard/src/openapi-generator/ \
-p "generateAliasAsModel=false" \
-p "withInterfaces=true" \
-p "supportsES6=true"
echo "@@@@ Please, review all warnings generated by openapi-generator-cli above!"
gen-ent: # @HELP Generate Ent assets.
gen-ent: $(ENT)
ent generate ./internal/persistence/ent/schema \
--feature sql/versioned-migration \
--target=./internal/persistence/ent/db
ent generate ./internal/storage/persistence/ent/schema \
--feature sql/versioned-migration \
--target=./internal/storage/persistence/ent/db
gen-enums: # @HELP Generate go-enum assets.
gen-enums: ENUM_FLAGS = --names --template=$(CURDIR)/hack/make/enums.tmpl
gen-enums: $(GO_ENUM)
go-enum $(ENUM_FLAGS) \
-f internal/enums/package_type.go \
-f internal/enums/pkg_status.go \
-f internal/enums/preprocessing_task_outcome.go \
-f internal/enums/pres_action_status.go \
-f internal/enums/pres_action_type.go \
-f internal/enums/pres_task_status.go
gen-goa: # @HELP Generate Goa assets.
gen-goa: $(GOA)
goa gen github.com/artefactual-sdps/enduro/internal/api/design -o internal/api
$(MAKE) gen-goa-json-pretty
gen-goa-json-pretty: HTTP_DIR = "internal/api/gen/http"
gen-goa-json-pretty: JSON_FILES = $(shell find $(HTTP_DIR) -type f -name "*.json" | sort -u)
gen-goa-json-pretty: $(JQ)
for f in $(JSON_FILES); \
do (cat "$$f" | jq -S '.' >> "$$f".sorted && mv "$$f".sorted "$$f") \
&& echo "Formatting $$f with jq" || exit 1; \
done
gen-mock: # @HELP Generate mocks.
gen-mock: $(MOCKGEN)
mockgen -typed -destination=./internal/a3m/fake/mock_transfer_service_client.go -package=fake buf.build/gen/go/artefactual/a3m/grpc/go/a3m/api/transferservice/v1beta1/transferservicev1beta1grpc TransferServiceClient
mockgen -typed -destination=./internal/api/auth/fake/mock_ticket_store.go -package=fake github.com/artefactual-sdps/enduro/internal/api/auth TicketStore
mockgen -typed -destination=./internal/api/auth/fake/mock_token_verifier.go -package=fake github.com/artefactual-sdps/enduro/internal/api/auth TokenVerifier
mockgen -typed -destination=./internal/package_/fake/mock_package_.go -package=fake github.com/artefactual-sdps/enduro/internal/package_ Service
mockgen -typed -destination=./internal/persistence/fake/mock_persistence.go -package=fake github.com/artefactual-sdps/enduro/internal/persistence Service
mockgen -typed -destination=./internal/sftp/fake/mock_sftp.go -package=fake github.com/artefactual-sdps/enduro/internal/sftp Client,AsyncUpload
mockgen -typed -destination=./internal/storage/fake/mock_client.go -package=fake github.com/artefactual-sdps/enduro/internal/storage Client
mockgen -typed -destination=./internal/storage/fake/mock_storage.go -package=fake github.com/artefactual-sdps/enduro/internal/storage Service
mockgen -typed -destination=./internal/storage/persistence/fake/mock_persistence.go -package=fake github.com/artefactual-sdps/enduro/internal/storage/persistence Storage
mockgen -typed -destination=./internal/watcher/fake/mock_service.go -package=fake github.com/artefactual-sdps/enduro/internal/watcher Service
mockgen -typed -destination=./internal/watcher/fake/mock_watcher.go -package=fake github.com/artefactual-sdps/enduro/internal/watcher Watcher
golines: # @HELP Run the golines formatter to fix long lines.
golines: GOLINES_OUT_MODE ?= write-output
golines: $(GOLINES)
golines \
--chain-split-dots \
--ignored-dirs="$(TEST_IGNORED_PACKAGES)" \
--max-len=120 \
--reformat-tags \
--shorten-comments \
--$(GOLINES_OUT_MODE) \
.
gosec: # @HELP Run gosec security scanner.
gosec: GOSEC_VERBOSITY ?= "-terse"
gosec: $(GOSEC)
gosec \
$(GOSEC_VERBOSITY) \
-exclude-dir=dashboard \
-exclude-dir=hack \
-exclude-dir=internal/api/gen \
-exclude-dir=internal/persistence/ent/db \
-exclude-dir=internal/storage/persistence/ent/db \
./...
help: # @HELP Print this message.
help:
echo "TARGETS:"
grep -E '^.*: *# *@HELP' Makefile \
| awk ' \
BEGIN {FS = ": *# *@HELP"}; \
{ printf " %-30s %s\n", $$1, $$2 }; \
'
lint: # @HELP Lint the project Go files with golangci-lint.
lint: OUT_FORMAT ?= colored-line-number
lint: LINT_FLAGS ?= --timeout=5m --fix
lint: $(GOLANGCI_LINT)
golangci-lint run --out-format $(OUT_FORMAT) $(LINT_FLAGS)
list-tested-packages: # @HELP Print a list of packages being tested.
list-tested-packages:
$(foreach PACKAGE,$(TEST_PACKAGES),@echo $(PACKAGE)$(NEWLINE))
list-ignored-packages: # @HELP Print a list of packages ignored in testing.
list-ignored-packages:
$(foreach PACKAGE,$(TEST_IGNORED_PACKAGES),@echo $(PACKAGE)$(NEWLINE))
mod-tidy: # @HELP Synchronize mod files with current code dependencies.
mod-tidy:
go mod download
go mod tidy
mod-tidy-check: # @HELP Check that mod files are tidy.
go mod tidy -diff
cd hack/pulumi && go mod tidy -diff
pre-commit: # @HELP Check that code is ready to commit.
pre-commit:
$(MAKE) -j \
golines \
gosec GOSEC_VERBOSITY="-quiet"\
lint \
mod-tidy-check \
shfmt \
test-race \
workflowcheck \
shfmt: SHELL_PROGRAMS := $(shell find $(CURDIR)/hack -name *.sh)
shfmt: $(SHFMT) # @HELP Run shfmt to format shell programs in the hack directory.
shfmt \
--list \
--write \
--diff \
--simplify \
--language-dialect=posix \
--indent=0 \
--case-indent \
--space-redirects \
--func-next-line \
$(SHELL_PROGRAMS)
test: # @HELP Run all tests and output a summary using gotestsum.
test: TFORMAT ?= short
test: GOTEST_FLAGS ?=
test: COMBINED_FLAGS ?= $(GOTEST_FLAGS) $(TEST_PACKAGES)
test: $(GOTESTSUM)
gotestsum --format=$(TFORMAT) -- $(COMBINED_FLAGS)
test-ci: # @HELP Run all tests in CI with coverage and the race detector.
test-ci:
$(MAKE) test GOTEST_FLAGS="-race -coverprofile=covreport -covermode=atomic"
test-race: # @HELP Run all tests with the race detector.
test-race:
$(MAKE) test GOTEST_FLAGS="-race"
tilt-am-knownhosts: # @HELP Update Archivematica Storage Service known_hosts.
tilt-am-knownhosts: HOST ?= host.k3d.internal
tilt-am-knownhosts: PORT ?= 12322
tilt-am-knownhosts:
ssh-keyscan -H -p $(PORT) $(HOST) > hack/kube/overlays/dev-am/.known_hosts.secret
tilt trigger "(Tiltfile)"
tilt wait --for=condition=Ready "uiresource/(Tiltfile)"
tilt trigger enduro-am
tilt wait --for=condition=Ready uiresource/enduro-am
tools: # @HELP Install tools.
tools: $(TOOLS)
tparse: # @HELP Run all tests and output a coverage report using tparse.
tparse: $(TPARSE)
go test -count=1 -json -cover $(TEST_PACKAGES) | tparse -follow -all -notests
upload-sample-transfer: # @HELP Upload sample transfer (small.zip).
upload-sample-transfer: ADDRESS ?= localhost:9002
upload-sample-transfer:
curl \
-F "file=@$(CURDIR)/internal/testdata/zipped_transfer/small.zip" \
http://$(ADDRESS)/package/upload
workflowcheck: # @HELP Detect non-determinism in workflow functions.
workflowcheck: $(WORKFLOWCHECK)
workflowcheck ./...