[sasl] Improve handling of unicode strings and atoms

9 files changed, 312 insertions, 9 deletions

diff --git a/lib/sasl/test/release_handler_SUITE.erl b/lib/sasl/test/release_handler_SUITE.erl
index 7093158502..50932e89e4 100644
--- a/lib/sasl/test/release_handler_SUITE.erl
+++ b/lib/sasl/test/release_handler_SUITE.erl
@@ -66,7 +66,7 @@ cases() ->
      supervisor_which_children_timeout,
      release_handler_which_releases, install_release_syntax_check,
      upgrade_supervisor, upgrade_supervisor_fail, otp_9864,
-     otp_10463_upgrade_script_regexp, no_dot_erlang].
+     otp_10463_upgrade_script_regexp, no_dot_erlang, unicode_upgrade].
 
 groups() ->
     [{release,[],
@@ -1875,6 +1875,86 @@ no_dot_erlang(Conf) ->
 	ok
     end.
 
+%%%-----------------------------------------------------------------
+%%% Test unicode handling. Make sure that release name, application
+%%% description, and application environment variables may contain
+%%% unicode characters.
+unicode_upgrade(Conf) ->
+    %% Set some paths
+    DataDir = ?config(data_dir, Conf),
+    PrivDir = priv_dir(Conf),
+    Dir = filename:join(PrivDir,"unicode"),
+    LibDir0 = filename:join(DataDir, "unicode"),
+    LibDir =
+        case {file:native_name_encoding(),os:type()} of
+            {utf8,{Os,_}} when Os =/= win32 ->
+                LD = filename:join(DataDir,"unicode_αβ"),
+                file:make_symlink("unicode",LD),
+                LD;
+            _ ->
+                LibDir0
+        end,
+
+    %% Create the releases
+    RelName = "unicode_rel_αβ",
+    Rel1 = create_and_install_fake_first_release(Dir,{RelName,"1"},
+						 [{u,"1.0",LibDir}]),
+    Rel2 = create_fake_upgrade_release(Dir,
+				       {RelName,"2"},
+				       [{u,"1.1",LibDir}],
+				       {[Rel1],[Rel1],[LibDir]}),
+    Rel1Dir = filename:dirname(Rel1),
+    Rel2Dir = filename:dirname(Rel2),
+
+    %% Start a slave node
+    {ok, Node} = t_start_node(unicode_upgrade, Rel1,
+                              filename:join(Rel1Dir,"sys.config"), "+pc unicode"),
+
+    %% Check
+    Dir1 = filename:join([LibDir, "u-1.0"]),
+    Dir1 = rpc:call(Node, code, lib_dir, [u]),
+    UBeam1 = filename:join([Dir1,"ebin","u.beam"]),
+    UBeam1 = rpc:call(Node,code,which,[u]),
+    {RelName,"1"} = rpc:call(Node,init,script_id,[]),
+    {Env,state} = rpc:call(Node,u,u,[]),
+    'val_αβ' = proplists:get_value('key_αβ',Env),
+    [{RelName,"1",_,permanent}|_] =
+        rpc:call(Node,release_handler,which_releases,[]),
+    {ok,ReleasesDir} = rpc:call(Node,application,get_env,[sasl,releases_dir]),
+    {ok,[[{release,RelName,"1",_,_,permanent}|_]]} =
+        file:consult(filename:join(ReleasesDir,"RELEASES")),
+
+    %% Install second release
+    {ok, RelVsn2} =
+	rpc:call(Node, release_handler, set_unpacked,
+		 [Rel2++".rel", [{u,"1.1",LibDir}]]),
+    ok = rpc:call(Node, release_handler, install_file,
+		  [RelVsn2, filename:join(Rel2Dir, "relup")]),
+    ok = rpc:call(Node, release_handler, install_file,
+		  [RelVsn2, filename:join(Rel2Dir, "start.boot")]),
+    ok = rpc:call(Node, release_handler, install_file,
+		  [RelVsn2, filename:join(Rel2Dir, "sys.config")]),
+
+    {ok, _RelVsn1, []} =
+	rpc:call(Node, release_handler, install_release, [RelVsn2]),
+
+    %% And check
+    Dir2 = filename:join([LibDir, "u-1.1"]),
+    Dir2 = rpc:call(Node, code, lib_dir, [u]),
+    UBeam2 = filename:join([Dir2,"ebin","u.beam"]),
+    {file,UBeam2} = rpc:call(Node,code,is_loaded,[u]),
+    {RelName,"1"} = rpc:call(Node,init,script_id,[]),
+    {Env,{state,'αβ'}} = rpc:call(Node,u,u,[]),
+    [{RelName,"2",_,current}|_] =
+        rpc:call(Node,release_handler,which_releases,[]),
+    {ok,ReleasesDir2} = rpc:call(Node,application,get_env,[sasl,releases_dir]),
+    {ok,<<"%% coding: utf-8\n[{release,\"unicode_rel_αβ\",\"2\""/utf8,_/binary>>}=
+        file:read_file(filename:join(ReleasesDir2,"RELEASES")),
+    ok.
+
+unicode_upgrade(cleanup,_Conf) ->
+    stop_node(node_name(unicode_upgrade)).
+
 
 %%%=================================================================
 %%% Misceleaneous functions
@@ -2002,6 +2082,8 @@ are_names_reg_gg(Node, Names, N) ->
 
 
 t_start_node(Name, Boot, SysConfig) ->
+    t_start_node(Name, Boot, SysConfig, "").
+t_start_node(Name, Boot, SysConfig, ArgStr) ->
     Args = 
 	case Boot of
 	    [] -> [];
@@ -2010,8 +2092,9 @@ t_start_node(Name, Boot, SysConfig) ->
 	case SysConfig of
 	    [] -> [];
 	    _ -> " -config " ++ SysConfig
-	end,
-    test_server:start_node(Name, slave, [{args, Args}]).
+	end ++
+        " " ++ ArgStr,
+    test_server:start_node(Name, peer, [{args, Args}]).
 
 stop_node(Node) ->
     ?t:stop_node(Node).
@@ -2460,7 +2543,9 @@ create_rel_file(RelFile,RelName,RelVsn,Erts,ExtraApps) ->
 
 %% Insert a term in a file, which can be read with file:consult/1.
 write_term_file(File,Term) ->
-    ok = file:write_file(File,io_lib:format("~p.~n",[Term])).
+    Str = io_lib:format("%% ~s~n~tp.~n",[epp:encoding_to_string(utf8),Term]),
+    Bin = unicode:characters_to_binary(Str),
+    ok = file:write_file(File,Bin).
     
 
 %% Check that global group info is correct - try again for a maximum of 5 sec
@@ -2719,8 +2804,8 @@ cover_fun(Node,Func) ->
 %% and possibly other applications if they are listed in AppDirs =
 %% [{App,Vsn,LibDir}]
 create_and_install_fake_first_release(Dir,AppDirs) ->
-    %% Create the first release
-    {RelName,RelVsn} = init:script_id(),
+    create_and_install_fake_first_release(Dir,init:script_id(),AppDirs).
+create_and_install_fake_first_release(Dir,{RelName,RelVsn},AppDirs) ->
     {Rel,_} = create_fake_release(Dir,RelName,RelVsn,AppDirs),
     ReleasesDir = filename:join(Dir, "releases"),
     RelDir = filename:dirname(Rel),
@@ -2744,9 +2829,11 @@ create_and_install_fake_first_release(Dir,AppDirs) ->
 %% be upgraded to from the release created by
 %% create_and_install_fake_first_release/2. Unpack first by calls to
 %% release_handler:set_unpacked and release_handler:install_file.
-create_fake_upgrade_release(Dir,RelVsn,AppDirs,{UpFrom,DownTo,ExtraLibs}) ->
-    %% Create a new release
+create_fake_upgrade_release(Dir,RelVsn,AppDirs,UpgrInstr) when not is_tuple(RelVsn) ->
     {RelName,_} = init:script_id(),
+    create_fake_upgrade_release(Dir,{RelName,RelVsn},AppDirs,UpgrInstr);
+create_fake_upgrade_release(Dir,{RelName,RelVsn},AppDirs,{UpFrom,DownTo,ExtraLibs}) ->
+    %% Create a new release
     {Rel,Paths} = create_fake_release(Dir,RelName,RelVsn,AppDirs),
     RelDir = filename:dirname(Rel),
 
diff --git a/lib/sasl/test/release_handler_SUITE_data/Makefile.src b/lib/sasl/test/release_handler_SUITE_data/Makefile.src
index b794aa0e6f..113d3e2290 100644
--- a/lib/sasl/test/release_handler_SUITE_data/Makefile.src
+++ b/lib/sasl/test/release_handler_SUITE_data/Makefile.src
@@ -76,7 +76,13 @@ SUP= \
 	 release_handler_timeouts/dummy-0.1/ebin/dummy_sup.@EMULATOR@ \
 	 release_handler_timeouts/dummy-0.1/ebin/dummy_sup_2.@EMULATOR@
 
-all: $(LIB) $(APP) $(OTP2740) $(C) $(SUP)
+UNICODE= \
+     unicode/u-1.0/ebin/u.@EMULATOR@ \
+     unicode/u-1.0/ebin/u_sup.@EMULATOR@ \
+     unicode/u-1.1/ebin/u.@EMULATOR@ \
+     unicode/u-1.1/ebin/u_sup.@EMULATOR@
+
+all: $(LIB) $(APP) $(OTP2740) $(C) $(SUP) $(UNICODE)
 
 lib/a-1.0/ebin/a.@EMULATOR@: lib/a-1.0/src/a.erl
 	erlc $(EFLAGS) -olib/a-1.0/ebin lib/a-1.0/src/a.erl
@@ -236,3 +242,13 @@ release_handler_timeouts/dummy-0.1/ebin/dummy_sup.@EMULATOR@: release_handler_ti
 	erlc $(EFLAGS) -orelease_handler_timeouts/dummy-0.1/ebin release_handler_timeouts/dummy-0.1/src/dummy_sup.erl
 release_handler_timeouts/dummy-0.1/ebin/dummy_sup_2.@EMULATOR@: release_handler_timeouts/dummy-0.1/src/dummy_sup_2.erl
 	erlc $(EFLAGS) -orelease_handler_timeouts/dummy-0.1/ebin release_handler_timeouts/dummy-0.1/src/dummy_sup_2.erl
+
+unicode/u-1.0/ebin/u.@EMULATOR@: unicode/u-1.0/src/u.erl
+	erlc $(EFLAGS) -ounicode/u-1.0/ebin unicode/u-1.0/src/u.erl
+unicode/u-1.0/ebin/u_sup.@EMULATOR@: unicode/u-1.0/src/u_sup.erl
+	erlc $(EFLAGS) -ounicode/u-1.0/ebin unicode/u-1.0/src/u_sup.erl
+
+unicode/u-1.1/ebin/u.@EMULATOR@: unicode/u-1.1/src/u.erl
+	erlc $(EFLAGS) -ounicode/u-1.1/ebin unicode/u-1.1/src/u.erl
+unicode/u-1.1/ebin/u_sup.@EMULATOR@: unicode/u-1.1/src/u_sup.erl
+	erlc $(EFLAGS) -ounicode/u-1.1/ebin unicode/u-1.1/src/u_sup.erl
diff --git a/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/ebin/u.app b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/ebin/u.app
new file mode 100644
index 0000000000..fea4f9992e
--- /dev/null
+++ b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/ebin/u.app
@@ -0,0 +1,8 @@
+{application, u,
+	     [{description, "This app shall test unicode handling αβ"},
+              {vsn, "1.0"},
+	      {modules, [u, u_sup]},
+	      {registered, [u_sup]},
+	      {applications, [kernel, stdlib]},
+	      {env, [{'key_αβ', 'val_αβ'}]},
+	      {mod, {u_sup, []}}]}.
diff --git a/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/src/u.erl b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/src/u.erl
new file mode 100644
index 0000000000..45fe098c0e
--- /dev/null
+++ b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/src/u.erl
@@ -0,0 +1,50 @@
+%% ``Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% The Initial Developer of the Original Code is Ericsson Utvecklings AB.
+%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
+%% AB. All Rights Reserved.''
+%%
+%%     $Id$
+%%
+-module(u).
+
+
+-behaviour(gen_server).
+
+-vsn(1).
+
+%% External exports
+-export([start_link/0, u/0]).
+%% Internal exports
+-export([init/1, handle_call/3, handle_info/2, terminate/2]).
+
+start_link() -> gen_server:start_link({local, uu}, u, [], []).
+
+u() -> gen_server:call(uu, u).
+
+%%-----------------------------------------------------------------
+%% Callback functions from gen_server
+%%-----------------------------------------------------------------
+init([]) ->
+    process_flag(trap_exit, true),
+    {ok, state}.
+
+handle_call(u, _From, State) ->
+    X = application:get_all_env(u),
+    {reply, {X,State}, State}.
+
+handle_info(_, State) ->
+    {noreply, State}.
+
+terminate(_Reason, _State) ->
+    ok.
diff --git a/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/src/u_sup.erl b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/src/u_sup.erl
new file mode 100644
index 0000000000..b0d4a7b58f
--- /dev/null
+++ b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.0/src/u_sup.erl
@@ -0,0 +1,38 @@
+%% ``Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% The Initial Developer of the Original Code is Ericsson Utvecklings AB.
+%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
+%% AB. All Rights Reserved.''
+%%
+%%     $Id$
+%%
+-module(u_sup).
+
+
+-behaviour(supervisor).
+
+%% External exports
+-export([start/2]).
+
+%% Internal exports
+-export([init/1]).
+
+start(_, _) ->
+    supervisor:start_link({local, ?MODULE}, ?MODULE, []).
+
+init([]) ->
+    SupFlags = {one_for_one, 4, 3600},
+    Config = {u,
+	      {u, start_link, []},
+	      permanent, 2000, worker, [u]},
+    {ok, {SupFlags, [Config]}}.
diff --git a/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/ebin/u.app b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/ebin/u.app
new file mode 100644
index 0000000000..8fcc3bba42
--- /dev/null
+++ b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/ebin/u.app
@@ -0,0 +1,8 @@
+{application, u,
+	     [{description, "This app shall test unicode handling αβ"},
+              {vsn, "1.1"},
+	      {modules, [u, u_sup]},
+	      {registered, [u_sup]},
+	      {applications, [kernel, stdlib]},
+	      {env, [{'key_αβ', 'val_αβ'}]},
+	      {mod, {u_sup, []}}]}.
diff --git a/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/ebin/u.appup b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/ebin/u.appup
new file mode 100644
index 0000000000..0344ce92ab
--- /dev/null
+++ b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/ebin/u.appup
@@ -0,0 +1,3 @@
+{"1.1",
+ [{"1.0",[{update,u,{advanced,'αβ'}}]}],
+ [{"1.0",[{update,u,{advanced,'αβ'}}]}]}.
diff --git a/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/src/u.erl b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/src/u.erl
new file mode 100644
index 0000000000..d2544d6fc1
--- /dev/null
+++ b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/src/u.erl
@@ -0,0 +1,55 @@
+%% ``Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% The Initial Developer of the Original Code is Ericsson Utvecklings AB.
+%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
+%% AB. All Rights Reserved.''
+%%
+%%     $Id$
+%%
+-module(u).
+
+
+-behaviour(gen_server).
+
+-vsn(1).
+
+%% External exports
+-export([start_link/0, u/0]).
+%% Internal exports
+-export([init/1, handle_call/3, handle_info/2, terminate/2, code_change/3]).
+
+start_link() -> gen_server:start_link({local, uu}, u, [], []).
+
+u() -> gen_server:call(uu, u).
+
+%%-----------------------------------------------------------------
+%% Callback functions from gen_server
+%%-----------------------------------------------------------------
+init([]) ->
+    process_flag(trap_exit, true),
+    {ok, {state,'αβ'}}.
+
+handle_call(u, _From, State) ->
+    X = application:get_all_env(u),
+    {reply, {X,State}, State}.
+
+handle_info(_, State) ->
+    {noreply, State}.
+
+terminate(_Reason, _State) ->
+    ok.
+
+code_change({down,_}, {State,_}, _Extra) ->
+    {ok, State};
+code_change(_, State, Extra) ->
+    {ok, {State, Extra}}.
diff --git a/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/src/u_sup.erl b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/src/u_sup.erl
new file mode 100644
index 0000000000..b0d4a7b58f
--- /dev/null
+++ b/lib/sasl/test/release_handler_SUITE_data/unicode/u-1.1/src/u_sup.erl
@@ -0,0 +1,38 @@
+%% ``Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% The Initial Developer of the Original Code is Ericsson Utvecklings AB.
+%% Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
+%% AB. All Rights Reserved.''
+%%
+%%     $Id$
+%%
+-module(u_sup).
+
+
+-behaviour(supervisor).
+
+%% External exports
+-export([start/2]).
+
+%% Internal exports
+-export([init/1]).
+
+start(_, _) ->
+    supervisor:start_link({local, ?MODULE}, ?MODULE, []).
+
+init([]) ->
+    SupFlags = {one_for_one, 4, 3600},
+    Config = {u,
+	      {u, start_link, []},
+	      permanent, 2000, worker, [u]},
+    {ok, {SupFlags, [Config]}}.