Support .appup.src[.script] files

Similar to how .app.src are being handled, all files in directory .src ending with .appup.src are processed, checked for correctness and copied to ebin without the .src extension. By way of using rebar_config:consult_file/1, .appup.src.script files are automatically supported in exactly the same manner as in .app.src.script.
2024-11-14 11:09:35 +00:00 · 2015-02-02 12:03:14 +00:00 · 2015-02-02 12:03:14 +00:00 · 53fbb7cf8e
commit 53fbb7cf8e
parent fffc745e11
11 changed files with 267 additions and 0 deletions
--- a/ebin/rebar.app
+++ b/ebin/rebar.app
@ -27,6 +27,7 @@
              rebar_log,
              rebar_neotoma_compiler,
              rebar_otp_app,
+              rebar_otp_appup,
              rebar_port_compiler,
              rebar_proto_compiler,
              rebar_protobuffs_compiler,
@ -80,6 +81,7 @@
                               rebar_erlydtl_compiler,
                               rebar_port_compiler,
                               rebar_otp_app,
+                               rebar_otp_appup,
                               rebar_ct,
                               rebar_eunit,
                               rebar_qc,
--- a/inttest/appup_src/appup_src_rt.erl
+++ b/inttest/appup_src/appup_src_rt.erl
@ -0,0 +1,67 @@
+%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 et
+%% -------------------------------------------------------------------
+%%
+%% rebar: Erlang Build Tools
+%%
+%% Copyright (c) 2015 Luis Rascao (luis.rascao@gmail.com)
+%%
+%% Permission is hereby granted, free of charge, to any person obtaining a copy
+%% of this software and associated documentation files (the "Software"), to deal
+%% in the Software without restriction, including without limitation the rights
+%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+%% copies of the Software, and to permit persons to whom the Software is
+%% furnished to do so, subject to the following conditions:
+%%
+%% The above copyright notice and this permission notice shall be included in
+%% all copies or substantial portions of the Software.
+%%
+%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+%% THE SOFTWARE.
+%% -------------------------------------------------------------------
+-module(appup_src_rt).
+
+-compile(export_all).
+
+-include_lib("eunit/include/eunit.hrl").
+
+files() ->
+    [{copy, "../../rebar", "rebar"},
+     {copy, "src", "src"}].
+
+run(Dir) ->
+    retest_log:log(debug, "Running in Dir: ~s~n", [Dir]),
+    {ok, [_Pid|Output]} = retest:sh("./rebar compile -vv",
+                                    [{async, false}]),
+
+    LineRegexp = "Compiled src/app\.appup\.src",
+    ?assertEqual(true, has_line(Output, LineRegexp)),
+
+    %% check that ebin/app.appup exists
+    ?assertMatch(true, filelib:is_regular("ebin/app.appup")),
+    retest_log:log(debug, "Generated ebin/app.appup~n", []),
+
+    %% check that ebin/app.appup has expected version
+    {ok, [{AppVersion, [{UpgradeFrom, _}], [{DowngradeTo, _}]}]} =
+        file:consult("ebin/app.appup"),
+    ?assertEqual(AppVersion, "1.2.2"),
+    ?assertEqual(UpgradeFrom, "1.2.1"),
+    ?assertEqual(DowngradeTo, "1.2.1"),
+    ok.
+
+has_line([], _RE) ->
+    false;
+has_line([L|T], RE) ->
+    case re:run(L, RE, []) of
+        {match, _Captured} ->
+            true;
+        match ->
+            true;
+        nomatch ->
+            has_line(T, RE)
+    end.
--- a/inttest/appup_src/src/app.app.src
+++ b/inttest/appup_src/src/app.app.src
@ -0,0 +1,5 @@
+{application, app,
+	[{vsn, "1"},
+     {modules, []},
+     {registered, []},
+     {applications, [kernel, stdlib]}]}.
--- a/inttest/appup_src/src/app.appup.src
+++ b/inttest/appup_src/src/app.appup.src
@ -0,0 +1,6 @@
+{"1.2.2",
+	[{"1.2.1",
+		[{update,proc1,{advanced,[]},[]},
+         {update,proc2,{advanced,[]},[]}]
+     }],
+     [{"1.2.1", []}]}.
--- a/inttest/appup_src/src/appup_src.erl
+++ b/inttest/appup_src/src/appup_src.erl
@ -0,0 +1,6 @@
+-module(appup_src).
+
+-compile(export_all).
+
+test() ->
+    ok.
--- a/inttest/appup_src_script/appup_src_script_rt.erl
+++ b/inttest/appup_src_script/appup_src_script_rt.erl
@ -0,0 +1,67 @@
+%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 et
+%% -------------------------------------------------------------------
+%%
+%% rebar: Erlang Build Tools
+%%
+%% Copyright (c) 2015 Luis Rascao (luis.rascao@gmail.com)
+%%
+%% Permission is hereby granted, free of charge, to any person obtaining a copy
+%% of this software and associated documentation files (the "Software"), to deal
+%% in the Software without restriction, including without limitation the rights
+%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+%% copies of the Software, and to permit persons to whom the Software is
+%% furnished to do so, subject to the following conditions:
+%%
+%% The above copyright notice and this permission notice shall be included in
+%% all copies or substantial portions of the Software.
+%%
+%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+%% THE SOFTWARE.
+%% -------------------------------------------------------------------
+-module(appup_src_script_rt).
+
+-compile(export_all).
+
+-include_lib("eunit/include/eunit.hrl").
+
+files() ->
+    [{copy, "../../rebar", "rebar"},
+     {copy, "src", "src"}].
+
+run(Dir) ->
+    retest_log:log(debug, "Running in Dir: ~s~n", [Dir]),
+    {ok, [_Pid|Output]} = retest:sh("./rebar compile -vv",
+                                    [{async, false}]),
+
+    LineRegexp = "Compiled src/app\.appup\.src",
+    ?assertEqual(true, has_line(Output, LineRegexp)),
+
+    %% check that ebin/app.appup exists
+    ?assertMatch(true, filelib:is_regular("ebin/app.appup")),
+    retest_log:log(debug, "Generated ebin/app.appup~n", []),
+
+    %% check that ebin/app.appup has expected version
+    {ok, [{AppVersion, [{UpgradeFrom, _}], [{DowngradeTo, _}]}]} =
+        file:consult("ebin/app.appup"),
+    ?assertEqual(AppVersion, "2.1.2"),
+    ?assertEqual(UpgradeFrom, "2.1.1"),
+    ?assertEqual(DowngradeTo, "2.1.1"),
+    ok.
+
+has_line([], _RE) ->
+    false;
+has_line([L|T], RE) ->
+    case re:run(L, RE, []) of
+        {match, _Captured} ->
+            true;
+        match ->
+            true;
+        nomatch ->
+            has_line(T, RE)
+    end.
--- a/inttest/appup_src_script/src/app.app.src
+++ b/inttest/appup_src_script/src/app.app.src
@ -0,0 +1,5 @@
+{application, app,
+	[{vsn, "1"},
+     {modules, []},
+     {registered, []},
+     {applications, [kernel, stdlib]}]}.
--- a/inttest/appup_src_script/src/app.appup.src
+++ b/inttest/appup_src_script/src/app.appup.src
@ -0,0 +1,6 @@
+{"1.2.2",
+	[{"1.2.1",
+		[{update,proc1,{advanced,[]},[]},
+         {update,proc2,{advanced,[]},[]}]
+     }],
+     [{"1.2.1", []}]}.
--- a/inttest/appup_src_script/src/app.appup.src.script
+++ b/inttest/appup_src_script/src/app.appup.src.script
@ -0,0 +1,9 @@
+%% decompose the appup
+[{AppVersion,
+	[{UpgradeFrom, UpgradeInstructions}],
+	[{DowngradeTo, DowngradeInstructions}]}] = CONFIG,
+
+%% and replace the version strings
+[{"2.1.2",
+	[{"2.1.1", UpgradeInstructions}],
+	[{"2.1.1", DowngradeInstructions}]}].
--- a/inttest/appup_src_script/src/appup_src.erl
+++ b/inttest/appup_src_script/src/appup_src.erl
@ -0,0 +1,6 @@
+-module(appup_src).
+
+-compile(export_all).
+
+test() ->
+    ok.
--- a/src/rebar_otp_appup.erl
+++ b/src/rebar_otp_appup.erl
@ -0,0 +1,88 @@
+%% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*-
+%% ex: ts=4 sw=4 et
+%% -------------------------------------------------------------------
+%%
+%% rebar: Erlang Build Tools
+%%
+%% Copyright (c) 2015 Luis Rascao (luis.rascao@gmail.com)
+%%
+%% Permission is hereby granted, free of charge, to any person obtaining a copy
+%% of this software and associated documentation files (the "Software"), to deal
+%% in the Software without restriction, including without limitation the rights
+%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+%% copies of the Software, and to permit persons to whom the Software is
+%% furnished to do so, subject to the following conditions:
+%%
+%% The above copyright notice and this permission notice shall be included in
+%% all copies or substantial portions of the Software.
+%%
+%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+%% THE SOFTWARE.
+%% -------------------------------------------------------------------
+-module(rebar_otp_appup).
+
+-export([compile/2,
+         clean/2]).
+
+%% for internal use only
+-export([info/2]).
+
+-include("rebar.hrl").
+
+%% ===================================================================
+%% Public API
+%% ===================================================================
+
+-spec compile(rebar_config:config(), file:filename()) ->
+    {'ok', rebar_config:config()}.
+compile(Config, _AppFile) ->
+    %% If we get an *.appup.src file, it needs to be pre-processed and
+    %% written out as a ebin/*.appup file.
+    Files = rebar_utils:find_files_by_ext("src", ".appup.src"),
+    Targets = [filename:join("ebin",
+                             filename:rootname(filename:basename(F)))
+               || F <- Files],
+    rebar_base_compiler:run(Config, [],
+                            lists:zip(Files, Targets),
+                            fun preprocess/3,
+                            [{check_last_mod, true}]).
+
+clean(Config, _AppFile) ->
+    Files = rebar_utils:find_files_by_ext("ebin", ".appup"),
+    rebar_file_utils:delete_each([Files]),
+    {ok, Config}.
+
+%% ===================================================================
+%% Internal functions
+%% ===================================================================
+
+info(help, compile) ->
+    ?CONSOLE("Validate .appup.src file", []);
+info(help, clean) ->
+    ?CONSOLE("Delete .appup file if generated from .appup.src", []).
+
+preprocess(SourceFile, TargetFile, _Config) ->
+    %% Perform basic validation on the appup file
+    %% i.e. if a consult succeeds and basic appup
+    %% structure exists.
+    case rebar_config:consult_file(SourceFile) of
+        %% The .appup syntax is described in
+        %% http://erlang.org/doc/man/appup.html.
+        {ok, [{_Vsn, [_UpFromVsn], [_DownToVsn]} = AppUp]} ->
+            case file:write_file(TargetFile,
+                                 lists:flatten(io_lib:format("~p.", [AppUp]))) of
+                {error, Reason} ->
+                    ?ABORT("Failed writing to target file ~s due to ~s",
+                        [TargetFile, Reason]);
+                ok -> ok
+            end;
+        {error, Reason} ->
+            ?ABORT("Failed to compile ~s: ~p~n", [SourceFile, Reason]);
+        _ ->
+            ?ABORT("Failed to compile ~s, not an appup~n", [SourceFile])
+    end.