mix.exs 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879
  1. defmodule EMQXUmbrella.MixProject do
  2. use Mix.Project
  3. @moduledoc """
  4. The purpose of this file is to configure the release of EMQX under
  5. Mix. Since EMQX uses its own configuration conventions and startup
  6. procedures, one cannot simply use `iex -S mix`. Instead, it's
  7. recommendd to build and use the release.
  8. ## Profiles
  9. To control the profile and edition to build, we case split on the
  10. MIX_ENV value.
  11. The following profiles are valid:
  12. * `emqx`
  13. * `emqx-enterprise`
  14. * `emqx-pkg`
  15. * `emqx-enterprise-pkg`
  16. * `dev` -> same as `emqx`, for convenience
  17. ## Release Environment Variables
  18. The release build is controlled by a few environment variables.
  19. * `ELIXIR_MAKE_TAR` - If set to `yes`, will produce a `.tar.gz`
  20. tarball along with the release.
  21. """
  22. def project() do
  23. profile_info = check_profile!()
  24. version = pkg_vsn()
  25. [
  26. app: :emqx_mix,
  27. version: version,
  28. deps: deps(profile_info, version),
  29. releases: releases()
  30. ]
  31. end
  32. defp deps(profile_info, version) do
  33. # we need several overrides here because dependencies specify
  34. # other exact versions, and not ranges.
  35. [
  36. {:lc, github: "emqx/lc", tag: "0.3.2", override: true},
  37. {:redbug, "2.0.8"},
  38. {:covertool, github: "zmstone/covertool", tag: "2.0.4.1", override: true},
  39. {:typerefl, github: "ieQu1/typerefl", tag: "0.9.1", override: true},
  40. {:ehttpc, github: "emqx/ehttpc", tag: "0.4.7", override: true},
  41. {:gproc, github: "uwiger/gproc", tag: "0.8.0", override: true},
  42. {:jiffy, github: "emqx/jiffy", tag: "1.0.5", override: true},
  43. {:cowboy, github: "emqx/cowboy", tag: "2.9.0", override: true},
  44. {:esockd, github: "emqx/esockd", tag: "5.9.6", override: true},
  45. {:rocksdb, github: "emqx/erlang-rocksdb", tag: "1.7.2-emqx-9", override: true},
  46. {:ekka, github: "emqx/ekka", tag: "0.14.6", override: true},
  47. {:gen_rpc, github: "emqx/gen_rpc", tag: "2.8.1", override: true},
  48. {:grpc, github: "emqx/grpc-erl", tag: "0.6.7", override: true},
  49. {:minirest, github: "emqx/minirest", tag: "1.3.8", override: true},
  50. {:ecpool, github: "emqx/ecpool", tag: "0.5.3", override: true},
  51. {:replayq, github: "emqx/replayq", tag: "0.3.7", override: true},
  52. {:pbkdf2, github: "emqx/erlang-pbkdf2", tag: "2.0.4", override: true},
  53. # maybe forbid to fetch quicer
  54. {:emqtt,
  55. github: "emqx/emqtt", tag: "1.8.5", override: true, system_env: maybe_no_quic_env()},
  56. {:rulesql, github: "emqx/rulesql", tag: "0.1.5"},
  57. {:observer_cli, "1.7.1"},
  58. {:system_monitor, github: "ieQu1/system_monitor", tag: "3.0.3"},
  59. {:telemetry, "1.1.0"},
  60. # in conflict by emqtt and hocon
  61. {:getopt, "1.0.2", override: true},
  62. {:snabbkaffe, github: "kafka4beam/snabbkaffe", tag: "1.0.7", override: true},
  63. {:hocon, github: "emqx/hocon", tag: "0.38.0", override: true},
  64. {:emqx_http_lib, github: "emqx/emqx_http_lib", tag: "0.5.2", override: true},
  65. {:esasl, github: "emqx/esasl", tag: "0.2.0"},
  66. {:jose, github: "potatosalad/erlang-jose", tag: "1.11.2"},
  67. # in conflict by ehttpc and emqtt
  68. {:gun, github: "emqx/gun", tag: "1.3.9", override: true},
  69. # in conflict by emqx_connector and system_monitor
  70. {:epgsql, github: "emqx/epgsql", tag: "4.7.0.1", override: true},
  71. # in conflict by emqx and observer_cli
  72. {:recon, github: "ferd/recon", tag: "2.5.1", override: true},
  73. {:jsx, github: "talentdeficit/jsx", tag: "v3.1.0", override: true},
  74. # in conflict by erlavro and rocketmq
  75. {:jsone, github: "emqx/jsone", tag: "1.7.1", override: true},
  76. # dependencies of dependencies; we choose specific refs to match
  77. # what rebar3 chooses.
  78. # in conflict by gun and emqtt
  79. {:cowlib,
  80. github: "ninenines/cowlib", ref: "c6553f8308a2ca5dcd69d845f0a7d098c40c3363", override: true},
  81. # in conflict by cowboy_swagger and cowboy
  82. {:ranch,
  83. github: "ninenines/ranch", ref: "a692f44567034dacf5efcaa24a24183788594eb7", override: true},
  84. # in conflict by grpc and eetcd
  85. {:gpb, "4.19.5", override: true, runtime: false},
  86. {:hackney, github: "emqx/hackney", tag: "1.18.1-1", override: true}
  87. ] ++
  88. emqx_apps(profile_info, version) ++
  89. enterprise_deps(profile_info) ++ bcrypt_dep() ++ jq_dep() ++ quicer_dep()
  90. end
  91. defp emqx_apps(profile_info, version) do
  92. apps = umbrella_apps() ++ enterprise_apps(profile_info)
  93. set_emqx_app_system_env(apps, profile_info, version)
  94. end
  95. defp umbrella_apps() do
  96. "apps/*"
  97. |> Path.wildcard()
  98. |> Enum.map(fn path ->
  99. app =
  100. path
  101. |> Path.basename()
  102. |> String.to_atom()
  103. {app, path: path, manager: :rebar3, override: true}
  104. end)
  105. end
  106. defp enterprise_apps(_profile_info = %{edition_type: :enterprise}) do
  107. "lib-ee/*"
  108. |> Path.wildcard()
  109. |> Enum.filter(&File.dir?/1)
  110. |> Enum.map(fn path ->
  111. app =
  112. path
  113. |> Path.basename()
  114. |> String.to_atom()
  115. {app, path: path, manager: :rebar3, override: true}
  116. end)
  117. end
  118. defp enterprise_apps(_profile_info) do
  119. []
  120. end
  121. defp enterprise_deps(_profile_info = %{edition_type: :enterprise}) do
  122. [
  123. {:hstreamdb_erl, github: "hstreamdb/hstreamdb_erl", tag: "0.2.5"},
  124. {:influxdb, github: "emqx/influxdb-client-erl", tag: "1.1.9", override: true},
  125. {:wolff, github: "kafka4beam/wolff", tag: "1.7.5"},
  126. {:kafka_protocol, github: "kafka4beam/kafka_protocol", tag: "4.1.2", override: true},
  127. {:brod_gssapi, github: "kafka4beam/brod_gssapi", tag: "v0.1.0-rc1"},
  128. {:brod, github: "kafka4beam/brod", tag: "3.16.8"},
  129. {:snappyer, "1.2.8", override: true},
  130. {:supervisor3, "1.1.11", override: true}
  131. ]
  132. end
  133. defp enterprise_deps(_profile_info) do
  134. []
  135. end
  136. defp set_emqx_app_system_env(apps, profile_info, version) do
  137. system_env = emqx_app_system_env(profile_info, version) ++ maybe_no_quic_env()
  138. Enum.map(
  139. apps,
  140. fn {app, opts} ->
  141. {app,
  142. Keyword.update(
  143. opts,
  144. :system_env,
  145. system_env,
  146. &Keyword.merge(&1, system_env)
  147. )}
  148. end
  149. )
  150. end
  151. def emqx_app_system_env(profile_info, version) do
  152. erlc_options(profile_info, version)
  153. |> dump_as_erl()
  154. |> then(&[{"ERL_COMPILER_OPTIONS", &1}])
  155. end
  156. defp erlc_options(%{edition_type: edition_type}, version) do
  157. [
  158. :debug_info,
  159. {:compile_info, [{:emqx_vsn, String.to_charlist(version)}]},
  160. {:d, :EMQX_RELEASE_EDITION, erlang_edition(edition_type)},
  161. {:d, :snk_kind, :msg}
  162. ]
  163. end
  164. def maybe_no_quic_env() do
  165. if not enable_quicer?() do
  166. [{"BUILD_WITHOUT_QUIC", "true"}]
  167. else
  168. []
  169. end
  170. end
  171. defp releases() do
  172. [
  173. emqx: fn ->
  174. %{
  175. release_type: release_type,
  176. package_type: package_type,
  177. edition_type: edition_type
  178. } = check_profile!()
  179. base_steps = [
  180. &make_docs(&1),
  181. :assemble,
  182. &create_RELEASES/1,
  183. &copy_files(&1, release_type, package_type, edition_type),
  184. &copy_escript(&1, "nodetool"),
  185. &copy_escript(&1, "install_upgrade.escript")
  186. ]
  187. steps =
  188. if System.get_env("ELIXIR_MAKE_TAR") == "yes" do
  189. base_steps ++ [&prepare_tar_overlays/1, :tar]
  190. else
  191. base_steps
  192. end
  193. [
  194. applications: applications(edition_type),
  195. skip_mode_validation_for: [
  196. :emqx_gateway,
  197. :emqx_stomp,
  198. :emqx_mqttsn,
  199. :emqx_coap,
  200. :emqx_lwm2m,
  201. :emqx_exproto,
  202. :emqx_dashboard,
  203. :emqx_resource,
  204. :emqx_connector,
  205. :emqx_exhook,
  206. :emqx_bridge,
  207. :emqx_modules,
  208. :emqx_management,
  209. :emqx_statsd,
  210. :emqx_retainer,
  211. :emqx_prometheus,
  212. :emqx_auto_subscribe,
  213. :emqx_slow_subs,
  214. :emqx_plugins
  215. ],
  216. steps: steps,
  217. strip_beams: false
  218. ]
  219. end
  220. ]
  221. end
  222. def applications(edition_type) do
  223. [
  224. crypto: :permanent,
  225. public_key: :permanent,
  226. asn1: :permanent,
  227. syntax_tools: :permanent,
  228. ssl: :permanent,
  229. os_mon: :permanent,
  230. inets: :permanent,
  231. compiler: :permanent,
  232. runtime_tools: :permanent,
  233. redbug: :permanent,
  234. xmerl: :permanent,
  235. hocon: :load,
  236. telemetry: :permanent,
  237. emqx: :load,
  238. emqx_conf: :load,
  239. emqx_machine: :permanent
  240. ] ++
  241. if(enable_rocksdb?(),
  242. do: [mnesia_rocksdb: :load],
  243. else: []
  244. ) ++
  245. [
  246. mnesia: :load,
  247. ekka: :load,
  248. emqx_plugin_libs: :load,
  249. esasl: :load,
  250. observer_cli: :permanent,
  251. tools: :load,
  252. covertool: :load,
  253. system_monitor: :load,
  254. emqx_http_lib: :permanent,
  255. emqx_resource: :permanent,
  256. emqx_connector: :permanent,
  257. emqx_authn: :permanent,
  258. emqx_authz: :permanent,
  259. emqx_auto_subscribe: :permanent,
  260. emqx_gateway: :permanent,
  261. emqx_stomp: :permanent,
  262. emqx_mqttsn: :permanent,
  263. emqx_coap: :permanent,
  264. emqx_lwm2m: :permanent,
  265. emqx_exproto: :permanent,
  266. emqx_exhook: :permanent,
  267. emqx_bridge: :permanent,
  268. emqx_rule_engine: :permanent,
  269. emqx_modules: :permanent,
  270. emqx_management: :permanent,
  271. emqx_dashboard: :permanent,
  272. emqx_retainer: :permanent,
  273. emqx_statsd: :permanent,
  274. emqx_prometheus: :permanent,
  275. emqx_psk: :permanent,
  276. emqx_slow_subs: :permanent,
  277. emqx_plugins: :permanent,
  278. emqx_mix: :none
  279. ] ++
  280. if(enable_quicer?(), do: [quicer: :permanent], else: []) ++
  281. if(enable_bcrypt?(), do: [bcrypt: :permanent], else: []) ++
  282. if(enable_jq?(), do: [jq: :load], else: []) ++
  283. if(is_app(:observer),
  284. do: [observer: :load],
  285. else: []
  286. ) ++
  287. if(edition_type == :enterprise,
  288. do: [
  289. emqx_license: :permanent,
  290. emqx_ee_conf: :load,
  291. emqx_ee_connector: :permanent,
  292. emqx_ee_bridge: :permanent,
  293. emqx_ee_schema_registry: :permanent
  294. ],
  295. else: []
  296. )
  297. end
  298. defp is_app(name) do
  299. case Application.load(name) do
  300. :ok ->
  301. true
  302. {:error, {:already_loaded, _}} ->
  303. true
  304. _ ->
  305. false
  306. end
  307. end
  308. def check_profile!() do
  309. valid_envs = [
  310. :dev,
  311. :emqx,
  312. :"emqx-pkg",
  313. :"emqx-enterprise",
  314. :"emqx-enterprise-pkg"
  315. ]
  316. if Mix.env() not in valid_envs do
  317. formatted_envs =
  318. valid_envs
  319. |> Enum.map(&" * #{&1}")
  320. |> Enum.join("\n")
  321. Mix.raise("""
  322. Invalid env #{Mix.env()}. Valid options are:
  323. #{formatted_envs}
  324. """)
  325. end
  326. {
  327. release_type,
  328. package_type,
  329. edition_type
  330. } =
  331. case Mix.env() do
  332. :dev ->
  333. {:cloud, :bin, :community}
  334. :emqx ->
  335. {:cloud, :bin, :community}
  336. :"emqx-enterprise" ->
  337. {:cloud, :bin, :enterprise}
  338. :"emqx-pkg" ->
  339. {:cloud, :pkg, :community}
  340. :"emqx-enterprise-pkg" ->
  341. {:cloud, :pkg, :enterprise}
  342. end
  343. normalize_env!()
  344. %{
  345. release_type: release_type,
  346. package_type: package_type,
  347. edition_type: edition_type
  348. }
  349. end
  350. #############################################################################
  351. # Custom Steps
  352. #############################################################################
  353. defp make_docs(release) do
  354. profile = System.get_env("MIX_ENV")
  355. os_cmd("build", [profile, "docs"])
  356. release
  357. end
  358. defp copy_files(release, release_type, package_type, edition_type) do
  359. overwrite? = Keyword.get(release.options, :overwrite, false)
  360. bin = Path.join(release.path, "bin")
  361. etc = Path.join(release.path, "etc")
  362. log = Path.join(release.path, "log")
  363. plugins = Path.join(release.path, "plugins")
  364. Mix.Generator.create_directory(bin)
  365. Mix.Generator.create_directory(etc)
  366. Mix.Generator.create_directory(log)
  367. Mix.Generator.create_directory(plugins)
  368. Mix.Generator.create_directory(Path.join(etc, "certs"))
  369. Enum.each(
  370. ["mnesia", "configs", "patches", "scripts"],
  371. fn dir ->
  372. path = Path.join([release.path, "data", dir])
  373. Mix.Generator.create_directory(path)
  374. end
  375. )
  376. Mix.Generator.copy_file(
  377. "apps/emqx_authz/etc/acl.conf",
  378. Path.join(etc, "acl.conf"),
  379. force: overwrite?
  380. )
  381. # required by emqx_authz
  382. File.cp_r!(
  383. "apps/emqx/etc/certs",
  384. Path.join(etc, "certs")
  385. )
  386. profile = System.get_env("MIX_ENV")
  387. Mix.Generator.copy_file(
  388. "_build/docgen/#{profile}/emqx.conf.en.example",
  389. Path.join(etc, "emqx.conf.example"),
  390. force: overwrite?
  391. )
  392. # this is required by the produced escript / nodetool
  393. Mix.Generator.copy_file(
  394. Path.join(release.version_path, "start_clean.boot"),
  395. Path.join(bin, "no_dot_erlang.boot"),
  396. force: overwrite?
  397. )
  398. assigns = template_vars(release, release_type, package_type, edition_type)
  399. # This is generated by `scripts/merge-config.escript` or `make merge-config`
  400. # So, this should be run before the release.
  401. # TODO: run as a "compiler" step???
  402. render_template(
  403. "apps/emqx_conf/etc/emqx.conf.all",
  404. assigns,
  405. Path.join(etc, "emqx.conf")
  406. )
  407. if edition_type == :enterprise do
  408. render_template(
  409. "apps/emqx_conf/etc/emqx-enterprise.conf.all",
  410. assigns,
  411. Path.join(etc, "emqx-enterprise.conf")
  412. )
  413. end
  414. render_template(
  415. "rel/emqx_vars",
  416. assigns,
  417. Path.join([release.path, "releases", "emqx_vars"])
  418. )
  419. vm_args_template_path =
  420. case release_type do
  421. :cloud ->
  422. "apps/emqx/etc/vm.args.cloud"
  423. end
  424. render_template(
  425. vm_args_template_path,
  426. assigns,
  427. [
  428. Path.join(etc, "vm.args"),
  429. Path.join(release.version_path, "vm.args")
  430. ]
  431. )
  432. for name <- [
  433. "emqx",
  434. "emqx_ctl"
  435. ] do
  436. Mix.Generator.copy_file(
  437. "bin/#{name}",
  438. Path.join(bin, name),
  439. force: overwrite?
  440. )
  441. # Files with the version appended are expected by the release
  442. # upgrade script `install_upgrade.escript`
  443. Mix.Generator.copy_file(
  444. Path.join(bin, name),
  445. Path.join(bin, name <> "-#{release.version}"),
  446. force: overwrite?
  447. )
  448. end
  449. for base_name <- ["emqx", "emqx_ctl"],
  450. suffix <- ["", "-#{release.version}"] do
  451. name = base_name <> suffix
  452. File.chmod!(Path.join(bin, name), 0o755)
  453. end
  454. Mix.Generator.copy_file(
  455. "bin/node_dump",
  456. Path.join(bin, "node_dump"),
  457. force: overwrite?
  458. )
  459. File.chmod!(Path.join(bin, "node_dump"), 0o755)
  460. Mix.Generator.copy_file(
  461. "bin/emqx_cluster_rescue",
  462. Path.join(bin, "emqx_cluster_rescue"),
  463. force: overwrite?
  464. )
  465. File.chmod!(Path.join(bin, "emqx_cluster_rescue"), 0o755)
  466. render_template(
  467. "rel/BUILD_INFO",
  468. assigns,
  469. Path.join(release.version_path, "BUILD_INFO")
  470. )
  471. release
  472. end
  473. defp render_template(template, assigns, target) when is_binary(target) do
  474. render_template(template, assigns, [target])
  475. end
  476. defp render_template(template, assigns, tartgets) when is_list(tartgets) do
  477. rendered =
  478. File.read!(template)
  479. |> from_rebar_to_eex_template()
  480. |> EEx.eval_string(assigns)
  481. for target <- tartgets do
  482. File.write!(target, rendered)
  483. end
  484. end
  485. # needed by nodetool and by release_handler
  486. defp create_RELEASES(release) do
  487. apps =
  488. Enum.map(release.applications, fn {app_name, app_props} ->
  489. app_vsn = Keyword.fetch!(app_props, :vsn)
  490. app_path =
  491. "./lib"
  492. |> Path.join("#{app_name}-#{app_vsn}")
  493. |> to_charlist()
  494. {app_name, app_vsn, app_path}
  495. end)
  496. release_entry = [
  497. {
  498. :release,
  499. to_charlist(release.name),
  500. to_charlist(release.version),
  501. release.erts_version,
  502. apps,
  503. :permanent
  504. }
  505. ]
  506. release.path
  507. |> Path.join("releases")
  508. |> Path.join("RELEASES")
  509. |> File.open!([:write, :utf8], fn handle ->
  510. IO.puts(handle, "%% coding: utf-8")
  511. :io.format(handle, ~c"~tp.~n", [release_entry])
  512. end)
  513. release
  514. end
  515. defp copy_escript(release, escript_name) do
  516. [shebang, rest] =
  517. "bin/#{escript_name}"
  518. |> File.read!()
  519. |> String.split("\n", parts: 2)
  520. # the elixir version of escript + start.boot required the boot_var
  521. # RELEASE_LIB to be defined.
  522. boot_var = "%%!-boot_var RELEASE_LIB $RUNNER_ROOT_DIR/lib"
  523. # Files with the version appended are expected by the release
  524. # upgrade script `install_upgrade.escript`
  525. Enum.each(
  526. [escript_name, escript_name <> "-" <> release.version],
  527. fn name ->
  528. path = Path.join([release.path, "bin", name])
  529. File.write!(path, [shebang, "\n", boot_var, "\n", rest])
  530. end
  531. )
  532. release
  533. end
  534. # The `:tar` built-in step in Mix Release does not currently add the
  535. # `etc` directory into the resulting tarball. The workaround is to
  536. # add those to the `:overlays` key before running `:tar`.
  537. # See: https://hexdocs.pm/mix/1.13.4/Mix.Release.html#__struct__/0
  538. defp prepare_tar_overlays(release) do
  539. Map.update!(
  540. release,
  541. :overlays,
  542. &[
  543. "etc",
  544. "data",
  545. "plugins",
  546. "bin/node_dump"
  547. | &1
  548. ]
  549. )
  550. end
  551. #############################################################################
  552. # Helper functions
  553. #############################################################################
  554. defp template_vars(release, release_type, :bin = _package_type, edition_type) do
  555. [
  556. emqx_default_erlang_cookie: default_cookie(),
  557. platform_data_dir: "data",
  558. platform_etc_dir: "etc",
  559. platform_log_dir: "log",
  560. platform_plugins_dir: "plugins",
  561. runner_bin_dir: "$RUNNER_ROOT_DIR/bin",
  562. emqx_etc_dir: "$RUNNER_ROOT_DIR/etc",
  563. runner_lib_dir: "$RUNNER_ROOT_DIR/lib",
  564. runner_log_dir: "$RUNNER_ROOT_DIR/log",
  565. runner_user: "",
  566. release_version: release.version,
  567. erts_vsn: release.erts_version,
  568. # FIXME: this is empty in `make emqx` ???
  569. erl_opts: "",
  570. emqx_description: emqx_description(release_type, edition_type),
  571. emqx_schema_mod: emqx_schema_mod(edition_type),
  572. is_elixir: "yes",
  573. is_enterprise: if(edition_type == :enterprise, do: "yes", else: "no")
  574. ] ++ build_info()
  575. end
  576. defp template_vars(release, release_type, :pkg = _package_type, edition_type) do
  577. [
  578. emqx_default_erlang_cookie: default_cookie(),
  579. platform_data_dir: "/var/lib/emqx",
  580. platform_etc_dir: "/etc/emqx",
  581. platform_log_dir: "/var/log/emqx",
  582. platform_plugins_dir: "/var/lib/emqx/plugins",
  583. runner_bin_dir: "/usr/bin",
  584. emqx_etc_dir: "/etc/emqx",
  585. runner_lib_dir: "$RUNNER_ROOT_DIR/lib",
  586. runner_log_dir: "/var/log/emqx",
  587. runner_user: "emqx",
  588. release_version: release.version,
  589. erts_vsn: release.erts_version,
  590. # FIXME: this is empty in `make emqx` ???
  591. erl_opts: "",
  592. emqx_description: emqx_description(release_type, edition_type),
  593. emqx_schema_mod: emqx_schema_mod(edition_type),
  594. is_elixir: "yes",
  595. is_enterprise: if(edition_type == :enterprise, do: "yes", else: "no")
  596. ] ++ build_info()
  597. end
  598. defp default_cookie() do
  599. "emqx50elixir"
  600. end
  601. defp emqx_description(release_type, edition_type) do
  602. case {release_type, edition_type} do
  603. {:cloud, :enterprise} ->
  604. "EMQX Enterprise"
  605. {:cloud, :community} ->
  606. "EMQX"
  607. end
  608. end
  609. defp emqx_schema_mod(:enterprise), do: :emqx_ee_conf_schema
  610. defp emqx_schema_mod(:community), do: :emqx_conf_schema
  611. defp bcrypt_dep() do
  612. if enable_bcrypt?(),
  613. do: [{:bcrypt, github: "emqx/erlang-bcrypt", tag: "0.6.0", override: true}],
  614. else: []
  615. end
  616. defp jq_dep() do
  617. if enable_jq?(),
  618. do: [{:jq, github: "emqx/jq", tag: "v0.3.9", override: true}],
  619. else: []
  620. end
  621. defp quicer_dep() do
  622. if enable_quicer?(),
  623. # in conflict with emqx and emqtt
  624. do: [{:quicer, github: "emqx/quic", tag: "0.0.114", override: true}],
  625. else: []
  626. end
  627. defp enable_bcrypt?() do
  628. not win32?()
  629. end
  630. defp enable_jq?() do
  631. not Enum.any?([
  632. build_without_jq?(),
  633. win32?()
  634. ]) or "1" == System.get_env("BUILD_WITH_JQ")
  635. end
  636. defp enable_quicer?() do
  637. not Enum.any?([
  638. build_without_quic?(),
  639. win32?(),
  640. centos6?(),
  641. macos?()
  642. ]) or "1" == System.get_env("BUILD_WITH_QUIC")
  643. end
  644. defp enable_rocksdb?() do
  645. not Enum.any?([
  646. build_without_rocksdb?(),
  647. raspbian?()
  648. ]) or "1" == System.get_env("BUILD_WITH_ROCKSDB")
  649. end
  650. defp pkg_vsn() do
  651. %{edition_type: edition_type} = check_profile!()
  652. basedir = Path.dirname(__ENV__.file)
  653. script = Path.join(basedir, "pkg-vsn.sh")
  654. os_cmd(script, [Atom.to_string(edition_type)])
  655. end
  656. defp os_cmd(script, args) do
  657. {str, 0} = System.cmd("bash", [script | args])
  658. String.trim(str)
  659. end
  660. defp win32?(),
  661. do: match?({:win_32, _}, :os.type())
  662. defp centos6?() do
  663. case File.read("/etc/centos-release") do
  664. {:ok, "CentOS release 6" <> _} ->
  665. true
  666. _ ->
  667. false
  668. end
  669. end
  670. defp macos?() do
  671. {:unix, :darwin} == :os.type()
  672. end
  673. defp raspbian?() do
  674. os_cmd("./scripts/get-distro.sh", []) =~ "raspbian"
  675. end
  676. defp build_without_jq?() do
  677. opt = System.get_env("BUILD_WITHOUT_JQ", "false")
  678. String.downcase(opt) != "false"
  679. end
  680. defp build_without_quic?() do
  681. opt = System.get_env("BUILD_WITHOUT_QUIC", "false")
  682. String.downcase(opt) != "false"
  683. end
  684. defp build_without_rocksdb?() do
  685. opt = System.get_env("BUILD_WITHOUT_ROCKSDB", "false")
  686. String.downcase(opt) != "false"
  687. end
  688. defp from_rebar_to_eex_template(str) do
  689. # we must not consider surrounding space in the template var name
  690. # because some help strings contain informative variables that
  691. # should not be interpolated, and those have no spaces.
  692. Regex.replace(
  693. ~r/\{\{ ([a-zA-Z0-9_]+) \}\}/,
  694. str,
  695. "<%= \\g{1} %>"
  696. )
  697. end
  698. defp build_info() do
  699. [
  700. build_info_arch: to_string(:erlang.system_info(:system_architecture)),
  701. build_info_wordsize: wordsize(),
  702. build_info_os: os_cmd("./scripts/get-distro.sh", []),
  703. build_info_erlang: otp_release(),
  704. build_info_elixir: System.version(),
  705. build_info_relform: System.get_env("EMQX_REL_FORM", "tgz")
  706. ]
  707. end
  708. # https://github.com/erlang/rebar3/blob/e3108ac187b88fff01eca6001a856283a3e0ec87/src/rebar_utils.erl#L142
  709. defp wordsize() do
  710. size =
  711. try do
  712. :erlang.system_info({:wordsize, :external})
  713. rescue
  714. ErlangError ->
  715. :erlang.system_info(:wordsize)
  716. end
  717. to_string(8 * size)
  718. end
  719. defp normalize_env!() do
  720. env =
  721. case Mix.env() do
  722. :dev ->
  723. :emqx
  724. env ->
  725. env
  726. end
  727. Mix.env(env)
  728. end
  729. # As from Erlang/OTP 17, the OTP release number corresponds to the
  730. # major OTP version number. No erlang:system_info() argument gives
  731. # the exact OTP version.
  732. # https://www.erlang.org/doc/man/erlang.html#system_info_otp_release
  733. # https://github.com/erlang/rebar3/blob/e3108ac187b88fff01eca6001a856283a3e0ec87/src/rebar_utils.erl#L572-L577
  734. defp otp_release() do
  735. major_version = System.otp_release()
  736. root_dir = to_string(:code.root_dir())
  737. [root_dir, "releases", major_version, "OTP_VERSION"]
  738. |> Path.join()
  739. |> File.read()
  740. |> case do
  741. {:error, _} ->
  742. major_version
  743. {:ok, version} ->
  744. version
  745. |> String.trim()
  746. |> String.split("**")
  747. |> List.first()
  748. end
  749. end
  750. defp dump_as_erl(term) do
  751. term
  752. |> then(&:io_lib.format("~0p", [&1]))
  753. |> :erlang.iolist_to_binary()
  754. end
  755. defp erlang_edition(:community), do: :ce
  756. defp erlang_edition(:enterprise), do: :ee
  757. end