Merge tag 'OTP-19.0' into sverker/19/binary_to_atom-utf8-crash/ERL-474/OTP-14590

1 files changed, 141 insertions, 35 deletions

diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl
index e6732f7fc7..d7ae81a5ce 100644
--- a/lib/common_test/src/ct.erl
+++ b/lib/common_test/src/ct.erl
@@ -1,18 +1,19 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2003-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2003-2016. 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/.
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
 %%
-%% 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.
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
 %%
 %% %CopyrightEnd%
 %%
@@ -52,6 +53,7 @@
 -module(ct).
 
 -include("ct.hrl").
+-include("ct_util.hrl").
 
 %% Command line user interface for running tests
 -export([install/1, run/1, run/2, run/3,
@@ -62,7 +64,8 @@
 -export([require/1, require/2,
 	 get_config/1, get_config/2, get_config/3,
 	 reload_config/1,
-	 log/1, log/2, log/3, log/4,
+	 escape_chars/1, escape_chars/2,
+	 log/1, log/2, log/3, log/4, log/5,
 	 print/1, print/2, print/3, print/4,
 	 pal/1, pal/2, pal/3, pal/4,
 	 capture_start/0, capture_stop/0, capture_get/0, capture_get/1,
@@ -77,6 +80,8 @@
 
 %% Other interface functions
 -export([get_status/0, abort_current_testcase/1,
+	 get_event_mgr_ref/0,
+	 get_testspec_terms/0, get_testspec_terms/1,
 	 encrypt_config_file/2, encrypt_config_file/3,
 	 decrypt_config_file/2, decrypt_config_file/3]).
 
@@ -150,14 +155,15 @@ run(TestDirs) ->
 %%%               {silent_connections,Conns} | {stylesheet,CSSFile} |
 %%%               {cover,CoverSpecFile} | {cover_stop,Bool} | {step,StepOpts} |
 %%%               {event_handler,EventHandlers} | {include,InclDirs} |
-%%%               {auto_compile,Bool} | {create_priv_dir,CreatePrivDir}  |
+%%%               {auto_compile,Bool} | {abort_if_missing_suites,Bool} |
+%%%               {create_priv_dir,CreatePrivDir}  |
 %%%               {multiply_timetraps,M} | {scale_timetraps,Bool} |
 %%%               {repeat,N} | {duration,DurTime} | {until,StopTime} |
 %%%               {force_stop,ForceStop} | {decrypt,DecryptKeyOrFile} |
 %%%               {refresh_logs,LogDir} | {logopts,LogOpts} | 
-%%%               {verbosity,VLevels} | {basic_html,Bool} | 
-%%%               {ct_hooks, CTHs} | {enable_builtin_hooks,Bool} |
-%%%               {release_shell,Bool}
+%%%               {verbosity,VLevels} | {basic_html,Bool} |
+%%%               {esc_chars,Bool} | {ct_hooks, CTHs} |
+%%%               {enable_builtin_hooks,Bool} | {release_shell,Bool}
 %%%   TestDirs = [string()] | string()
 %%%   Suites = [string()] | [atom()] | string() | atom()
 %%%   Cases = [atom()] | atom()
@@ -276,7 +282,7 @@ step(TestDir,Suite,Case,Opts) ->
 %%% <c>&gt; ct_telnet:cmd(unix_telnet, "ls .").</c><br/>
 %%% <c>{ok,["ls","file1  ...",...]}</c></p>
 start_interactive() ->
-    ct_util:start(interactive),
+    _ = ct_util:start(interactive),
     ok.
 
 %%%-----------------------------------------------------------------
@@ -460,44 +466,132 @@ reload_config(Required)->
     ct_config:reload_config(Required).
 
 %%%-----------------------------------------------------------------
+%%% @spec get_testspec_terms() -> TestSpecTerms | undefined
+%%%      TestSpecTerms = [{Tag,Value}]
+%%%      Value = [term()]
+%%%
+%%% @doc Get a list of all test specification terms used to
+%%% configure and run this test.
+%%%
+get_testspec_terms() ->
+    case ct_util:get_testdata(testspec) of
+	undefined ->
+	    undefined;
+	CurrSpecRec ->
+	    ct_testspec:testspec_rec2list(CurrSpecRec)
+    end.
+
+%%%-----------------------------------------------------------------
+%%% @spec get_testspec_terms(Tags) -> TestSpecTerms | undefined
+%%%      Tags = [Tag] | Tag
+%%%      Tag = atom()
+%%%      TestSpecTerms = [{Tag,Value}] | {Tag,Value}
+%%%      Value = [{Node,term()}] | [term()]
+%%%      Node = atom()
+%%%
+%%% @doc Read one or more terms from the test specification used
+%%% to configure and run this test. Tag is any valid test specification
+%%% tag, such as e.g. <c>label</c>, <c>config</c>, <c>logdir</c>.
+%%% User specific terms are also available to read if the
+%%% <c>allow_user_terms</c> option has been set. Note that all value tuples
+%%% returned, except user terms, will have the node name as first element.
+%%% Note also that in order to read test terms, use <c>Tag = tests</c>
+%%% (rather than <c>suites</c>, <c>groups</c> or <c>cases</c>). Value is
+%%% then the list of *all* tests on the form:
+%%% <c>[{Node,Dir,[{TestSpec,GroupsAndCases1},...]},...], where
+%%% GroupsAndCases = [{Group,[Case]}] | [Case]</c>.
+get_testspec_terms(Tags) ->
+    case ct_util:get_testdata(testspec) of
+	undefined ->
+	    undefined;
+	CurrSpecRec ->
+	    ct_testspec:testspec_rec2list(Tags, CurrSpecRec)
+    end.
+
+
+%%%-----------------------------------------------------------------
+%%% @spec escape_chars(IoList1) -> IoList2 | {error,Reason}
+%%%      IoList1 = iolist()
+%%%      IoList2 = iolist()
+%%%
+%%% @doc Escape special characters to be printed in html log
+%%%
+escape_chars(IoList) ->
+    ct_logs:escape_chars(IoList).
+
+%%%-----------------------------------------------------------------
+%%% @spec escape_chars(Format, Args) -> IoList | {error,Reason}
+%%%      Format = string()
+%%%      Args = list()
+%%%
+%%% @doc Escape special characters to be printed in html log
+%%%
+escape_chars(Format, Args) ->
+    try io_lib:format(Format, Args) of
+	IoList ->
+	    ct_logs:escape_chars(IoList)
+    catch
+	_:Reason ->
+	    {error,Reason}
+    end.
+
+%%%-----------------------------------------------------------------
 %%% @spec log(Format) -> ok
-%%% @equiv log(default,50,Format,[])
+%%% @equiv log(default,50,Format,[],[])
 log(Format) ->
-    log(default,?STD_IMPORTANCE,Format,[]).
+    log(default,?STD_IMPORTANCE,Format,[],[]).
 
 %%%-----------------------------------------------------------------
 %%% @spec log(X1,X2) -> ok
 %%%      X1 = Category | Importance | Format
 %%%      X2 = Format | Args
-%%% @equiv log(Category,Importance,Format,Args)
+%%% @equiv log(Category,Importance,Format,Args,[])
 log(X1,X2) ->
     {Category,Importance,Format,Args} = 
 	if is_atom(X1)    -> {X1,?STD_IMPORTANCE,X2,[]};
 	   is_integer(X1) -> {default,X1,X2,[]};
 	   is_list(X1)    -> {default,?STD_IMPORTANCE,X1,X2}
 	end,
-    log(Category,Importance,Format,Args).
+    log(Category,Importance,Format,Args,[]).
 
 %%%-----------------------------------------------------------------
 %%% @spec log(X1,X2,X3) -> ok
+%%%      X1 = Category | Importance | Format
+%%%      X2 = Importance | Format | Args
+%%%      X3 = Format | Args | Opts
+%%% @equiv log(Category,Importance,Format,Args,Opts)
+log(X1,X2,X3) ->
+    {Category,Importance,Format,Args,Opts} = 
+	if is_atom(X1), is_integer(X2) -> {X1,X2,X3,[],[]};
+	   is_atom(X1), is_list(X2)    -> {X1,?STD_IMPORTANCE,X2,X3,[]};
+	   is_integer(X1)              -> {default,X1,X2,X3,[]};
+	   is_list(X1), is_list(X2)    -> {default,?STD_IMPORTANCE,X1,X2,X3}
+	end,
+    log(Category,Importance,Format,Args,Opts).
+
+%%%-----------------------------------------------------------------
+%%% @spec log(X1,X2,X3,X4) -> ok
 %%%      X1 = Category | Importance
 %%%      X2 = Importance | Format
 %%%      X3 = Format | Args
-%%% @equiv log(Category,Importance,Format,Args)
-log(X1,X2,X3) ->
-    {Category,Importance,Format,Args} = 
-	if is_atom(X1), is_integer(X2) -> {X1,X2,X3,[]};
-	   is_atom(X1), is_list(X2)    -> {X1,?STD_IMPORTANCE,X2,X3};
-	   is_integer(X1)              -> {default,X1,X2,X3}
+%%%      X4 = Args | Opts
+%%% @equiv log(Category,Importance,Format,Args,Opts)
+log(X1,X2,X3,X4) ->
+    {Category,Importance,Format,Args,Opts} = 
+	if is_atom(X1), is_integer(X2) -> {X1,X2,X3,X4,[]};
+	   is_atom(X1), is_list(X2)    -> {X1,?STD_IMPORTANCE,X2,X3,X4};
+	   is_integer(X1)              -> {default,X1,X2,X3,X4}
 	end,
-    log(Category,Importance,Format,Args).
+    log(Category,Importance,Format,Args,Opts).
 
 %%%-----------------------------------------------------------------
-%%% @spec log(Category,Importance,Format,Args) -> ok
+%%% @spec log(Category,Importance,Format,Args,Opts) -> ok
 %%%      Category = atom()
 %%%      Importance = integer()
 %%%      Format = string()
 %%%      Args = list()
+%%%      Opts = [Opt]
+%%%      Opt = esc_chars | no_css
 %%%
 %%% @doc Printout from a test case to the log file. 
 %%%
@@ -509,8 +603,8 @@ log(X1,X2,X3) ->
 %%% and default value for <c>Args</c> is <c>[]</c>.</p>
 %%% <p>Please see the User's Guide for details on <c>Category</c>
 %%% and <c>Importance</c>.</p>
-log(Category,Importance,Format,Args) ->
-    ct_logs:tc_log(Category,Importance,Format,Args).
+log(Category,Importance,Format,Args,Opts) ->
+    ct_logs:tc_log(Category,Importance,Format,Args,Opts).
 
 
 %%%-----------------------------------------------------------------
@@ -681,7 +775,7 @@ capture_get([]) ->
     test_server:capture_get().
 
 %%%-----------------------------------------------------------------
-%%% @spec fail(Reason) -> void()
+%%% @spec fail(Reason) -> ok
 %%%      Reason = term()
 %%%
 %%% @doc Terminate a test case with the given error
@@ -699,7 +793,7 @@ fail(Reason) ->
     end.
 
 %%%-----------------------------------------------------------------
-%%% @spec fail(Format, Args) -> void()
+%%% @spec fail(Format, Args) -> ok
 %%%      Format = string()
 %%%      Args = list()
 %%%
@@ -725,7 +819,7 @@ fail(Format, Args) ->
     end.
 
 %%%-----------------------------------------------------------------
-%%% @spec comment(Comment) -> void()
+%%% @spec comment(Comment) -> ok
 %%%      Comment = term()
 %%%
 %%% @doc Print the given <c>Comment</c> in the comment field in
@@ -748,7 +842,7 @@ comment(Comment) ->
     send_html_comment(lists:flatten(Formatted)).
 
 %%%-----------------------------------------------------------------
-%%% @spec comment(Format, Args) -> void()
+%%% @spec comment(Format, Args) -> ok
 %%%      Format = string()
 %%%      Args = list()
 %%%
@@ -772,7 +866,7 @@ comment(Format, Args) when is_list(Format), is_list(Args) ->
 
 send_html_comment(Comment) ->
     Html = "<font color=\"green\">" ++ Comment ++ "</font>",
-    ct_util:set_testdata({comment,Html}),
+    ct_util:set_testdata({{comment,group_leader()},Html}),
     test_server:comment(Html).
 
 %%%-----------------------------------------------------------------
@@ -1004,6 +1098,18 @@ abort_current_testcase(Reason) ->
     test_server_ctrl:abort_current_testcase(Reason).
 
 %%%-----------------------------------------------------------------
+%%% @spec get_event_mgr_ref() -> EvMgrRef
+%%%       EvMgrRef = atom()
+%%%
+%%% @doc <p>Call this function in order to get a reference to the
+%%%         CT event manager. The reference can be used to e.g. add
+%%%         a user specific event handler while tests are running.
+%%%         Example:
+%%%         <c>gen_event:add_handler(ct:get_event_mgr_ref(), my_ev_h, [])</c></p>
+get_event_mgr_ref() ->
+    ?CT_EVMGR_REF.
+
+%%%-----------------------------------------------------------------
 %%% @spec encrypt_config_file(SrcFileName, EncryptFileName) -> 
 %%%                                                  ok | {error,Reason}
 %%%       SrcFileName = string()