Merge remote branch 'origin/peppe/common_test/ct_conn_handling' into maint

* origin/peppe/common_test/ct_conn_handling:
  Add test suite
  Fix faulty connection handling

OTP-10126

1 files changed, 74 insertions, 58 deletions

diff --git a/lib/common_test/src/ct_util.erl b/lib/common_test/src/ct_util.erl
index b77845eb5b..68e76c2396 100644
--- a/lib/common_test/src/ct_util.erl
+++ b/lib/common_test/src/ct_util.erl
@@ -25,13 +25,13 @@
 %%%
 -module(ct_util).
 
--export([start/0,start/1,start/2,start/3,
-	 stop/1,update_last_run_index/0]).
+-export([start/0, start/1, start/2, start/3,
+	 stop/1, update_last_run_index/0]).
 
--export([register_connection/4,unregister_connection/1,
-	 does_connection_exist/3,get_key_from_name/1]).
+-export([register_connection/4, unregister_connection/1,
+	 does_connection_exist/3, get_key_from_name/1]).
 
--export([close_connections/0]).
+-export([get_connections/1, close_connections/0]).
 
 -export([save_suite_data/3, save_suite_data/2,
 	 save_suite_data_async/3, save_suite_data_async/2,
@@ -56,11 +56,11 @@
 
 -export([listenv/1]).
 
--export([get_target_name/1, get_connections/2]).
+-export([get_target_name/1, get_connection/2]).
 
 -export([is_test_dir/1, get_testdir/2]).
 
--export([kill_attached/2, get_attached/1, ct_make_ref/0]).
+-export([kill_attached/2, get_attached/1]).
 
 -export([warn_duplicates/1]).
 
@@ -417,7 +417,8 @@ loop(Mode,TestData,StartDir) ->
 					 ?MAX_IMPORTANCE,
 					 "CT Error Notification",
 					 "Connection process died: "
-					 "Pid: ~w, Address: ~p, Callback: ~w\n"
+					 "Pid: ~w, Address: ~p, "
+					 "Callback: ~w\n"
 					 "Reason: ~p\n\n",
 					 [Pid,A,CB,Reason]),
 		    catch CB:close(Pid),
@@ -426,8 +427,8 @@ loop(Mode,TestData,StartDir) ->
 		    loop(Mode,TestData,StartDir);
 		_ ->
 		    %% Let process crash in case of error, this shouldn't happen!
-		    io:format("\n\nct_util_server got EXIT from ~w: ~p\n\n",
-			      [Pid,Reason]),
+		    io:format("\n\nct_util_server got EXIT "
+			      "from ~w: ~p\n\n", [Pid,Reason]),
 		    file:set_cwd(StartDir),
 		    exit(Reason)
 	    end
@@ -457,10 +458,13 @@ get_key_from_name(Name)->
 %%% table, and ct_util will close all registered connections when the
 %%% test is finished by calling <code>Callback:close/1</code>.</p>
 register_connection(TargetName,Address,Callback,Handle) ->
+    %% If TargetName is a registered alias for a config
+    %% variable, use it as reference for the connection,
+    %% otherwise use the Handle value.
     TargetRef = 
-	case ct_config:get_ref_from_name(TargetName) of
-	    {ok,Ref} ->
-		Ref;
+	case ct_config:get_key_from_name(TargetName) of
+	    {ok,_Key} ->
+		TargetName;
 	    _ ->
 		%% no config name associated with connection,
 		%% use handle for identification instead
@@ -496,10 +500,10 @@ unregister_connection(Handle) ->
 %%%
 %%% @doc Check if a connection already exists.
 does_connection_exist(TargetName,Address,Callback) ->
-    case ct_config:get_ref_from_name(TargetName) of
-	{ok,TargetRef} ->
+    case ct_config:get_key_from_name(TargetName) of
+	{ok,_Key} ->
 	    case ets:select(?conn_table,[{#conn{handle='$1',
-						targetref=TargetRef,
+						targetref=TargetName,
 						address=Address,
 						callback=Callback},
 					  [],
@@ -514,41 +518,76 @@ does_connection_exist(TargetName,Address,Callback) ->
     end.
 
 %%%-----------------------------------------------------------------
-%%% @spec get_connections(TargetName,Callback) -> 
-%%%                                {ok,Connections} | {error,Reason}
+%%% @spec get_connection(TargetName,Callback) -> 
+%%%                                {ok,Connection} | {error,Reason}
 %%%      TargetName = ct:target_name()
 %%%      Callback = atom()
-%%%      Connections = [Connection]
 %%%      Connection = {Handle,Address}
 %%%      Handle = term()
 %%%      Address = term()
 %%%
-%%% @doc Return all connections for the <code>Callback</code> on the
+%%% @doc Return the connection for <code>Callback</code> on the
 %%% given target (<code>TargetName</code>).
-get_connections(TargetName,Callback) ->
-    case ct_config:get_ref_from_name(TargetName) of
-	{ok,Ref} ->
-	    {ok,ets:select(?conn_table,[{#conn{handle='$1',
-					       address='$2',
-					       targetref=Ref,
-					       callback=Callback},
-					 [],
-					 [{{'$1','$2'}}]}])};
+get_connection(TargetName,Callback) ->
+    %% check that TargetName is a registered alias
+    case ct_config:get_key_from_name(TargetName) of
+	{ok,_Key} ->
+	    case ets:select(?conn_table,[{#conn{handle='$1',
+						address='$2',
+						targetref=TargetName,
+						callback=Callback},
+					  [],
+					  [{{'$1','$2'}}]}]) of
+		[Result] ->
+		    {ok,Result};
+		[] ->
+		    {error,no_registered_connection}
+	    end;
 	Error ->
 	    Error
     end.
 
 %%%-----------------------------------------------------------------
+%%% @spec get_connections(ConnPid) -> 
+%%%                                {ok,Connections} | {error,Reason}
+%%%      Connections = [Connection]
+%%%      Connection = {TargetName,Handle,Callback,Address}
+%%%      TargetName = ct:target_name() | undefined
+%%%      Handle = term()
+%%%      Callback = atom()
+%%%      Address = term()
+%%%
+%%% @doc Get data for all connections associated with a particular
+%%%      connection pid (see Callback:init/3).
+get_connections(ConnPid) ->
+    Conns = ets:tab2list(?conn_table),
+    lists:flatmap(fun(#conn{targetref=TargetName,
+			    handle=Handle,
+			    callback=Callback,
+			    address=Address}) ->
+			  case ct_gen_conn:get_conn_pid(Handle) of
+			      ConnPid when is_atom(TargetName) ->
+				  [{TargetName,Handle,
+				    Callback,Address}];
+			      ConnPid ->
+				  [{undefined,Handle,
+				   Callback,Address}];
+			      _ ->
+				  []
+			  end
+		  end, Conns).
+
+%%%-----------------------------------------------------------------
 %%% @hidden
 %%% @equiv ct:get_target_name/1
-get_target_name(ConnPid) ->
-    case ets:select(?conn_table,[{#conn{handle=ConnPid,targetref='$1',_='_'},
+get_target_name(Handle) ->
+    case ets:select(?conn_table,[{#conn{handle=Handle,targetref='$1',_='_'},
 				  [],
 				  ['$1']}]) of
-	[TargetRef] ->
-	    ct_config:get_name_from_ref(TargetRef);
-	[] ->
-	    {error,{unknown_connection,ConnPid}}
+	[TargetName] when is_atom(TargetName) ->
+	    {ok,TargetName};
+	_ ->
+	    {error,{unknown_connection,Handle}}
     end.
 
 %%%-----------------------------------------------------------------
@@ -922,29 +961,6 @@ cast(Msg) ->
 seconds(T) ->
     test_server:seconds(T).
 
-ct_make_ref() ->
-    Pid = case whereis(ct_make_ref) of
-	      undefined -> 
-		  spawn_link(fun() -> ct_make_ref_init() end);
-	      P -> 
-		  P
-	  end,
-    Pid ! {self(),ref_req},
-    receive
-	{Pid,Ref} -> Ref
-    end.
-
-ct_make_ref_init() ->
-    register(ct_make_ref,self()),
-    ct_make_ref_loop(0).
-
-ct_make_ref_loop(N) ->
-    receive
-	{From,ref_req} -> 
-	    From ! {self(),N},
-	    ct_make_ref_loop(N+1)
-    end.
-
 abs_name("/") ->
     "/";
 abs_name(Dir0) ->