From 2df013b5bfd714247570d9b4958b40f7559d35dd Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Fri, 6 Oct 2017 14:22:25 +0200
Subject: Tag Common Test system processes using process dictionary

---
 lib/common_test/src/ct_config.erl        |  1 +
 lib/common_test/src/ct_default_gl.erl    |  1 +
 lib/common_test/src/ct_event.erl         |  1 +
 lib/common_test/src/ct_gen_conn.erl      |  9 ++++++---
 lib/common_test/src/ct_hooks_lock.erl    |  1 +
 lib/common_test/src/ct_logs.erl          |  8 ++++----
 lib/common_test/src/ct_master.erl        |  2 ++
 lib/common_test/src/ct_master_event.erl  |  1 +
 lib/common_test/src/ct_master_logs.erl   |  2 +-
 lib/common_test/src/ct_repeat.erl        |  4 ++--
 lib/common_test/src/ct_run.erl           | 10 +++++-----
 lib/common_test/src/ct_slave.erl         |  2 +-
 lib/common_test/src/ct_telnet_client.erl |  1 +
 lib/common_test/src/ct_util.erl          | 16 +++++++++++++++-
 lib/common_test/src/ct_webtool.erl       |  1 +
 lib/common_test/src/ct_webtool_sup.erl   |  1 +
 lib/common_test/src/cth_log_redirect.erl |  1 +
 lib/common_test/src/test_server.erl      |  9 +++++++++
 lib/common_test/src/test_server_ctrl.erl |  2 ++
 lib/common_test/src/test_server_io.erl   |  1 +
 lib/common_test/src/test_server_node.erl |  1 +
 lib/common_test/src/test_server_sup.erl  |  2 +-
 lib/common_test/src/vts.erl              |  4 ++--
 23 files changed, 61 insertions(+), 20 deletions(-)

(limited to 'lib')

diff --git a/lib/common_test/src/ct_config.erl b/lib/common_test/src/ct_config.erl
index d48ae830bb..9cb9b0ba16 100644
--- a/lib/common_test/src/ct_config.erl
+++ b/lib/common_test/src/ct_config.erl
@@ -81,6 +81,7 @@ start(Mode) ->
 
 do_start(Parent) ->
     process_flag(trap_exit,true),
+    ct_util:mark_process(),
     register(ct_config_server,self()),
     ct_util:create_table(?attr_table,bag,#ct_conf.key),
     {ok,StartDir} = file:get_cwd(),
diff --git a/lib/common_test/src/ct_default_gl.erl b/lib/common_test/src/ct_default_gl.erl
index d1b52e5f4f..9ae430c546 100644
--- a/lib/common_test/src/ct_default_gl.erl
+++ b/lib/common_test/src/ct_default_gl.erl
@@ -55,6 +55,7 @@ stop() ->
 
 init([ParentGL]) ->
     register(?MODULE, self()),
+    ct_util:mark_process(),
     {ok,#{parent_gl_pid => ParentGL,
 	  parent_gl_monitor => erlang:monitor(process,ParentGL)}}.
 
diff --git a/lib/common_test/src/ct_event.erl b/lib/common_test/src/ct_event.erl
index 1a0ee4f3cd..8b5bba7600 100644
--- a/lib/common_test/src/ct_event.erl
+++ b/lib/common_test/src/ct_event.erl
@@ -137,6 +137,7 @@ is_alive() ->
 %% this function is called to initialize the event handler.
 %%--------------------------------------------------------------------
 init(RecvPids) ->
+    ct_util:mark_process(),
     %% RecvPids = [{RecvTag,Pid}]
     {ok,#state{receivers=RecvPids}}.
 
diff --git a/lib/common_test/src/ct_gen_conn.erl b/lib/common_test/src/ct_gen_conn.erl
index badb7c52ae..456bfd8bd1 100644
--- a/lib/common_test/src/ct_gen_conn.erl
+++ b/lib/common_test/src/ct_gen_conn.erl
@@ -186,9 +186,11 @@ end_log() ->
 do_within_time(Fun,Timeout) ->
     Self = self(),
     Silent = get(silent),
-    TmpPid = spawn_link(fun() -> put(silent,Silent),
-				 R = Fun(),
-				 Self ! {self(),R}
+    TmpPid = spawn_link(fun() -> 
+                                ct_util:mark_process(),
+                                put(silent,Silent),
+                                R = Fun(),
+                                Self ! {self(),R}
 			end),
     ConnPid = get(conn_pid),
     receive
@@ -301,6 +303,7 @@ return({To,Ref},Result) ->
 
 init_gen(Parent,Opts) ->
     process_flag(trap_exit,true),
+    ct_util:mark_process(),
     put(silent,false),
     try (Opts#gen_opts.callback):init(Opts#gen_opts.name,
 				      Opts#gen_opts.address,
diff --git a/lib/common_test/src/ct_hooks_lock.erl b/lib/common_test/src/ct_hooks_lock.erl
index fea298e535..a82be288e1 100644
--- a/lib/common_test/src/ct_hooks_lock.erl
+++ b/lib/common_test/src/ct_hooks_lock.erl
@@ -78,6 +78,7 @@ release() ->
 
 %% @doc Initiates the server
 init(Id) ->
+    ct_util:mark_process(),
     {ok, #state{ id = Id }}.
 
 %% @doc Handling call messages
diff --git a/lib/common_test/src/ct_logs.erl b/lib/common_test/src/ct_logs.erl
index f7c118a4c7..f1f8065599 100644
--- a/lib/common_test/src/ct_logs.erl
+++ b/lib/common_test/src/ct_logs.erl
@@ -665,8 +665,8 @@ log_timestamp({MS,S,US}) ->
 		      tc_esc_chars}).
 
 logger(Parent, Mode, Verbosity) ->
-    put(app, common_test),
     register(?MODULE,self()),
+    ct_util:mark_process(),
     %%! Below is a temporary workaround for the limitation of
     %%! max one test run per second. 
     %%! --->
@@ -1005,7 +1005,7 @@ print_to_log(async, FromPid, Category, TCGL, Content, EscChars, State) ->
 	if FromPid /= TCGL ->
 		IoFun = create_io_fun(FromPid, CtLogFd, EscChars),
 		fun() ->
-                        put(app, common_test),
+                        ct_util:mark_process(),
 			test_server:permit_io(TCGL, self()),
 
 			%% Since asynchronous io gets can get buffered if
@@ -1037,7 +1037,7 @@ print_to_log(async, FromPid, Category, TCGL, Content, EscChars, State) ->
 		end;
 	   true ->
 		fun() ->
-                        put(app, common_test),
+                        ct_util:mark_process(),
 			unexpected_io(FromPid, Category, ?MAX_IMPORTANCE,
 				      Content, CtLogFd, EscChars)
 		end
@@ -3019,8 +3019,8 @@ simulate() ->
     cast(stop),
     S = self(),
     Pid = spawn(fun() -> 
-                        put(app, common_test),
 			register(?MODULE,self()),
+                        ct_util:mark_process(),
 			S ! {self(),started},
 			simulate_logger_loop() 
 		end),
diff --git a/lib/common_test/src/ct_master.erl b/lib/common_test/src/ct_master.erl
index 6e6d1879c2..ef2aff69b7 100644
--- a/lib/common_test/src/ct_master.erl
+++ b/lib/common_test/src/ct_master.erl
@@ -346,6 +346,7 @@ init_master(Parent,NodeOptsList,EvHandlers,MasterLogDir,LogDirs,
     case whereis(ct_master) of
 	undefined ->
 	    register(ct_master,self()),
+            ct_util:mark_process(),
 	    ok;
 	_Pid ->
 	    io:format("~nWarning: ct_master already running!~n"),
@@ -690,6 +691,7 @@ refresh_logs([],Refreshed) ->
 init_node_ctrl(MasterPid,Cookie,Opts) ->
     %% make sure tests proceed even if connection to master is lost
     process_flag(trap_exit, true),
+    ct_util:mark_process(),
     MasterNode = node(MasterPid),
     group_leader(whereis(user),self()),
     io:format("~n********** node_ctrl process ~w started on ~w **********~n",
diff --git a/lib/common_test/src/ct_master_event.erl b/lib/common_test/src/ct_master_event.erl
index d535d1274e..bd4d1efc92 100644
--- a/lib/common_test/src/ct_master_event.erl
+++ b/lib/common_test/src/ct_master_event.erl
@@ -116,6 +116,7 @@ sync_notify(Event) ->
 %% this function is called to initialize the event handler.
 %%--------------------------------------------------------------------
 init(_) ->
+    ct_util:mark_process(),
     ct_master_logs:log("CT Master Event Handler started","",[]),
     {ok,#state{}}.
 
diff --git a/lib/common_test/src/ct_master_logs.erl b/lib/common_test/src/ct_master_logs.erl
index f5a19a46d7..c4bb2cc69f 100644
--- a/lib/common_test/src/ct_master_logs.erl
+++ b/lib/common_test/src/ct_master_logs.erl
@@ -87,8 +87,8 @@ stop() ->
 %%%--------------------------------------------------------------------
 
 init(Parent,LogDir,Nodes) ->
-    put(app, common_test),
     register(?MODULE,self()),
+    ct_util:mark_process(),
     Time = calendar:local_time(),
     RunDir = make_dirname(Time),
     RunDirAbs = filename:join(LogDir,RunDir),
diff --git a/lib/common_test/src/ct_repeat.erl b/lib/common_test/src/ct_repeat.erl
index d878df9c66..177ef37d1f 100644
--- a/lib/common_test/src/ct_repeat.erl
+++ b/lib/common_test/src/ct_repeat.erl
@@ -70,7 +70,7 @@ loop_test(If,Args) when is_list(Args) ->
 				    CtrlPid = self(),
 				    spawn(
 				      fun() ->
-                                              put(app, common_test),
+                                              ct_util:mark_process(),
 					      stop_after(CtrlPid,Secs,ForceStop)
 				      end)
 			    end,
@@ -135,7 +135,7 @@ spawn_tester(script,Ctrl,Args) ->
 
 spawn_tester(func,Ctrl,Opts) ->
     Tester = fun() ->
-                     put(app, common_test),
+                     ct_util:mark_process(),
 		     case catch ct_run:run_test2(Opts) of
 			 {'EXIT',Reason} ->
 			     exit(Reason);
diff --git a/lib/common_test/src/ct_run.erl b/lib/common_test/src/ct_run.erl
index 7079e059f4..05b1e70098 100644
--- a/lib/common_test/src/ct_run.erl
+++ b/lib/common_test/src/ct_run.erl
@@ -251,7 +251,7 @@ finish(Tracing, ExitStatus, Args) ->
 
 script_start1(Parent, Args) ->
     %% tag this process
-    put(app, common_test),
+    ct_util:mark_process(),
     %% read general start flags
     Label = get_start_opt(label, fun([Lbl]) -> Lbl end, Args),
     Profile = get_start_opt(profile, fun([Prof]) -> Prof end, Args),
@@ -959,7 +959,7 @@ run_test(StartOpts) when is_list(StartOpts) ->
 
 run_test1_fun(StartOpts) ->
     fun() -> 
-            put(app, common_test),
+            ct_util:mark_process(),
             run_test1(StartOpts)
     end.
 
@@ -1453,7 +1453,7 @@ run_testspec(TestSpec) ->
 
 run_testspec1_fun(TestSpec) ->
     fun() -> 
-            put(app, common_test),
+            ct_util:mark_process(),
             run_testspec1(TestSpec)
     end.
 
@@ -1914,12 +1914,12 @@ possibly_spawn(true, Tests, Skip, Opts) ->
     CTUtilSrv = whereis(ct_util_server),
     Supervisor = 
 	fun() ->
-                put(app, common_test),
+                ct_util:mark_process(),
 		process_flag(trap_exit, true),
 		link(CTUtilSrv),
 		TestRun =
 		    fun() ->
-                            put(app, common_test),
+                            ct_util:mark_process(),
 			    TestResult = (catch do_run_test(Tests, Skip, Opts)),
 			    case TestResult of
 				{EType,_} = Error when EType == user_error;
diff --git a/lib/common_test/src/ct_slave.erl b/lib/common_test/src/ct_slave.erl
index e8459bc400..b39195483b 100644
--- a/lib/common_test/src/ct_slave.erl
+++ b/lib/common_test/src/ct_slave.erl
@@ -282,7 +282,7 @@ monitor_master(MasterNode) ->
 
 % code of the masterdeath-waiter process
 monitor_master_int(MasterNode) ->
-    put(app, common_test),
+    ct_util:mark_process(),
     erlang:monitor_node(MasterNode, true),
     receive
         {nodedown, MasterNode}->
diff --git a/lib/common_test/src/ct_telnet_client.erl b/lib/common_test/src/ct_telnet_client.erl
index c8d217cd2a..76e4b9ea70 100644
--- a/lib/common_test/src/ct_telnet_client.erl
+++ b/lib/common_test/src/ct_telnet_client.erl
@@ -118,6 +118,7 @@ get_data(Pid) ->
 %%%-----------------------------------------------------------------
 %%% Internal functions
 init(Parent, Server, Port, Timeout, KeepAlive, NoDelay, ConnName) ->
+    ct_util:mark_process(),
     case gen_tcp:connect(Server, Port, [list,{packet,0},{nodelay,NoDelay}], Timeout) of
 	{ok,Sock} ->
 	    dbg("~tp connected to: ~tp (port: ~w, keep_alive: ~w)\n",
diff --git a/lib/common_test/src/ct_util.erl b/lib/common_test/src/ct_util.erl
index 0e0d6f84e1..fd0db4a78d 100644
--- a/lib/common_test/src/ct_util.erl
+++ b/lib/common_test/src/ct_util.erl
@@ -65,6 +65,8 @@
 
 -export([warn_duplicates/1]).
 
+-export([mark_process/0, is_marked/1]).
+
 -export([get_profile_data/0, get_profile_data/1,
 	 get_profile_data/2, open_url/3]).
 
@@ -124,9 +126,9 @@ start(Mode, LogDir, Verbosity) ->
     end.
 
 do_start(Parent, Mode, LogDir, Verbosity) ->
-    put(app, common_test),
     process_flag(trap_exit,true),
     register(ct_util_server,self()),
+    mark_process(),
     create_table(?conn_table,#conn.handle),
     create_table(?board_table,2),
     create_table(?suite_table,#suite_data.key),
@@ -931,6 +933,18 @@ warn_duplicates(Suites) ->
     lists:foreach(Warn, Suites),
     ok.
 
+%%%-----------------------------------------------------------------
+%%% @spec
+%%%
+%%% @doc
+mark_process() ->
+    put(app, common_test).
+
+is_marked(Pid) ->
+    {dictionary,List} = process_info(self(), dictionary),
+    common_test == proplists:get_value(app, List).
+
+
 %%%-----------------------------------------------------------------
 %%% @spec
 %%%
diff --git a/lib/common_test/src/ct_webtool.erl b/lib/common_test/src/ct_webtool.erl
index 9016aca899..82aa78fc4b 100644
--- a/lib/common_test/src/ct_webtool.erl
+++ b/lib/common_test/src/ct_webtool.erl
@@ -343,6 +343,7 @@ code_change(_,State,_)->
 % Start the gen_server
 %----------------------------------------------------------------------
 init({Path,Config})->
+    ct_util:mark_process(),
     case filelib:is_dir(Path) of
 	true ->
 	    {ok, Table} = get_tool_files_data(),
diff --git a/lib/common_test/src/ct_webtool_sup.erl b/lib/common_test/src/ct_webtool_sup.erl
index c02ec69d04..6c6dbde0a6 100644
--- a/lib/common_test/src/ct_webtool_sup.erl
+++ b/lib/common_test/src/ct_webtool_sup.erl
@@ -46,6 +46,7 @@ stop(Pid)->
 %%          {error, Reason}   
 %%----------------------------------------------------------------------
 init(_StartArgs) ->
+    ct_util:mark_process(),
     %%Child1 = 
     %%Child2 ={webcover_backend,{webcover_backend,start_link,[]},permanent,2000,worker,[webcover_backend]},
     %%{ok,{{simple_one_for_one,5,10},[Child1]}}.
diff --git a/lib/common_test/src/cth_log_redirect.erl b/lib/common_test/src/cth_log_redirect.erl
index 8b29d0f96d..77f90c0df6 100644
--- a/lib/common_test/src/cth_log_redirect.erl
+++ b/lib/common_test/src/cth_log_redirect.erl
@@ -56,6 +56,7 @@ id(_Opts) ->
     ?MODULE.
 
 init(?MODULE, _Opts) ->
+    ct_util:mark_process(),
     error_logger:add_report_handler(?MODULE),
     tc_log_async.
 
diff --git a/lib/common_test/src/test_server.erl b/lib/common_test/src/test_server.erl
index dc6b7a536c..d4991408cd 100644
--- a/lib/common_test/src/test_server.erl
+++ b/lib/common_test/src/test_server.erl
@@ -784,6 +784,7 @@ spawn_fw_call(Mod,IPTC={init_per_testcase,Func},CurrConf,Pid,
 	      Why,Loc,SendTo) ->
     FwCall =
 	fun() ->
+                ct_util:mark_process(),
 		Skip = {skip,{failed,{Mod,init_per_testcase,Why}}},
 		%% if init_per_testcase fails, the test case
 		%% should be skipped
@@ -814,6 +815,7 @@ spawn_fw_call(Mod,EPTC={end_per_testcase,Func},EndConf,Pid,
 	      Why,_Loc,SendTo) ->
     FwCall =
 	fun() ->
+                ct_util:mark_process(),
 		{RetVal,Report} =
 		    case proplists:get_value(tc_status, EndConf) of
 			undefined ->
@@ -863,6 +865,7 @@ spawn_fw_call(Mod,EPTC={end_per_testcase,Func},EndConf,Pid,
 spawn_fw_call(FwMod,FwFunc,_,_Pid,{framework_error,FwError},_,SendTo) ->
     FwCall =
 	fun() ->
+                ct_util:mark_process(),
 		test_server_sup:framework_call(report, [framework_error,
 							{{FwMod,FwFunc},
 							 FwError}]),
@@ -879,6 +882,7 @@ spawn_fw_call(FwMod,FwFunc,_,_Pid,{framework_error,FwError},_,SendTo) ->
     spawn_link(FwCall);
 
 spawn_fw_call(Mod,Func,CurrConf,Pid,Error,Loc,SendTo) ->
+    ct_util:mark_process(),
     {Func1,EndTCFunc} = case Func of
 			    CF when CF == init_per_suite; CF == end_per_suite;
 				    CF == init_per_group; CF == end_per_group ->
@@ -917,6 +921,7 @@ start_job_proxy() ->
 
 %% The io_reply_proxy is not the most satisfying solution but it works...
 io_reply_proxy(ReplyTo) ->
+    ct_util:mark_process(),
     receive
 	IoReply when is_tuple(IoReply),
 		     element(1, IoReply) == io_reply ->
@@ -926,6 +931,7 @@ io_reply_proxy(ReplyTo) ->
     end.
 
 job_proxy_msgloop() ->
+    ct_util:mark_process(),
     receive
 
 	%%
@@ -1803,6 +1809,7 @@ break(CBM, TestCase, Comment) ->
 spawn_break_process(Pid, PName) ->
     spawn(fun() ->
 		  register(PName, self()),
+                  ct_util:mark_process(),
 		  receive
 		      continue -> continue(Pid);
 		      cancel -> ok
@@ -2000,6 +2007,7 @@ time_ms_apply(Func, TCPid, MultAndScale) ->
 
 user_timetrap_supervisor(Func, Spawner, TCPid, GL, T0, MultAndScale) ->
     process_flag(trap_exit, true),
+    ct_util:mark_process(),
     Spawner ! {self(),infinity},
     MonRef = monitor(process, TCPid),
     UserTTSup = self(),
@@ -2570,6 +2578,7 @@ run_on_shielded_node(Fun, CArgs) when is_function(Fun), is_list(CArgs) ->
 -spec start_job_proxy_fun(_, _) -> fun(() -> no_return()).
 start_job_proxy_fun(Master, Fun) ->
     fun () ->
+            ct_util:mark_process(),
             _ = start_job_proxy(),
             receive
                 Ref ->
diff --git a/lib/common_test/src/test_server_ctrl.erl b/lib/common_test/src/test_server_ctrl.erl
index 71978c7267..701a45a517 100644
--- a/lib/common_test/src/test_server_ctrl.erl
+++ b/lib/common_test/src/test_server_ctrl.erl
@@ -1126,6 +1126,7 @@ init_tester(Mod, Func, Args, Dir, Name, {_,_,MinLev}=Levels,
 	    RejectIoReqs, CreatePrivDir, TCCallback, ExtraTools) ->
     process_flag(trap_exit, true),
     _ = test_server_io:start_link(),
+    put(app, common_test),
     put(test_server_name, Name),
     put(test_server_dir, Dir),
     put(test_server_total_time, 0),
@@ -3704,6 +3705,7 @@ run_test_case(Ref, Num, Mod, Func, Args, RunInit, TimetrapData, Mode) ->
 	    spawn_link(
 	      fun() ->
 		      process_flag(trap_exit, true),
+                      ct_util:mark_process(),
 		      _ = [put(Key, Val) || {Key,Val} <- Dictionary],
 		      set_io_buffering({tc,Main}),
 		      run_test_case1(Ref, Num, Mod, Func, Args, RunInit,
diff --git a/lib/common_test/src/test_server_io.erl b/lib/common_test/src/test_server_io.erl
index 062e3bd8ff..09da57e4dd 100644
--- a/lib/common_test/src/test_server_io.erl
+++ b/lib/common_test/src/test_server_io.erl
@@ -184,6 +184,7 @@ reset_state() ->
 
 init([]) ->
     process_flag(trap_exit, true),
+    ct_util:mark_process(),
     Empty = gb_trees:empty(),
     {ok,Shared} = test_server_gl:start_link(self()),
     {ok,#st{fds=Empty,shared_gl=Shared,gls=gb_sets:empty(),
diff --git a/lib/common_test/src/test_server_node.erl b/lib/common_test/src/test_server_node.erl
index c0d7e12721..b3b6ae3d92 100644
--- a/lib/common_test/src/test_server_node.erl
+++ b/lib/common_test/src/test_server_node.erl
@@ -747,6 +747,7 @@ unpack(Bin) ->
 id(I) -> I.
    
 print_data(Port) ->
+    ct_util:mark_process(),
     receive
 	{Port, {data, Bytes}} ->
 	    io:put_chars(Bytes),
diff --git a/lib/common_test/src/test_server_sup.erl b/lib/common_test/src/test_server_sup.erl
index 756dd0b59b..5ab31e2087 100644
--- a/lib/common_test/src/test_server_sup.erl
+++ b/lib/common_test/src/test_server_sup.erl
@@ -849,8 +849,8 @@ util_start() ->
     case whereis(?MODULE) of
 	undefined ->	
 	    spawn_link(fun() ->
-                               put(app, common_test),
 			       register(?MODULE, self()),
+                               put(app, common_test),
 			       util_loop(#util_state{starter=Starter})
 		       end),
 	    ok;
diff --git a/lib/common_test/src/vts.erl b/lib/common_test/src/vts.erl
index e1482d9014..83fcde2f48 100644
--- a/lib/common_test/src/vts.erl
+++ b/lib/common_test/src/vts.erl
@@ -155,9 +155,9 @@ test_info(_VtsPid,Type,Data) ->
     call({test_info,Type,Data}).
 
 init(Parent) ->
-    put(app, common_test),
     register(?MODULE,self()),
     process_flag(trap_exit,true),
+    ct_util:mark_process(),
     Parent ! {self(),started},
     {ok,Cwd} = file:get_cwd(),
     InitState = #state{start_dir=Cwd},
@@ -285,7 +285,7 @@ run_test1(State=#state{tests=Tests,current_log_dir=LogDir,
 		       logopts=LogOpts}) ->
     Self=self(),
     RunTest = fun() ->
-                      put(app, common_test),
+                      ct_util:mark_process(),
 		      case ct_run:do_run(Tests,[],LogDir,LogOpts) of
 			  {error,_Reason} ->
 			      aborted();
-- 
cgit v1.2.3