Merge pull request #557 from tsloughter/relx_args

only reverse some relx args, fixes profile usage for relx

src/rebar_prv_release.erl

@@ -32,34 +32,7 @@ init(State) ->
 
 -spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.
 do(State) ->
-    Options = rebar_state:command_args(State),
-    DepsDir = rebar_dir:deps_dir(State),
-    ProjectAppDirs = lists:delete(".", ?DEFAULT_PROJECT_APP_DIRS),
-    LibDirs = rebar_utils:filtermap(fun ec_file:exists/1,
-                                   [?DEFAULT_CHECKOUTS_DIR, DepsDir | ProjectAppDirs]),
-    OutputDir = filename:join(rebar_dir:base_dir(State), ?DEFAULT_RELEASE_DIR),
-    AllOptions = string:join(["release" | Options], " "),
-    Cwd = rebar_state:dir(State),
-    Providers = rebar_state:providers(State),
-    rebar_hooks:run_all_hooks(Cwd, pre, ?PROVIDER, Providers, State),
-    try
-        case rebar_state:get(State, relx, []) of
-            [] ->
-                relx:main([{lib_dirs, LibDirs}
-                          ,{output_dir, OutputDir}
-                          ,{caller, api}], AllOptions);
-            Config ->
-                relx:main([{lib_dirs, LibDirs}
-                          ,{config, lists:reverse(Config)}
-                          ,{output_dir, OutputDir}
-                          ,{caller, api}], AllOptions)
-        end,
-        rebar_hooks:run_all_hooks(Cwd, post, ?PROVIDER, Providers, State),
-        {ok, State}
-    catch
-        throw:T ->
-            {error, {rlx_prv_release, T}}
-    end.
+    rebar_relx:do(rlx_prv_release, "release", ?PROVIDER, State).
 
 -spec format_error(any()) -> iolist().
 format_error(Reason) ->

src/rebar_prv_relup.erl

@@ -33,34 +33,7 @@ init(State) ->
 
 -spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.
 do(State) ->
-    Options = rebar_state:command_args(State),
-    DepsDir = rebar_dir:deps_dir(State),
-    ProjectAppDirs = lists:delete(".", ?DEFAULT_PROJECT_APP_DIRS),
-    LibDirs = rebar_utils:filtermap(fun ec_file:exists/1,
-                                   [?DEFAULT_CHECKOUTS_DIR, DepsDir | ProjectAppDirs]),
-    OutputDir = filename:join(rebar_dir:base_dir(State), ?DEFAULT_RELEASE_DIR),
-    AllOptions = string:join(["relup" | Options], " "),
-    Cwd = rebar_state:dir(State),
-    Providers = rebar_state:providers(State),
-    rebar_hooks:run_all_hooks(Cwd, pre, ?PROVIDER, Providers, State),
-    try
-        case rebar_state:get(State, relx, []) of
-            [] ->
-                relx:main([{lib_dirs, LibDirs}
-                          ,{output_dir, OutputDir}
-                          ,{caller, api}], AllOptions);
-            Config ->
-                relx:main([{lib_dirs, LibDirs}
-                          ,{config, lists:reverse(Config)}
-                          ,{output_dir, OutputDir}
-                          ,{caller, api}], AllOptions)
-        end,
-        rebar_hooks:run_all_hooks(Cwd, post, ?PROVIDER, Providers, State),
-        {ok, State}
-    catch
-        throw:T ->
-            {error, {rlx_prv_release, T}}
-    end.
+    rebar_relx:do(rlx_prv_release, "relup", ?PROVIDER, State).
 
 -spec format_error(any()) -> iolist().
 format_error(Reason) ->

src/rebar_prv_tar.erl

@@ -32,29 +32,7 @@ init(State) ->
 
 -spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.
 do(State) ->
-    Options = rebar_state:command_args(State),
-    DepsDir = rebar_dir:deps_dir(State),
-    ProjectAppDirs = lists:delete(".", ?DEFAULT_PROJECT_APP_DIRS),
-    LibDirs = rebar_utils:filtermap(fun ec_file:exists/1,
-                                   [?DEFAULT_CHECKOUTS_DIR, DepsDir | ProjectAppDirs]),
-    OutputDir = filename:join(rebar_dir:base_dir(State), ?DEFAULT_RELEASE_DIR),
-    AllOptions = string:join(["tar" | Options], " "),
-    Cwd = rebar_state:dir(State),
-    Providers = rebar_state:providers(State),
-    rebar_hooks:run_all_hooks(Cwd, pre, ?PROVIDER, Providers, State),
-    case rebar_state:get(State, relx, []) of
-        [] ->
-            relx:main([{lib_dirs, LibDirs}
-                      ,{output_dir, OutputDir}
-                      ,{caller, api}], AllOptions);
-        Config ->
-            relx:main([{lib_dirs, LibDirs}
-                      ,{config, lists:reverse(Config)}
-                      ,{output_dir, OutputDir}
-                      ,{caller, api}], AllOptions)
-    end,
-    rebar_hooks:run_all_hooks(Cwd, post, ?PROVIDER, Providers, State),
-    {ok, State}.
+    rebar_relx:do(rlx_prv_release, "tar", ?PROVIDER, State).
 
 -spec format_error(any()) -> iolist().
 format_error(Reason) ->

src/rebar_relx.erl

@@ -0,0 +1,69 @@
+%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 et
+
+-module(rebar_relx).
+
+-export([do/4,
+         format_error/1]).
+
+-include("rebar.hrl").
+
+%% ===================================================================
+%% Public API
+%% ===================================================================
+
+-spec do(atom(), string(), atom(), rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.
+do(Module, Command, Provider, State) ->
+    Options = rebar_state:command_args(State),
+    DepsDir = rebar_dir:deps_dir(State),
+    ProjectAppDirs = lists:delete(".", ?DEFAULT_PROJECT_APP_DIRS),
+    LibDirs = rebar_utils:filtermap(fun ec_file:exists/1,
+                                   [?DEFAULT_CHECKOUTS_DIR, DepsDir | ProjectAppDirs]),
+    OutputDir = filename:join(rebar_dir:base_dir(State), ?DEFAULT_RELEASE_DIR),
+    AllOptions = string:join([Command | Options], " "),
+    Cwd = rebar_state:dir(State),
+    Providers = rebar_state:providers(State),
+    rebar_hooks:run_all_hooks(Cwd, pre, Provider, Providers, State),
+    try
+        case rebar_state:get(State, relx, []) of
+            [] ->
+                relx:main([{lib_dirs, LibDirs}
+                          ,{output_dir, OutputDir}
+                          ,{caller, api}], AllOptions);
+            Config ->
+                Config1 = update_config(Config),
+                relx:main([{lib_dirs, LibDirs}
+                          ,{config, Config1}
+                          ,{output_dir, OutputDir}
+                          ,{caller, api}], AllOptions)
+        end,
+        rebar_hooks:run_all_hooks(Cwd, post, Provider, Providers, State),
+        {ok, State}
+    catch
+        throw:T ->
+            {error, {Module, T}}
+    end.
+
+-spec format_error(any()) -> iolist().
+format_error(Reason) ->
+    io_lib:format("~p", [Reason]).
+
+%% To handle profiles rebar3 expects the provider to use the first entry
+%% in a configuration key-value list as the value of a key if dups exist.
+%% This does not work with relx. Some config options must not lose their
+%% order (release which has an extends option is one). So here we pull out
+%% options that are special so we can reverse the rest so what we expect
+%% from a rebar3 profile is what we get on the relx side.
+-define(SPECIAL_KEYS, [release, vm_args, sys_config, overlay_vars, lib_dirs]).
+
+update_config(Config) ->
+    {Special, Other} =
+        lists:foldl(fun(Tuple, {SpecialAcc, OtherAcc}) when is_tuple(Tuple) ->
+                            case lists:member(element(1, Tuple), ?SPECIAL_KEYS) of
+                                true ->
+                                    {[Tuple | SpecialAcc], OtherAcc};
+                                false ->
+                                    {SpecialAcc, [Tuple | OtherAcc]}
+                            end
+                    end, {[], []}, Config),
+    lists:reverse(Special) ++ Other.

test/rebar_release_SUITE.erl

@@ -6,7 +6,8 @@
 all() -> [release,
           dev_mode_release,
           profile_dev_mode_override_release,
-          tar].
+          tar,
+          extend_release].
 
 init_per_testcase(Case, Config0) ->
     Config = rebar_test_utils:init_rebar_state(Config0),
@@ -90,3 +91,21 @@ tar(Config) ->
       ["tar"],
       {ok, [{release, list_to_atom(Name), Vsn, false}, {tar, Name, Vsn}]}
      ).
+
+%% Test that the order of release config args is not lost. If it is extend would fail.
+extend_release(Config) ->
+    AppDir = ?config(apps, Config),
+    Name = ?config(name, Config),
+    Vsn = "1.0.0",
+    {ok, RebarConfig} =
+        file:consult(rebar_test_utils:create_config(AppDir,
+                                                    [{relx, [{release, {list_to_atom(Name), Vsn},
+                                                              [list_to_atom(Name)]},
+                                                             {release, {extended, Vsn, {extend, list_to_atom(Name)}},
+                                                              []},
+                                                             {lib_dirs, [AppDir]}]}])),
+    rebar_test_utils:run_and_check(
+      Config, RebarConfig,
+      ["release", "-n", "extended"],
+      {ok, [{release, extended, Vsn, false}]}
+     ).