-
Notifications
You must be signed in to change notification settings - Fork 466
/
Makefile
420 lines (330 loc) · 13.8 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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
ROOT = $(shell cd "$(dirname '.')" && pwd -P)
DEPS_DIR = $(ROOT)/deps
RELX = $(DEPS_DIR)/relx
ELVIS = $(DEPS_DIR)/elvis
TAGS = $(ROOT)/TAGS
ERLANG_LS = $(ROOT)/erlang_ls.config
PLT = $(ROOT)/.kazoo.plt
ERLANG_MK = $(ROOT)/erlang.mk
ERLANG_MK_COMMIT = 82179575d9191305805c8e6e8107be7c3f80a6be
DOT_ERLANG_MK = $(ROOT)/.erlang.mk
BASE_BRANCH := $(shell cat $(ROOT)/.base_branch)
## list files changed for more focused checks
ifeq ($(strip $(CHANGED)),)
CHANGED := $(shell git --no-pager diff --name-only HEAD $(BASE_BRANCH) -- applications core scripts doc)
else
CHANGED := $(CHANGED)
endif
CHANGED_SWAGGER ?= $(shell git --no-pager diff --name-only HEAD $(BASE_BRANCH) -- applications/crossbar/priv/api/swagger.json)
CHANGED_ERL=$(filter %.hrl %.erl %.escript,$(CHANGED))
CHANGED_JSON=$(filter %.json,$(CHANGED))
CHANGED_YML=$(filter %.yml,$(CHANGED))
# You can override this when calling make, e.g. make JOBS=1
# to prevent parallel builds, or make JOBS="8".
JOBS ?= 1
.PHONY: kazoo deps core apps \
apis \
build-release build-ci-release tar-release release read-release-cookie \
bump-copyright \
changed changed_swagger \
circle \
clean clean-test clean-release clean-kazoo clean-core clean-apps \
code_checks \
coverage-report \
dialyze dialyze-apps dialyze-core dialyze-kazoo dialyze-hard dialyze-changed \
dialyze-it dialyze-it-hard dialyze-it-changed \
diff \
docs \
elvis \
fixture_shell \
fs-headers \
install \
sdks \
validate-js \
validate-schemas \
validate-swagger \
xref xref_release
all: prerequisites compile
changed:
@echo "changed: $(CHANGED)"
@echo "changed ERL: $(CHANGED_ERL)"
@echo "changed JSON: $(CHANGED_JSON)"
@echo "changed YML: $(CHANGED_YML)"
changed_swagger:
@echo "$(CHANGED_SWAGGER)"
prerequisites: make-dependency-check
make-dependency-check:
$(ROOT)/scripts/make-prerequisite.sh
compile: ACTION = all
compile: deps kazoo
compile-lean: ACTION = compile-lean
compile-lean: deps compile-lean-core compile-lean-apps
compile-lean-core:
@$(MAKE) -j$(JOBS) -C core/ compile-lean
compile-lean-apps:
@$(MAKE) -j$(JOBS) -C applications/ compile-lean
sparkly-clean: clean-apps clean-kazoo clean-release clean-deps
clean: clean-kazoo
$(if $(wildcard *crash.dump), rm *crash.dump)
$(if $(wildcard scripts/log/*), rm -rf scripts/log/*)
$(if $(wildcard rel/dev-vm.args), rm rel/dev-vm.args)
clean-kazoo: clean-core clean-apps
clean-core:
@$(MAKE) -j$(JOBS) -C core/ clean
clean-apps:
@$(MAKE) -j$(JOBS) -C applications/ clean
clean-test: clean-test-core clean-test-apps
clean-test-core:
@$(MAKE) -j$(JOBS) -C core/ clean-test
clean-test-apps:
@$(MAKE) -j$(JOBS) -C applications/ clean-test
compile-proper: ERLC_OPTS += -DPROPER
compile-proper: compile-test
compile-test: ERLC_OPTS += +nowarn_missing_spec
compile-test: deps compile-test-core compile-test-apps
compile-test-core:
@$(MAKE) -j$(JOBS) -C core/ compile-test-direct
compile-test-apps:
@$(MAKE) -j$(JOBS) -C applications/ compile-test-direct
eunit: eunit-core eunit-apps
eunit-core:
@$(MAKE) -j$(JOBS) -C core/ eunit
eunit-apps:
@$(MAKE) -j$(JOBS) -C applications/ eunit
proper: ERLC_OPTS += -DPROPER
proper: proper-core proper-apps
proper-core:
@$(MAKE) -j$(JOBS) -C core/ proper
proper-apps:
@$(MAKE) -j$(JOBS) -C applications/ proper
test: ERLC_OPTS += -DPROPER
test: ERLC_OPTS += +nowarn_missing_spec
test: test-core test-apps
test-core:
@$(MAKE) -j$(JOBS) -C core/ test
test-apps:
@$(MAKE) -j$(JOBS) -C applications/ test
coverage-report:
$(ROOT)/scripts/cover.escript
check: ERLC_OPTS += -DPROPER
check: compile-test eunit clean-kazoo kazoo
clean-deps: clean-deps-hash
@$(if $(wildcard $(DEPS_DIR)), rm -rf $(DEPS_DIR))
@$(if $(wildcard $(DOT_ERLANG_MK)), rm -rf $(DOT_ERLANG_MK))
@$(if $(wildcard $(ERLANG_MK)), rm -r $(ERLANG_MK))
@echo "Cleaned deps-related files"
clean-deps-hash:
$(if $(wildcard make/.deps.mk.*), rm make/.deps.mk.*)
.PHONY=dot_erlang_mk
dot_erlang_mk: $(DOT_ERLANG_MK)
$(DOT_ERLANG_MK): $(ERLANG_MK)
@ERLANG_MK_COMMIT=$(ERLANG_MK_COMMIT) $(MAKE) -f $(ERLANG_MK) erlang.mk
$(ERLANG_MK):
@wget 'https://raw.githubusercontent.com/ninenines/erlang.mk/2018.03.01/erlang.mk' -O $(ERLANG_MK)
DEPS_HASH := $(shell md5sum make/deps.mk | cut -d' ' -f1)
DEPS_HASH_FILE := make/.deps.mk.$(DEPS_HASH)
deps: $(DEPS_HASH_FILE)
$(DEPS_HASH_FILE):
@$(MAKE) clean-deps
@$(MAKE) $(DEPS_DIR)/Makefile
@$(MAKE) -C $(DEPS_DIR)/ all
touch $(DEPS_HASH_FILE)
$(DEPS_DIR)/Makefile: $(DOT_ERLANG_MK) clean-plt
mkdir -p deps
@$(MAKE) -f $(ERLANG_MK) deps
cp $(ROOT)/make/Makefile.deps $(DEPS_DIR)/Makefile
core:
@$(MAKE) -j$(JOBS) -C core/ all
apps: core
@$(MAKE) -j$(JOBS) -C applications/ all
kazoo: deps apps $(TAGS)
tags: $(TAGS)
$(TAGS):
ERL_LIBS=deps:core:applications ./scripts/tags.escript $(TAGS)
clean-tags:
$(if $(wildcard $(TAGS)), rm $(TAGS))
erlang-ls: $(ERLANG_LS)
$(ERLANG_LS):
@touch $(ERLANG_LS)
@echo "plt_path: $(PLT)" >> $(ERLANG_LS)
@echo "apps_dirs: " >> $(ERLANG_LS)
@echo " - $(ROOT)/core/*" >> $(ERLANG_LS)
@echo " - $(ROOT)/applications/*" >> $(ERLANG_LS)
@echo "deps_dirs: " >> $(ERLANG_LS)
@echo " - $(ROOT)/deps/*" >> $(ERLANG_LS)
@echo "generated $(ERLANG_LS)"
clean-erlang-ls:
@rm $(ERLANG_LS)
$(RELX):
wget 'https://erlang.mk/res/relx-v3.27.0' -O $@
chmod +x $@
clean-release:
$(if $(wildcard _rel/), rm -r _rel/)
build-release: $(RELX) clean-release rel/relx.config rel/relx.config.script rel/sys.config rel/vm.args
$(RELX) --config rel/relx.config -V 2 release --relname 'kazoo'
build-dev-release: $(RELX) clean-release rel/dev.relx.config rel/dev.relx.config.script rel/dev.vm.args rel/dev.sys.config
$(RELX) --dev-mode true --config rel/dev.relx.config -V 2 release --relname 'kazoo'
build-ci-release: $(RELX) clean-release rel/ci.relx.config rel/ci.relx.config.script rel/ci.sys.config rel/ci.vm.args
$(RELX) --config rel/ci.relx.config -V 2 release --relname 'kazoo'
build-dist-release: $(RELX) clean-release rel/dist.relx.config rel/dist.relx.config.script rel/dist.vm.args rel/dist.sys.config
$(RELX) --config rel/dist.relx.config -V 2 release --relname 'kazoo'
tar-release: $(RELX) rel/relx.config rel/relx.config.script rel/sys.config rel/vm.args
$(RELX) --config rel/relx.config -V 2 release tar --relname 'kazoo'
## More ACTs at //github.com/erlware/relx/priv/templates/extended_bin
release: ACT ?= console # start | attach | stop | console | foreground
release: REL ?= kazoo_apps # kazoo_apps | ecallmgr | …
release: COOKIE ?= change_me
release:
NODE_NAME="$(REL)" COOKIE="$(COOKIE)" $(ROOT)/scripts/dev/kazoo.sh $(ACT) "$$@"
install: compile build-release
cp -a _rel/kazoo /opt
read-release-cookie: REL ?= kazoo_apps
read-release-cookie:
@NODE_NAME='$(REL)' _rel/kazoo/bin/kazoo escript lib/kazoo_config-*/priv/read-cookie.escript "$$@"
fixture_shell: ERL_CRASH_DUMP = "$(ROOT)/$(shell date +%s)_ecallmgr_erl_crash.dump"
fixture_shell: ERL_LIBS = "$(DEPS_DIR):$(ROOT)/core:$(ROOT)/applications:$(shell echo $(DEPS_DIR)/rabbitmq_erlang_client-*/deps)"
fixture_shell: NODE_NAME ?= fixturedb
fixture_shell:
@ERL_CRASH_DUMP="$(ERL_CRASH_DUMP)" ERL_LIBS="$(ERL_LIBS)" KAZOO_CONFIG=$(ROOT)/rel/config-test.ini \
erl -name '$(NODE_NAME)' -s reloader "$$@"
DIALYZER ?= dialyzer
DIALYZER += --statistics --no_native
OTP_APPS ?= erts kernel stdlib crypto public_key ssl asn1 inets xmerl
EXCLUDE_DEPS = $(DEPS_DIR)/erlang_localtime/ebin
$(PLT): DEPS_EBIN ?= $(filter-out $(EXCLUDE_DEPS),$(wildcard $(DEPS_DIR)/*/ebin))
# $(PLT): CORE_EBINS ?= $(shell find $(ROOT)/core -name ebin)
$(PLT):
@-$(DIALYZER) --build_plt --output_plt $(PLT) \
--apps $(OTP_APPS) \
-r $(DEPS_EBIN)
@for ebin in $(CORE_EBINS); do \
$(DIALYZER) --add_to_plt --plt $(PLT) --output_plt $(PLT) -r $$ebin; \
done
build-plt: $(PLT)
clean-plt:
@rm -f $(PLT)
dialyze-kazoo: TO_DIALYZE = $(shell find $(ROOT)/applications $(ROOT)/core -name ebin)
dialyze-kazoo: dialyze
dialyze-apps: TO_DIALYZE = $(shell find $(ROOT)/applications -name ebin)
dialyze-apps: dialyze
dialyze-core: TO_DIALYZE = $(shell find $(ROOT)/core -name ebin)
dialyze-core: dialyze-it
dialyze: TO_DIALYZE ?= $(shell find $(ROOT)/applications -name ebin)
dialyze: dialyze-it
dialyze-changed: TO_DIALYZE = $(strip $(filter %.beam %.erl %/ebin,$(CHANGED)))
dialyze-changed: dialyze-it-changed
dialyze-hard: TO_DIALYZE = $(CHANGED)
dialyze-hard: dialyze-it-hard
dialyze-it: $(PLT)
@echo ":: dialyzing"
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/check-dialyzer.escript $(ROOT)/.kazoo.plt $(filter %.beam %.erl %/ebin,$(TO_DIALYZE)) && echo "dialyzer is happy!"
dialyze-it-hard: $(PLT)
@echo ":: dialyzing hard"
@ERL_LIBS=deps:core:applications $(if $(DEBUG),time -v) $(ROOT)/scripts/check-dialyzer.escript $(ROOT)/.kazoo.plt --hard $(filter %.beam %.erl %/ebin,$(TO_DIALYZE)) && echo "dialyzer is happy!"
dialyze-it-changed: $(PLT)
@if [ -n "$(TO_DIALYZE)" ]; then \
echo "dialyzing changes against $(BASE_BRANCH)" ; \
ERL_LIBS=deps:core:applications $(if $(DEBUG),time -v) $(ROOT)/scripts/check-dialyzer.escript $(ROOT)/.kazoo.plt --bulk $(TO_DIALYZE) && echo "dialyzer is happy!"; \
else \
echo "no erlang changes to dialyze"; \
fi
xref: TO_XREF ?= $(shell find $(ROOT)/applications $(ROOT)/core $(DEPS_DIR) -name ebin)
xref:
@$(ROOT)/scripts/check-xref.escript $(TO_XREF)
xref_release: TO_XREF = $(shell find $(ROOT)/_rel/kazoo/lib -name ebin)
xref_release:
@$(ROOT)/scripts/check-xref.escript $(TO_XREF)
sup_completion: sup_completion_file = $(ROOT)/sup.bash
sup_completion:
@$(if $(wildcard $(sup_completion_file)), rm $(sup_completion_file))
@$(ROOT)/core/sup/priv/build-autocomplete.escript $(sup_completion_file) applications/ core/
@echo SUP Bash completion file written at $(sup_completion_file)
$(ELVIS):
wget 'https://github.com/inaka/elvis/releases/download/0.2.12/elvis' -O $@
chmod +x $@
elvis: $(ELVIS)
$(ELVIS) --config make/elvis.config rock
ci: clean compile xref build-plt diff sup_completion build-ci-release compile-test eunit elvis
diff: export TO_DIALYZE = $(shell git diff --name-only $(BASE_BRANCH)... -- $(ROOT)/applications/ $(ROOT)/core/)
diff: dialyze-it
bump-copyright:
@$(ROOT)/scripts/bump-copyright-year.py $(shell find applications core -name '*.erl')
app_applications:
ERL_LIBS=deps:core:applications $(ROOT)/scripts/apps_of_app.escript -a $(shell find applications -name *.app.src)
code_checks:
@printf ":: Check for copyright year\n\n"
@$(ROOT)/scripts/bump-copyright-year.py $(CHANGED_ERL)
@printf "\n:: Check code\n\n"
@$(ROOT)/scripts/code_checks.bash $(CHANGED_ERL)
@printf "\n:: Check for raw JSON usage\n\n"
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/no_raw_json.escript $(CHANGED_ERL)
@printf "\n:: Check for spelling\n\n"
@$(ROOT)/scripts/check-spelling.bash
@printf "\n:: Check for Kazoo diaspora\n\n"
@$(ROOT)/scripts/kz_diaspora.bash
@printf "\n:: Check for Edoc\n\n"
@$(ROOT)/scripts/edocify.escript
@printf "\n:: Check for Kazoo document accessors\n\n"
@$(ROOT)/scripts/kzd_module_check.bash
@printf "\n:: Check for proper log message usage\n\n"
@$(ROOT)/scripts/check-loglines.bash
@printf "\n:: Check for Erlang 21 new stacktrace syntax\n\n"
@$(ROOT)/scripts/check-stacktrace.py $(CHANGED_ERL)
.PHONY: raw_json_check
raw_json_check:
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/no_raw_json.escript
check_stacktrace:
@$(ROOT)/scripts/check-stacktrace.py $(shell grep -rl "get_stacktrace" scripts applications core --include "*.[e|h]rl" --exclude "kz_types.hrl")
## FIXME: `format-couchdb-view.py` command is a copy-paste from fmt.mk
## Adding this format couchdb view target to circleci steps for every app is painful
## also this formatting is better to be done before validate-js ci step to make sure
## the view is still in correct shape
apis: schemas
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/generate-api-endpoints.escript
@$(ROOT)/scripts/generate-doc-schemas.py `egrep -rl '(#+) Schema' core/ applications/ | grep -v '.[h|e]rl'`
@$(ROOT)/scripts/format-json.py applications/crossbar/priv/api/swagger.json
@$(ROOT)/scripts/format-json.py $(shell find applications core -wholename '*/api/*.json')
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/generate-fs-headers-hrl.escript
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/generate-kzd-builders.escript
@$(ROOT)/scripts/format-couchdb-views.py $(shell find core/kazoo_apps/priv/couchdb/account -name '*.json')
@$(ROOT)/scripts/format-couchdb-views.py $(shell find applications core -wholename '*/couchdb/views/*.json')
.PHONY: schemas
schemas:
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/generate-schemas.escript $(CHANGED_ERL)
@$(ROOT)/scripts/format-json.py $(shell find applications core -wholename '*/schemas/*.json')
DOCS_ROOT=$(ROOT)/doc/mkdocs
docs: docs-validate docs-report docs-setup docs-build
admonitions:
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/check-admonitions.escript $(shell grep -rlE '^!!! ' scripts applications core doc)
docs-validate:
@$(ROOT)/scripts/check-scripts-readme.bash
@$(ROOT)/scripts/empty_schema_descriptions.bash
@$(ROOT)/scripts/check-ref-docs.bash
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/check-admonitions.escript $(CHANGED)
docs-report:
@$(ROOT)/scripts/reconcile_docs_to_index.bash
docs-setup:
@$(ROOT)/scripts/validate_mkdocs.py
@$(ROOT)/scripts/setup_docs.bash
docs-build:
@$(MAKE) -C $(DOCS_ROOT) DOCS_ROOT=$(DOCS_ROOT) docs-build
docs-clean:
@$(MAKE) -C $(DOCS_ROOT) DOCS_ROOT=$(DOCS_ROOT) clean
YML ?= mkdocs.yml
docs-serve: docs-setup docs-build
@$(MAKE) -C $(DOCS_ROOT) YML=$(YML) DOCS_ROOT=$(DOCS_ROOT) docs-serve
fs-headers:
@ERL_LIBS=deps:core:applications $(ROOT)/scripts/generate-fs-headers-hrl.escript
validate-swagger:
@$(ROOT)/scripts/validate-swagger.py
validate-js:
@$(ROOT)/scripts/validate-js.py $(CHANGED_JSON)
sdks:
@$(ROOT)/scripts/make-swag.sh
validate-schemas:
@$(ROOT)/scripts/validate-schemas.py $(ROOT)/applications/crossbar/priv/couchdb/schemas
include make/splchk.mk
include make/ci.mk
include make/fmt.mk
include make/pest.mk
circle: ci