erlang.mk 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
  1. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  2. #
  3. # Permission to use, copy, modify, and/or distribute this software for any
  4. # purpose with or without fee is hereby granted, provided that the above
  5. # copyright notice and this permission notice appear in all copies.
  6. #
  7. # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  8. # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  9. # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  10. # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  11. # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  12. # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  13. # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  14. .PHONY: all deps app rel docs tests clean distclean help
  15. ERLANG_MK_VERSION = 1
  16. # Core configuration.
  17. PROJECT ?= $(notdir $(CURDIR))
  18. PROJECT := $(strip $(PROJECT))
  19. # Verbosity.
  20. V ?= 0
  21. gen_verbose_0 = @echo " GEN " $@;
  22. gen_verbose = $(gen_verbose_$(V))
  23. # Core targets.
  24. all:: deps app rel
  25. clean::
  26. $(gen_verbose) rm -f erl_crash.dump
  27. distclean:: clean
  28. help::
  29. @printf "%s\n" \
  30. "erlang.mk (version $(ERLANG_MK_VERSION)) is distributed under the terms of the ISC License." \
  31. "Copyright (c) 2013-2014 Loïc Hoguin <essen@ninenines.eu>" \
  32. "" \
  33. "Usage: [V=1] make [target]" \
  34. "" \
  35. "Core targets:" \
  36. " all Run deps, app and rel targets in that order" \
  37. " deps Fetch dependencies (if needed) and compile them" \
  38. " app Compile the project" \
  39. " rel Build a release for this project, if applicable" \
  40. " docs Build the documentation for this project" \
  41. " tests Run the tests for this project" \
  42. " clean Delete temporary and output files from most targets" \
  43. " distclean Delete all temporary and output files" \
  44. " help Display this help and exit" \
  45. "" \
  46. "The target clean only removes files that are commonly removed." \
  47. "Dependencies and releases are left untouched." \
  48. "" \
  49. "Setting V=1 when calling make enables verbose mode."
  50. # Core functions.
  51. ifeq ($(shell which wget 2>/dev/null | wc -l), 1)
  52. define core_http_get
  53. wget --no-check-certificate -O $(1) $(2)|| rm $(1)
  54. endef
  55. else
  56. define core_http_get
  57. erl -noshell -eval 'ssl:start(), inets:start(), case httpc:request(get, {"$(2)", []}, [{autoredirect, true}], []) of {ok, {{_, 200, _}, _, Body}} -> case file:write_file("$(1)", Body) of ok -> ok; {error, R1} -> halt(R1) end; {error, R2} -> halt(R2) end, halt(0).'
  58. endef
  59. endif
  60. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  61. # This file is part of erlang.mk and subject to the terms of the ISC License.
  62. .PHONY: distclean-deps distclean-pkg pkg-list pkg-search
  63. # Configuration.
  64. DEPS_DIR ?= $(CURDIR)/deps
  65. export DEPS_DIR
  66. REBAR_DEPS_DIR = $(DEPS_DIR)
  67. export REBAR_DEPS_DIR
  68. ALL_DEPS_DIRS = $(addprefix $(DEPS_DIR)/,$(DEPS))
  69. ifeq ($(filter $(DEPS_DIR),$(subst :, ,$(ERL_LIBS))),)
  70. ifeq ($(ERL_LIBS),)
  71. ERL_LIBS = $(DEPS_DIR)
  72. else
  73. ERL_LIBS := $(ERL_LIBS):$(DEPS_DIR)
  74. endif
  75. endif
  76. export ERL_LIBS
  77. PKG_FILE2 ?= $(CURDIR)/.erlang.mk.packages.v2
  78. export PKG_FILE2
  79. PKG_FILE_URL ?= https://raw.githubusercontent.com/ninenines/erlang.mk/master/packages.v2.tsv
  80. # Core targets.
  81. deps:: $(ALL_DEPS_DIRS)
  82. @for dep in $(ALL_DEPS_DIRS) ; do \
  83. if [ -f $$dep/GNUmakefile ] || [ -f $$dep/makefile ] || [ -f $$dep/Makefile ] ; then \
  84. $(MAKE) -C $$dep ; \
  85. else \
  86. echo "include $(CURDIR)/erlang.mk" | $(MAKE) -f - -C $$dep ; \
  87. fi ; \
  88. done
  89. distclean:: distclean-deps distclean-pkg
  90. # Deps related targets.
  91. define dep_fetch
  92. if [ "$$$$VS" = "git" ]; then \
  93. git clone -n -- $$$$REPO $(DEPS_DIR)/$(1); \
  94. cd $(DEPS_DIR)/$(1) && git checkout -q $$$$COMMIT; \
  95. elif [ "$$$$VS" = "hg" ]; then \
  96. hg clone -U $$$$REPO $(DEPS_DIR)/$(1); \
  97. cd $(DEPS_DIR)/$(1) && hg update -q $$$$COMMIT; \
  98. else \
  99. echo "Unknown or invalid dependency: $(1). Please consult the erlang.mk README for instructions." >&2; \
  100. exit 78; \
  101. fi
  102. endef
  103. define dep_target
  104. $(DEPS_DIR)/$(1):
  105. @mkdir -p $(DEPS_DIR)
  106. @if [ ! -f $(PKG_FILE2) ]; then $(call core_http_get,$(PKG_FILE2),$(PKG_FILE_URL)); fi
  107. ifeq (,$(dep_$(1)))
  108. @DEPPKG=$$$$(awk 'BEGIN { FS = "\t" }; $$$$1 == "$(1)" { print $$$$2 " " $$$$3 " " $$$$4 }' $(PKG_FILE2);); \
  109. VS=$$$$(echo $$$$DEPPKG | cut -d " " -f1); \
  110. REPO=$$$$(echo $$$$DEPPKG | cut -d " " -f2); \
  111. COMMIT=$$$$(echo $$$$DEPPKG | cut -d " " -f3); \
  112. $(call dep_fetch,$(1))
  113. else
  114. @VS=$(word 1,$(dep_$(1))); \
  115. REPO=$(word 2,$(dep_$(1))); \
  116. COMMIT=$(word 3,$(dep_$(1))); \
  117. $(call dep_fetch,$(1))
  118. endif
  119. endef
  120. $(foreach dep,$(DEPS),$(eval $(call dep_target,$(dep))))
  121. distclean-deps:
  122. $(gen_verbose) rm -rf $(DEPS_DIR)
  123. # Packages related targets.
  124. $(PKG_FILE2):
  125. @$(call core_http_get,$(PKG_FILE2),$(PKG_FILE_URL))
  126. pkg-list: $(PKG_FILE2)
  127. @cat $(PKG_FILE2) | awk 'BEGIN { FS = "\t" }; { print \
  128. "Name:\t\t" $$1 "\n" \
  129. "Repository:\t" $$3 "\n" \
  130. "Website:\t" $$5 "\n" \
  131. "Description:\t" $$6 "\n" }'
  132. ifdef q
  133. pkg-search: $(PKG_FILE2)
  134. @cat $(PKG_FILE2) | grep -i ${q} | awk 'BEGIN { FS = "\t" }; { print \
  135. "Name:\t\t" $$1 "\n" \
  136. "Repository:\t" $$3 "\n" \
  137. "Website:\t" $$5 "\n" \
  138. "Description:\t" $$6 "\n" }'
  139. else
  140. pkg-search:
  141. $(error Usage: make pkg-search q=STRING)
  142. endif
  143. distclean-pkg:
  144. $(gen_verbose) rm -f $(PKG_FILE2)
  145. help::
  146. @printf "%s\n" "" \
  147. "Package-related targets:" \
  148. " pkg-list List all known packages" \
  149. " pkg-search q=STRING Search for STRING in the package index"
  150. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  151. # This file is part of erlang.mk and subject to the terms of the ISC License.
  152. .PHONY: clean-app
  153. # Configuration.
  154. ERLC_OPTS ?= -Werror +debug_info +warn_export_all +warn_export_vars \
  155. +warn_shadow_vars +warn_obsolete_guard # +bin_opt_info +warn_missing_spec
  156. COMPILE_FIRST ?=
  157. COMPILE_FIRST_PATHS = $(addprefix src/,$(addsuffix .erl,$(COMPILE_FIRST)))
  158. # Verbosity.
  159. appsrc_verbose_0 = @echo " APP " $(PROJECT).app.src;
  160. appsrc_verbose = $(appsrc_verbose_$(V))
  161. erlc_verbose_0 = @echo " ERLC " $(filter %.erl %.core,$(?F));
  162. erlc_verbose = $(erlc_verbose_$(V))
  163. xyrl_verbose_0 = @echo " XYRL " $(filter %.xrl %.yrl,$(?F));
  164. xyrl_verbose = $(xyrl_verbose_$(V))
  165. # Core targets.
  166. app:: erlc-include ebin/$(PROJECT).app
  167. $(eval MODULES := $(shell find ebin -type f -name \*.beam \
  168. | sed "s/ebin\//'/;s/\.beam/',/" | sed '$$s/.$$//'))
  169. @if [ -z "$$(grep -E '^[^%]*{modules,' src/$(PROJECT).app.src)" ]; then \
  170. echo "Empty modules entry not found in $(PROJECT).app.src. Please consult the erlang.mk README for instructions." >&2; \
  171. exit 1; \
  172. fi
  173. $(appsrc_verbose) cat src/$(PROJECT).app.src \
  174. | sed "s/{modules,[[:space:]]*\[\]}/{modules, \[$(MODULES)\]}/" \
  175. > ebin/$(PROJECT).app
  176. define compile_erl
  177. $(erlc_verbose) erlc -v $(ERLC_OPTS) -o ebin/ \
  178. -pa ebin/ -I include/ $(COMPILE_FIRST_PATHS) $(1)
  179. endef
  180. define compile_xyrl
  181. $(xyrl_verbose) erlc -v -o ebin/ $(1)
  182. $(xyrl_verbose) erlc $(ERLC_OPTS) -o ebin/ ebin/*.erl
  183. @rm ebin/*.erl
  184. endef
  185. ifneq ($(wildcard src/),)
  186. ebin/$(PROJECT).app::
  187. @mkdir -p ebin/
  188. ebin/$(PROJECT).app:: $(shell find src -type f -name \*.erl) \
  189. $(shell find src -type f -name \*.core)
  190. $(if $(strip $?),$(call compile_erl,$?))
  191. ebin/$(PROJECT).app:: $(shell find src -type f -name \*.xrl) \
  192. $(shell find src -type f -name \*.yrl)
  193. $(if $(strip $?),$(call compile_xyrl,$?))
  194. endif
  195. clean:: clean-app
  196. # Extra targets.
  197. erlc-include:
  198. -@if [ -d ebin/ ]; then \
  199. find include/ src/ -type f -name \*.hrl -newer ebin -exec touch $(shell find src/ -type f -name "*.erl") \; 2>/dev/null || printf ''; \
  200. fi
  201. clean-app:
  202. $(gen_verbose) rm -rf ebin/
  203. # Copyright (c) 2014, Loïc Hoguin <essen@ninenines.eu>
  204. # This file is part of erlang.mk and subject to the terms of the ISC License.
  205. .PHONY: bootstrap bootstrap-lib bootstrap-rel new list-templates
  206. # Core targets.
  207. help::
  208. @printf "%s\n" "" \
  209. "Bootstrap targets:" \
  210. " bootstrap Generate a skeleton of an OTP application" \
  211. " bootstrap-lib Generate a skeleton of an OTP library" \
  212. " bootstrap-rel Generate the files needed to build a release" \
  213. " new t=TPL n=NAME Generate a module NAME based on the template TPL" \
  214. " list-templates List available templates"
  215. # Bootstrap templates.
  216. bs_appsrc = "{application, $(PROJECT), [" \
  217. " {description, \"\"}," \
  218. " {vsn, \"0.1.0\"}," \
  219. " {modules, []}," \
  220. " {registered, []}," \
  221. " {applications, [" \
  222. " kernel," \
  223. " stdlib" \
  224. " ]}," \
  225. " {mod, {$(PROJECT)_app, []}}," \
  226. " {env, []}" \
  227. "]}."
  228. bs_appsrc_lib = "{application, $(PROJECT), [" \
  229. " {description, \"\"}," \
  230. " {vsn, \"0.1.0\"}," \
  231. " {modules, []}," \
  232. " {registered, []}," \
  233. " {applications, [" \
  234. " kernel," \
  235. " stdlib" \
  236. " ]}" \
  237. "]}."
  238. bs_Makefile = "PROJECT = $(PROJECT)" \
  239. "include erlang.mk"
  240. bs_app = "-module($(PROJECT)_app)." \
  241. "-behaviour(application)." \
  242. "" \
  243. "-export([start/2])." \
  244. "-export([stop/1])." \
  245. "" \
  246. "start(_Type, _Args) ->" \
  247. " $(PROJECT)_sup:start_link()." \
  248. "" \
  249. "stop(_State) ->" \
  250. " ok."
  251. bs_relx_config = "{release, {$(PROJECT)_release, \"1\"}, [$(PROJECT)]}." \
  252. "{extended_start_script, true}." \
  253. "{sys_config, \"rel/sys.config\"}." \
  254. "{vm_args, \"rel/vm.args\"}."
  255. bs_sys_config = "[" \
  256. "]."
  257. bs_vm_args = "-name $(PROJECT)@127.0.0.1" \
  258. "-setcookie $(PROJECT)" \
  259. "-heart"
  260. # Normal templates.
  261. tpl_supervisor = "-module($(n))." \
  262. "-behaviour(supervisor)." \
  263. "" \
  264. "-export([start_link/0])." \
  265. "-export([init/1])." \
  266. "" \
  267. "start_link() ->" \
  268. " supervisor:start_link({local, ?MODULE}, ?MODULE, [])." \
  269. "" \
  270. "init([]) ->" \
  271. " Procs = []," \
  272. " {ok, {{one_for_one, 1, 5}, Procs}}."
  273. tpl_gen_server = "-module($(n))." \
  274. "-behaviour(gen_server)." \
  275. "" \
  276. "%% API." \
  277. "-export([start_link/0])." \
  278. "" \
  279. "%% gen_server." \
  280. "-export([init/1])." \
  281. "-export([handle_call/3])." \
  282. "-export([handle_cast/2])." \
  283. "-export([handle_info/2])." \
  284. "-export([terminate/2])." \
  285. "-export([code_change/3])." \
  286. "" \
  287. "-record(state, {" \
  288. "})." \
  289. "" \
  290. "%% API." \
  291. "" \
  292. "-spec start_link() -> {ok, pid()}." \
  293. "start_link() ->" \
  294. " gen_server:start_link(?MODULE, [], [])." \
  295. "" \
  296. "%% gen_server." \
  297. "" \
  298. "init([]) ->" \
  299. " {ok, \#state{}}." \
  300. "" \
  301. "handle_call(_Request, _From, State) ->" \
  302. " {reply, ignored, State}." \
  303. "" \
  304. "handle_cast(_Msg, State) ->" \
  305. " {noreply, State}." \
  306. "" \
  307. "handle_info(_Info, State) ->" \
  308. " {noreply, State}." \
  309. "" \
  310. "terminate(_Reason, _State) ->" \
  311. " ok." \
  312. "" \
  313. "code_change(_OldVsn, State, _Extra) ->" \
  314. " {ok, State}."
  315. tpl_cowboy_http = "-module($(n))." \
  316. "-behaviour(cowboy_http_handler)." \
  317. "" \
  318. "-export([init/3])." \
  319. "-export([handle/2])." \
  320. "-export([terminate/3])." \
  321. "" \
  322. "-record(state, {" \
  323. "})." \
  324. "" \
  325. "init(_, Req, _Opts) ->" \
  326. " {ok, Req, \#state{}}." \
  327. "" \
  328. "handle(Req, State=\#state{}) ->" \
  329. " {ok, Req2} = cowboy_req:reply(200, Req)," \
  330. " {ok, Req2, State}." \
  331. "" \
  332. "terminate(_Reason, _Req, _State) ->" \
  333. " ok."
  334. tpl_cowboy_loop = "-module($(n))." \
  335. "-behaviour(cowboy_loop_handler)." \
  336. "" \
  337. "-export([init/3])." \
  338. "-export([info/3])." \
  339. "-export([terminate/3])." \
  340. "" \
  341. "-record(state, {" \
  342. "})." \
  343. "" \
  344. "init(_, Req, _Opts) ->" \
  345. " {loop, Req, \#state{}, 5000, hibernate}." \
  346. "" \
  347. "info(_Info, Req, State) ->" \
  348. " {loop, Req, State, hibernate}." \
  349. "" \
  350. "terminate(_Reason, _Req, _State) ->" \
  351. " ok."
  352. tpl_cowboy_rest = "-module($(n))." \
  353. "" \
  354. "-export([init/3])." \
  355. "-export([content_types_provided/2])." \
  356. "-export([get_html/2])." \
  357. "" \
  358. "init(_, _Req, _Opts) ->" \
  359. " {upgrade, protocol, cowboy_rest}." \
  360. "" \
  361. "content_types_provided(Req, State) ->" \
  362. " {[{{<<\"text\">>, <<\"html\">>, '*'}, get_html}], Req, State}." \
  363. "" \
  364. "get_html(Req, State) ->" \
  365. " {<<\"<html><body>This is REST!</body></html>\">>, Req, State}."
  366. tpl_cowboy_ws = "-module($(n))." \
  367. "-behaviour(cowboy_websocket_handler)." \
  368. "" \
  369. "-export([init/3])." \
  370. "-export([websocket_init/3])." \
  371. "-export([websocket_handle/3])." \
  372. "-export([websocket_info/3])." \
  373. "-export([websocket_terminate/3])." \
  374. "" \
  375. "-record(state, {" \
  376. "})." \
  377. "" \
  378. "init(_, _, _) ->" \
  379. " {upgrade, protocol, cowboy_websocket}." \
  380. "" \
  381. "websocket_init(_, Req, _Opts) ->" \
  382. " Req2 = cowboy_req:compact(Req)," \
  383. " {ok, Req2, \#state{}}." \
  384. "" \
  385. "websocket_handle({text, Data}, Req, State) ->" \
  386. " {reply, {text, Data}, Req, State};" \
  387. "websocket_handle({binary, Data}, Req, State) ->" \
  388. " {reply, {binary, Data}, Req, State};" \
  389. "websocket_handle(_Frame, Req, State) ->" \
  390. " {ok, Req, State}." \
  391. "" \
  392. "websocket_info(_Info, Req, State) ->" \
  393. " {ok, Req, State}." \
  394. "" \
  395. "websocket_terminate(_Reason, _Req, _State) ->" \
  396. " ok."
  397. tpl_ranch_protocol = "-module($(n))." \
  398. "-behaviour(ranch_protocol)." \
  399. "" \
  400. "-export([start_link/4])." \
  401. "-export([init/4])." \
  402. "" \
  403. "-type opts() :: []." \
  404. "-export_type([opts/0])." \
  405. "" \
  406. "-record(state, {" \
  407. " socket :: inet:socket()," \
  408. " transport :: module()" \
  409. "})." \
  410. "" \
  411. "start_link(Ref, Socket, Transport, Opts) ->" \
  412. " Pid = spawn_link(?MODULE, init, [Ref, Socket, Transport, Opts])," \
  413. " {ok, Pid}." \
  414. "" \
  415. "-spec init(ranch:ref(), inet:socket(), module(), opts()) -> ok." \
  416. "init(Ref, Socket, Transport, _Opts) ->" \
  417. " ok = ranch:accept_ack(Ref)," \
  418. " loop(\#state{socket=Socket, transport=Transport})." \
  419. "" \
  420. "loop(State) ->" \
  421. " loop(State)."
  422. # Plugin-specific targets.
  423. bootstrap:
  424. ifneq ($(wildcard src/),)
  425. $(error Error: src/ directory already exists)
  426. endif
  427. @printf "%s\n" $(bs_Makefile) > Makefile
  428. @mkdir src/
  429. @printf "%s\n" $(bs_appsrc) > src/$(PROJECT).app.src
  430. @printf "%s\n" $(bs_app) > src/$(PROJECT)_app.erl
  431. $(eval n := $(PROJECT)_sup)
  432. @printf "%s\n" $(tpl_supervisor) > src/$(PROJECT)_sup.erl
  433. bootstrap-lib:
  434. ifneq ($(wildcard src/),)
  435. $(error Error: src/ directory already exists)
  436. endif
  437. @printf "%s\n" $(bs_Makefile) > Makefile
  438. @mkdir src/
  439. @printf "%s\n" $(bs_appsrc_lib) > src/$(PROJECT).app.src
  440. bootstrap-rel:
  441. ifneq ($(wildcard relx.config),)
  442. $(error Error: relx.config already exists)
  443. endif
  444. ifneq ($(wildcard rel/),)
  445. $(error Error: rel/ directory already exists)
  446. endif
  447. @printf "%s\n" $(bs_relx_config) > relx.config
  448. @mkdir rel/
  449. @printf "%s\n" $(bs_sys_config) > rel/sys.config
  450. @printf "%s\n" $(bs_vm_args) > rel/vm.args
  451. new:
  452. ifeq ($(wildcard src/),)
  453. $(error Error: src/ directory does not exist)
  454. endif
  455. ifndef t
  456. $(error Usage: make new t=TEMPLATE n=NAME)
  457. endif
  458. ifndef tpl_$(t)
  459. $(error Unknown template)
  460. endif
  461. ifndef n
  462. $(error Usage: make new t=TEMPLATE n=NAME)
  463. endif
  464. @printf "%s\n" $(tpl_$(t)) > src/$(n).erl
  465. list-templates:
  466. @echo Available templates: $(sort $(patsubst tpl_%,%,$(filter tpl_%,$(.VARIABLES))))
  467. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  468. # This file is part of erlang.mk and subject to the terms of the ISC License.
  469. .PHONY: build-ct-deps build-ct-suites tests-ct clean-ct distclean-ct
  470. # Configuration.
  471. CT_OPTS ?=
  472. ifneq ($(wildcard test/),)
  473. CT_SUITES ?= $(sort $(subst _SUITE.erl,,$(shell find test -type f -name \*_SUITE.erl -exec basename {} \;)))
  474. else
  475. CT_SUITES ?=
  476. endif
  477. TEST_ERLC_OPTS ?= +debug_info +warn_export_vars +warn_shadow_vars +warn_obsolete_guard
  478. TEST_ERLC_OPTS += -DTEST=1 -DEXTRA=1 +'{parse_transform, eunit_autoexport}'
  479. # Core targets.
  480. tests:: tests-ct
  481. clean:: clean-ct
  482. distclean:: distclean-ct
  483. help::
  484. @printf "%s\n" "" \
  485. "All your common_test suites have their associated targets." \
  486. "A suite named http_SUITE can be ran using the ct-http target."
  487. # Plugin-specific targets.
  488. ALL_TEST_DEPS_DIRS = $(addprefix $(DEPS_DIR)/,$(TEST_DEPS))
  489. CT_RUN = ct_run \
  490. -no_auto_compile \
  491. -noshell \
  492. -pa $(realpath ebin) $(DEPS_DIR)/*/ebin \
  493. -dir test \
  494. -logdir logs
  495. $(foreach dep,$(TEST_DEPS),$(eval $(call dep_target,$(dep))))
  496. build-ct-deps: $(ALL_TEST_DEPS_DIRS)
  497. @for dep in $(ALL_TEST_DEPS_DIRS) ; do $(MAKE) -C $$dep; done
  498. build-ct-suites: build-ct-deps
  499. $(gen_verbose) erlc -v $(TEST_ERLC_OPTS) -o test/ \
  500. $(wildcard test/*.erl test/*/*.erl) -pa ebin/
  501. tests-ct: ERLC_OPTS = $(TEST_ERLC_OPTS)
  502. tests-ct: clean deps app build-ct-suites
  503. @if [ -d "test" ] ; \
  504. then \
  505. mkdir -p logs/ ; \
  506. $(CT_RUN) -suite $(addsuffix _SUITE,$(CT_SUITES)) $(CT_OPTS) ; \
  507. fi
  508. $(gen_verbose) rm -f test/*.beam
  509. define ct_suite_target
  510. ct-$(1): ERLC_OPTS = $(TEST_ERLC_OPTS)
  511. ct-$(1): clean deps app build-ct-suites
  512. @if [ -d "test" ] ; \
  513. then \
  514. mkdir -p logs/ ; \
  515. $(CT_RUN) -suite $(addsuffix _SUITE,$(1)) $(CT_OPTS) ; \
  516. fi
  517. $(gen_verbose) rm -f test/*.beam
  518. endef
  519. $(foreach test,$(CT_SUITES),$(eval $(call ct_suite_target,$(test))))
  520. clean-ct:
  521. $(gen_verbose) rm -rf test/*.beam
  522. distclean-ct:
  523. $(gen_verbose) rm -rf logs/
  524. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  525. # This file is part of erlang.mk and subject to the terms of the ISC License.
  526. .PHONY: plt distclean-plt dialyze
  527. # Configuration.
  528. DIALYZER_PLT ?= $(CURDIR)/.$(PROJECT).plt
  529. export DIALYZER_PLT
  530. PLT_APPS ?=
  531. DIALYZER_OPTS ?= -Werror_handling -Wrace_conditions \
  532. -Wunmatched_returns # -Wunderspecs
  533. # Core targets.
  534. distclean:: distclean-plt
  535. help::
  536. @printf "%s\n" "" \
  537. "Dialyzer targets:" \
  538. " plt Build a PLT file for this project" \
  539. " dialyze Analyze the project using Dialyzer"
  540. # Plugin-specific targets.
  541. $(DIALYZER_PLT): deps app
  542. @dialyzer --build_plt --apps erts kernel stdlib $(PLT_APPS) $(ALL_DEPS_DIRS)
  543. plt: $(DIALYZER_PLT)
  544. distclean-plt:
  545. $(gen_verbose) rm -f $(DIALYZER_PLT)
  546. ifneq ($(wildcard $(DIALYZER_PLT)),)
  547. dialyze:
  548. else
  549. dialyze: $(DIALYZER_PLT)
  550. endif
  551. @dialyzer --no_native --src -r src $(DIALYZER_OPTS)
  552. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  553. # This file is part of erlang.mk and subject to the terms of the ISC License.
  554. # Verbosity.
  555. dtl_verbose_0 = @echo " DTL " $(filter %.dtl,$(?F));
  556. dtl_verbose = $(dtl_verbose_$(V))
  557. # Core targets.
  558. define compile_erlydtl
  559. $(dtl_verbose) erl -noshell -pa ebin/ $(DEPS_DIR)/erlydtl/ebin/ -eval ' \
  560. Compile = fun(F) -> \
  561. Module = list_to_atom( \
  562. string:to_lower(filename:basename(F, ".dtl")) ++ "_dtl"), \
  563. erlydtl:compile(F, Module, [{out_dir, "ebin/"}]) \
  564. end, \
  565. _ = [Compile(F) || F <- string:tokens("$(1)", " ")], \
  566. init:stop()'
  567. endef
  568. ifneq ($(wildcard src/),)
  569. ebin/$(PROJECT).app:: $(shell find templates -type f -name \*.dtl 2>/dev/null)
  570. $(if $(strip $?),$(call compile_erlydtl,$?))
  571. endif
  572. # Copyright (c) 2013-2014, Loïc Hoguin <essen@ninenines.eu>
  573. # This file is part of erlang.mk and subject to the terms of the ISC License.
  574. .PHONY: relx-rel distclean-relx-rel distclean-relx
  575. # Configuration.
  576. RELX_CONFIG ?= $(CURDIR)/relx.config
  577. RELX ?= $(CURDIR)/relx
  578. export RELX
  579. RELX_URL ?= https://github.com/erlware/relx/releases/download/v1.0.2/relx
  580. RELX_OPTS ?=
  581. RELX_OUTPUT_DIR ?= _rel
  582. ifeq ($(firstword $(RELX_OPTS)),-o)
  583. RELX_OUTPUT_DIR = $(word 2,$(RELX_OPTS))
  584. else
  585. RELX_OPTS += -o $(RELX_OUTPUT_DIR)
  586. endif
  587. # Core targets.
  588. ifneq ($(wildcard $(RELX_CONFIG)),)
  589. rel:: distclean-relx-rel relx-rel
  590. endif
  591. distclean:: distclean-relx-rel distclean-relx
  592. # Plugin-specific targets.
  593. define relx_fetch
  594. $(call core_http_get,$(RELX),$(RELX_URL))
  595. chmod +x $(RELX)
  596. endef
  597. $(RELX):
  598. @$(call relx_fetch)
  599. relx-rel: $(RELX)
  600. @$(RELX) -c $(RELX_CONFIG) $(RELX_OPTS)
  601. distclean-relx-rel:
  602. $(gen_verbose) rm -rf $(RELX_OUTPUT_DIR)
  603. distclean-relx:
  604. $(gen_verbose) rm -rf $(RELX)
  605. # Copyright (c) 2014, M Robert Martin <rob@version2beta.com>
  606. # This file is contributed to erlang.mk and subject to the terms of the ISC License.
  607. .PHONY: shell
  608. # Configuration.
  609. SHELL_PATH ?= -pa ../$(PROJECT)/ebin $(DEPS_DIR)/*/ebin
  610. SHELL_OPTS ?=
  611. ALL_SHELL_DEPS_DIRS = $(addprefix $(DEPS_DIR)/,$(SHELL_DEPS))
  612. # Core targets
  613. help::
  614. @printf "%s\n" "" \
  615. "Shell targets:" \
  616. " shell Run an erlang shell with SHELL_OPTS or reasonable default"
  617. # Plugin-specific targets.
  618. $(foreach dep,$(SHELL_DEPS),$(eval $(call dep_target,$(dep))))
  619. build-shell-deps: $(ALL_SHELL_DEPS_DIRS)
  620. @for dep in $(ALL_SHELL_DEPS_DIRS) ; do $(MAKE) -C $$dep ; done
  621. shell: build-shell-deps
  622. $(gen_verbose) erl $(SHELL_PATH) $(SHELL_OPTS)