Refactor of overlay support in reltool extension; adding support for templating overlay files

--HG--
extra : rebase_source : f042bd65d63dbaf4177f444f66033883bf7522a5

src/rebar_reltool.erl

@@ -49,7 +49,7 @@ generate(Config, ReltoolFile) ->
     validate_rel_apps(Server, sys_tuple(ReltoolConfig)),
 
     %% Finally, run reltool
-    case catch(run_reltool(Config, ReltoolConfig)) of
+    case catch(run_reltool(Server, Config, ReltoolConfig)) of
         ok ->
             ok;
         {error, failed} ->
@@ -60,9 +60,9 @@ generate(Config, ReltoolFile) ->
     end.
 
 
-clean(Config, ReltoolFile) ->
+clean(_Config, ReltoolFile) ->
     ReltoolConfig = load_config(ReltoolFile),
-    TargetDir = target_dir(Config, sys_tuple(ReltoolConfig)),
+    TargetDir = target_dir(ReltoolConfig),
     rebar_file_utils:rm_rf(TargetDir),
     rebar_file_utils:delete_each(["reltool.spec"]).
 
@@ -72,44 +72,66 @@ clean(Config, ReltoolFile) ->
 %% Internal functions
 %% ===================================================================
 
+%%
+%% Load terms from reltool.config
+%%
+load_config(ReltoolFile) ->
+    case file:consult(ReltoolFile) of
+        {ok, Terms} ->
+            Terms;
+        Other ->
+            ?ABORT("Failed to load expected config from ~s: ~p\n", [ReltoolFile, Other])
+    end.
+
+%%
+%% Look for the {sys, [...]} tuple in the reltool.config file. Without this present, we
+%% can't run reltool.
+%%
 sys_tuple(ReltoolConfig) ->
     case lists:keysearch(sys, 1, ReltoolConfig) of
         {value, {sys, Data}} ->
             {sys, Data};
         false ->
-            ?ERROR("Failed to find {sys, ...} tuple in reltool.config.", []),
+            ?ABORT("Failed to find {sys, [...]} tuple in reltool.config.", [])
-            ?FAIL
     end.
 
-load_config(ReltoolFile) ->
-    %% Load the reltool configuration from the file
-    case file:consult(ReltoolFile) of
-        {ok, Terms} ->
-            Terms;
-        Other ->
-            ?ERROR("Failed to load expected config from ~s: ~p\n", [ReltoolFile, Other]),
-            ?FAIL
-    end.
-
-
 %%
-%% Determine the name of the target directory; try the user provided name
+%% Look for {target_dir, TargetDir} in the reltool config file; if none is
-%% first, or fall back to the release name if that's available. If neither
+%% found, use the name of the release as the default target directory.
-%% is available, just use "target"
 %%
-target_dir(Config, {sys, ReltoolConfig}) ->
+target_dir(ReltoolConfig) ->
-  case rebar_config:get(Config, target_name, undefined) of
+    case lists:keysearch(target_dir, 1, ReltoolConfig) of
-      undefined ->
+        {value, {target_dir, TargetDir}} ->
-          case lists:keysearch(rel, 1, ReltoolConfig) of
+            filename:absname(TargetDir);
-              {value, {rel, Name, _Vsn, _Apps}} ->
-                  Name;
         false ->
-                  "target"
+            {sys, SysInfo} = sys_tuple(ReltoolConfig),
-          end;
+            case lists:keysearch(rel, 1, SysInfo) of
-      Name ->
+                {value, {rel, Name, _Vsn, _Apps}} ->
-          Name
+                    filename:absname(Name);
+                false ->
+                    filename:absname("target")
+            end
     end.
 
+%%
+%% Look for overlay_vars file reference. The user can override this from the
+%% command line (i.e. globals), so we check there first and then fall back to
+%% what is present in the reltool.config file
+%%
+overlay_vars(ReltoolConfig) ->
+    case rebar_config:get_global(overlay_vars, undefined) of
+        undefined ->
+            case lists:keysearch(overlay_vars, 1, ReltoolConfig) of
+                {value, {overlay_vars, File}} ->
+                    File;
+                false ->
+                    undefined
+            end;
+        File ->
+            File
+    end.
+
+
 validate_rel_apps(ReltoolServer, {sys, ReltoolConfig}) ->
     case lists:keysearch(rel, 1, ReltoolConfig) of
         {value, {rel, _Name, _Vsn, Apps}} ->
@@ -121,13 +143,11 @@ validate_rel_apps(ReltoolServer, {sys, ReltoolConfig}) ->
                 [] ->
                     ok;
                 _ ->
-                    ?ERROR("Apps in {rel, ...} section not found by reltool: ~p\n", [Missing]),
+                    ?ABORT("Apps in {rel, ...} section not found by reltool: ~p\n", [Missing])
-                    ?FAIL
             end;
         {value, Rel} ->
             %% Invalid release format!
-            ?ERROR("Invalid {rel, ...} section in reltools.config: ~p\n", [Rel]),
+            ?ABORT("Invalid {rel, ...} section in reltools.config: ~p\n", [Rel]);
-            ?FAIL;
         false ->
             ok
     end.
@@ -143,33 +163,53 @@ app_exists(AppTuple, Server) when is_tuple(AppTuple) ->
     app_exists(element(1, AppTuple), Server).
 
 
-run_reltool(Config, ReltoolConfig) ->
+run_reltool(Server, Config, ReltoolConfig) ->
-    {ok, Server} = reltool:start_server([sys_tuple(ReltoolConfig)]),
     case reltool:get_target_spec(Server) of
         {ok, Spec} ->
-            TargetDir = target_dir(Config, sys_tuple(ReltoolConfig)),
+            %% Pull the target dir and make sure it exists
+            TargetDir = target_dir(ReltoolConfig),
             mk_target_dir(TargetDir),
 
-            %% Post process the specification with rebar directives (if any exist)
+            %% Dump the spec, if necessary
-            FinalSpec = case lists:keysearch(rebar, 1, ReltoolConfig) of
+            dump_spec(Spec),
-                            {value, {rebar, RebarConfig}} ->
-                                process_rebar_specs(RebarConfig, Spec);
-                            false ->
-                                Spec
-                        end,
 
-            dump_spec(FinalSpec),
+            %% Have reltool actually run
-
+            case reltool:eval_target_spec(Spec, code:root_dir(), TargetDir) of
-            case reltool:eval_target_spec(FinalSpec, code:root_dir(), TargetDir) of
                 ok ->
                     ok;
                 {error, Reason} ->
-                    ?ERROR("Failed to generate target from spec: ~p\n", [Reason]),
+                    ?ABORT("Failed to generate target from spec: ~p\n", [Reason])
-                    ?FAIL
+            end,
+
+            %% Initialize overlay vars with some basics (that can get overwritten)
+            OverlayVars0 = [{erts_vsn, "erts-" ++ erlang:system_info(version)}],
+
+            %% Load up any variables specified by overlay_vars
+            OverlayVars = case overlay_vars(ReltoolConfig) of
+                              undefined ->
+                                  dict:new(OverlayVars0);
+                              File ->
+                                  case file:consult(File) of
+                                      {ok, Terms} ->
+                                          dict:from_list(OverlayVars0 ++ Terms);
+                                      {error, Reason2} ->
+                                          ?ABORT("Unable to load overlay_vars from ~s: ~p\n",
+                                                 [File, Reason2])
+                                  end
+                          end,
+
+            %% Finally, overlay the files specified by the overlay section
+            case lists:keysearch(overlay, 1, ReltoolConfig) of
+                {value, {overlay, Overlay}} when is_list(Overlay) ->
+                    execute_overlay(Overlay, OverlayVars, rebar_utils:get_cwd(), TargetDir);
+                {value, _} ->
+                    ?ABORT("{overlay, [...]} entry in reltool.config must be a list.\n", []);
+                false ->
+                    ?INFO("No {overlay, [...]} found in reltool.config.\n", [])
             end;
+
         {error, Reason} ->
-            ?ERROR("Unable to generate spec: ~s\n", [Reason]),
+            ?ABORT("Unable to generate spec: ~s\n", [Reason])
-            ?FAIL
     end.
 
 
@@ -199,67 +239,72 @@ dump_spec(Spec) ->
             ok
     end.
 
-process_rebar_specs([], Spec) ->
-    Spec;
-process_rebar_specs([{overlay, Source} | Rest], Spec) ->
-    case file:list_dir(Source) of
-        {ok, Files} ->
-            OverlaySpec = spec_copy_overlay(Files, Source, []),
-            process_rebar_specs(Rest, Spec ++ OverlaySpec);
-        {error, Reason} ->
-            ?ERROR("Failed to list overlay directory ~p: ~p\n", [Source, Reason]),
-            ?FAIL
-    end;
-process_rebar_specs([{empty_dirs, Dirs} | Rest], Spec) ->
-    Spec2 = lists:foldl(fun(Dir, SpecAcc) ->
-                                spec_create_dir(filename:split(Dir), SpecAcc)
-                        end, Spec, Dirs),
-    process_rebar_specs(Rest, Spec2);
-process_rebar_specs([ Other | Rest], Spec) ->
-    ?WARN("Ignoring unknown rebar spec: ~p\n", [Other]),
-    process_rebar_specs(Rest, Spec).
 
-
+execute_overlay([], _Vars, _BaseDir, _TargetDir) ->
-spec_create_dir([], Spec) ->
+    ok;
-    Spec;
+execute_overlay([{mkdir, Out} | Rest], Vars, BaseDir, TargetDir) ->
-spec_create_dir([Path | Rest], Spec) ->
+    OutFile = render(filename:join([TargetDir, Out, "dummy"]), Vars),
-    case lists:keysearch(Path, 2, Spec) of
+    filelib:ensure_dir(OutFile),
-        {value, {create_dir, Path, Subspec}} ->
+    ?DEBUG("Created dir ~s\n", [filename:dirname(OutFile)]),
-            %% Directory already exists; process down into
+    execute_overlay(Rest, Vars, BaseDir, TargetDir);
-            %% Note: this is not tail recursive, but unless the directory structure
+execute_overlay([{copy, In} | Rest], _Vars, BaseDir, TargetDir) ->
-            %% is insanely deep, shouldn't be a problem
+    execute_overlay([{copy, In, ""} | Rest], _Vars, BaseDir, TargetDir);
-            lists:keystore(Path, 2, Spec, {create_dir, Path, spec_create_dir(Rest, Subspec)});
+execute_overlay([{copy, In, Out} | Rest], Vars, BaseDir, TargetDir) ->
-        {value, Other} ->
+    InFile = render(filename:join(BaseDir, In), Vars),
-            %% Collision -- something other than create_dir is associated with this
+    OutFile = render(filename:join(TargetDir, Out), Vars),
-            %% portion of our path name.
+    case filelib:is_dir(InFile) of
-            ?ERROR("Collision of path name with existing tuple in spec: ~p\n", [Other]),
+        true ->
-            ?FAIL;
+            ok;
         false ->
-            %% Directory doesn't yet exist
+            ok = filelib:ensure_dir(OutFile)
-            [{create_dir, Path, spec_create_dir(Rest, [])} | Spec]
-    end.
-
-spec_copy_overlay([], _Dir, Acc) ->
-    lists:reverse(Acc);
-spec_copy_overlay([F | Rest], Dir, Acc) ->
-    Filename = filename:join(Dir, F),
-    {ok, Info} = file:read_file_info(Filename),
-    case Info#file_info.type of
-        directory ->
-            %% If this directory has the special name of "erts-vsn", we are going to replace "vsn" with the
-            %% actual erts vsn for the output directory name
-            case filename:basename(Filename) of
-                "erts-vsn" -> OutDir = "erts-" ++ erlang:system_info(version);
-                OutDir -> ok
     end,
-            {ok, Files} = file:list_dir(Filename),
+    rebar_utils:sh(?FMT("cp -R ~p ~p", [InFile, OutFile])),
-            Entry = {create_dir, OutDir, spec_copy_overlay(Files, Filename, [])},
+    execute_overlay(Rest, Vars, BaseDir, TargetDir);
-            spec_copy_overlay(Rest, Dir, [Entry | Acc]);
+execute_overlay([{template, In, Out} | Rest], Vars, BaseDir, TargetDir) ->
-        regular ->
+    {ok, InFileData} = file:read_file(render(filename:join(BaseDir, In), Vars)),
-            Entry = {copy_file, filename:basename(F), filename:absname(Filename)},
+    OutFile = render(filename:join(TargetDir, Out), Vars),
-            spec_copy_overlay(Rest, Dir, [Entry | Acc]);
+    ok = filelib:ensure_dir(OutFile),
-        Other ->
+    case file:write_file(OutFile, render(InFileData, Vars)) of
-            ?DEBUG("Skipping ~p of type ~p\n", [F, Other]),
+        ok ->
-            spec_copy_overlay(Rest, Dir, Acc)
+            ?DEBUG("Templated ~p\n", [OutFile]),
-    end.
+            execute_overlay(Rest, Vars, BaseDir, TargetDir);
+        {error, Reason} ->
+            ?ABORT("Failed to template ~p: ~p\n", [OutFile, Reason])
+    end;
+execute_overlay([{create, Out, Contents} | Rest], Vars, BaseDir, TargetDir) ->
+    OutFile = render(filename:join(TargetDir, Out), Vars),
+    ok = filelib:ensure_dir(OutFile),
+    case file:write_file(OutFile, Contents) of
+        ok ->
+            ?DEBUG("Created ~p\n", [OutFile]),
+            execute_overlay(Rest, Vars, BaseDir, TargetDir);
+        {error, Reason} ->
+            ?ABORT("Failed to create ~p: ~p\n", [OutFile, Reason])
+    end;
+execute_overlay([{replace, Out, Regex, Replacement} | Rest],
+                Vars, BaseDir, TargetDir) ->
+    execute_overlay([{replace, Out, Regex, Replacement, []} | Rest], Vars, BaseDir, TargetDir);
+execute_overlay([{replace, Out, Regex, Replacement, Opts} | Rest],
+                Vars, BaseDir, TargetDir) ->
+    Filename = render(filename:join(TargetDir, Out), Vars),
+    {ok, OrigData} = file:read_file(Filename),
+    Data = re:replace(OrigData, Regex, Replacement, [global, {return, binary}] ++ Opts),
+    case file:write_file(Filename, Data) of
+        ok ->
+            ?DEBUG("Edited ~s: s/~s/~s/\n", [Filename, Regex, Replacement]),
+            execute_overlay(Rest, Vars, BaseDir, TargetDir);
+        {error, Reason} ->
+            ?ABORT("Failed to edit ~p: ~p\n", [Filename, Reason])
+    end;
+execute_overlay([Other | _Rest], _Vars, _BaseDir, _TargetDir) ->
+    {error, {unsupported_operation, Other}}.
 
+
+
+%%
+%% Render a binary to a string, using mustache and the specified context
+%%
+render(Bin, Context) ->
+    %% Be sure to escape any double-quotes before rendering...
+    Str = re:replace(Bin, "\"", "\\\\\"", [global, {return,list}]),
+    mustache:render(Str, Context).