[sasl] Sort applications used by other applications correctly in .script

OTP-9984

Applications that are listed in {applications,Apps} in the app file
were not sorted correctly in the script file. They were loaded/started
in the reverse order of how they were listed in the .app file.

This is corrected so they are now sorted (internally between each
other) in the same way as they are listed in the .rel file.

2 files changed, 166 insertions, 27 deletions

diff --git a/lib/sasl/src/systools_make.erl b/lib/sasl/src/systools_make.erl
index 12ba2a5476..3c1002e4a6 100644
--- a/lib/sasl/src/systools_make.erl
+++ b/lib/sasl/src/systools_make.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1996-2011. All Rights Reserved.
+%% Copyright Ericsson AB 1996-2012. 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
@@ -375,7 +375,7 @@ get_release1(File, Path, ModTestP, Machine) ->
     {ok, Release, Warnings1} = read_release(File, Path),
     {ok, Appls0} = collect_applications(Release, Path),
     {ok, Appls1} = check_applications(Appls0),
-    {ok, Appls2} = sort_included_applications(Appls1, Release), % OTP-4121
+    {ok, Appls2} = sort_used_and_incl_appls(Appls1, Release), % OTP-4121, OTP-9984
     {ok, Warnings2} = check_modules(Appls2, Path, ModTestP, Machine),
     {ok, Appls} = sort_appls(Appls2),
     {ok, Release, Appls, Warnings1 ++ Warnings2}.
@@ -842,34 +842,45 @@ undefined_applications(Appls) ->
     filter(fun(X) -> not member(X, Defined) end, Uses).
 
 %%______________________________________________________________________
-%% sort_included_applications(Applications, Release) -> Applications
+%% sort_used_and_incl_appls(Applications, Release) -> Applications
 %%   Applications = [{{Name,Vsn},#application}]
 %%   Release = #release{}
 %%    
-%% Check that included applications are given in the same order as in
-%% the release resource file (.rel). Otherwise load instructions in
-%% the boot script, and consequently release upgrade instructions in
-%% relup, may end up in the wrong order.
+%% OTP-4121, OTP-9984
+%% Check that used and included applications are given in the same
+%% order as in the release resource file (.rel). Otherwise load and
+%% start instructions in the boot script, and consequently release
+%% upgrade instructions in relup, may end up in the wrong order.
 
-sort_included_applications(Applications, Release) when is_tuple(Release) ->
+sort_used_and_incl_appls(Applications, Release) when is_tuple(Release) ->
     {ok,
-     sort_included_applications(Applications, Release#release.applications)};
-
-sort_included_applications([{Tuple,Appl}|Appls], OrderedAppls) ->
-    case Appl#application.includes of
-	Incls when length(Incls)>1 ->
-	    IndexedIncls = find_pos(Incls, OrderedAppls),
-	    SortedIndexedIncls = lists:keysort(1, IndexedIncls),
-	    Incls2 = lists:map(fun({_Index,Name}) -> Name end,
-			       SortedIndexedIncls),
-	    Appl2 = Appl#application{includes=Incls2},
-	    [{Tuple,Appl2}|sort_included_applications(Appls, OrderedAppls)];
-	_Incls ->
-	    [{Tuple,Appl}|sort_included_applications(Appls, OrderedAppls)]
-    end;
-sort_included_applications([], _OrderedAppls) ->
+     sort_used_and_incl_appls(Applications, Release#release.applications)};
+
+sort_used_and_incl_appls([{Tuple,Appl}|Appls], OrderedAppls) ->
+    Incls2 =
+	case Appl#application.includes of
+	    Incls when length(Incls)>1 ->
+		sort_appl_list(Incls, OrderedAppls);
+	    Incls ->
+		Incls
+	end,
+    Uses2 =
+	case Appl#application.uses of
+	    Uses when length(Uses)>1 ->
+		sort_appl_list(Uses, OrderedAppls);
+	    Uses ->
+		Uses
+	end,
+    Appl2 = Appl#application{includes=Incls2, uses=Uses2},
+    [{Tuple,Appl2}|sort_used_and_incl_appls(Appls, OrderedAppls)];
+sort_used_and_incl_appls([], _OrderedAppls) ->
     [].
 
+sort_appl_list(List, Order) ->
+    IndexedList = find_pos(List, Order),
+    SortedIndexedList = lists:keysort(1, IndexedList),
+    lists:map(fun({_Index,Name}) -> Name end, SortedIndexedList).
+
 find_pos([Name|Incs], OrderedAppls) ->
     [find_pos(1, Name, OrderedAppls)|find_pos(Incs, OrderedAppls)];
 find_pos([], _OrderedAppls) ->
@@ -1253,7 +1264,8 @@ sort_appls(Appls) -> {ok, sort_appls(Appls, [], [], [])}.
 
 sort_appls([{N, A}|T], Missing, Circular, Visited) ->
     {Name,_Vsn} = N,
-    {Uses, T1, NotFnd1} = find_all(Name, A#application.uses, T, Visited, [], []),
+    {Uses, T1, NotFnd1} = find_all(Name, lists:reverse(A#application.uses),
+				   T, Visited, [], []),
     {Incs, T2, NotFnd2} = find_all(Name, lists:reverse(A#application.includes),
 				   T1, Visited, [], []),
     Missing1 = NotFnd1 ++ NotFnd2 ++ Missing,
diff --git a/lib/sasl/test/systools_SUITE.erl b/lib/sasl/test/systools_SUITE.erl
index 4cf7364d74..72b3eb8954 100644
--- a/lib/sasl/test/systools_SUITE.erl
+++ b/lib/sasl/test/systools_SUITE.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2011. All Rights Reserved.
+%% Copyright Ericsson AB 2012. 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
@@ -45,7 +45,7 @@
 	 abnormal_script/1, src_tests_script/1, crazy_script/1,
 	 included_script/1, included_override_script/1,
 	 included_fail_script/1, included_bug_script/1, exref_script/1,
-	 otp_3065_circular_dependenies/1]).
+	 otp_3065_circular_dependenies/1, included_and_used_sort_script/1]).
 -export([tar_options/1, normal_tar/1, no_mod_vsn_tar/1, system_files_tar/1,
 	 system_files_tar/2, invalid_system_files_tar/1,
 	 invalid_system_files_tar/2, variable_tar/1,
@@ -80,7 +80,7 @@ groups() ->
        no_sasl_script, src_tests_script, crazy_script,
        included_script, included_override_script,
        included_fail_script, included_bug_script, exref_script,
-       otp_3065_circular_dependenies]},
+       otp_3065_circular_dependenies, included_and_used_sort_script]},
      {tar, [],
       [tar_options, normal_tar, no_mod_vsn_tar, system_files_tar,
        invalid_system_files_tar, variable_tar,
@@ -600,6 +600,24 @@ otp_3065_circular_dependenies(Config) when is_list(Config) ->
     ok = file:set_cwd(OldDir),
     ok.
 
+%% Test sorting of included applications and used applications
+included_and_used_sort_script(Config) when is_list(Config) ->
+    {ok, OldDir} = file:get_cwd(),
+    {LatestDir1, LatestName1} = create_include_files(sort_apps, Config),
+    ok = file:set_cwd(LatestDir1),
+    ok = systools:make_script(LatestName1),
+    ok = check_include_script(LatestName1,
+			      [t20,t19,t18,t17,t16,t15,t14],[t20,t19,t18,t14]),
+
+    {LatestDir2, LatestName2} = create_include_files(sort_apps_rev, Config),
+    ok = file:set_cwd(LatestDir2),
+    ok = systools:make_script(LatestName2),
+    ok = check_include_script(LatestName2,
+			      [t18,t19,t20,t15,t16,t17,t14],[t18,t19,t20,t14]),
+
+    ok = file:set_cwd(OldDir),
+    ok.
+
 
 %% make_script: Check that make_script exref option works.
 exref_script(Config) when is_list(Config) ->
@@ -2301,8 +2319,53 @@ create_include_files(otp_3065_circular_dependenies, Config) ->
 	"  {chAts, \"1.0\"}, {aa12, \"1.0\"}, \n"
 	"  {chTraffic, \"1.0\"}]}.\n",
     file:write_file(Name ++ ".rel", list_to_binary(Rel)),
+    {filename:dirname(Name), filename:basename(Name)};
+
+create_include_files(sort_apps, Config) ->
+    PrivDir = ?privdir,
+    Name = fname(PrivDir, sort_apps),
+    create_sort_apps(PrivDir),
+
+    Apps = application_controller:which_applications(),
+    {value,{_,_,KernelVer}} = lists:keysearch(kernel,1,Apps),
+    {value,{_,_,StdlibVer}} = lists:keysearch(stdlib,1,Apps),
+
+    Rel = "{release, {\"test\",\"R1A\"}, {erts, \"45\"},\n"
+	" [{kernel, \"" ++ KernelVer ++ "\"}, {stdlib, \""
+	++ StdlibVer ++ "\"},\n"
+	"  {t14, \"1.0\"}, \n"
+	"  {t20, \"1.0\"}, \n"
+	"  {t19, \"1.0\"}, \n"
+	"  {t18, \"1.0\"}, \n"
+	"  {t17, \"1.0\"}, \n"
+	"  {t16, \"1.0\"}, \n"
+	"  {t15, \"1.0\"}]}.\n",
+    file:write_file(Name ++ ".rel", list_to_binary(Rel)),
+    {filename:dirname(Name), filename:basename(Name)};
+
+create_include_files(sort_apps_rev, Config) ->
+    PrivDir = ?privdir,
+    Name = fname(PrivDir, sort_apps_rev),
+    create_sort_apps(PrivDir),
+
+    Apps = application_controller:which_applications(),
+    {value,{_,_,KernelVer}} = lists:keysearch(kernel,1,Apps),
+    {value,{_,_,StdlibVer}} = lists:keysearch(stdlib,1,Apps),
+
+    Rel = "{release, {\"test\",\"R1A\"}, {erts, \"45\"},\n"
+	" [{kernel, \"" ++ KernelVer ++ "\"}, {stdlib, \""
+	++ StdlibVer ++ "\"},\n"
+	"  {t14, \"1.0\"}, \n"
+	"  {t18, \"1.0\"}, \n"
+	"  {t19, \"1.0\"}, \n"
+	"  {t20, \"1.0\"}, \n"
+	"  {t15, \"1.0\"}, \n"
+	"  {t16, \"1.0\"}, \n"
+	"  {t17, \"1.0\"}]}.\n",
+    file:write_file(Name ++ ".rel", list_to_binary(Rel)),
     {filename:dirname(Name), filename:basename(Name)}.
 
+
 create_apps(Dir) ->
     T1 = "{application, t1,\n"
 	" [{vsn, \"1.0\"},\n"
@@ -2451,6 +2514,70 @@ create_apps_3065(Dir) ->
 	"  {registered, []}]}.\n",
     file:write_file(fname(Dir, 'aa12.app'), list_to_binary(T13)).
 
+create_sort_apps(Dir) ->
+    T14 = "{application, t14,\n"
+	" [{vsn, \"1.0\"},\n"
+	"  {description, \"test\"},\n"
+	"  {modules, []},\n"
+	"  {applications, [t18,t20,t19]},\n"
+	"  {included_applications, [t15,t17,t16]},\n"
+	"  {registered, []}]}.\n",
+    file:write_file(fname(Dir, 't14.app'), list_to_binary(T14)),
+
+    T15 = "{application, t15,\n"
+	" [{vsn, \"1.0\"},\n"
+	"  {description, \"test\"},\n"
+	"  {modules, []},\n"
+	"  {applications, []},\n"
+	"  {included_applications, []},\n"
+	"  {registered, []}]}.\n",
+    file:write_file(fname(Dir, 't15.app'), list_to_binary(T15)),
+
+    T16 = "{application, t16,\n"
+	" [{vsn, \"1.0\"},\n"
+	"  {description, \"test\"},\n"
+	"  {modules, []},\n"
+	"  {applications, []},\n"
+	"  {included_applications, []},\n"
+	"  {registered, []}]}.\n",
+    file:write_file(fname(Dir, 't16.app'), list_to_binary(T16)),
+
+    T17 = "{application, t17,\n"
+	" [{vsn, \"1.0\"},\n"
+	"  {description, \"test\"},\n"
+	"  {modules, []},\n"
+	"  {applications, []},\n"
+	"  {included_applications, []},\n"
+	"  {registered, []}]}.\n",
+    file:write_file(fname(Dir, 't17.app'), list_to_binary(T17)),
+
+    T18 = "{application, t18,\n"
+	" [{vsn, \"1.0\"},\n"
+	"  {description, \"test\"},\n"
+	"  {modules, []},\n"
+	"  {applications, []},\n"
+	"  {included_applications, []},\n"
+	"  {registered, []}]}.\n",
+    file:write_file(fname(Dir, 't18.app'), list_to_binary(T18)),
+
+    T19 = "{application, t19,\n"
+	" [{vsn, \"1.0\"},\n"
+	"  {description, \"test\"},\n"
+	"  {modules, []},\n"
+	"  {applications, []},\n"
+	"  {included_applications, []},\n"
+	"  {registered, []}]}.\n",
+    file:write_file(fname(Dir, 't19.app'), list_to_binary(T19)),
+
+    T20 = "{application, t20,\n"
+	" [{vsn, \"1.0\"},\n"
+	"  {description, \"test\"},\n"
+	"  {modules, []},\n"
+	"  {applications, []},\n"
+	"  {included_applications, []},\n"
+	"  {registered, []}]}.\n",
+    file:write_file(fname(Dir, 't20.app'), list_to_binary(T20)).
+
 fname(N) ->
     filename:join(N).