Merge branch 'peppe/common_test/group_events'

* peppe/common_test/group_events:
  Update test suites and fix various remaining problems
  Update event protocol and CT Hooks API
  Introduce group name for skipped cases in events, hooks and overview log

OTP-11732

2 files changed, 28 insertions, 24 deletions

diff --git a/lib/common_test/src/ct_framework.erl b/lib/common_test/src/ct_framework.erl
index 580588fbd2..63bfea68c4 100644
--- a/lib/common_test/src/ct_framework.erl
+++ b/lib/common_test/src/ct_framework.erl
@@ -1277,28 +1277,35 @@ report(What,Data) ->
 	    ct_util:set_testdata({What,Data}),
 	    ok;
 	tc_start ->
-	    %% Data = {{Suite,Func},LogFileName}
+	    %% Data = {Suite,{Func,GroupName}},LogFileName}
+	    Data1 = case Data of
+			{{Suite,{Func,undefined}},LFN} -> {{Suite,Func},LFN};
+			_ -> Data
+		    end,
 	    ct_event:sync_notify(#event{name=tc_logfile,
 					node=node(),
-					data=Data}),
+					data=Data1}),
 	    ok;
 	tc_done ->
-	    {_Suite,Case,Result} = Data,
+	    {Suite,{Func,GrName},Result} = Data,
+	    Data1 = if GrName == undefined -> {Suite,Func,Result};
+		       true                -> Data
+	    end,
 	    case Result of
 		{failed, _} ->
-		    ct_hooks:on_tc_fail(What, Data);
+		    ct_hooks:on_tc_fail(What, Data1);
 		{skipped,{failed,{_,init_per_testcase,_}}} ->
-		    ct_hooks:on_tc_skip(tc_auto_skip, Data);
+		    ct_hooks:on_tc_skip(tc_auto_skip, Data1);
 		{skipped,{require_failed,_}} ->
-		    ct_hooks:on_tc_skip(tc_auto_skip, Data);
+		    ct_hooks:on_tc_skip(tc_auto_skip, Data1);
 		{skipped,_} ->
-		    ct_hooks:on_tc_skip(tc_user_skip, Data);
+		    ct_hooks:on_tc_skip(tc_user_skip, Data1);
 		{auto_skipped,_} ->
-		    ct_hooks:on_tc_skip(tc_auto_skip, Data);
+		    ct_hooks:on_tc_skip(tc_auto_skip, Data1);
 		_Else ->
 		    ok
 	    end,
-	    case {Case,Result} of
+	    case {Func,Result} of
 		{init_per_suite,_} ->
 		    ok;
 		{end_per_suite,_} ->
@@ -1327,20 +1334,17 @@ report(What,Data) ->
 	tc_user_skip ->
 	    %% test case or config function specified as skipped in testspec,
 	    %% or init config func for suite/group has returned {skip,Reason}
-	    %% Data = {Suite,Case,Comment} | 
-	    %%        {Suite,{GroupConfigFunc,GroupName},Comment} 
+	    %% Data = {Suite,{Func,GroupName},Comment}
 	    {Func,Data1} = case Data of
-			       {Suite,{ConfigFunc,undefined},Cmt} ->
-				   {ConfigFunc,{Suite,ConfigFunc,Cmt}};
-			       {_,{ConfigFunc,_},_} -> {ConfigFunc,Data};
-			       {_,Case,_} -> {Case,Data}
+			       {Suite,{F,undefined},Comment} ->
+				   {F,{Suite,F,Comment}};
+			       D = {_,{F,_},_} ->
+				   {F,D}
 			   end,
-
 	    ct_event:sync_notify(#event{name=tc_user_skip,
 					node=node(),
 					data=Data1}),
 	    ct_hooks:on_tc_skip(What, Data1),
-
 	    if Func /= init_per_suite, Func /= init_per_group,
 	       Func /= end_per_suite, Func /= end_per_group ->
 		    add_to_stats(user_skipped);
@@ -1350,13 +1354,12 @@ report(What,Data) ->
 	tc_auto_skip ->
 	    %% test case skipped because of error in config function, or
 	    %% config function skipped because of error in info function
-	    %% Data = {Suite,Case,Comment} |
-	    %%        {Suite,{GroupConfigFunc,GroupName},Comment} 
+	    %% Data = {Suite,{Func,GroupName},Comment}
 	    {Func,Data1} = case Data of
-			       {Suite,{ConfigFunc,undefined},Cmt} ->
-				   {ConfigFunc,{Suite,ConfigFunc,Cmt}};
-			       {_,{ConfigFunc,_},_} -> {ConfigFunc,Data};
-			       {_,Case,_} -> {Case,Data}
+			       {Suite,{F,undefined},Comment} ->
+				   {F,{Suite,F,Comment}};
+			       D = {_,{F,_},_} ->
+				   {F,D}
 			   end,
 	    %% this test case does not have a log, so printouts
 	    %% from event handlers should end up in the main log
@@ -1364,7 +1367,6 @@ report(What,Data) ->
 					node=node(),
 					data=Data1}),
 	    ct_hooks:on_tc_skip(What, Data1),
-
 	    if Func /= end_per_suite, 
 	       Func /= end_per_group ->
 		    add_to_stats(auto_skipped);
diff --git a/lib/common_test/src/ct_hooks.erl b/lib/common_test/src/ct_hooks.erl
index e845e9e908..2e667030a9 100644
--- a/lib/common_test/src/ct_hooks.erl
+++ b/lib/common_test/src/ct_hooks.erl
@@ -121,9 +121,11 @@ end_tc(_Mod, TC, Config, Result, _Return) ->
     call(fun call_generic/3, Result, [post_end_per_testcase, TC, Config],
 	'$ct_no_change').
 
+%% Case = TestCase | {TestCase,GroupName}
 on_tc_skip(How, {Suite, Case, Reason}) ->
     call(fun call_cleanup/3, {How, Reason}, [on_tc_skip, Suite, Case]).
 
+%% Case = TestCase | {TestCase,GroupName}
 on_tc_fail(_How, {Suite, Case, Reason}) ->
     call(fun call_cleanup/3, Reason, [on_tc_fail, Suite, Case]).