Merge branch 'bjorn/ct/env-vars/OTP-10469'

* bjorn/ct/env-vars/OTP-10469:
  Add support for passing environment variables in master mode
  Remove redundant sleep in ct_master_SUITE
  Test that test cases succeed
  Add ct_test_support:verify_events/4 which takes a node name

4 files changed, 69 insertions, 42 deletions

diff --git a/lib/common_test/src/ct_slave.erl b/lib/common_test/src/ct_slave.erl
index cb05423497..58633b7de6 100644
--- a/lib/common_test/src/ct_slave.erl
+++ b/lib/common_test/src/ct_slave.erl
@@ -37,7 +37,7 @@
 
 -record(options, {username, password, boot_timeout, init_timeout,
 		  startup_timeout, startup_functions, monitor_master,
-		  kill_if_fail, erl_flags}).
+		  kill_if_fail, erl_flags, env}).
 
 %%%-----------------------------------------------------------------
 %%% @spec start(Node) -> Result
@@ -85,7 +85,8 @@ start(Host, Node) ->
 %%%		  {startup_functions, StartupFunctions} |
 %%%		  {monitor_master, Monitor} |
 %%%		  {kill_if_fail, KillIfFail} |
-%%%		  {erl_flags, ErlangFlags}
+%%%		  {erl_flags, ErlangFlags} |
+%%%               {env, [{EnvVar,Value}]}
 %%%   Username = string()
 %%%   Password = string()
 %%%   BootTimeout = integer()
@@ -99,6 +100,8 @@ start(Host, Node) ->
 %%%   Monitor = bool()
 %%%   KillIfFail = bool()
 %%%   ErlangFlags = string()
+%%%   EnvVar = string()
+%%%   Value = string()
 %%%   Result = {ok, NodeName} | {error, already_started, NodeName} |
 %%%	       {error, started_not_connected, NodeName} |
 %%%	       {error, boot_timeout, NodeName} |
@@ -152,6 +155,9 @@ start(Host, Node) ->
 %%% <p>Option <code>erlang_flags</code> specifies, which flags will be added
 %%% to the parameters of the <code>erl</code> executable.</p>
 %%%
+%%% <p>Option <code>env</code> specifies a list of environment variables
+%%% that will extended the environment.</p>
+%%%
 %%% <p>Special return values are:
 %%% <list>
 %%%  <item><code>{error, already_started, NodeName}</code> - if the node with
@@ -233,10 +239,12 @@ fetch_options(Options) ->
     Monitor = get_option_value(monitor_master, Options, false),
     KillIfFail = get_option_value(kill_if_fail, Options, true),
     ErlFlags = get_option_value(erl_flags, Options, []),
+    EnvVars = get_option_value(env, Options, []),
     #options{username=UserName, password=Password,
 	     boot_timeout=BootTimeout, init_timeout=InitTimeout,
 	     startup_timeout=StartupTimeout, startup_functions=StartupFunctions,
-	     monitor_master=Monitor, kill_if_fail=KillIfFail, erl_flags=ErlFlags}.
+	     monitor_master=Monitor, kill_if_fail=KillIfFail,
+	     erl_flags=ErlFlags, env=EnvVars}.
 
 % send a message when slave node is started
 % @hidden
@@ -306,6 +314,7 @@ do_start(Host, Node, Options) ->
 	true->
 	    spawn_remote_node(Host, Node, Options)
     end,
+
     BootTimeout = Options#options.boot_timeout,
     InitTimeout = Options#options.init_timeout,
     StartupTimeout = Options#options.startup_timeout,
@@ -372,9 +381,9 @@ get_cmd(Node, Flags) ->
 
 % spawn node locally
 spawn_local_node(Node, Options) ->
-    ErlFlags = Options#options.erl_flags,
+    #options{env=Env,erl_flags=ErlFlags} = Options,
     Cmd = get_cmd(Node, ErlFlags),
-    open_port({spawn, Cmd}, [stream]).
+    open_port({spawn, Cmd}, [stream,{env,Env}]).
 
 % start crypto and ssh if not yet started
 check_for_ssh_running() ->
@@ -393,9 +402,10 @@ check_for_ssh_running() ->
 
 % spawn node remotely
 spawn_remote_node(Host, Node, Options) ->
-    Username = Options#options.username,
-    Password = Options#options.password,
-    ErlFlags = Options#options.erl_flags,
+    #options{username=Username,
+	     password=Password,
+	     erl_flags=ErlFlags,
+	     env=Env} = Options,
     SSHOptions = case {Username, Password} of
 	{[], []}->
 	    [];
@@ -407,8 +417,17 @@ spawn_remote_node(Host, Node, Options) ->
     check_for_ssh_running(),
     {ok, SSHConnRef} = ssh:connect(atom_to_list(Host), 22, SSHOptions),
     {ok, SSHChannelId} = ssh_connection:session_channel(SSHConnRef, infinity),
+    ssh_setenv(SSHConnRef, SSHChannelId, Env),
     ssh_connection:exec(SSHConnRef, SSHChannelId, get_cmd(Node, ErlFlags), infinity).
 
+
+ssh_setenv(SSHConnRef, SSHChannelId, [{Var, Value} | Vars])
+  when is_list(Var), is_list(Value) ->
+    success = ssh_connection:setenv(SSHConnRef, SSHChannelId,
+				    Var, Value, infinity),
+    ssh_setenv(SSHConnRef, SSHChannelId, Vars);
+ssh_setenv(_SSHConnRef, _SSHChannelId, []) -> ok.
+
 % call functions on a remote Erlang node
 call_functions(_Node, []) ->
     ok;
diff --git a/lib/common_test/test/ct_master_SUITE.erl b/lib/common_test/test/ct_master_SUITE.erl
index 27243a0067..56a343a96f 100644
--- a/lib/common_test/test/ct_master_SUITE.erl
+++ b/lib/common_test/test/ct_master_SUITE.erl
@@ -117,14 +117,8 @@ ct_master_test(Config) when is_list(Config) ->
 			       reformat(Events, ?eh),
 			       PrivDir, []),
 
-    find_events(NodeNames, [{tc_start,{master_SUITE,init_per_suite}},
-			    {tc_start,{master_SUITE,first_testcase}},
-			    {tc_start,{master_SUITE,second_testcase}},
-			    {tc_start,{master_SUITE,third_testcase}},
-			    {tc_start,{master_SUITE,end_per_suite}}],
-	       Events),
-    
-    ok.
+    TestEvents = events_to_check(ct_master_test),
+    ok = find_events(NodeNames, TestEvents, Events, Config).
 
 %%%-----------------------------------------------------------------
 %%% HELP FUNCTIONS
@@ -153,13 +147,15 @@ make_spec(DataDir, FileName, NodeNames, Suites, Config) ->
     
     CM = [{config,master,filename:join(DataDir,"master/config.txt")}],
 
+    Env = [{"THIS_MUST_BE_SET","yes"},
+	   {"SO_MUST_THIS","value"}],
     NS = lists:map(
 	   fun(NodeName) ->
 		   {init,NodeName,[
 				   {node_start,[{startup_functions,[]},
-						{monitor_master,true}]},
-				   {eval,{erlang,nodes,[]}}
-				  ]
+						{monitor_master,true},
+						{env,Env}]},
+				   {eval,{erlang,nodes,[]}}]
 		   }
 	   end,
 	   NodeNames),
@@ -199,7 +195,6 @@ run_test(_Name, FileName, Config) ->
     [{FileName,ok}] = ct_test_support:run({ct_master,run,[FileName]},
 					  [{ct_master,basic_html,[true]}],
 					  Config),
-    timer:sleep(5000),
     [{FileName,ok}] = ct_test_support:run({ct_master,run,[FileName]},
 					  [{ct_master,basic_html,[false]}],
 					  Config).
@@ -210,28 +205,26 @@ reformat(Events, EH) ->
 %%%-----------------------------------------------------------------
 %%% TEST EVENTS
 %%%-----------------------------------------------------------------
-find_events([], _CheckEvents, _) ->
-    ok;
-find_events([NodeName|NodeNames],CheckEvents,AllEvents) ->
-    find_events(NodeNames, CheckEvents,
-		remove_events(add_host(NodeName),CheckEvents, AllEvents, [])).
-
-remove_events(Node,[{Name,Data} | RestChecks],
-	      [{?eh,#event{ name = Name, node = Node, data = Data }}|RestEvs],
-	       Acc) ->
-    remove_events(Node, RestChecks, RestEvs, Acc);
-remove_events(Node, Checks, [Event|RestEvs], Acc) ->
-    remove_events(Node, Checks, RestEvs, [Event | Acc]);
-remove_events(_Node, [], [], Acc) ->
-    lists:reverse(Acc);
-remove_events(Node, Events, [], Acc) ->
-    test_server:format("Could not find events: ~p in ~p for node ~p",
-	   [Events, lists:reverse(Acc), Node]),
-    exit(event_not_found).
+
+find_events(NodeNames, TestEvents, Events, Config) ->
+    [begin
+	 Node = add_host(Node0),
+	 io:format("Searching for events for node: ~s", [Node]),
+	 ok = ct_test_support:verify_events(TestEvents, Events, Node, Config),
+	 io:nl()
+     end || Node0 <- NodeNames],
+    ok.
 
 add_host(NodeName) ->
     {ok, HostName} = inet:gethostname(),
     list_to_atom(atom_to_list(NodeName)++"@"++HostName).
     
-expected_events(_) ->
-    [].
+events_to_check(_) ->
+    [{?eh,tc_start,{master_SUITE,first_testcase}},
+     {?eh,tc_done,{master_SUITE,first_testcase,ok}},
+     {?eh,tc_start,{master_SUITE,second_testcase}},
+     {?eh,tc_done,{master_SUITE,second_testcase,ok}},
+     {?eh,tc_start,{master_SUITE,third_testcase}},
+     {?eh,tc_done,{master_SUITE,third_testcase,ok}},
+     {?eh,tc_start,{master_SUITE,env_vars}},
+     {?eh,tc_done,{master_SUITE,env_vars,ok}}].
diff --git a/lib/common_test/test/ct_master_SUITE_data/master/master_SUITE.erl b/lib/common_test/test/ct_master_SUITE_data/master/master_SUITE.erl
index 032d69ad9f..8a5009ad62 100644
--- a/lib/common_test/test/ct_master_SUITE_data/master/master_SUITE.erl
+++ b/lib/common_test/test/ct_master_SUITE_data/master/master_SUITE.erl
@@ -39,7 +39,8 @@ init_per_suite(Config) ->
 end_per_suite(_) ->
     ok.
 
-all() -> [first_testcase, second_testcase, third_testcase].
+all() -> [first_testcase, second_testcase, third_testcase,
+	  env_vars].
 
 init_per_testcase(_, Config) ->
     Config.
@@ -56,3 +57,9 @@ second_testcase(_)->
 third_testcase(_)->
     A = 4,
     A = 2*2.
+
+env_vars(_) ->
+    io:format("~p\n", [os:getenv()]),
+    "yes" = os:getenv("THIS_MUST_BE_SET"),
+    "value" = os:getenv("SO_MUST_THIS"),
+    ok.
diff --git a/lib/common_test/test/ct_test_support.erl b/lib/common_test/test/ct_test_support.erl
index 901e53c71d..e5e2e68fcb 100644
--- a/lib/common_test/test/ct_test_support.erl
+++ b/lib/common_test/test/ct_test_support.erl
@@ -32,7 +32,7 @@
 	 run/2, run/3, run/4, get_opts/1, wait_for_ct_stop/1]).
 
 -export([handle_event/2, start_event_receiver/1, get_events/2,
-	 verify_events/3, reformat/2, log_events/4,
+	 verify_events/3, verify_events/4, reformat/2, log_events/4,
 	 join_abs_dirs/2]).
 
 -export([ct_test_halt/1]).
@@ -370,6 +370,14 @@ verify_events(TEvs, Evs, Config) ->
 	    ok
     end.
 
+verify_events(TEvs, Evs, Node, Config) ->
+    case catch verify_events1(TEvs, Evs, Node, Config) of
+	{'EXIT',Reason} ->
+	    Reason;
+	_ ->
+	    ok
+    end.
+
 verify_events1([TestEv|_], [{TEH,#event{name=stop_logging,node=Node,data=_}}|_], Node, _)
   when element(1,TestEv) == TEH, element(2,TestEv) =/= stop_logging ->
     test_server:format("Failed to find ~p in the list of events!~n", [TestEv]),