From 5e282d9ba621008355fbd9a9ff27310577404b98 Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Sun, 11 Mar 2012 23:54:03 +0100
Subject: Introduce error notification printout in the tc log

Also fix problem with parallel test cases printing "into each other"
(when using ct:print or ct:pal).

OTP-9904
OTP-9900
---
 lib/common_test/src/ct_framework.erl | 37 +++++++++++++++++++-----------------
 lib/common_test/src/ct_logs.erl      | 34 ++++++++++++++++++---------------
 2 files changed, 39 insertions(+), 32 deletions(-)

(limited to 'lib/common_test/src')

diff --git a/lib/common_test/src/ct_framework.erl b/lib/common_test/src/ct_framework.erl
index c24a7c238b..cdd8a6a596 100644
--- a/lib/common_test/src/ct_framework.erl
+++ b/lib/common_test/src/ct_framework.erl
@@ -806,31 +806,36 @@ error_notification(Mod,Func,_Args,{Error,Loc}) ->
 	    end
     end,
 
-    io:format(user, "~n- - - - - - - - - - - - - - - - "
-	      "- - - - - - - - - -~n", []),
+    PrintErr = fun(ErrFormat, ErrArgs) ->
+		       Div = "~n- - - - - - - - - - - - - - - - "
+			   "- - - - - - - - - -~n",
+		       io:format(user, lists:concat([Div,ErrFormat,Div,"~n"]),
+				 ErrArgs),
+		       ct_logs:tc_log(ct_error_notify, "CT Error Notification",
+				      ErrFormat, ErrArgs)
+	       end,
     case Loc of
-	%% we don't use the line parse transform as we compile this 
-	%% module so location will be on form {M,F}
 	[{?MODULE,error_in_suite}] ->
-	    io:format(user, "Error in suite detected: ~s", [ErrStr]);
+	    PrintErr("Error in suite detected: ~s", [ErrStr]);
 
-	R when R == unknown;  R == undefined ->
-	    io:format(user, "Error detected: ~s", [ErrStr]);
+	R when R == unknown; R == undefined ->
+	    PrintErr("Error detected: ~s", [ErrStr]);
 
 	%% if a function specified by all/0 does not exist, we
 	%% pick up undef here
-	[{LastMod,LastFunc}] ->
-	    io:format(user, "~w:~w could not be executed~n", 
-		      [LastMod,LastFunc]),
-	    io:format(user, "Reason: ~s", [ErrStr]);
+	[{LastMod,LastFunc}|_] when ErrStr == "undef" ->
+	    PrintErr("~w:~w could not be executed~nReason: ~s",
+		     [LastMod,LastFunc,ErrStr]);
+
+	[{LastMod,LastFunc}|_] ->
+	    PrintErr("~w:~w failed~nReason: ~s", [LastMod,LastFunc,ErrStr]);
 	    
 	[{LastMod,LastFunc,LastLine}|_] ->
 	    %% print error to console, we are only
 	    %% interested in the last executed expression
-	    io:format(user, "~w:~w failed on line ~w~n", 
-		      [LastMod,LastFunc,LastLine]),
-	    io:format(user, "Reason: ~s", [ErrStr]),
-    
+	    PrintErr("~w:~w failed on line ~w~nReason: ~s",
+		     [LastMod,LastFunc,LastLine,ErrStr]),
+	    
 	    case ct_util:read_suite_data({seq,Mod,Func}) of
 		undefined ->
 		    ok;
@@ -839,8 +844,6 @@ error_notification(Mod,Func,_Args,{Error,Loc}) ->
 		    mark_as_failed(Seq,Mod,Func,SeqTCs)
 	    end	    
     end,
-    io:format(user, "~n- - - - - - - - - - - - - - - - "
-	      "- - - - - - - - - -~n~n", []),
     ok.
 
 %% cases in seq that have already run
diff --git a/lib/common_test/src/ct_logs.erl b/lib/common_test/src/ct_logs.erl
index 5f0626c0b0..b2f669fefe 100644
--- a/lib/common_test/src/ct_logs.erl
+++ b/lib/common_test/src/ct_logs.erl
@@ -38,7 +38,7 @@
 -export([get_ts_html_wrapper/3]).
 
 %% Logging stuff directly from testcase
--export([tc_log/3,tc_log_async/3,tc_print/3,tc_pal/3,ct_log/3,
+-export([tc_log/3,tc_log/4,tc_log_async/3,tc_print/3,tc_pal/3,ct_log/3,
 	 basic_html/0]).
 
 %% Simulate logger process for use without ct environment running
@@ -333,7 +333,10 @@ add_link(Heading,File,Type) ->
 %%% stuff directly from a testcase (i.e. not from within the CT
 %%% framework).</p>
 tc_log(Category,Format,Args) ->
-    cast({log,sync,self(),group_leader(),[{div_header(Category),[]},
+    tc_log(Category,"User",Format,Args).
+
+tc_log(Category,Printer,Format,Args) ->
+    cast({log,sync,self(),group_leader(),[{div_header(Category,Printer),[]},
 					  {Format,Args},
 					  {div_footer(),[]}]}),
     ok.
@@ -369,19 +372,18 @@ tc_log_async(Category,Format,Args) ->
 %%% <p>This function is called by <code>ct</code> when printing
 %%% stuff a testcase on the user console.</p>
 tc_print(Category,Format,Args) ->
-    print_heading(Category),
-    io:format(user,Format,Args),
-    io:format(user,"\n\n",[]),
+    Head = get_heading(Category),
+    io:format(user, lists:concat([Head,Format,"\n\n"]), Args),
     ok.
 
-print_heading(default) ->
-    io:format(user,
-	      "----------------------------------------------------\n~s\n",
-	      [log_timestamp(now())]);
-print_heading(Category) ->
-    io:format(user,
-	      "----------------------------------------------------\n~s  ~w\n",
-	      [log_timestamp(now()),Category]).    
+get_heading(default) ->
+    io_lib:format("-----------------------------"
+		  "-----------------------\n~s\n",
+		  [log_timestamp(now())]);
+get_heading(Category) ->
+    io_lib:format("-----------------------------"
+		  "-----------------------\n~s  ~w\n",
+		  [log_timestamp(now()),Category]).    
     
 
 %%%-----------------------------------------------------------------
@@ -428,8 +430,10 @@ int_footer() ->
     "</div>".
 
 div_header(Class) ->
-    "<div class=\"" ++ atom_to_list(Class) ++ "\"><b>*** User  " ++   
-	log_timestamp(now()) ++ " ***</b>".
+    div_header(Class,"User").
+div_header(Class,Printer) ->
+    "<div class=\"" ++ atom_to_list(Class) ++ "\"><b>*** " ++ Printer ++
+    " " ++ log_timestamp(now()) ++ " ***</b>".
 div_footer() ->
     "</div>".
 
-- 
cgit v1.2.3