Extract dist config handling, support {dist, ...}

This commit moves the handling of distribution config and starting out
of rebar_prv_shell and into rebar_dist_utils. The module is able to
handle standard config options and boot a distributed node mode. This
could be used in plugins (once it is exposed) and other providers like
CT.

Configuration is also expanded so that options like:

    {dist, [{sname, atom()}, {name, atom()}, {setcookie, term()}]}

can be used and will be handled as a default. The config handler
supports similar terms from the command line being parsed in if the
calling provider supports them.

A test suite is added for configuration handling.

1 files changed, 74 insertions, 0 deletions

diff --git a/test/rebar_dist_utils_SUITE.erl b/test/rebar_dist_utils_SUITE.erl
new file mode 100644
index 0000000..f0a71be
--- /dev/null
+++ b/test/rebar_dist_utils_SUITE.erl
@@ -0,0 +1,74 @@
+%%% This suite currently only tests for options parsing since we do
+%%% not know if epmd will be running to actually boot nodes.
+-module(rebar_dist_utils_SUITE).
+-include_lib("common_test/include/ct.hrl").
+-include_lib("eunit/include/eunit.hrl").
+-compile(export_all).
+
+all() -> [from_config, from_cli, overlap, from_config_profile].
+
+init_per_testcase(_, Config0) ->
+    Config = rebar_test_utils:init_rebar_state(Config0),
+    AppDir = ?config(apps, Config),
+    Name = rebar_test_utils:create_random_name("app_"),
+    Vsn = rebar_test_utils:create_random_vsn(),
+    rebar_test_utils:create_app(filename:join([AppDir,"apps",Name]), Name, Vsn, [kernel, stdlib]),
+    Config.
+
+
+end_per_testcase(_, _) ->
+    ok.
+
+from_config(Config) ->
+    ShortConfig = [{dist, [{sname, 'a@localhost'}, {setcookie, abc}]}],
+    LongConfig = [{dist, [{name, 'a@localhost.x'}, {setcookie, abc}]}],
+    BothConfig = [{dist, [{sname, 'a@localhost'}, {name, 'a@localhost.x'}, {setcookie,abc}]}],
+    NoConfig = [],
+    CookieConfig = [{dist, [{setcookie, def}]}],
+    NoCookie = [{dist, [{sname, 'a@localhost'}]}],
+    {ok, State0} = rebar_test_utils:run_and_check(Config, ShortConfig, ["version"], return),
+    {undefined, 'a@localhost', [{setcookie, abc}]} = rebar_dist_utils:find_options(State0),
+    {ok, State1} = rebar_test_utils:run_and_check(Config, LongConfig, ["version"], return),
+    {'a@localhost.x', undefined, [{setcookie, abc}]} = rebar_dist_utils:find_options(State1),
+    %% only support the first name found, side-effect of wanting profile support
+    {ok, State2} = rebar_test_utils:run_and_check(Config, BothConfig, ["version"], return),
+    {undefined, 'a@localhost', [{setcookie, abc}]} = rebar_dist_utils:find_options(State2),
+    {ok, State3} = rebar_test_utils:run_and_check(Config, NoConfig, ["version"], return),
+    {undefined, undefined, []} = rebar_dist_utils:find_options(State3),
+    {ok, State4} = rebar_test_utils:run_and_check(Config, CookieConfig, ["version"], return),
+    {undefined, undefined, [{setcookie, def}]} = rebar_dist_utils:find_options(State4),
+    {ok, State5} = rebar_test_utils:run_and_check(Config, NoCookie, ["version"], return),
+    {undefined, 'a@localhost', []} = rebar_dist_utils:find_options(State5),
+    ok.
+
+from_cli(Config) ->
+    {ok, State0} = rebar_test_utils:run_and_check(Config, [], ["version"], return),
+    {undefined, undefined, []} = rebar_dist_utils:find_options(State0),
+    State1 = rebar_state:command_parsed_args(State0, {[{sname, 'a@localhost'}, {setcookie,abc}], []}),
+    {undefined, 'a@localhost', [{setcookie, abc}]} = rebar_dist_utils:find_options(State1),
+    State2 = rebar_state:command_parsed_args(State0, {[{name, 'a@localhost.x'}, {setcookie,abc}], []}),
+    {'a@localhost.x', undefined, [{setcookie, abc}]} = rebar_dist_utils:find_options(State2),
+    State3 = rebar_state:command_parsed_args(State0, {[{sname, 'a@localhost'}, {name, 'a@localhost.x'}, {setcookie,abc}], []}),
+    {'a@localhost.x', 'a@localhost', [{setcookie, abc}]} = rebar_dist_utils:find_options(State3),
+    State4 = rebar_state:command_parsed_args(State0, {[{setcookie,def}], []}),
+    {undefined, undefined, [{setcookie, def}]} = rebar_dist_utils:find_options(State4),
+    State5 = rebar_state:command_parsed_args(State0, {[{sname, 'a@localhost'}], []}),
+    {undefined, 'a@localhost', []} = rebar_dist_utils:find_options(State5),
+    ok.
+
+overlap(Config) ->
+    %% Make sure that CLI config takes over rebar config without clash for names, though
+    %% cookies can pass through
+    RebarConfig = [{dist, [{sname, 'a@localhost'}, {setcookie, abc}]}],
+    {ok, State0} = rebar_test_utils:run_and_check(Config, RebarConfig, ["version"], return),
+    State1 = rebar_state:command_parsed_args(State0, {[{name, 'b@localhost.x'}], []}),
+    {'b@localhost.x', undefined, [{setcookie, abc}]} = rebar_dist_utils:find_options(State1),
+    ok.
+
+from_config_profile(Config) ->
+    %% running as a profile does not create name clashes
+    RebarConfig = [{dist, [{sname, 'a@localhost'}, {setcookie, abc}]},
+                   {profiles, [ {fake, [{dist, [{name, 'a@localhost.x'}]}]} ]}],
+    {ok, State0} = rebar_test_utils:run_and_check(Config, RebarConfig, ["as","fake","version"], return),
+    {'a@localhost.x', undefined, [{setcookie, abc}]} = rebar_dist_utils:find_options(State0),
+    ok.