Merge branch 'peppe/common_test/r14b03_tickets' into dev

* peppe/common_test/r14b03_tickets:
  Have test_server locate the source code file for a test suite module if it's not in the same directory as the beam file.
  Fix error in vts mode, making it impossible to execute suites with test case groups.
  Fix problem with merging ticket branch.
  Fix problems with timetrap handling in common_test: 1. ct:timetrap(infinity) not supported. 2. Previous set timetrap for a test case is not cancelled by new one.
  Document the new init_per_testcase return value.
  Make it possible to fail test case by returning {fail,Reason} from init_per_testcase.
  Fix problem with merging a ticket branch.
  Fix issues related to test case groups: 1. Allow empty group to be specified without generating an error. 2. Sort out potential problem with unnecessary call to delete_subs/2.
  Add test case for suite with empty group.
  Improve validation of test events.
  Fix failing tests on Windows.
  Make it possible to refresh the top level index page at the start of a test run.
  Fix problem with CT hook start error causing IO to be sent to wrong group leader process.
  Do minor updates of the ts test framework.
  Correct failing test cases.

OTP-9233
OTP-9210
OTP-9195
OTP-9161
OTP-9160
OTP-9159
OTP-9138

5 files changed, 111 insertions, 44 deletions

diff --git a/lib/test_server/src/test_server.erl b/lib/test_server/src/test_server.erl
index 8fe7d72270..591329b361 100644
--- a/lib/test_server/src/test_server.erl
+++ b/lib/test_server/src/test_server.erl
@@ -36,7 +36,7 @@
 -export([capture_start/0,capture_stop/0,capture_get/0]).
 -export([messages_get/0]).
 -export([hours/1,minutes/1,seconds/1,sleep/1,adjusted_sleep/1,timecall/3]).
--export([timetrap_scale_factor/0,timetrap/1,timetrap_cancel/1]).
+-export([timetrap_scale_factor/0,timetrap/1,timetrap_cancel/1,timetrap_cancel/0]).
 -export([m_out_of_n/3,do_times/4,do_times/2]).
 -export([call_crash/3,call_crash/4,call_crash/5]).
 -export([temp_name/1]).
@@ -1077,7 +1077,7 @@ run_test_case_eval(Mod, Func, Args0, Name, Ref, RunInit,
 
     {{Time,Value},Loc,Opts} =
 	case test_server_sup:framework_call(init_tc,[?pl2a(Mod),Func,Args0],
-					    {ok, Args0}) of
+					    {ok,Args0}) of
 	    {ok,Args} ->
 		run_test_case_eval1(Mod, Func, Args, Name, RunInit, TCCallback);
 	    Error = {error,_Reason} ->
@@ -1085,18 +1085,17 @@ run_test_case_eval(Mod, Func, Args0, Name, Ref, RunInit,
 					   {skip,{failed,Error}}),
 		{{0,NewResult},{Mod,Func},[]};
 	    {fail,Reason} ->
-		[Conf] = Args0,
-		Conf1 = [{tc_status,{failed,Reason}} | Conf],
+		Conf = [{tc_status,{failed,Reason}} | hd(Args0)],
 		fw_error_notify(Mod, Func, Conf, Reason),
-		NewResult = do_end_tc_call(Mod,Func, {{error,Reason},[Conf1]},
-					   {fail, Reason}),
+		NewResult = do_end_tc_call(Mod,Func, {{error,Reason},[Conf]},
+					   {fail,Reason}),
 		{{0,NewResult},{Mod,Func},[]};
 	    Skip = {skip,_Reason} ->
 		NewResult = do_end_tc_call(Mod,Func,{Skip,Args0},Skip),
 		{{0,NewResult},{Mod,Func},[]};
 	    {auto_skip,Reason} ->
 		NewResult = do_end_tc_call(Mod, Func, {{skip,Reason},Args0},
-					   {skip, {fw_auto_skip,Reason}}),
+					   {skip,{fw_auto_skip,Reason}}),
 		{{0,NewResult},{Mod,Func},[]}
 	end,
     exit({Ref,Time,Value,Loc,Opts}).
@@ -1116,9 +1115,15 @@ run_test_case_eval1(Mod, Func, Args, Name, RunInit, TCCallback) ->
 		{skip_and_save,Reason,SaveCfg} ->
 		    Line = get_loc(),
 		    Conf = [{tc_status,{skipped,Reason}},{save_config,SaveCfg}],
-		    NewRes = do_end_tc_call(Mod, Func, {{skip, Reason}, [Conf]},
+		    NewRes = do_end_tc_call(Mod, Func, {{skip,Reason},[Conf]},
 					    {skip, Reason}),
 		    {{0,NewRes},Line,[]};
+		FailTC = {fail,Reason} ->       % user fails the testcase
+		    EndConf = [{tc_status,{failed,Reason}} | hd(Args)],
+		    fw_error_notify(Mod, Func, EndConf, Reason),
+		    NewRes = do_end_tc_call(Mod, Func, {{error,Reason},[EndConf]},
+					    FailTC),
+		    {{0,NewRes},{Mod,Func},[]};
 		{ok,NewConf} ->
 		    put(test_server_init_or_end_conf,undefined),
 		    %% call user callback function if defined
@@ -1153,8 +1158,9 @@ run_test_case_eval1(Mod, Func, Args, Name, RunInit, TCCallback) ->
 		    {FWReturn1,TSReturn1,EndConf2} =
 			case end_per_testcase(Mod, Func, EndConf1) of
 			    SaveCfg1={save_config,_} ->
-				{FWReturn,TSReturn,[SaveCfg1|lists:keydelete(save_config, 1, EndConf1)]};
-			    {fail,ReasonToFail} ->                       % user has failed the testcase
+				{FWReturn,TSReturn,[SaveCfg1|lists:keydelete(save_config,1,
+									     EndConf1)]};
+			    {fail,ReasonToFail} ->                % user has failed the testcase
 				fw_error_notify(Mod, Func, EndConf1, ReasonToFail),
 				{{error,ReasonToFail},{failed,ReasonToFail},EndConf1};
 			    {failed,{_,end_per_testcase,_}} = Failure -> % unexpected termination
@@ -1301,7 +1307,7 @@ init_per_testcase(Mod, Func, Args) ->
 	false -> code:load_file(Mod);
 	_ -> ok
     end,
-%% init_per_testcase defined, returns new configuration
+    %% init_per_testcase defined, returns new configuration
     case erlang:function_exported(Mod,init_per_testcase,2) of
 	true ->
 	    case catch my_apply(Mod, init_per_testcase, [Func|Args]) of
@@ -1321,6 +1327,8 @@ init_per_testcase(Mod, Func, Args) ->
 					      "bad elements in Config: ~p\n",[Bad]},
 			    {skip,{failed,{Mod,init_per_testcase,bad_return}}}
 		    end;
+		{'$test_server_ok',Res={fail,_Reason}} ->
+		    Res;
 		{'$test_server_ok',_Other} ->
 		    group_leader() ! {printout,12,
 				      "ERROR! init_per_testcase did not return "
@@ -1695,7 +1703,7 @@ fail() ->
 break(Comment) ->
     case erase(test_server_timetraps) of
 	undefined -> ok;
-	List -> lists:foreach(fun(Ref) -> timetrap_cancel(Ref) end,List)
+	List -> lists:foreach(fun({Ref,_}) -> timetrap_cancel(Ref) end, List)
     end,
     io:format(user,
 	      "\n\n\n--- SEMIAUTOMATIC TESTING ---"
@@ -1776,14 +1784,16 @@ timetrap(Timeout0) ->
 	{undefined,false} -> timetrap1(Timeout, false);
 	{undefined,_} -> timetrap1(Timeout, true);
 	{infinity,_} -> infinity;
+	{_Int,_Scale} when Timeout == infinity -> infinity;
 	{Int,Scale} -> timetrap1(Timeout*Int, Scale)
     end.
 
 timetrap1(Timeout, Scale) ->
-    Ref = spawn_link(test_server_sup,timetrap,[Timeout,Scale,self()]),
+    TCPid = self(),
+    Ref = spawn_link(test_server_sup,timetrap,[Timeout,Scale,TCPid]),
     case get(test_server_timetraps) of
-	undefined -> put(test_server_timetraps,[Ref]);
-	List -> put(test_server_timetraps,[Ref|List])
+	undefined -> put(test_server_timetraps,[{Ref,TCPid}]);
+	List -> put(test_server_timetraps,[{Ref,TCPid}|List])
     end,
     Ref.
 
@@ -1796,14 +1806,16 @@ ensure_timetrap(Config) ->
 		undefined -> ok;
 		Garbage ->
 		    erase(test_server_default_timetrap),
-		    format("=== WARNING: garbage in test_server_default_timetrap: ~p~n",
+		    format("=== WARNING: garbage in "
+			   "test_server_default_timetrap: ~p~n",
 			   [Garbage])
 	    end,
 	    DTmo = case lists:keysearch(default_timeout,1,Config) of
 		       {value,{default_timeout,Tmo}} -> Tmo;
 		       _ -> ?DEFAULT_TIMETRAP_SECS
 		   end,
-	    format("=== test_server setting default timetrap of ~p seconds~n",
+	    format("=== test_server setting default "
+		   "timetrap of ~p seconds~n",
 		   [DTmo]),
 	    put(test_server_default_timetrap, timetrap(seconds(DTmo)))
     end.
@@ -1815,11 +1827,13 @@ cancel_default_timetrap() ->
 	TimeTrap when is_pid(TimeTrap) ->
 	    timetrap_cancel(TimeTrap),
 	    erase(test_server_default_timetrap),
-	    format("=== test_server canceled default timetrap since another timetrap was set~n"),
+	    format("=== test_server canceled default timetrap "
+		   "since another timetrap was set~n"),
 	    ok;
 	Garbage ->
 	    erase(test_server_default_timetrap),
-	    format("=== WARNING: garbage in test_server_default_timetrap: ~p~n",
+	    format("=== WARNING: garbage in "
+		   "test_server_default_timetrap: ~p~n",
 		   [Garbage]),
 	    error
     end.
@@ -1833,6 +1847,7 @@ time_ms({Other,_N}) ->
 	   "Should be seconds, minutes, or hours.~n", [Other]),
     exit({invalid_time_spec,Other});
 time_ms(Ms) when is_integer(Ms) -> Ms;
+time_ms(infinity) -> infinity;
 time_ms(Other) -> exit({invalid_time_spec,Other}).
 
 
@@ -1846,11 +1861,29 @@ timetrap_cancel(infinity) ->
 timetrap_cancel(Handle) ->
     case get(test_server_timetraps) of
 	undefined -> ok;
-	[Handle] -> erase(test_server_timetraps);
-	List -> put(test_server_timetraps,lists:delete(Handle,List))
+	[{Handle,_}] -> erase(test_server_timetraps);
+	Timers -> put(test_server_timetraps,
+		      lists:keydelete(Handle, 1, Timers))
     end,
     test_server_sup:timetrap_cancel(Handle).
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% timetrap_cancel() -> ok
+%%
+%% Cancels timetrap for current test case.
+timetrap_cancel() ->
+    case get(test_server_timetraps) of
+	undefined ->
+	    ok;
+	Timers ->
+	    case lists:keysearch(self(), 2, Timers) of
+		{value,{Handle,_}} ->
+		    timetrap_cancel(Handle);
+		_ ->
+		    ok
+	    end
+    end.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% hours(N) -> Milliseconds
 %% minutes(N) -> Milliseconds
diff --git a/lib/test_server/src/test_server_ctrl.erl b/lib/test_server/src/test_server_ctrl.erl
index 30d7314058..de9b962dfc 100644
--- a/lib/test_server/src/test_server_ctrl.erl
+++ b/lib/test_server/src/test_server_ctrl.erl
@@ -1812,6 +1812,9 @@ start_log_file() ->
     ok = file:make_dir(PrivDir),
     put(test_server_priv_dir,PrivDir++"/"),
     print_timestamp(13,"Suite started at "),
+
+    LogInfo = [{topdir,Dir},{rundir,lists:flatten(TestDir)}],
+    test_server_sup:framework_call(report, [loginfo,LogInfo]),
     ok.
 
 make_html_link(LinkName, Target, Explanation) ->
@@ -1925,7 +1928,6 @@ html_convert_modules(TestSpec, _Config) ->
     copy_html_files(get(test_server_dir), get(test_server_log_dir_base)).
 
 %% Retrieve a list of modules out of the test spec.
-
 html_isolate_modules(List) -> html_isolate_modules(List, sets:new()).
 
 html_isolate_modules([], Set) -> sets:to_list(Set);
@@ -1939,37 +1941,56 @@ html_isolate_modules([{Mod,_Case,_Args}|Cases], Set) ->
     html_isolate_modules(Cases, sets:add_element(Mod, Set)).
 
 %% Given a list of modules, convert each module's source code to HTML.
-
 html_convert_modules([Mod|Mods]) ->
     case code:which(Mod) of
 	Path when is_list(Path) ->
 	    SrcFile = filename:rootname(Path) ++ ".erl",
-	    DestDir = get(test_server_dir),
-	    Name = atom_to_list(Mod),
-	    DestFile = filename:join(DestDir, downcase(Name) ++ ?src_listing_ext),
-	    html_possibly_convert(SrcFile, DestFile),
-	    html_convert_modules(Mods);
-	_Other -> ok
+	    FoundSrcFile =
+		case file:read_file_info(SrcFile) of
+		    {ok,SInfo} ->
+			{SrcFile,SInfo};
+		    {error,_} ->
+			ModInfo = Mod:module_info(compile),
+			case proplists:get_value(source, ModInfo) of
+			    undefined ->
+				undefined;
+			    OtherSrcFile ->
+				case file:read_file_info(OtherSrcFile) of
+				    {ok,SInfo} ->
+					{OtherSrcFile,SInfo};
+				    {error,_} ->
+					undefined
+				end
+			end
+		end,
+	    case FoundSrcFile of
+		undefined ->
+		    html_convert_modules(Mods);
+		{SrcFile1,SrcFileInfo} ->
+		    DestDir = get(test_server_dir),
+		    Name = atom_to_list(Mod),
+		    DestFile = filename:join(DestDir,
+					     downcase(Name)++?src_listing_ext),
+		    html_possibly_convert(SrcFile1, SrcFileInfo, DestFile),
+		    html_convert_modules(Mods)
+	    end;
+	_Other ->
+	    html_convert_modules(Mods)
     end;
 html_convert_modules([]) -> ok.
 
 %% Convert source code to HTML if possible and needed.
-
-html_possibly_convert(Src, Dest) ->
-    case file:read_file_info(Src) of
-	{ok,SInfo} ->
-	    case file:read_file_info(Dest) of
-		{error,_Reason} ->		% no dest file
-		    erl2html2:convert(Src, Dest);
-		{ok,DInfo} when DInfo#file_info.mtime < SInfo#file_info.mtime ->
-		    erl2html2:convert(Src, Dest);
-		{ok,_DInfo} -> ok		% dest file up to date
-	    end;
-	{error,_Reason} -> ok			% no source code found
+html_possibly_convert(Src, SrcInfo, Dest) ->
+    case file:read_file_info(Dest) of
+	{error,_Reason} ->			% no dest file
+	    erl2html2:convert(Src, Dest);
+	{ok,DestInfo} when DestInfo#file_info.mtime < SrcInfo#file_info.mtime ->
+	    erl2html2:convert(Src, Dest);
+	{ok,_DestInfo} ->
+	    ok					% dest file up to date
     end.
 
 %% Copy all HTML files in InDir to OutDir.
-
 copy_html_files(InDir, OutDir) ->
     Files = filelib:wildcard(filename:join(InDir, "*" ++ ?src_listing_ext)),
     lists:foreach(fun (Src) -> copy_html_file(Src, OutDir) end, Files).
diff --git a/lib/test_server/src/test_server_sup.erl b/lib/test_server/src/test_server_sup.erl
index 1a614d74d5..53dfb45e3a 100644
--- a/lib/test_server/src/test_server_sup.erl
+++ b/lib/test_server/src/test_server_sup.erl
@@ -83,13 +83,13 @@ timetrap(Timeout0, Scale, Pid) ->
 %% Handle = term()
 %%
 %% Cancels a time trap.
-
 timetrap_cancel(Handle) ->
     unlink(Handle),
     MonRef = erlang:monitor(process, Handle),
     exit(Handle, kill),
     receive {'DOWN',MonRef,_,_,_} -> ok after 2000 -> ok end.
 
+
 capture_get(Msgs) ->
     receive
 	{captured,Msg} ->
diff --git a/lib/test_server/src/ts_install.erl b/lib/test_server/src/ts_install.erl
index 2ddffccf5b..8332ccfb40 100644
--- a/lib/test_server/src/ts_install.erl
+++ b/lib/test_server/src/ts_install.erl
@@ -22,6 +22,7 @@
 -export([install/2, platform_id/1]).
 
 -include("ts.hrl").
+-include_lib("kernel/include/file.hrl").
 
 install(install_local, Options) ->
     install(os:type(), Options);
@@ -150,11 +151,17 @@ add_vars(Vars0, Opts0) ->
 	end,
     {PlatformId, PlatformLabel, PlatformFilename, Version} =
 	platform([{longnames, LongNames}|Vars0]),
+    NetDir = lists:concat(["/net", hostname()]),
+    Mounted = case file:read_file_info(NetDir) of
+		  {ok, #file_info{type = directory}} -> NetDir;
+		  _ -> ""
+	      end,
     {Opts, [{longnames, LongNames},
 	    {platform_id, PlatformId},
 	    {platform_filename, PlatformFilename},
 	    {rsh_name, get_rsh_name()},
 	    {platform_label, PlatformLabel},
+	    {ts_net_dir, Mounted},
 	    {erl_flags, []},
 	    {erl_release, Version},
 	    {ts_testcase_callback, get_testcase_callback()} | Vars0]}.
diff --git a/lib/test_server/src/ts_run.erl b/lib/test_server/src/ts_run.erl
index 067961a216..d145290820 100644
--- a/lib/test_server/src/ts_run.erl
+++ b/lib/test_server/src/ts_run.erl
@@ -212,6 +212,12 @@ make_command(Vars, Spec, State) ->
 	false -> 
 	    ok
     end,
+
+    %% If Common Test specific variables are needed, add them here
+    %% on form: "{key1,value1}" "{key2,value2}" ...
+    NetDir = ts_lib:var(ts_net_dir, Vars),
+    TestVars = [ "\"{net_dir,\\\"",NetDir,"\\\"}\"" ],
+
     %% NOTE: Do not use ' in these commands as it wont work on windows
     Cmd = [Erl, Naming, "test_server"
 	   " -rsh ", ts_lib:var(rsh_name, Vars),
@@ -224,6 +230,7 @@ make_command(Vars, Spec, State) ->
 	   %%	   " -test_server_format_exception false",
 	   " -boot start_sasl -sasl errlog_type error",
 	   " -pz ",Cwd,
+	   " -ct_test_vars ",TestVars,
 	   " -eval \"file:set_cwd(\\\"",TestDir,"\\\")\" "
 	   " -eval \"ct:run_test(", 
 	   backslashify(lists:flatten(State#state.test_server_args)),")\""
@@ -369,7 +376,6 @@ make_common_test_args(Args0, Options, _Vars) ->
 		 end,
     ConfigFiles = [{config,[filename:join(ConfigPath,File)
 			    || File <- get_config_files()]}],
-
     io_lib:format("~100000p",[Args0++Trace++Cover++Logdir++
 				  ConfigFiles++Options]).