Merge branch 'peppe/common_test/shell_mode_broken' into maint-r15

* peppe/common_test/shell_mode_broken:
  Fix broken interactive mode

6 files changed, 164 insertions, 16 deletions

diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl
index 49b51c9207..5014309c0f 100644
--- a/lib/common_test/src/ct.erl
+++ b/lib/common_test/src/ct.erl
@@ -274,7 +274,8 @@ step(TestDir,Suite,Case,Opts) ->
 %%% <c>&gt; ct_telnet:cmd(unix_telnet, "ls .").</c><br/>
 %%% <c>{ok,["ls","file1  ...",...]}</c></p>
 start_interactive() ->
-    ct_util:start(interactive).
+    ct_util:start(interactive),
+    ok.
 
 %%%-----------------------------------------------------------------
 %%% @spec stop_interactive() -> ok
@@ -282,7 +283,8 @@ start_interactive() ->
 %%% @doc Exit the interactive mode.
 %%% @see start_interactive/0
 stop_interactive() ->
-    ct_util:stop(normal).
+    ct_util:stop(normal),
+    ok.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%% MISC INTERFACE
diff --git a/lib/common_test/src/ct_run.erl b/lib/common_test/src/ct_run.erl
index d80d216f9e..3383244bf4 100644
--- a/lib/common_test/src/ct_run.erl
+++ b/lib/common_test/src/ct_run.erl
@@ -211,6 +211,8 @@ analyze_test_result([Result|Rs], Args) ->
     end;
 analyze_test_result([], _) ->
     ?EXIT_STATUS_TEST_SUCCESSFUL;
+analyze_test_result(interactive_mode, _) ->
+    interactive_mode;
 analyze_test_result(Unknown, _) ->
     io:format("\nTest run failed! Reason:\n~p\n\n\n",[Unknown]),
     ?EXIT_STATUS_TEST_RUN_FAILED.
@@ -218,17 +220,22 @@ analyze_test_result(Unknown, _) ->
 finish(Tracing, ExitStatus, Args) ->
     stop_trace(Tracing),
     timer:sleep(1000),
-    %% it's possible to tell CT to finish execution with a call
-    %% to a different function than the normal halt/1 BIF
-    %% (meant to be used mainly for reading the CT exit status)
-    case get_start_opt(halt_with,
-		       fun([HaltMod,HaltFunc]) -> {list_to_atom(HaltMod),
-						   list_to_atom(HaltFunc)} end,
-		       Args) of
-	undefined ->
-	    halt(ExitStatus);
-	{M,F} ->
-	    apply(M, F, [ExitStatus])
+    if ExitStatus == interactive_mode ->
+	    interactive_mode;
+       true ->
+	    %% it's possible to tell CT to finish execution with a call
+	    %% to a different function than the normal halt/1 BIF
+	    %% (meant to be used mainly for reading the CT exit status)
+	    case get_start_opt(halt_with,
+			       fun([HaltMod,HaltFunc]) -> 
+				       {list_to_atom(HaltMod),
+					list_to_atom(HaltFunc)} end,
+			       Args) of
+		undefined ->
+		    halt(ExitStatus);
+		{M,F} ->
+		    apply(M, F, [ExitStatus])
+	    end
     end.
 
 script_start1(Parent, Args) ->
@@ -635,6 +642,7 @@ script_start4(#opts{label = Label, profile = Profile,
 		    verbosity = Verbosity,
 		    enable_builtin_hooks = EnableBuiltinHooks,
 		    logdir = LogDir, testspecs = Specs}, _Args) ->
+
     %% label - used by ct_logs
     application:set_env(common_test, test_label, Label),
 
@@ -655,7 +663,7 @@ script_start4(#opts{label = Label, profile = Profile,
 	    ct_util:set_testdata({logopts, LogOpts}),
 	    log_ts_names(Specs),
 	    io:nl(),
-	    ok;
+	    interactive_mode;
 	Error ->
 	    Error
     end;
@@ -2776,6 +2784,8 @@ opts2args(EnvStartOpts) ->
 			  [{exit_status,[atom_to_list(ExitStatusOpt)]}];
 		     ({halt_with,{HaltM,HaltF}}) ->
 			  [{halt_with,[atom_to_list(HaltM),atom_to_list(HaltF)]}];
+		     ({interactive_mode,true}) ->
+			  [{shell,[]}];
 		     ({config,CfgFiles}) ->
 			  [{ct_config,[CfgFiles]}];
 		     ({userconfig,{CBM,CfgStr=[X|_]}}) when is_integer(X) ->
diff --git a/lib/common_test/test/Makefile b/lib/common_test/test/Makefile
index 7628ada61a..686ee43aa3 100644
--- a/lib/common_test/test/Makefile
+++ b/lib/common_test/test/Makefile
@@ -50,7 +50,8 @@ MODULES= \
 	ct_netconfc_SUITE \
 	ct_basic_html_SUITE \
 	ct_auto_compile_SUITE \
-	ct_verbosity_SUITE
+	ct_verbosity_SUITE \
+	ct_shell_SUITE
 
 ERL_FILES= $(MODULES:%=%.erl)
 
diff --git a/lib/common_test/test/ct_shell_SUITE.erl b/lib/common_test/test/ct_shell_SUITE.erl
new file mode 100644
index 0000000000..4b8c43d800
--- /dev/null
+++ b/lib/common_test/test/ct_shell_SUITE.erl
@@ -0,0 +1,133 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2010-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
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+%%%-------------------------------------------------------------------
+%%% File: ct_shell_SUITE
+%%%
+%%% Description:
+%%% Test that the interactive mode starts properly
+%%%
+%%% The suites used for the test are located in the data directory.
+%%%-------------------------------------------------------------------
+-module(ct_shell_SUITE).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+-include_lib("common_test/include/ct_event.hrl").
+
+-define(eh, ct_test_support_eh).
+
+%%--------------------------------------------------------------------
+%% TEST SERVER CALLBACK FUNCTIONS
+%%--------------------------------------------------------------------
+
+init_per_suite(Config) ->
+    Config1 = ct_test_support:init_per_suite(Config),
+    Config1.
+
+end_per_suite(Config) ->
+    ct_test_support:end_per_suite(Config).
+
+init_per_testcase(TestCase, Config) ->
+    ct_test_support:init_per_testcase(TestCase, Config).
+
+end_per_testcase(TestCase, Config) ->
+    ct_test_support:end_per_testcase(TestCase, Config).
+
+suite() -> [{ct_hooks,[ts_install_cth]}].
+
+all() -> 
+    [start_interactive].
+
+%%--------------------------------------------------------------------
+%% TEST CASES
+%%--------------------------------------------------------------------
+
+%%%-----------------------------------------------------------------
+%%%
+start_interactive(Config) ->
+    DataDir = ?config(data_dir, Config),
+    CfgFile = filename:join(DataDir, "cfgdata"),
+
+    {Opts,ERPid} = setup([{interactive_mode,true},{config,CfgFile}],
+			 Config),
+    CTNode = proplists:get_value(ct_node, Config),
+    Level = proplists:get_value(trace_level, Config),
+    test_server:format(Level, "Saving start opts on ~p: ~p~n",
+		       [CTNode, Opts]),
+    rpc:call(CTNode, application, set_env,
+	     [common_test, run_test_start_opts, Opts]),
+    test_server:format(Level, "Calling ct_run:script_start() on ~p~n",
+		       [CTNode]),
+
+    interactive_mode = rpc:call(CTNode, ct_run, script_start, []),
+
+    ok = rpc:call(CTNode, ct, require, [key1]),
+    value1 = rpc:call(CTNode, ct, get_config, [key1]),
+    ok = rpc:call(CTNode, ct, require, [x,key2]),
+    value2 = rpc:call(CTNode, ct, get_config, [x]),
+
+    ok = rpc:call(CTNode, ct, stop_interactive, []),
+
+    case rpc:call(CTNode, erlang, whereis, [ct_util_server]) of
+	undefined ->
+	    ok;
+	_ ->
+	    test_server:format(Level,
+			       "ct_util_server not stopped on ~p yet, waiting 5 s...~n",
+			       [CTNode]),
+	    timer:sleep(5000),
+	    undefined = rpc:call(CTNode, erlang, whereis, [ct_util_server])
+    end,
+    Events = ct_test_support:get_events(ERPid, Config),
+
+    ct_test_support:log_events(start_interactive,
+			       reformat(Events, ?eh),
+			       ?config(priv_dir, Config),
+			       Opts),
+    TestEvents = test_events(start_interactive),
+    ok = ct_test_support:verify_events(TestEvents, Events, Config).
+
+%%%-----------------------------------------------------------------
+%%% HELP FUNCTIONS
+%%%-----------------------------------------------------------------
+
+setup(Test, Config) ->
+    Opts0 = ct_test_support:get_opts(Config),
+    Level = ?config(trace_level, Config),
+    EvHArgs = [{cbm,ct_test_support},{trace_level,Level}],
+    Opts = Opts0 ++ [{event_handler,{?eh,EvHArgs}}|Test],
+    ERPid = ct_test_support:start_event_receiver(Config),
+    {Opts,ERPid}.
+
+reformat(Events, EH) ->
+    ct_test_support:reformat(Events, EH).
+
+%%%-----------------------------------------------------------------
+%%% TEST EVENTS
+%%%-----------------------------------------------------------------
+
+test_events(start_interactive) ->
+    [
+     {?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}
+    ].
diff --git a/lib/common_test/test/ct_shell_SUITE_data/cfgdata b/lib/common_test/test/ct_shell_SUITE_data/cfgdata
new file mode 100644
index 0000000000..23a40ad21a
--- /dev/null
+++ b/lib/common_test/test/ct_shell_SUITE_data/cfgdata
@@ -0,0 +1,2 @@
+{key1,value1}.
+{key2,value2}.
diff --git a/lib/common_test/vsn.mk b/lib/common_test/vsn.mk
index 877aa775fd..5c9fdfc47e 100644
--- a/lib/common_test/vsn.mk
+++ b/lib/common_test/vsn.mk
@@ -1 +1 @@
-COMMON_TEST_VSN = 1.6.2
+COMMON_TEST_VSN = 1.6.2.1