Add support for config info functions (e.g. init_per_suite/0)

Also fixed bug: return value {fail,Reason} from end_tc(init_per_suite) was ignored.

5 files changed, 315 insertions, 13 deletions

diff --git a/lib/common_test/src/ct_framework.erl b/lib/common_test/src/ct_framework.erl
index 60978209b3..3dd1026f13 100644
--- a/lib/common_test/src/ct_framework.erl
+++ b/lib/common_test/src/ct_framework.erl
@@ -161,6 +161,7 @@ init_tc2(Mod,Func,SuiteInfo,MergeResult,Config,DoInit) ->
 	    _ ->
 		MergeResult
 	end,
+
     %% timetrap must be handled before require
     MergedInfo1 = timetrap_first(MergedInfo, [], []),
     %% tell logger to use specified style sheet
@@ -244,8 +245,8 @@ add_defaults(Mod,Func,FuncInfo,DoInit) ->
 	_ ->
 	    {suite0_failed,bad_return_value}
     end.
-    
-add_defaults1(_Mod,init_per_suite,[],SuiteInfo,_) ->
+
+add_defaults1(_Mod,init_per_suite,[],SuiteInfo,_DoInit) ->
     SuiteInfo;
 
 add_defaults1(Mod,Func,FuncInfo,SuiteInfo,DoInit) ->
@@ -253,15 +254,27 @@ add_defaults1(Mod,Func,FuncInfo,SuiteInfo,DoInit) ->
     %% can result in weird behaviour (suite values get overwritten)
     SuiteReqs = 
 	[SDDef || SDDef <- SuiteInfo,
-		  require == element(1,SDDef)],
-    case [element(2,Clash) || Clash <- SuiteReqs, 
-	  true == lists:keymember(element(2,Clash),2,FuncInfo)] of
+		  ((require == element(1,SDDef)) or
+		   (default_config == element(1,SDDef)))],
+    FuncReqs =
+	[FIDef || FIDef <- FuncInfo,
+		  require == element(1,FIDef)],
+    case [element(2,Clash) || Clash <- SuiteReqs,
+			      require == element(1, Clash),
+			      true == lists:keymember(element(2,Clash),2,
+						      FuncReqs)] of
 	[] ->
 	    add_defaults2(Mod,Func,FuncInfo,SuiteInfo,SuiteReqs,DoInit);
 	Clashes ->
 	    {error,{config_name_already_in_use,Clashes}}
     end.
 
+add_defaults2(Mod,init_per_suite,IPSInfo,SuiteInfo,SuiteReqs,false) ->
+    %% not common practise to use a test case info function for
+    %% init_per_suite (usually handled by suite/0), but let's support
+    %% it just in case...
+    add_defaults2(Mod,init_per_suite,IPSInfo,SuiteInfo,SuiteReqs,true);
+
 add_defaults2(_Mod,_Func,FuncInfo,SuiteInfo,_,false) ->
     %% include require elements from test case info, but not from suite/0
     %% (since we've already required those vars)
diff --git a/lib/common_test/test/ct_error_SUITE.erl b/lib/common_test/test/ct_error_SUITE.erl
index 11482f1508..199a1ad97a 100644
--- a/lib/common_test/test/ct_error_SUITE.erl
+++ b/lib/common_test/test/ct_error_SUITE.erl
@@ -87,7 +87,9 @@ cfg_error(Config) when is_list(Config) ->
 	      Join(DataDir, "cfg_error_6_SUITE"),
 	      Join(DataDir, "cfg_error_7_SUITE"),
 	      Join(DataDir, "cfg_error_8_SUITE"),
-	      Join(DataDir, "cfg_error_9_SUITE")
+	      Join(DataDir, "cfg_error_9_SUITE"),
+	      Join(DataDir, "cfg_error_10_SUITE"),
+	      Join(DataDir, "cfg_error_11_SUITE")
 	     ],
     {Opts,ERPid} = setup([{suite,Suites}], Config),
     ok = ct_test_support:run(Opts, Config),
@@ -228,7 +230,7 @@ test_events(cfg_error) ->
     [
      {?eh,start_logging,{'DEF','RUNDIR'}},
      {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
-     {?eh,start_info,{9,9,33}},
+     {?eh,start_info,{11,11,36}},
 
      {?eh,tc_start,{cfg_error_1_SUITE,init_per_suite}},
      {?eh,tc_done,
@@ -540,6 +542,28 @@ test_events(cfg_error) ->
      {?eh,tc_start,{cfg_error_9_SUITE,end_per_suite}},
      {?eh,tc_done,{cfg_error_9_SUITE,end_per_suite,ok}},
 
+     {?eh,tc_start,{cfg_error_10_SUITE,init_per_suite}},
+     {?eh,tc_done,{cfg_error_10_SUITE,init_per_suite,
+		   {failed,{error,fail_init_per_suite}}}},
+     {?eh,tc_auto_skip,{cfg_error_10_SUITE,tc1,
+			{failed,{cfg_error_10_SUITE,init_per_suite,
+				 {failed,fail_init_per_suite}}}}},
+     {?eh,test_stats,{12,3,{0,19}}},
+     {?eh,tc_auto_skip,{cfg_error_10_SUITE,end_per_suite,
+			{failed,{cfg_error_10_SUITE,init_per_suite,
+				 {failed,fail_init_per_suite}}}}},
+     {?eh,tc_start,{cfg_error_11_SUITE,init_per_suite}},
+     {?eh,tc_done,{cfg_error_11_SUITE,init_per_suite,ok}},
+     {?eh,tc_start,{cfg_error_11_SUITE,tc1}},
+     {?eh,tc_done,{cfg_error_11_SUITE,tc1,
+		   {skipped,{config_name_already_in_use,[dummy0]}}}},
+     {?eh,test_stats,{12,3,{1,19}}},
+     {?eh,tc_start,{cfg_error_11_SUITE,tc2}},
+     {?eh,tc_done,{cfg_error_11_SUITE,tc2,ok}},
+     {?eh,test_stats,{13,3,{1,19}}},
+     {?eh,tc_start,{cfg_error_11_SUITE,end_per_suite}},
+     {?eh,tc_done,{cfg_error_11_SUITE,end_per_suite,ok}},
+
      {?eh,test_done,{'DEF','STOP_TIME'}},
      {?eh,stop_logging,[]}
     ];
diff --git a/lib/common_test/test/ct_error_SUITE_data/error/test/cfg_error_10_SUITE.erl b/lib/common_test/test/ct_error_SUITE_data/error/test/cfg_error_10_SUITE.erl
new file mode 100644
index 0000000000..3bb2f63d34
--- /dev/null
+++ b/lib/common_test/test/ct_error_SUITE_data/error/test/cfg_error_10_SUITE.erl
@@ -0,0 +1,123 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2009-2010. 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%
+%%
+-module(cfg_error_10_SUITE).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+
+%%--------------------------------------------------------------------
+%% Function: suite() -> Info
+%% Info = [tuple()]
+%%--------------------------------------------------------------------
+suite() ->
+    [{timetrap,{seconds,2}},
+     {require, dummy0}, {default_config, dummy0, "suite/0"},
+     {require, dummy1}, {default_config, dummy1, "suite/0"},
+     {require, dummy2}, {default_config, dummy2, "suite/0"}].
+
+%%--------------------------------------------------------------------
+%% Function: init_per_suite(Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%%--------------------------------------------------------------------
+init_per_suite() ->
+    put('$test_server_framework_test',
+	fun(init_tc, _Default) -> {fail,fail_init_per_suite};
+	   (_, Default) -> Default
+	end),
+    [{require, dummy3}, {default_config, dummy3, "init_per_suite/0"},
+     {timetrap,3000}].
+
+init_per_suite(Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% Function: end_per_suite(Config0) -> void() | {save_config,Config1}
+%% Config0 = Config1 = [tuple()]
+%%--------------------------------------------------------------------
+end_per_suite(Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Function: init_per_group(GroupName, Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% GroupName = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%%--------------------------------------------------------------------
+init_per_group(_GroupName, Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% Function: end_per_group(GroupName, Config0) ->
+%%               void() | {save_config,Config1}
+%% GroupName = atom()
+%% Config0 = Config1 = [tuple()]
+%%--------------------------------------------------------------------
+end_per_group(_GroupName, _Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Function: init_per_testcase(TestCase, Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%%--------------------------------------------------------------------
+init_per_testcase(_, Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% Function: end_per_testcase(TestCase, Config0) ->
+%%               void() | {save_config,Config1}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%%--------------------------------------------------------------------
+end_per_testcase(_TestCase, _Config) ->
+    done.
+
+%%--------------------------------------------------------------------
+%% Function: groups() -> [Group]
+%% Group = {GroupName,Properties,GroupsAndTestCases}
+%% GroupName = atom()
+%% Properties = [parallel | sequence | Shuffle | {RepeatType,N}]
+%% GroupsAndTestCases = [Group | {group,GroupName} | TestCase]
+%% TestCase = atom()
+%% Shuffle = shuffle | {shuffle,{integer(),integer(),integer()}}
+%% RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail |
+%%              repeat_until_any_ok | repeat_until_any_fail
+%% N = integer() | forever
+%%--------------------------------------------------------------------
+groups() ->
+    [].
+
+%%--------------------------------------------------------------------
+%% Function: all() -> GroupsAndTestCases | {skip,Reason}
+%% GroupsAndTestCases = [{group,GroupName} | TestCase]
+%% GroupName = atom()
+%% TestCase = atom()
+%% Reason = term()
+%%--------------------------------------------------------------------
+all() ->
+    [tc1].
+
+tc1(_) ->
+    exit(should_never_run).
diff --git a/lib/common_test/test/ct_error_SUITE_data/error/test/cfg_error_11_SUITE.erl b/lib/common_test/test/ct_error_SUITE_data/error/test/cfg_error_11_SUITE.erl
new file mode 100644
index 0000000000..224e83620e
--- /dev/null
+++ b/lib/common_test/test/ct_error_SUITE_data/error/test/cfg_error_11_SUITE.erl
@@ -0,0 +1,134 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2009-2010. 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%
+%%
+-module(cfg_error_11_SUITE).
+
+-compile(export_all).
+
+-include_lib("common_test/include/ct.hrl").
+
+%%--------------------------------------------------------------------
+%% Function: suite() -> Info
+%% Info = [tuple()]
+%%--------------------------------------------------------------------
+suite() ->
+    [{timetrap,{seconds,2}},
+     {require, dummy0}, {default_config, dummy0, "suite/0"},
+     {require, dummy1}, {default_config, dummy1, "suite/0"},
+     {require, dummy2}, {default_config, dummy2, "suite/0"}].
+
+
+
+%%--------------------------------------------------------------------
+%% Function: init_per_suite(Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%%--------------------------------------------------------------------
+init_per_suite(Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% Function: end_per_suite(Config0) -> void() | {save_config,Config1}
+%% Config0 = Config1 = [tuple()]
+%%--------------------------------------------------------------------
+end_per_suite() ->
+    put('$test_server_framework_test',
+	fun(end_tc, _Default) -> {fail,fail_end_per_suite};
+	   (_, Default) -> Default
+	end),
+    [{require, dummy3}, {default_config, dummy3, "end_per_suite/0"},
+     {timetrap,3000}].
+
+end_per_suite(_Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Function: init_per_group(GroupName, Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% GroupName = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%%--------------------------------------------------------------------
+init_per_group(_GroupName, Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% Function: end_per_group(GroupName, Config0) ->
+%%               void() | {save_config,Config1}
+%% GroupName = atom()
+%% Config0 = Config1 = [tuple()]
+%%--------------------------------------------------------------------
+end_per_group(_GroupName, _Config) ->
+    ok.
+
+%%--------------------------------------------------------------------
+%% Function: init_per_testcase(TestCase, Config0) ->
+%%               Config1 | {skip,Reason} | {skip_and_save,Reason,Config1}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%% Reason = term()
+%%--------------------------------------------------------------------
+init_per_testcase(_, Config) ->
+    Config.
+
+%%--------------------------------------------------------------------
+%% Function: end_per_testcase(TestCase, Config0) ->
+%%               void() | {save_config,Config1}
+%% TestCase = atom()
+%% Config0 = Config1 = [tuple()]
+%%--------------------------------------------------------------------
+end_per_testcase(_TestCase, _Config) ->
+    done.
+
+%%--------------------------------------------------------------------
+%% Function: groups() -> [Group]
+%% Group = {GroupName,Properties,GroupsAndTestCases}
+%% GroupName = atom()
+%% Properties = [parallel | sequence | Shuffle | {RepeatType,N}]
+%% GroupsAndTestCases = [Group | {group,GroupName} | TestCase]
+%% TestCase = atom()
+%% Shuffle = shuffle | {shuffle,{integer(),integer(),integer()}}
+%% RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail |
+%%              repeat_until_any_ok | repeat_until_any_fail
+%% N = integer() | forever
+%%--------------------------------------------------------------------
+groups() ->
+    [].
+
+%%--------------------------------------------------------------------
+%% Function: all() -> GroupsAndTestCases | {skip,Reason}
+%% GroupsAndTestCases = [{group,GroupName} | TestCase]
+%% GroupName = atom()
+%% TestCase = atom()
+%% Reason = term()
+%%--------------------------------------------------------------------
+all() ->
+    [tc1, tc2].
+
+tc1() ->
+    [{require, dummy0}, {default_config, dummy0, "tc1"}].
+
+tc1(_) ->
+    dummy.
+
+tc2() ->
+    [{timetrap,1}].
+
+tc2(_) ->
+    dummy.
diff --git a/lib/test_server/src/test_server.erl b/lib/test_server/src/test_server.erl
index 444af0c0d7..b70ac08622 100644
--- a/lib/test_server/src/test_server.erl
+++ b/lib/test_server/src/test_server.erl
@@ -1171,10 +1171,14 @@ process_return_val(Return, M,F,A, Loc, Final) ->
 process_return_val1([Failed={E,TCError}|_], M,F,A=[Args], Loc, _, SaveOpts) when E=='EXIT';
 										 E==failed ->
     fw_error_notify(M,F,A, TCError, mod_loc(Loc)),
-    test_server_sup:framework_call(end_tc,
-				   [?pl2a(M),F,{{error,TCError},
-						[[{tc_status,{failed,TCError}}|Args]]}]),
-    {Failed,SaveOpts};
+    case test_server_sup:framework_call(end_tc,
+					[?pl2a(M),F,{{error,TCError},
+						     [[{tc_status,{failed,TCError}}|Args]]}]) of
+	{fail,FWReason} ->
+	    {{failed,FWReason},SaveOpts};
+	_ ->
+	    {Failed,SaveOpts}
+    end;
 process_return_val1([SaveCfg={save_config,_}|Opts], M,F,[Args], Loc, Final, SaveOpts) ->
     process_return_val1(Opts, M,F,[[SaveCfg|Args]], Loc, Final, SaveOpts);
 process_return_val1([{skip_and_save,Why,SaveCfg}|Opts], M,F,[Args], Loc, _, SaveOpts) ->
@@ -1187,8 +1191,12 @@ process_return_val1([RetVal={Tag,_}|Opts], M,F,A, Loc, _, SaveOpts) when Tag==sk
 process_return_val1([_|Opts], M,F,A, Loc, Final, SaveOpts) ->
     process_return_val1(Opts, M,F,A, Loc, Final, SaveOpts);
 process_return_val1([], M,F,A, _Loc, Final, SaveOpts) ->
-    test_server_sup:framework_call(end_tc, [?pl2a(M),F,{Final,A}]),
-    {Final,lists:reverse(SaveOpts)}.
+    case test_server_sup:framework_call(end_tc, [?pl2a(M),F,{Final,A}]) of
+	{fail,FWReason} ->
+	    {{failed,FWReason},SaveOpts};
+	_ ->
+	    {Final,lists:reverse(SaveOpts)}
+    end.
 
 user_callback(undefined, _, _, _, Args) ->
     Args;