Add testcases for multiple SCBs and unexisting SCBs

2 files changed, 324 insertions, 12 deletions

diff --git a/lib/common_test/test/ct_suite_callback_SUITE.erl b/lib/common_test/test/ct_suite_callback_SUITE.erl
index 7a8ad9a82e..f8a111d28c 100644
--- a/lib/common_test/test/ct_suite_callback_SUITE.erl
+++ b/lib/common_test/test/ct_suite_callback_SUITE.erl
@@ -71,7 +71,7 @@ all() ->
 
 all(suite) -> 
     [
-     empty
+     one_scb, two_scb, faulty_scb_no_init
     ].
      
 
@@ -81,25 +81,38 @@ all(suite) ->
 
 %%%-----------------------------------------------------------------
 %%% 
-empty(Config) when is_list(Config) -> 
+one_scb(Config) when is_list(Config) -> 
+    do_test(one_empty_scb, "ct_scb_empty_SUITE.erl",[empty_scb], Config).
+
+two_scb(Config) when is_list(Config) -> 
+    do_test(two_empty_scb, "ct_scb_empty_SUITE.erl",[empty_scb,empty_scb],
+	    Config).
+
+faulty_scb_no_init(Config) when is_list(Config) ->
+    do_test(faulty_scb_no_init, "ct_scb_empty_SUITE.erl",[askjhdkljashdkaj],
+	   Config).
+
+%%%-----------------------------------------------------------------
+%%% HELP FUNCTIONS
+%%%-----------------------------------------------------------------
+
+do_test(Tag, SuiteWildCard, SCBs, Config) ->
+    
     DataDir = ?config(data_dir, Config),
-    Suites = [filename:join(DataDir,"scb/tests/ct_scb_empty_SUITE.erl")],
+    Suites = filelib:wildcard(
+	       filename:join([DataDir,"scb/tests",SuiteWildCard])),
     {Opts,ERPid} = setup([{suite,Suites},
-			  {suite_callbacks,[empty_scb]}], Config),
+			  {suite_callbacks,SCBs}], Config),
     ok = ct_test_support:run(Opts, Config),
     Events = ct_test_support:get_events(ERPid, Config),
 
-    ct_test_support:log_events(empty_scb, 
+    ct_test_support:log_events(Tag, 
 			       reformat(Events, ?eh), 
 			       ?config(priv_dir, Config)),
 
-    TestEvents = events_to_check(empty),
+    TestEvents = events_to_check(Tag),
     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),
@@ -125,7 +138,7 @@ events_to_check(_, 0) ->
 events_to_check(Test, N) ->
     test_events(Test) ++ events_to_check(Test, N-1).
 
-test_events(empty) ->
+test_events(one_empty_scb) ->
     [
      {?eh,start_logging,{'DEF','RUNDIR'}},
      {?eh,scb,{empty_scb,init,[[]]}},
@@ -147,4 +160,55 @@ test_events(empty) ->
      {?eh,test_done,{'DEF','STOP_TIME'}},
      {?eh,scb,{empty_scb,terminate,[[]]}},
      {?eh,stop_logging,[]}
-    ].
+    ];
+
+test_events(two_empty_scb) ->
+    [
+     {?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,scb,{empty_scb,init,[[]]}},
+     {?eh,scb,{empty_scb,init,[[]]}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,tc_start,{ct_scb_empty_SUITE,init_per_suite}},
+     {?eh,scb,{empty_scb,pre_init_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,scb,{empty_scb,pre_init_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,scb,{empty_scb,post_init_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,scb,{empty_scb,post_init_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,tc_done,{ct_scb_empty_SUITE,init_per_suite,ok}},
+
+     {?eh,tc_start,{ct_scb_empty_SUITE,test_case}},
+     {?eh,scb,{empty_scb,pre_init_per_testcase,[test_case,[]]}},
+     {?eh,scb,{empty_scb,pre_init_per_testcase,[test_case,[]]}},
+     {?eh,scb,{empty_scb,post_end_per_testcase,[test_case,[]]}},
+     {?eh,scb,{empty_scb,post_end_per_testcase,[test_case,[]]}},
+     {?eh,tc_done,{ct_scb_empty_SUITE,test_case,ok}},
+     
+     {?eh,tc_start,{ct_scb_empty_SUITE,end_per_suite}},
+     {?eh,scb,{empty_scb,pre_end_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,scb,{empty_scb,pre_end_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,scb,{empty_scb,post_end_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,scb,{empty_scb,post_end_per_suite,[ct_scb_empty_SUITE,[]]}},
+     {?eh,tc_done,{ct_scb_empty_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,scb,{empty_scb,terminate,[[]]}},
+     {?eh,scb,{empty_scb,terminate,[[]]}},
+     {?eh,stop_logging,[]}
+    ];
+
+test_events(faulty_scb_no_init) ->
+    [
+     {?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,tc_start,{ct_scb_empty_SUITE,init_per_suite}},
+     {?eh,tc_done,{ct_scb_empty_SUITE,init_per_suite,ok}},
+
+     {?eh,tc_start,{ct_scb_empty_SUITE,test_case}},
+     {?eh,tc_done,{ct_scb_empty_SUITE,test_case,ok}},
+     
+     {?eh,tc_start,{ct_scb_empty_SUITE,end_per_suite}},
+     {?eh,tc_done,{ct_scb_empty_SUITE,end_per_suite,ok}},
+     {?eh,test_done,{'DEF','STOP_TIME'}},
+     {?eh,stop_logging,[]}
+    ];
+
+test_events(ok) ->
+    ok.
diff --git a/lib/common_test/test/ct_suite_callback_SUITE_data/scb/tests/empty_scb.erl b/lib/common_test/test/ct_suite_callback_SUITE_data/scb/tests/empty_scb.erl
new file mode 100644
index 0000000000..1b8979ee4b
--- /dev/null
+++ b/lib/common_test/test/ct_suite_callback_SUITE_data/scb/tests/empty_scb.erl
@@ -0,0 +1,248 @@
+%%

+%% %CopyrightBegin%

+%%

+%% Copyright Ericsson AB 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%

+%%

+

+%%% @doc Common Test Example Suite Callback module.

+%%%

+%%% <p>This module gives an example of a common test SCB (Suite CallBack).

+%%% There are many ways to add a SCB to a test run, you can do it either in

+%%% the command line using -suite_callback, in a test spec using

+%%% {suite_callback,M} or in the suite it self by returning suite_callback

+%%% from either suite/0, init_per_suite/1, init_per_group/2 and

+%%% init_per_testcase/2. The scope of the SCB is determined by where is it

+%%% started. If it is started in the command line or test spec then it will

+%%% be stopped at the end of all tests. If it is started in init_per_suite,

+%%% it will be stopped after end_per_suite and so on. See terminate

+%%% documentation for a table describing the scoping machanics. 

+%%%

+%%% All of callbacks except init/1 in a SCB are optional.</p>

+

+-module(empty_scb).

+

+%% Suite Callbacks

+-export([init/1]).

+

+-export([pre_init_per_suite/3]).

+-export([post_init_per_suite/3]).

+-export([pre_end_per_suite/3]).

+-export([post_end_per_suite/3]).

+

+-export([pre_init_per_group/3]).

+-export([post_init_per_group/3]).

+-export([pre_end_per_group/3]).

+-export([post_end_per_group/3]).

+

+-export([pre_init_per_testcase/3]).

+-export([post_end_per_testcase/3]).

+

+-export([on_tc_fail/3]).

+

+-export([terminate/1]).

+

+-include_lib("common_test/src/ct_util.hrl").

+-include_lib("common_test/include/ct_event.hrl").

+

+-type proplist() :: list({atom(),term()}).

+-type config() :: proplist().

+-type reason() :: term().

+-type skip_or_fail() :: {skip, reason()} |

+                        {auto_skip, reason()} |

+                        {fail, reason()}.

+

+-record(state, { id = ?MODULE :: term()}).

+

+%% @doc Always called before any other callback function. Use this to initiate

+%% any common state. It should return an ID for this SCB and a state. The ID

+%% is used to uniquly identify an SCB instance, if two SCB's return the same

+%% ID the seconds SCB is ignored. This function should NOT have any side

+%% effects as it might be called multiple times by common test.

+-spec init(Opts :: proplist()) ->

+    {Id :: term(), State :: #state{}}.

+init(Opts) ->

+    gen_event:notify(?CT_EVMGR_REF, #event{ name = scb, node = node(),

+					    data = {?MODULE, init, [Opts]}}),

+    {now(), Opts}.

+

+%% @doc Called before init_per_suite is called. Note that this callback is

+%% only called if the SCB is added before init_per_suite is run (eg. in a test

+%% specification, suite/0 function etc).

+%% You can change the config in the this function.

+-spec pre_init_per_suite(Suite :: atom(),

+		     Config :: config(),

+		     State :: #state{}) ->

+    {config() | skip_or_fail(), NewState :: #state{}}.

+pre_init_per_suite(Suite,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, pre_init_per_suite,

+				     [Suite,State]}}),

+    {Config, State}.

+

+%% @doc Called after init_per_suite.

+%% you can change the config in this function.

+-spec post_init_per_suite(Suite :: atom(),

+		      Config :: config(),

+		      State :: #state{}) ->

+    {config() | skip_or_fail(), NewState :: #state{}}.

+post_init_per_suite(Suite,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, post_init_per_suite,

+				     [Suite,State]}}),

+    {Config, State}.

+

+%% @doc Called before end_per_suite. Note that the config cannot be

+%% changed here, only the status of the suite.

+-spec pre_end_per_suite(Suite :: atom(),

+		    Config :: config(),

+		    State :: #state{}) ->

+    {ok | skip_or_fail(), NewState :: #state{}}.

+pre_end_per_suite(Suite,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, pre_end_per_suite,

+				     [Suite,State]}}),

+    {Config, State}.

+

+%% @doc Called after end_per_suite. Note that the config cannot be

+%% changed here, only the status of the suite.

+-spec post_end_per_suite(Suite :: atom(),

+		     Config :: config(),

+		     State :: #state{}) ->

+    {ok | skip_or_fail(), NewState :: #state{}}.

+post_end_per_suite(Suite,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, post_end_per_suite,

+				     [Suite,State]}}),

+    {Config, State}.

+

+%% @doc Called before each init_per_group.

+%% You can change the config in this function.

+-spec pre_init_per_group(Group :: atom(),

+		     Config :: config(),

+		     State :: #state{}) ->

+    {config() | skip_or_fail(), NewState :: #state{}}.

+pre_init_per_group(Group,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, pre_init_per_group,

+				     [Group,State]}}),

+    {Config, State}.

+

+%% @doc Called after each init_per_group.

+%% You can change the config in this function.

+-spec post_init_per_group(Group :: atom(),

+		      Config :: config(),

+		      State :: #state{}) ->

+    {config() | skip_or_fail(), NewState :: #state{}}.

+post_init_per_group(Group,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, post_init_per_group,

+				     [Group,State]}}),

+    {Config, State}.

+

+%% @doc Called after each end_per_group. Note that the config cannot be

+%% changed here, only the status of the group.

+-spec pre_end_per_group(Group :: atom(),

+		    Config :: config(),

+		    State :: #state{}) ->

+    {ok | skip_or_fail(), NewState :: #state{}}.

+pre_end_per_group(Group,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, pre_end_per_group,

+				     [Group,State]}}),

+    {Config, State}.

+

+%% @doc Called after each end_per_group. Note that the config cannot be

+%% changed here, only the status of the group.

+-spec post_end_per_group(Group :: atom(),

+		     Config :: config(),

+		     State :: #state{}) ->

+    {ok | skip_or_fail(), NewState :: #state{}}.

+post_end_per_group(Group,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, post_end_per_group,

+				     [Group,State]}}),

+    {Config, State}.

+

+%% @doc Called before each test case.

+%% You can change the config in this function.

+-spec pre_init_per_testcase(TC :: atom(),

+		  Config :: config(),

+		  State :: #state{}) ->

+    {config() | skip_or_fail(), NewState :: #state{}}.

+pre_init_per_testcase(TC,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, pre_init_per_testcase,

+				     [TC,State]}}),

+    {Config, State}.

+

+%% @doc Called after each test case. Note that the config cannot be

+%% changed here, only the status of the test case.

+-spec post_end_per_testcase(TC :: atom(),

+		  Config :: config(),

+		  State :: #state{}) ->

+    {ok | skip_or_fail(), NewState :: #state{}}.

+post_end_per_testcase(TC,Config,State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, post_end_per_testcase,

+				     [TC,State]}}),

+    {Config, State}.

+

+%% @doc Called after post_init_per_suite, post_end_per_suite, post_init_per_group,

+%% post_end_per_group and post_end_per_tc if the suite, group or test case failed.

+%% This function should be used for extra cleanup which might be needed.

+%% It is not possible to modify the config or the status of the test run.

+-spec on_tc_fail(TC :: init_per_suite | end_per_suite |

+		 init_per_group | end_per_group | atom(),

+		 Config :: config(), State :: #state{}) ->

+    ok.

+on_tc_fail(TC, Config, State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, on_tc_fail,

+				     [TC,State]}}),

+    ok.

+

+%% @doc Called when the scope of the SCB is done, this depends on

+%% when the SCB was specified. This translation table describes when this

+%% function is called.

+%%

+%%  | Started in          |     terminate called    |

+%%  |---------------------|-------------------------|

+%%  | command_line        | after all tests are run |

+%%  | test spec           | after all tests are run |

+%%  | suite/0             | after SUITE is done     |

+%%  | init_per_suite/1    | after SUITE is done     |

+%%  | init_per_group/2    | after group is done     |

+%%  | init_per_testcase/2 | after test case is done |

+%%  |-----------------------------------------------|

+%%

+-spec terminate(State :: #state{}) ->

+    term().

+terminate(State) ->

+    gen_event:notify(

+      ?CT_EVMGR_REF, #event{ name = scb, node = node(),

+			     data = {?MODULE, terminate, [State]}}),

+    ok.