Add restart_new_emulator instruction to kernel, stdlib and sasl appups

The appup files for kernel, stdlib and sasl did not contain any
UpFromVsn and DownToVsn. This means that it was not possible to create
a relup file with systool:make_relup if any of these applications had
changed.

This commit adds entries in the appup files for a maximum of two major
releases back - all with only one upgrade instruction:
restart_new_emulator. The point is to allow relups to be generated,
but ensure that no soft upgrade is done for these three applications -
i.e. they will always cause a restart of the emulator prior to all
other upgrade instructions from other applications.

Test cases (appup_test) are added to kernel_SUITE, stdlib_SUITE and
sasl_SUITE. These all check that expected versions are matched in the
appups, and illegal versions (older than two major releases, or in any
other way illegal) do not match. The test is written in a general way
where it is assumed that the version of these applications are stepped
according the the rule that major releases step the second number,
maintenance releases step the third number and patches step the fourth
number.

7 files changed, 302 insertions, 27 deletions

diff --git a/lib/kernel/src/kernel.appup.src b/lib/kernel/src/kernel.appup.src
index 54a63833e6..bded2408a7 100644
--- a/lib/kernel/src/kernel.appup.src
+++ b/lib/kernel/src/kernel.appup.src
@@ -1 +1,27 @@
-{"%VSN%",[],[]}.
+%% -*- erlang -*-
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 1999-2011. All Rights Reserved.
+%%
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+{"%VSN%",
+ %% Up from - max two major revisions back
+ [{<<"2\\.15(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R15
+  {<<"2\\.14(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R14
+  {<<"2\\.13(\\.[0-9]+)*">>,[restart_new_emulator]}],%% R13
+ %% Down to - max two major revisions back
+ [{<<"2\\.15(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R15
+  {<<"2\\.14(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R14
+  {<<"2\\.13(\\.[0-9]+)*">>,[restart_new_emulator]}] %% R13
+}.
diff --git a/lib/kernel/test/kernel_SUITE.erl b/lib/kernel/test/kernel_SUITE.erl
index 16b6c54939..0f29d895e5 100644
--- a/lib/kernel/test/kernel_SUITE.erl
+++ b/lib/kernel/test/kernel_SUITE.erl
@@ -32,7 +32,7 @@
 -export([init_per_testcase/2, end_per_testcase/2]).
 
 % Test cases must be exported.
--export([app_test/1]).
+-export([app_test/1, appup_test/1]).
 
 %%
 %% all/1
@@ -40,7 +40,7 @@
 suite() -> [{ct_hooks,[ts_install_cth]}].
 
 all() -> 
-    [app_test].
+    [app_test, appup_test].
 
 groups() -> 
     [].
@@ -76,3 +76,63 @@ app_test(suite) ->
 app_test(Config) when is_list(Config) ->
     ?line ok=?t:app_test(kernel),
     ok.
+
+
+%% Test that appup allows upgrade from/downgrade to a maximum of two
+%% major releases back.
+appup_test(_Config) ->
+    application:load(kernel),
+    {_,_,Vsn} = lists:keyfind(kernel,1,application:loaded_applications()),
+    AppupFile = filename:join([code:lib_dir(kernel),ebin,"kernel.appup"]),
+    {ok,[{Vsn,UpFrom,DownTo}=AppupScript]} = file:consult(AppupFile),
+    ct:log("~p~n",[AppupScript]),
+    {OkVsns,NokVsns} = create_test_vsns(Vsn),
+    check_appup(OkVsns,UpFrom,{ok,[restart_new_emulator]}),
+    check_appup(OkVsns,DownTo,{ok,[restart_new_emulator]}),
+    check_appup(NokVsns,UpFrom,error),
+    check_appup(NokVsns,DownTo,error),
+    ok.
+
+create_test_vsns(Current) ->
+    [XStr,YStr|Rest] = string:tokens(Current,"."),
+    X = list_to_integer(XStr),
+    Y = list_to_integer(YStr),
+    SecondMajor = vsn(X,Y-2),
+    SecondMinor = SecondMajor ++ ".1.3",
+    FirstMajor = vsn(X,Y-1),
+    FirstMinor = FirstMajor ++ ".57",
+    ThisMajor = vsn(X,Y),
+    This =
+	case Rest of
+	    [] ->
+		[];
+	    ["1"] ->
+		[ThisMajor];
+	    _ ->
+		ThisMinor = ThisMajor ++ ".1",
+		[ThisMajor,ThisMinor]
+	end,
+    OkVsns = This ++ [FirstMajor, FirstMinor, SecondMajor, SecondMinor],
+
+    ThirdMajor = vsn(X,Y-3),
+    ThirdMinor = ThirdMajor ++ ".10.12",
+    Illegal = ThisMajor ++ ",1",
+    Newer1Major = vsn(X,Y+1),
+    Newer1Minor = Newer1Major ++ ".1",
+    Newer2Major = ThisMajor ++ "1",
+    NokVsns = [ThirdMajor,ThirdMinor,
+	       Illegal,
+	       Newer1Major,Newer1Minor,
+	       Newer2Major],
+    {OkVsns,NokVsns}.
+
+vsn(X,Y) ->
+    integer_to_list(X) ++ "." ++ integer_to_list(Y).
+
+check_appup([Vsn|Vsns],Instrs,Expected) ->
+    case systools_relup:appup_search_for_version(Vsn, Instrs) of
+	Expected -> check_appup(Vsns,Instrs,Expected);
+	Other -> ct:fail({unexpected_result_for_vsn,Vsn,Other})
+    end;
+check_appup([],_,_) ->
+    ok.
diff --git a/lib/sasl/src/sasl.appup.src b/lib/sasl/src/sasl.appup.src
index 64c653a4e5..ce4aa1f8f8 100644
--- a/lib/sasl/src/sasl.appup.src
+++ b/lib/sasl/src/sasl.appup.src
@@ -1,25 +1,27 @@
-%%
+%% -*- erlang -*-
 %% %CopyrightBegin%
-%% 
-%% Copyright Ericsson AB 1999-2009. All Rights Reserved.
-%% 
+%%
+%% Copyright Ericsson AB 1999-2011. All Rights Reserved.
+%%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
 %% compliance with the License. You should have received a copy of the
 %% Erlang Public License along with this software. If not, it can be
 %% retrieved online at http://www.erlang.org/.
-%% 
+%%
 %% Software distributed under the License is distributed on an "AS IS"
 %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 %% the License for the specific language governing rights and limitations
 %% under the License.
-%% 
-%% %CopyrightEnd%
 %%
-
+%% %CopyrightEnd%
 {"%VSN%",
- [{"2.1.4", [{load_module, release_handler},
-	     {load_module, systools_relup}]}],
- [{"2.1.4", [{load_module, release_handler},
-	     {load_module, systools_relup}]}]
+ %% Up from - max two major revisions back
+ [{<<"2\\.2(\\.[0-9]+)*">>,[restart_new_emulator]},         %% R15
+  {<<"2\\.1\\.10(\\.[0-9]+)*">>,[restart_new_emulator]},    %% R14B04 (and later?)
+  {<<"2\\.1\\.[6-9](\\.[0-9]+)*">>,[restart_new_emulator]}],%% R13B-R14B03
+ %% Down to - max two major revisions back
+ [{<<"2\\.2(\\.[0-9]+)*">>,[restart_new_emulator]},         %% R15
+  {<<"2\\.1\\.10(\\.[0-9]+)*">>,[restart_new_emulator]},    %% R14B04 (and later?)
+  {<<"2\\.1\\.[6-9](\\.[0-9]+)*">>,[restart_new_emulator]}] %% R13B-R14B03
 }.
diff --git a/lib/sasl/src/systools_relup.erl b/lib/sasl/src/systools_relup.erl
index b750e86e29..27960e9938 100644
--- a/lib/sasl/src/systools_relup.erl
+++ b/lib/sasl/src/systools_relup.erl
@@ -112,6 +112,10 @@
 -export([mk_relup/3, mk_relup/4, format_error/1, format_warning/1]).
 -include("systools.hrl").
 
+
+%% For test purposes only - used by kernel, stdlib and sasl tests
+-export([appup_search_for_version/2]).
+
 %%-----------------------------------------------------------------
 %% mk_relup(TopRelFile, BaseUpRelDcs, BaseDnRelDcs)
 %% mk_relup(TopRelFile, BaseUpRelDcs, BaseDnRelDcs, Opts) -> Ret
@@ -452,25 +456,28 @@ get_script_from_appup(Mode, TopApp, BaseVsn, Ws, RUs) ->
 		  %% XXX Why is this a warning only?
 		  [{bad_vsn, {TopVsn, TopApp#application.vsn}}| Ws]
 	  end,
-    case search_for_version(BaseVsn, length(BaseVsn), VsnRUs) of
+    case appup_search_for_version(BaseVsn, VsnRUs) of
 	{ok, RU} ->
 	    {RUs ++ [RU], Ws1};
 	error ->
 	    throw({error, ?MODULE, {no_relup, FName, TopApp, BaseVsn}})
     end.
 
-search_for_version(BaseVsn,_,[{BaseVsn,RU}|_]) ->
+appup_search_for_version(BaseVsn, VsnRUs) ->
+    appup_search_for_version(BaseVsn, length(BaseVsn), VsnRUs).
+
+appup_search_for_version(BaseVsn,_,[{BaseVsn,RU}|_]) ->
     {ok,RU};
-search_for_version(BaseVsn,Size,[{Vsn,RU}|VsnRUs]) when is_binary(Vsn) ->
+appup_search_for_version(BaseVsn,Size,[{Vsn,RU}|VsnRUs]) when is_binary(Vsn) ->
     case re:run(BaseVsn,Vsn,[unicode,{capture,first,index}]) of
 	{match,[{0,Size}]} ->
 	    {ok, RU};
 	_ ->
-	    search_for_version(BaseVsn,Size,VsnRUs)
+	    appup_search_for_version(BaseVsn,Size,VsnRUs)
     end;
-search_for_version(BaseVsn,Size,[_|VsnRUs]) ->
-    search_for_version(BaseVsn,Size,VsnRUs);
-search_for_version(_,_,[]) ->
+appup_search_for_version(BaseVsn,Size,[_|VsnRUs]) ->
+    appup_search_for_version(BaseVsn,Size,VsnRUs);
+appup_search_for_version(_,_,[]) ->
     error.
 
 
diff --git a/lib/sasl/test/sasl_SUITE.erl b/lib/sasl/test/sasl_SUITE.erl
index 454095db6a..195324daa0 100644
--- a/lib/sasl/test/sasl_SUITE.erl
+++ b/lib/sasl/test/sasl_SUITE.erl
@@ -30,10 +30,11 @@
 
 % Test cases must be exported.
 -export([app_test/1,
+	 appup_test/1,
 	 log_mf_h_env/1]).
 
 all() -> 
-    [app_test, log_mf_h_env].
+    [app_test, appup_test, log_mf_h_env].
 
 groups() -> 
     [].
@@ -57,6 +58,102 @@ app_test(Config) when is_list(Config) ->
     ?line ?t:app_test(sasl, allow),
     ok.
 
+%% Test that appup allows upgrade from/downgrade to a maximum of two
+%% major releases back.
+appup_test(_Config) ->
+    application:load(sasl),
+    {sasl,_,SaslVsn} = lists:keyfind(sasl,1,application:loaded_applications()),
+    Ebin = filename:join(code:lib_dir(sasl),ebin),
+    {ok,[{SaslVsn,UpFrom,DownTo}=Appup]} =
+	file:consult(filename:join(Ebin,"sasl.appup")),
+    ct:log("~p~n",[Appup]),
+    ?line {OkVsns,NokVsns} = create_test_vsns(SaslVsn),
+    ?line check_appup(OkVsns,UpFrom,{ok,[restart_new_emulator]}),
+    ?line check_appup(OkVsns,DownTo,{ok,[restart_new_emulator]}),
+    ?line check_appup(NokVsns,UpFrom,error),
+    ?line check_appup(NokVsns,DownTo,error),
+    ok.
+
+
+%% For sasl, the versions up to R14B03 were not according to the rule
+%% used for other core applications - i.e. to change the second number
+%% at major releases, the third at maintenance releases and the fourth
+%% for patches - therefore test versions up to and including R16 are
+%% hardcoded.
+%% (All versions below are not necessarily existing.)
+-define(r12_vsns,["2.1.5"]).
+-define(r13_vsns,["2.1.6","2.1.7.1","2.1.9","2.1.9.1.2"]).
+-define(r14_vsns,["2.1.9.2","2.1.9.2.20","2.1.9.4","2.1.10"]).
+-define(r15_major,"2.2").
+-define(r16_major,"2.3").
+-define(r17_major,"2.4").
+create_test_vsns(?r15_major ++ Rest) ->
+    R15Vsns =
+	case string:tokens(Rest,".") of
+	    [] -> [];
+	    ["1"] -> [?r15_major];
+	    _ -> [?r15_major,?r15_major++".1"]
+	end,
+    OkVsns = ?r13_vsns ++ ?r14_vsns ++ R15Vsns,
+    NokVsns = ?r12_vsns ++ [?r15_major++",1", ?r16_major],
+    {OkVsns,NokVsns};
+create_test_vsns(?r16_major ++ Rest) ->
+    R16Vsns =
+	case string:tokens(Rest,".") of
+	    [] -> [];
+	    ["1"] -> [?r16_major];
+	    _ -> [?r16_major,?r16_major++".1"]
+	end,
+    OkVsns = ?r14_vsns ++ [?r15_major, ?r15_major ++ ".1.4"] ++ R16Vsns,
+    NokVsns = ?r13_vsns ++ [?r16_major++",1", ?r17_major],
+    {OkVsns,NokVsns};
+%% Normal erts case - i.e. for versions that comply to the erts standard
+create_test_vsns(Current) ->
+    [XStr,YStr|Rest] = string:tokens(Current,"."),
+    X = list_to_integer(XStr),
+    Y = list_to_integer(YStr),
+    SecondMajor = vsn(X,Y-2),
+    SecondMinor = SecondMajor ++ ".1.3",
+    FirstMajor = vsn(X,Y-1),
+    FirstMinor = FirstMajor ++ ".57",
+    ThisMajor = vsn(X,Y),
+    This =
+	case Rest of
+	    [] ->
+		[];
+	    ["1"] ->
+		[ThisMajor];
+	    _ ->
+		ThisMinor = ThisMajor ++ ".1",
+		[ThisMajor,ThisMinor]
+	end,
+    OkVsns = This ++ [FirstMajor, FirstMinor, SecondMajor, SecondMinor],
+
+    ThirdMajor = vsn(X,Y-3),
+    ThirdMinor = ThirdMajor ++ ".10.12",
+    Illegal = ThisMajor ++ ",1",
+    Newer1Major = vsn(X,Y+1),
+    Newer1Minor = Newer1Major ++ ".1",
+    Newer2Major = ThisMajor ++ "1",
+    NokVsns = [ThirdMajor,ThirdMinor,
+	       Illegal,
+	       Newer1Major,Newer1Minor,
+	       Newer2Major],
+    {OkVsns,NokVsns}.
+
+vsn(X,Y) ->
+    integer_to_list(X) ++ "." ++ integer_to_list(Y).
+
+check_appup([Vsn|Vsns],Instrs,Expected) ->
+    case systools_relup:appup_search_for_version(Vsn, Instrs) of
+	Expected -> check_appup(Vsns,Instrs,Expected);
+	Other -> ct:fail({unexpected_result_for_vsn,Vsn,Other})
+    end;
+check_appup([],_,_) ->
+    ok.
+
+
+
 %% OTP-9185 - fail sasl start if some but not all log_mf_h env vars
 %% are given.
 log_mf_h_env(Config) ->
diff --git a/lib/stdlib/src/stdlib.appup.src b/lib/stdlib/src/stdlib.appup.src
index 54a63833e6..94e81188b5 100644
--- a/lib/stdlib/src/stdlib.appup.src
+++ b/lib/stdlib/src/stdlib.appup.src
@@ -1 +1,27 @@
-{"%VSN%",[],[]}.
+%% -*- erlang -*-
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 1999-2011. All Rights Reserved.
+%%
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+{"%VSN%",
+ %% Up from - max two major revisions back
+ [{<<"1\\.18(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R15
+  {<<"1\\.17(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R14
+  {<<"1\\.16(\\.[0-9]+)*">>,[restart_new_emulator]}],%% R13
+ %% Down to - max two major revisions back
+ [{<<"1\\.18(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R15
+  {<<"1\\.17(\\.[0-9]+)*">>,[restart_new_emulator]}, %% R14
+  {<<"1\\.16(\\.[0-9]+)*">>,[restart_new_emulator]}] %% R13
+}.
diff --git a/lib/stdlib/test/stdlib_SUITE.erl b/lib/stdlib/test/stdlib_SUITE.erl
index 0cca030b3d..8a2cb5ea6b 100644
--- a/lib/stdlib/test/stdlib_SUITE.erl
+++ b/lib/stdlib/test/stdlib_SUITE.erl
@@ -33,8 +33,7 @@
 -export([init_per_testcase/2, end_per_testcase/2]).
 
 % Test cases must be exported.
--export([app_test/1]).
--define(cases, [app_test]).
+-export([app_test/1, appup_test/1]).
 
 %%
 %% all/1
@@ -42,7 +41,7 @@
 suite() -> [{ct_hooks,[ts_install_cth]}].
 
 all() -> 
-    [app_test].
+    [app_test, appup_test].
 
 groups() -> 
     [].
@@ -79,3 +78,61 @@ app_test(Config) when is_list(Config) ->
     ?t:app_test(stdlib),
     ok.
 
+%% Test that appup allows upgrade from/downgrade to a maximum of two
+%% major releases back.
+appup_test(_Config) ->
+    application:load(stdlib),
+    {_,_,Vsn} = lists:keyfind(stdlib,1,application:loaded_applications()),
+    AppupFile = filename:join([code:lib_dir(stdlib),ebin,"stdlib.appup"]),
+    {ok,[{Vsn,UpFrom,DownTo}=AppupScript]} = file:consult(AppupFile),
+    ct:log("~p~n",[AppupScript]),
+    {OkVsns,NokVsns} = create_test_vsns(Vsn),
+    check_appup(OkVsns,UpFrom,{ok,[restart_new_emulator]}),
+    check_appup(OkVsns,DownTo,{ok,[restart_new_emulator]}),
+    check_appup(NokVsns,UpFrom,error),
+    check_appup(NokVsns,DownTo,error),
+    ok.
+
+create_test_vsns(Current) ->
+    [XStr,YStr|Rest] = string:tokens(Current,"."),
+    X = list_to_integer(XStr),
+    Y = list_to_integer(YStr),
+    SecondMajor = vsn(X,Y-2),
+    SecondMinor = SecondMajor ++ ".1.3",
+    FirstMajor = vsn(X,Y-1),
+    FirstMinor = FirstMajor ++ ".57",
+    ThisMajor = vsn(X,Y),
+    This =
+	case Rest of
+	    [] ->
+		[];
+	    ["1"] ->
+		[ThisMajor];
+	    _ ->
+		ThisMinor = ThisMajor ++ ".1",
+		[ThisMajor,ThisMinor]
+	end,
+    OkVsns = This ++ [FirstMajor, FirstMinor, SecondMajor, SecondMinor],
+
+    ThirdMajor = vsn(X,Y-3),
+    ThirdMinor = ThirdMajor ++ ".10.12",
+    Illegal = ThisMajor ++ ",1",
+    Newer1Major = vsn(X,Y+1),
+    Newer1Minor = Newer1Major ++ ".1",
+    Newer2Major = ThisMajor ++ "1",
+    NokVsns = [ThirdMajor,ThirdMinor,
+	       Illegal,
+	       Newer1Major,Newer1Minor,
+	       Newer2Major],
+    {OkVsns,NokVsns}.
+
+vsn(X,Y) ->
+    integer_to_list(X) ++ "." ++ integer_to_list(Y).
+
+check_appup([Vsn|Vsns],Instrs,Expected) ->
+    case systools_relup:appup_search_for_version(Vsn, Instrs) of
+	Expected -> check_appup(Vsns,Instrs,Expected);
+	Other -> ct:fail({unexpected_result_for_vsn,Vsn,Other})
+    end;
+check_appup([],_,_) ->
+    ok.