mix.exs 24 KB

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