Add heading option to log functions

1 files changed, 97 insertions, 37 deletions

diff --git a/lib/common_test/test/ct_log_SUITE.erl b/lib/common_test/test/ct_log_SUITE.erl
index 9bdd44cbdf..93affda398 100644
--- a/lib/common_test/test/ct_log_SUITE.erl
+++ b/lib/common_test/test/ct_log_SUITE.erl
@@ -86,18 +86,7 @@ print(Config) ->
     io:format("5. Printing a pid: ~w~n", [Pid]),
     io:format("6. Printing HTML: <pre>~s</pre>~n", [String]),
 
-    %% --- API ---
-    %% pal(Format) ->
-    %%   = ct:pal(default, 50, Format, []).
-    %% pal(X1, X2) -> ok
-    %%   X1 = Category | Importance | Format
-    %%   X2 = Format | FormatArgs
-    %% pal(X1, X2, X3) -> ok
-    %%   X1 = Category | Importance
-    %%   X2 = Importance | Format
-    %%   X3 = Format | FormatArgs
-    %% pal(Category, Importance, Format, FormatArgs) -> ok
-    %% ------
+    %% ct:pal
     ct:pal("1. Printing nothing"),
     ct:pal("2. Printing nothing", []),
     ct:pal("3. Printing a string: ~s", [String]),
@@ -111,23 +100,16 @@ print(Config) ->
     ct:pal(50, "11. Printing with ~s", ["importance"]),
     ct:pal(ct_internal, 50, "12. Printing with ~s", ["category and importance"]),
 
-    %% --- API ---
-    %% log(Format) -> ok
-    %%   = ct:log(default, 50, Format, [], []).
-    %% log(X1, X2) -> ok
-    %%   X1 = Category | Importance | Format
-    %%   X2 = Format | FormatArgs
-    %% log(X1, X2, X3) -> ok
-    %%   X1 = Category | Importance
-    %%   X2 = Importance | Format
-    %%   X3 = Format | FormatArgs | Opts
-    %% log(X1, X2, X3, X4) -> ok
-    %%   X1 = Category | Importance
-    %%   X2 = Importance | Format
-    %%   X3 = Format | FormatArgs
-    %%   X4 = FormatArgs | Opts
-    %% log(Category, Importance, Format, FormatArgs, Opts) -> ok
-    %% ------
+    ct:pal("13. Printing with heading", [],
+           [{heading,"This is a heading"}]),
+    ct:pal(ct_internal, "14. Printing with category and heading", [],
+           [{heading,"This is a heading"}]),
+    ct:pal(50, "15. Printing with importance and heading", [],
+           [{heading,"This is a heading"}]),
+    ct:pal(ct_internal, 50, "16. Printing with category, importance and heading", [],
+           [{heading,"This is a heading"}]),
+
+    %% ct:log
     ct:log("1. Printing nothing"),
     ct:log("2. Printing nothing", []),
     ct:log("3. Printing a string: ~s", [String]),
@@ -153,8 +135,37 @@ print(Config) ->
     ct:log(ct_internal, 50, "21. Printing a pid escaped with ~s, no_css: ~w",
 	   ["category and importance",Pid], [esc_chars,no_css]),
 
+    ct:log("22. Printing with heading", [],
+           [{heading,"This is a heading"}]),
+    ct:log(ct_internal, "23. Printing with category and heading", [],
+           [{heading,"This is a heading"}]),
+    ct:log(50, "24. Printing with importance and heading", [],
+           [{heading,"This is a heading"}]),
+    ct:log(ct_internal, 50, "25. Printing with category, importance and heading", [],
+           [{heading,"This is a heading"}]),
+
     %% END mark
     ct:log("LOGGING END", [], [no_css]),
+
+
+    %% ct:print
+    ct:print("1. Does this show??"),
+    ct:print("2. Does this ~s", ["show??"]),
+    ct:print("3. Is this a non-html pid?? ~w", [self()]),
+    ct:print(ct_internal, "4. Printing with category"),
+    ct:print(ct_internal, "5. Printing with ~s", ["category"]),
+    ct:print(50, "6. Printing with importance"),
+    ct:print(50, "7. Printing with ~s", ["importance"]),
+    ct:print(ct_internal, 50, "8. Printing with ~s", ["category and importance"]),
+    ct:print("9. Printing with heading", [],
+           [{heading,"This is a heading"}]),
+    ct:print(ct_internal, "10. Printing with category and heading", [],
+           [{heading,"This is a heading"}]),
+    ct:print(50, "11. Printing with importance and heading", [],
+           [{heading,"This is a heading"}]),
+    ct:print(ct_internal, 50, "12. Printing with category, importance and heading", [],
+           [{heading,"This is a heading"}]),
+
     {save_config,[{the_logfile,TcLogFile},{the_pid,Pid},{the_string,String}]}.
 
 
@@ -169,6 +180,8 @@ verify(Config) ->
     {ok,Dev} = file:open(TcLogFile, [read]),
     ok = read_until(Dev, "LOGGING START\n"),
     
+    ct:pal("VERIFYING LOG ENTRIES...", []),
+
     %% io:format
     match_line(Dev, "1. Printing nothing", []),
     read_nl(Dev),
@@ -182,6 +195,7 @@ verify(Config) ->
     read_nl(Dev),
     match_line(Dev, "6. Printing HTML: &lt;pre&gt;~s&lt;/pre&gt;", [String]),
     read_nl(Dev),
+
     %% ct:pal
     read_header(Dev),
     match_line(Dev, "1. Printing nothing", []),
@@ -219,6 +233,19 @@ verify(Config) ->
     read_header(Dev, "\"ct_internal\""),
     match_line(Dev, "12. Printing with ~s", ["category and importance"]),
     read_footer(Dev),
+    read_header(Dev, "\"default\"", "This is a heading"),
+    match_line(Dev, "13. Printing with heading", []),
+    read_footer(Dev),
+    read_header(Dev, "\"ct_internal\"", "This is a heading"),
+    match_line(Dev, "14. Printing with category and heading", []),
+    read_footer(Dev),
+    read_header(Dev, "\"default\"", "This is a heading"),
+    match_line(Dev, "15. Printing with importance and heading", []),
+    read_footer(Dev),
+    read_header(Dev, "\"ct_internal\"", "This is a heading"),
+    match_line(Dev, "16. Printing with category, importance and heading", []),
+    read_footer(Dev),
+
     %% ct:log
     read_header(Dev),
     match_line(Dev, "1. Printing nothing", []),
@@ -275,7 +302,18 @@ verify(Config) ->
     read_footer(Dev),
     match_line(Dev, "21. Printing a pid escaped with ~s, no_css: ~s",
 	       ["category and importance",EscPid]),
-
+    read_header(Dev, "\"default\"", "This is a heading"),
+    match_line(Dev, "22. Printing with heading", []),
+    read_footer(Dev),
+    read_header(Dev, "\"ct_internal\"", "This is a heading"),
+    match_line(Dev, "23. Printing with category and heading", []),
+    read_footer(Dev),
+    read_header(Dev, "\"default\"", "This is a heading"),
+    match_line(Dev, "24. Printing with importance and heading", []),
+    read_footer(Dev),
+    read_header(Dev, "\"ct_internal\"", "This is a heading"),
+    match_line(Dev, "25. Printing with category, importance and heading", []),
+    read_footer(Dev),
     file:close(Dev),
     ok.
 
@@ -298,29 +336,51 @@ read_until(Dev, Pat) ->
 match_line(Dev, Format, Args) ->
     Pat = lists:flatten(io_lib:format(Format, Args)),
     Line = element(2, file:read_line(Dev)),
+
+    %% for debugging purposes:
+    ct:pal("L: ~tp", [Line], [no_css]),
+
     case re:run(Line, Pat) of
 	{match,_} ->
 	    ok;
 	nomatch ->
-	    ct:pal("ERROR! No match for ~p.\nLine = ~p", [Pat,Line]),
+	    ct:pal("ERROR! No match for ~p", [Pat]),
 	    file:close(Dev),
 	    ct:fail({mismatch,Pat,Line})
     end.
 
 read_header(Dev) ->
-    read_header(Dev, "\"default\"").
+    read_header(Dev, "\"default\"", "User").
     
 read_header(Dev, Cat) ->
+    read_header(Dev, Cat, "User").
+
+read_header(Dev, Cat, Heading) ->
     file:read_line(Dev),			% \n
     "</pre>\n" = element(2, file:read_line(Dev)),
-    {match,_} =
-	re:run(element(2, file:read_line(Dev)), "<div class="++Cat++"><pre><b>"
-	       "\\*\\*\\* User \\d{4}-\\d{2}-\\d{2} "
-	       "\\d{2}:\\d{2}:\\d{2}.\\d{1,} \\*\\*\\*</b>").
+    {ok,Hd} = file:read_line(Dev),
+
+    %% for debugging purposes:
+    ct:pal("H: ~tp", [Hd], [no_css]),
+    
+    Pat = "<div class="++Cat++"><pre><b>"++
+          "\\*\\*\\* "++Heading++" \\d{4}-\\d{2}-\\d{2} "++
+          "\\d{2}:\\d{2}:\\d{2}.\\d{1,} \\*\\*\\*</b>",
+
+    case re:run(Hd, Pat) of
+        {match,_} ->
+            ok;
+        _ ->
+            ct:pal("ERROR! No match for ~p", [Pat]),
+	    file:close(Dev),
+	    ct:fail({mismatch,Pat,Hd})
+    end.
 
 read_footer(Dev) ->
     "</pre></div>\n" = element(2, file:read_line(Dev)),
-    "<pre>\n" = element(2, file:read_line(Dev)).
+    "<pre>\n" = element(2, file:read_line(Dev)),
+    %% for debugging purposes:
+    ct:pal("F: </pre></div><pre>", [], [no_css]).
 
 read_nl(Dev) ->
     file:read_line(Dev).