Merge branch 'dev' into major

* dev:
  Fix a couple of minor bugs with hook priority
  Update to reflect addition of CTH priority addition
  Update CTH priority default to be 0
  Update to reflect new cth callback api
  Update the return from init/2 to be {ok, NewState} or {ok,NewState,Priority} instead of NewState.
  Add priority functionality and tests for ct hooks
  Update internal hooks state to use a record instead of tuples
  Improve and correct types and specifications in Kernel and STDLIB

5 files changed, 215 insertions, 7 deletions

diff --git a/lib/common_test/test/ct_hooks_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE.erl
index 8574d7aabc..5c99f0f9f7 100644
--- a/lib/common_test/test/ct_hooks_SUITE.erl
+++ b/lib/common_test/test/ct_hooks_SUITE.erl
@@ -83,7 +83,7 @@ all(suite) ->
        fail_post_suite_cth, skip_pre_suite_cth,
        skip_post_suite_cth, recover_post_suite_cth, update_config_cth,
        state_update_cth, options_cth, same_id_cth, 
-       fail_n_skip_with_minimal_cth
+       fail_n_skip_with_minimal_cth, prio_cth
       ]
     )
 	.
@@ -209,6 +209,11 @@ fail_n_skip_with_minimal_cth(Config) when is_list(Config) ->
     do_test(fail_n_skip_with_minimal_cth, "ct_cth_fail_one_skip_one_SUITE.erl",
 	    [minimal_terminate_cth],Config).
 
+prio_cth(Config) when is_list(Config) ->
+    do_test(prio_cth, "ct_cth_prio_SUITE.erl",
+	    [{empty_cth,[1000],1000},{empty_cth,[900],900},
+	     {prio_cth,[1100,100],100},{prio_cth,[1100]}],Config).
+
 %%%-----------------------------------------------------------------
 %%% HELP FUNCTIONS
 %%%-----------------------------------------------------------------
@@ -296,9 +301,9 @@ test_events(two_empty_cth) ->
      {?eh,start_logging,{'DEF','RUNDIR'}},
      {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
      {?eh,cth,{'_',id,[[]]}},
-     {?eh,cth,{'_',init,['_',[]]}},
      {?eh,cth,{'_',id,[[]]}},
      {?eh,cth,{'_',init,['_',[]]}},
+     {?eh,cth,{'_',init,['_',[]]}},
      {?eh,tc_start,{ct_cth_empty_SUITE,init_per_suite}},
      {?eh,cth,{'_',pre_init_per_suite,[ct_cth_empty_SUITE,'$proplist',[]]}},
      {?eh,cth,{'_',pre_init_per_suite,[ct_cth_empty_SUITE,'$proplist',[]]}},
@@ -365,9 +370,9 @@ test_events(minimal_and_maximal_cth) ->
     [
      {?eh,start_logging,{'DEF','RUNDIR'}},
      {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
+     {?eh,cth,{'_',id,[[]]}},
      {negative,{?eh,cth,{'_',id,['_',[]]}},
       {?eh,cth,{'_',init,['_',[]]}}},
-     {?eh,cth,{'_',id,[[]]}},
      {?eh,cth,{'_',init,['_',[]]}},
      {?eh,tc_start,{ct_cth_empty_SUITE,init_per_suite}},
      {?eh,cth,{'_',pre_init_per_suite,[ct_cth_empty_SUITE,'$proplist',[]]}},
@@ -954,8 +959,8 @@ test_events(same_id_cth) ->
      {?eh,start_logging,{'DEF','RUNDIR'}},
      {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}},
      {?eh,cth,{'_',id,[[]]}},
-     {?eh,cth,{'_',init,[same_id_cth,[]]}},
      {?eh,cth,{'_',id,[[]]}},
+     {?eh,cth,{'_',init,[same_id_cth,[]]}},
      {?eh,tc_start,{ct_cth_empty_SUITE,init_per_suite}},
      {?eh,cth,{'_',pre_init_per_suite,[ct_cth_empty_SUITE,'$proplist',[]]}},
      {negative,
@@ -1001,6 +1006,73 @@ test_events(fail_n_skip_with_minimal_cth) ->
      {?eh,stop_logging,[]}
     ];
 
+test_events(prio_cth) ->
+    
+    GenPre = fun(Func,States) ->
+		     [{?eh,cth,{'_',Func,['_','_',State]}} || 
+			 State <- States]
+	     end,
+
+    GenPost = fun(Func,States) ->
+		      [{?eh,cth,{'_',Func,['_','_','_',State]}} || 
+			  State <- States]
+	     end,
+    
+    [{?eh,start_logging,{'DEF','RUNDIR'}},
+     {?eh,test_start,{'DEF',{'START_TIME','LOGDIR'}}}] ++
+
+	[{?eh,tc_start,{ct_cth_prio_SUITE,init_per_suite}}] ++
+	GenPre(pre_init_per_suite,
+	       [[1100,100],[800],[900],[1000],[1200,1050],[1100],[1200]]) ++
+	GenPost(post_init_per_suite,
+		[[1100,100],[600,200],[600,600],[700],[800],[900],[1000],
+		 [1200,1050],[1100],[1200]]) ++
+	[{?eh,tc_done,{ct_cth_prio_SUITE,init_per_suite,ok}},
+	 
+
+	 [{?eh,tc_start,{ct_cth_prio_SUITE,{init_per_group,'_',[]}}}] ++
+	     GenPre(pre_init_per_group,
+		    [[1100,100],[600,200],[600,600],[700],[800],
+		     [900],[1000],[1200,1050],[1100],[1200]]) ++
+	     GenPost(post_init_per_group,
+		     [[1100,100],[600,200],[600,600],[600],[700],[800],
+		      [900],[900,900],[500,900],[1000],[1200,1050],
+		      [1100],[1200]]) ++
+	     [{?eh,tc_done,{ct_cth_prio_SUITE,{init_per_group,'_',[]},ok}}] ++
+	 
+	     [{?eh,tc_start,{ct_cth_prio_SUITE,test_case}}] ++
+	     GenPre(pre_init_per_testcase,
+		    [[1100,100],[600,200],[600,600],[600],[700],[800],
+		     [900],[900,900],[500,900],[1000],[1200,1050],
+		     [1100],[1200]]) ++
+	     GenPost(post_end_per_testcase,
+		     [[1100,100],[600,200],[600,600],[600],[700],[800],
+		      [900],[900,900],[500,900],[1000],[1200,1050],
+		      [1100],[1200]]) ++
+	     [{?eh,tc_done,{ct_cth_prio_SUITE,test_case,ok}},
+
+	      {?eh,tc_start,{ct_cth_prio_SUITE,{end_per_group,'_',[]}}}] ++
+	     GenPre(pre_end_per_group, 
+		    [[1100,100],[600,200],[600,600],[600],[700],[800],
+		     [900],[900,900],[500,900],[1000],[1200,1050],
+		     [1100],[1200]]) ++
+	     GenPost(post_end_per_group,
+		     [[1100,100],[600,200],[600,600],[600],[700],[800],
+		      [900],[900,900],[500,900],[1000],[1200,1050],
+		      [1100],[1200]]) ++
+	     [{?eh,tc_done,{ct_cth_prio_SUITE,{end_per_group,'_',[]},ok}}],
+
+	 {?eh,tc_start,{ct_cth_prio_SUITE,end_per_suite}}] ++
+	GenPre(pre_end_per_suite,
+	       [[1100,100],[600,200],[600,600],[700],[800],[900],[1000],
+		[1200,1050],[1100],[1200]]) ++
+	GenPost(post_end_per_suite,
+		[[1100,100],[600,200],[600,600],[700],[800],[900],[1000],
+		[1200,1050],[1100],[1200]]) ++
+	[{?eh,tc_done,{ct_cth_prio_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_hooks_SUITE_data/cth/tests/ct_cth_prio_SUITE.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_cth_prio_SUITE.erl
new file mode 100644
index 0000000000..d564398cd0
--- /dev/null
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_cth_prio_SUITE.erl
@@ -0,0 +1,62 @@
+%%

+%% %CopyrightBegin%

+%%

+%% Copyright Ericsson AB 2010-2011. 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(ct_cth_prio_SUITE).

+

+%% Note: This directive should only be used in test suites.

+-compile(export_all).

+

+-include("ct.hrl").

+

+suite() ->

+    ([{timetrap, {minutes, 10}},

+      {ct_hooks, [{empty_cth,[800],800},

+		  {prio_cth,[1200]},{prio_cth,[1200,1050],1050}]}]).

+

+%% Test server callback functions

+init_per_suite(Config) ->

+    [{ct_hooks, [{empty_cth,[700],700},

+		 {prio_cth,[600,600]},

+		 {prio_cth,[600,200],200}]}|Config].

+

+end_per_suite(_Config) ->

+    ok.

+

+init_per_group(_G, Config) ->

+    [{ct_hooks, [{empty_cth,[600],600},

+		 {prio_cth,[900,900]},{prio_cth,[500,900],900}]}|Config].

+

+end_per_group(_G, _Config) ->

+    ok.

+

+init_per_testcase(_TestCase, Config) ->

+    Config.

+

+end_per_testcase(_TestCase, _Config) ->

+    ok.

+

+all() ->

+    [{group,test_group}].

+

+groups() ->

+    [{test_group,[],[test_case]}].

+

+%% Test cases starts here.

+test_case(Config) when is_list(Config) ->

+    ok.

diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
index 71ed61b4c0..7befcfa57c 100644
--- a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
@@ -71,11 +71,11 @@
 %% @doc Always called before any other callback function. Use this to initiate

 %% any common state. It should return an state for this CTH.

 -spec init(Id :: term(), Opts :: proplists:proplist()) ->
-    State :: #state{}.

+    {ok, State :: #state{}}.

 init(Id, Opts) ->

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

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

-    Opts.

+    {ok,Opts}.

 

 %% @doc The ID is used to uniquly identify an CTH instance, if two CTH's 

 %% return the same ID the seconds CTH is ignored. This function should NOT 

diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/prio_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/prio_cth.erl
new file mode 100644
index 0000000000..82511ab0d3
--- /dev/null
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/prio_cth.erl
@@ -0,0 +1,74 @@
+%%

+%% %CopyrightBegin%

+%%

+%% Copyright Ericsson AB 2010-2011. 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(prio_cth).

+

+

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

+

+

+%% CT Hooks

+-compile(export_all).

+

+id(Opts) ->

+    empty_cth:id(Opts).

+

+init(Id, Opts) ->

+    {ok, [Prio|_] = State} = empty_cth:init(Id, Opts),

+    {ok, State, Prio}.

+

+pre_init_per_suite(Suite, Config, State) ->

+    empty_cth:pre_init_per_suite(Suite,Config,State).

+

+post_init_per_suite(Suite,Config,Return,State) ->

+    empty_cth:post_init_per_suite(Suite,Config,Return,State).

+

+pre_end_per_suite(Suite,Config,State) ->

+    empty_cth:pre_end_per_suite(Suite,Config,State).

+

+post_end_per_suite(Suite,Config,Return,State) ->

+    empty_cth:post_end_per_suite(Suite,Config,Return,State).

+

+pre_init_per_group(Group,Config,State) ->

+    empty_cth:pre_init_per_group(Group,Config,State).

+

+post_init_per_group(Group,Config,Return,State) ->

+    empty_cth:post_init_per_group(Group,Config,Return,State).

+

+pre_end_per_group(Group,Config,State) ->

+    empty_cth:pre_end_per_group(Group,Config,State).

+

+post_end_per_group(Group,Config,Return,State) ->

+    empty_cth:post_end_per_group(Group,Config,Return,State).

+

+pre_init_per_testcase(TC,Config,State) ->

+    empty_cth:pre_init_per_testcase(TC,Config,State).

+

+post_end_per_testcase(TC,Config,Return,State) ->

+    empty_cth:post_end_per_testcase(TC,Config,Return,State).

+

+on_tc_fail(TC, Reason, State) ->

+    empty_cth:on_tc_fail(TC,Reason,State).

+

+on_tc_skip(TC, Reason, State) ->

+    empty_cth:on_tc_skip(TC,Reason,State).

+

+terminate(State) ->

+    empty_cth:terminate(State).

diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/state_update_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/state_update_cth.erl
index 35c990c0be..9da48d3a4c 100644
--- a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/state_update_cth.erl
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/state_update_cth.erl
@@ -29,7 +29,7 @@
 

 init(Id, Opts) ->

     State = empty_cth:init(Id, Opts),

-    [init|State].

+    {ok, [init|State]}.

 

 pre_init_per_suite(Suite, Config, State) ->

     empty_cth:pre_init_per_suite(Suite,Config,State),