Introduce new CT hook functions

3 files changed, 133 insertions, 50 deletions

diff --git a/lib/common_test/src/ct_framework.erl b/lib/common_test/src/ct_framework.erl
index f792269c41..ae3f8a69e3 100644
--- a/lib/common_test/src/ct_framework.erl
+++ b/lib/common_test/src/ct_framework.erl
@@ -52,7 +52,13 @@
 %%%
 %%% @doc Test server framework callback, called by the test_server
 %%% when a new test case is started.
-init_tc(Mod,Func,Config) ->
+init_tc(Mod,Func0,Config) ->
+    {TCCfgFunc,Func} = case Func0 of
+			      {init_per_testcase,_} -> Func0;
+			      {end_per_testcase,_}  -> Func0;
+			      _                     -> {undefined,Func0}
+			  end,
+
     %% in case Mod == ct_framework, lookup the suite name
     Suite = get_suite_name(Mod, Config),
 
@@ -86,7 +92,7 @@ init_tc(Mod,Func,Config) ->
 					    end, [create]),
 		    case ct_util:read_suite_data({seq,Suite,Func}) of
 			undefined ->
-			    init_tc1(Mod,Suite,Func,Config);
+			    init_tc1(Mod,Suite,Func,TCCfgFunc,Config);
 			Seq when is_atom(Seq) ->
 			    case ct_util:read_suite_data({seq,Suite,Seq}) of
 				[Func|TCs] -> % this is the 1st case in Seq
@@ -102,27 +108,27 @@ init_tc(Mod,Func,Config) ->
 				_ ->
 				    ok
 			    end,
-			    init_tc1(Mod,Suite,Func,Config);
+			    init_tc1(Mod,Suite,Func,TCCfgFunc,Config);
 			{failed,Seq,BadFunc} ->
 			    {auto_skip,{sequence_failed,Seq,BadFunc}}
 		    end
 	    end
     end.	    
 
-init_tc1(?MODULE,_,error_in_suite,[Config0]) when is_list(Config0) ->
+init_tc1(?MODULE,_,error_in_suite,_,[Config0]) when is_list(Config0) ->
     ct_logs:init_tc(false),
     ct_event:notify(#event{name=tc_start,
 			   node=node(),
 			   data={?MODULE,error_in_suite}}),
-    ct_suite_init(?MODULE, error_in_suite, [], Config0),
-    case ?val(error, Config0) of
+    ct_suite_init(?MODULE,error_in_suite,undefined,[], Config0),
+    case ?val(error,Config0) of
 	undefined ->
 	    {fail,"unknown_error_in_suite"};
 	Reason ->
 	    {fail,Reason}
     end;
 
-init_tc1(Mod,Suite,Func,[Config0]) when is_list(Config0) ->
+init_tc1(Mod,Suite,Func,TCCfgFunc,[Config0]) when is_list(Config0) ->
     Config1 = 
 	case ct_util:read_suite_data(last_saved_config) of
 	    {{Suite,LastFunc},SavedConfig} ->	% last testcase
@@ -184,14 +190,15 @@ init_tc1(Mod,Suite,Func,[Config0]) when is_list(Config0) ->
 		    Initialize(),
 		    {fail,Reason};
 		_ ->
-		    init_tc2(Mod,Suite,Func,SuiteInfo,MergeResult,Config)
+		    init_tc2(Mod,Suite,Func,TCCfgFunc,SuiteInfo,
+			     MergeResult,Config)
 	    end
     end;
 
-init_tc1(_Mod,_Suite,_Func,Args) ->
+init_tc1(_Mod,_Suite,_Func,_TCCfgFunc,Args) ->
     {ok,Args}.
 
-init_tc2(Mod,Suite,Func,SuiteInfo,MergeResult,Config) ->
+init_tc2(Mod,Suite,Func,TCCfgFunc,SuiteInfo,MergeResult,Config) ->
     %% timetrap must be handled before require
     MergedInfo = timetrap_first(MergeResult, [], []),
     %% tell logger to use specified style sheet
@@ -238,7 +245,8 @@ init_tc2(Mod,Suite,Func,SuiteInfo,MergeResult,Config) ->
 	{ok,PostInitHook,Config1} ->
 	    case get('$test_server_framework_test') of
 		undefined ->
-		    ct_suite_init(Suite, FuncSpec, PostInitHook, Config1);
+		    ct_suite_init(Suite,FuncSpec,TCCfgFunc,
+				  PostInitHook,Config1);
 		Fun ->
 		    PostInitHookResult = do_post_init_hook(PostInitHook,
 							   Config1),
@@ -251,16 +259,20 @@ init_tc2(Mod,Suite,Func,SuiteInfo,MergeResult,Config) ->
 	    end
     end.
 
-ct_suite_init(Suite, FuncSpec, PostInitHook, Config) when is_list(Config) ->
-    case ct_hooks:init_tc(Suite, FuncSpec, Config) of
+ct_suite_init(Suite,FuncSpec,TCCfgFunc,
+	      PostInitHook,Config) when is_list(Config) ->
+    HookFunc = if TCCfgFunc /= undefined -> {TCCfgFunc,FuncSpec};
+		  true -> FuncSpec
+	       end,
+    case ct_hooks:init_tc(Suite,HookFunc,Config) of
 	NewConfig when is_list(NewConfig) ->
-	    PostInitHookResult = do_post_init_hook(PostInitHook, NewConfig),
+	    PostInitHookResult = do_post_init_hook(PostInitHook,NewConfig),
 	    {ok, [PostInitHookResult ++ NewConfig]};
 	Else ->
 	    Else
     end.
 
-do_post_init_hook(PostInitHook, Config) ->
+do_post_init_hook(PostInitHook,Config) ->
     lists:flatmap(fun({Tag,Fun}) ->
 			  case lists:keysearch(Tag,1,Config) of
 			      {value,_} ->
@@ -657,7 +669,12 @@ end_tc(Mod,Func,{TCPid,Result,[Args]}, Return) when is_pid(TCPid) ->
 end_tc(Mod,Func,{Result,[Args]}, Return) ->
     end_tc(Mod,Func,self(),Result,Args,Return).
 
-end_tc(Mod,Func,TCPid,Result,Args,Return) ->
+end_tc(Mod,Func0,TCPid,Result,Args,Return) ->
+    {TCCfgFunc,Func} = case Func0 of
+			      {init_per_testcase,_} -> Func0;
+			      {end_per_testcase,_}  -> Func0;
+			      _                     -> {undefined,Func0}
+			  end,
     %% in case Mod == ct_framework, lookup the suite name
     Suite = get_suite_name(Mod, Args),
 
@@ -687,10 +704,11 @@ end_tc(Mod,Func,TCPid,Result,Args,Return) ->
     ct_util:delete_suite_data(last_saved_config),
 
     FuncSpec = group_or_func(Func,Args),
-
+    HookFunc = if TCCfgFunc /= undefined -> Func0;
+		   true -> FuncSpec
+		end,
     {Result1,FinalNotify} =
-	case ct_hooks:end_tc(
-	       Suite, FuncSpec, Args, Result, Return) of
+	case ct_hooks:end_tc(Suite,HookFunc,Args,Result,Return) of
 	    '$ct_no_change' ->
 		{ok,Result};
 	    HookResult ->
diff --git a/lib/common_test/src/ct_hooks.erl b/lib/common_test/src/ct_hooks.erl
index 86d18696dc..4008ea998a 100644
--- a/lib/common_test/src/ct_hooks.erl
+++ b/lib/common_test/src/ct_hooks.erl
@@ -93,8 +93,10 @@ init_tc(Mod, {init_per_group, GroupName, Properties}, Config) ->
     call(fun call_generic/3, Config, [pre_init_per_group, GroupName]);
 init_tc(_Mod, {end_per_group, GroupName, _}, Config) ->
     call(fun call_generic/3, Config, [pre_end_per_group, GroupName]);
-init_tc(_Mod, TC, Config) ->
-    call(fun call_generic/3, Config, [pre_init_per_testcase, TC]).
+init_tc(_Mod, {init_per_testcase,TC}, Config) ->
+    call(fun call_generic/3, Config, [pre_init_per_testcase, TC]);
+init_tc(_Mod, {end_per_testcase,TC}, Config) ->
+    call(fun call_generic/3, Config, [pre_end_per_testcase, TC]).
 
 %% @doc Called as each test case is completed. This includes all configuration
 %% tests.
@@ -126,7 +128,10 @@ end_tc(Mod, {end_per_group, GroupName, Properties}, Config, Result, _Return) ->
 	       [post_end_per_group, GroupName, Config], '$ct_no_change'),
     maybe_stop_locker(Mod, GroupName, Properties),
     Res;
-end_tc(_Mod, TC, Config, Result, _Return) ->
+end_tc(_Mod, {init_per_testcase,TC}, Config, Result, _Return) ->
+    call(fun call_generic/3, Result, [post_init_per_testcase, TC, Config],
+	'$ct_no_change');
+end_tc(_Mod, {end_per_testcase,TC}, Config, Result, _Return) ->
     call(fun call_generic/3, Result, [post_end_per_testcase, TC, Config],
 	'$ct_no_change').
 
@@ -244,6 +249,8 @@ remove(_, Else) ->
 
 %% Translate scopes, i.e. init_per_group,group1 -> end_per_group,group1 etc
 scope([pre_init_per_testcase, TC|_]) ->
+    [post_init_per_testcase, TC];
+scope([pre_end_per_testcase, TC|_]) ->
     [post_end_per_testcase, TC];
 scope([pre_init_per_group, GroupName|_]) ->
     [post_end_per_group, GroupName];
@@ -317,7 +324,8 @@ get_hooks() ->
 %% If we are doing a cleanup call i.e. {post,pre}_end_per_*, all priorities
 %% are reversed. Probably want to make this sorting algorithm pluginable
 %% as some point...
-resort(Calls,Hooks,[F|_R]) when F == post_end_per_testcase;
+resort(Calls,Hooks,[F|_R]) when F == pre_end_per_testcase;
+				F == post_end_per_testcase;
 				F == pre_end_per_group;
 				F == post_end_per_group;
 				F == pre_end_per_suite;
diff --git a/lib/test_server/src/test_server.erl b/lib/test_server/src/test_server.erl
index 73803030a3..9bab85bcc9 100644
--- a/lib/test_server/src/test_server.erl
+++ b/lib/test_server/src/test_server.erl
@@ -925,32 +925,38 @@ run_test_case_eval(Mod, Func, Args0, Name, Ref, RunInit,
     Where = [{Mod,Func}],
     put(test_server_loc, Where),
 
-    FWInitResult = test_server_sup:framework_call(init_tc,[Mod,Func,Args0],
-						  {ok,Args0}),
+    FWInitFunc = case RunInit of
+		     run_init -> {init_per_testcase,Func};
+		     _        -> Func
+		 end,
+
+    FWInitResult0 = do_init_tc_call(Mod,FWInitFunc,Args0,{ok,Args0}),
+
     set_tc_state(running),
     {{Time,Value},Loc,Opts} =
-	case FWInitResult of
+	case FWInitResult0 of
 	    {ok,Args} ->
 		run_test_case_eval1(Mod, Func, Args, Name, RunInit, TCCallback);
 	    Error = {error,_Reason} ->
-		NewResult = do_end_tc_call(Mod,Func, {Error,Args0},
+		NewResult = do_end_tc_call(Mod,FWInitFunc, {Error,Args0},
 					   {auto_skip,{failed,Error}}),
 		{{0,NewResult},Where,[]};
 	    {fail,Reason} ->
 		Conf = [{tc_status,{failed,Reason}} | hd(Args0)],
 		fw_error_notify(Mod, Func, Conf, Reason),
-		NewResult = do_end_tc_call(Mod,Func, {{error,Reason},[Conf]},
+		NewResult = do_end_tc_call(Mod,FWInitFunc,
+					   {{error,Reason},[Conf]},
 					   {fail,Reason}),
 		{{0,NewResult},Where,[]};
 	    Skip = {SkipType,_Reason} when SkipType == skip;
 					   SkipType == skipped ->
-		NewResult = do_end_tc_call(Mod,Func,
+		NewResult = do_end_tc_call(Mod,FWInitFunc,
 					   {Skip,Args0}, Skip),
 		{{0,NewResult},Where,[]};
 	    AutoSkip = {auto_skip,_Reason} ->
 		%% special case where a conf case "pretends" to be skipped
 		NewResult =
-		    do_end_tc_call(Mod,Func, {AutoSkip,Args0}, AutoSkip),
+		    do_end_tc_call(Mod,FWInitFunc, {AutoSkip,Args0}, AutoSkip),
 		{{0,NewResult},Where,[]}
 	end,
     exit({Ref,Time,Value,Loc,Opts}).
@@ -965,31 +971,41 @@ run_test_case_eval1(Mod, Func, Args, Name, RunInit, TCCallback) ->
 					      SkipType == skipped ->
 		    Line = get_loc(),
 		    Conf = [{tc_status,{skipped,Reason}}|hd(Args)],
-		    NewRes = do_end_tc_call(Mod,Func,
+		    NewRes = do_end_tc_call(Mod,{init_per_testcase,Func},
 					    {Skip,[Conf]}, Skip),
 		    {{0,NewRes},Line,[]};
 		{skip_and_save,Reason,SaveCfg} ->
 		    Line = get_loc(),
 		    Conf = [{tc_status,{skipped,Reason}},
 			    {save_config,SaveCfg}|hd(Args)],
-		    NewRes = do_end_tc_call(Mod,Func, {{skip,Reason},[Conf]},
+		    NewRes = do_end_tc_call(Mod,{init_per_testcase,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,
+		    NewRes = do_end_tc_call(Mod,{init_per_testcase,Func},
 					    {{error,Reason},[EndConf]},
 					    FailTC),
 		    {{0,NewRes},[{Mod,Func}],[]};
 		{ok,NewConf} ->
-		    %% call user callback function if defined
-		    NewConf1 =
-			user_callback(TCCallback, Mod, Func, init, NewConf),
-		    %% save current state in controller loop
-		    set_tc_state(tc, NewConf1),
-		    %% execute the test case
-		    {{T,Return},Loc} = {ts_tc(Mod,Func,[NewConf1]), get_loc()},
+		    IPTCEndRes = do_end_tc_call(Mod,{init_per_testcase,Func},
+						{ok,[NewConf]}, NewConf),
+		    {{T,Return},Loc,NewConf1} =
+			if not is_list(IPTCEndRes) ->
+				%% received skip or fail, not config
+				{{0,IPTCEndRes},undefined,NewConf};
+			   true ->
+				%% call user callback function if defined
+				NewConfUC =
+				    user_callback(TCCallback, Mod, Func,
+						  init, IPTCEndRes),
+				%% save current state in controller loop
+				set_tc_state(tc, NewConfUC),
+				%% execute the test case
+				{ts_tc(Mod,Func,[NewConfUC]),get_loc(),NewConfUC}
+			end,
 		    {EndConf,TSReturn,FWReturn} =
 			case Return of
 			    {E,TCError} when E=='EXIT' ; E==failed ->
@@ -1015,36 +1031,47 @@ run_test_case_eval1(Mod, Func, Args, Name, RunInit, TCCallback) ->
 		    %% call user callback function if defined
 		    EndConf1 =
 			user_callback(TCCallback, Mod, Func, 'end', EndConf),
+
+		    %% We can't handle fails or skips here
+		    EndConf2 =
+			case do_init_tc_call(Mod,{end_per_testcase,Func},
+					     [EndConf1],{ok,[EndConf1]}) of
+			    {ok,[EPTCInitRes]} when is_list(EPTCInitRes) ->
+				EPTCInitRes;
+			    _ ->
+				EndConf1
+			end,
+
 		    %% update current state in controller loop
-		    {FWReturn1,TSReturn1,EndConf2} =
-			case end_per_testcase(Mod, Func, EndConf1) of
+		    {FWReturn1,TSReturn1,EndConf3} =
+			case end_per_testcase(Mod, Func, EndConf2) of
 			    SaveCfg1={save_config,_} ->
 				{FWReturn,TSReturn,
 				 [SaveCfg1|lists:keydelete(save_config,1,
-							   EndConf1)]};
+							   EndConf2)]};
 			    {fail,ReasonToFail} ->
 				%% user has failed the testcase
-				fw_error_notify(Mod, Func, EndConf1,
+				fw_error_notify(Mod, Func, EndConf2,
 						ReasonToFail),
 				{{error,ReasonToFail},
 				 {failed,ReasonToFail},
-				 EndConf1};
+				 EndConf2};
 			    {failed,{_,end_per_testcase,_}} = Failure when
 				  FWReturn == ok ->
 				%% unexpected termination in end_per_testcase
 				%% report this as the result to the framework
-				{Failure,TSReturn,EndConf1};
+				{Failure,TSReturn,EndConf2};
 			    _ ->
 				%% test case result should be reported to
 				%% framework no matter the status of
 				%% end_per_testcase
-				{FWReturn,TSReturn,EndConf1}
+				{FWReturn,TSReturn,EndConf2}
 			end,
 		    %% clear current state in controller loop
-		    case do_end_tc_call(Mod,Func,
-					{FWReturn1,[EndConf2]}, TSReturn1) of
+		    case do_end_tc_call(Mod,{end_per_testcase,Func},
+					{FWReturn1,[EndConf3]}, TSReturn1) of
 			{failed,Reason} = NewReturn ->
-			    fw_error_notify(Mod,Func,EndConf2, Reason),
+			    fw_error_notify(Mod,Func,EndConf3, Reason),
 			    {{T,NewReturn},[{Mod,Func}],[]};
 			NewReturn ->
 			    {{T,NewReturn},Loc,[]}
@@ -1070,7 +1097,37 @@ run_test_case_eval1(Mod, Func, Args, Name, RunInit, TCCallback) ->
 	    {{T,Return2},Loc,Opts}
     end.
 
+do_init_tc_call(Mod, Func, Res, Return) ->
+    test_server_sup:framework_call(init_tc,[Mod,Func,Res],Return).
+
+do_end_tc_call(Mod, IPTC={init_per_testcase,Func}, Res, Return) ->
+     case Return of
+	 {NOk,_} when NOk == auto_skip; NOk == fail;
+		      NOk == skip ; NOk == skipped ->
+	     IPTCEndRes =
+		 case do_end_tc_call1(Mod, IPTC, Res, Return) of
+		     IPTCEndConfig when is_list(IPTCEndConfig) ->
+			 IPTCEndConfig;
+		     _ ->
+			 Res
+		 end,
+	     EPTCInitRes =
+		 case do_init_tc_call(Mod,{end_per_testcase,Func},
+				      IPTCEndRes,Return) of
+		     {ok,EPTCInitConfig} when is_list(EPTCInitConfig) ->
+			 EPTCInitConfig;
+		     _ ->
+			 IPTCEndRes
+		 end,
+	     do_end_tc_call1(Mod, {end_per_testcase,Func},
+			     EPTCInitRes, Return);
+	 _Ok ->
+	     do_end_tc_call1(Mod, IPTC, Res, Return)
+     end;
 do_end_tc_call(Mod, Func, Res, Return) ->
+    do_end_tc_call1(Mod, Func, Res, Return).
+
+do_end_tc_call1(Mod, Func, Res, Return) ->
     FwMod = os:getenv("TEST_SERVER_FRAMEWORK"),
     Ref = make_ref(),
     if FwMod == "ct_framework" ; FwMod == "undefined"; FwMod == false ->