File 0227-common_test-add-anchor-links-to-log.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0227-common_test-add-anchor-links-to-log.patch of Package erlang (Revision 00188dd62c257ad2e14e824eab72d7ee)

Currently displaying revision 00188dd62c257ad2e14e824eab72d7ee , Show latest

From 1c80798d5c87e01eb1195abf4da3283704b71913 Mon Sep 17 00:00:00 2001
From: Anton Thomasson <anton.thomasson@ericsson.com>
Date: Fri, 12 Nov 2021 13:05:17 +0100
Subject: [PATCH] common_test: add anchor links to log

---
 lib/common_test/priv/ct_default.css |  5 +++
 lib/common_test/src/ct_logs.erl     | 48 +++++++++++++++++++----------
 2 files changed, 37 insertions(+), 16 deletions(-)

diff --git a/lib/common_test/priv/ct_default.css b/lib/common_test/priv/ct_default.css
index ff48b4fdc0..df4fe34f28 100644
--- a/lib/common_test/priv/ct_default.css
+++ b/lib/common_test/priv/ct_default.css
@@ -207,3 +207,8 @@ th + td {
     color: #fff;
     background-color: #809FFF;
 }
+
+a.link-to-entry {
+    float: right;
+    text-decoration: none;
+}
diff --git a/lib/common_test/src/ct_logs.erl b/lib/common_test/src/ct_logs.erl
index 93c15c490c..9e4a5a097e 100644
--- a/lib/common_test/src/ct_logs.erl
+++ b/lib/common_test/src/ct_logs.erl
@@ -655,7 +655,8 @@ log_timestamp({MS,S,US}) ->
 		      tc_groupleaders,
 		      stylesheet,
 		      async_print_jobs,
-		      tc_esc_chars}).
+		      tc_esc_chars,
+		      log_index}).
 
 logger(Parent, Mode, Verbosity) ->
     register(?MODULE,self()),
@@ -786,7 +787,8 @@ logger(Parent, Mode, Verbosity) ->
 			      ct_log_fd=CtLogFd,
 			      tc_groupleaders=[],
 			      async_print_jobs=[],
-			      tc_esc_chars=TcEscChars}).
+			      tc_esc_chars=TcEscChars,
+			      log_index=1}).
 
 copy_priv_files([SrcF | SrcFs], [DestF | DestFs]) ->
     case file:copy(SrcF, DestF) of
@@ -925,15 +927,19 @@ logger_loop(State) ->
     end.
 
 create_io_fun(FromPid, CtLogFd, EscChars) ->
+    create_io_fun(FromPid, CtLogFd, EscChars, undefined).
+
+create_io_fun(FromPid, CtLogFd, EscChars, LogIndex) ->
     %% we have to build one io-list of all strings
     %% before printing, or other io printouts (made in
     %% parallel) may get printed between this header 
     %% and footer
     fun(FormatData, IoList) ->
-	    {Escapable,Str,Args} =
+	    {Escapable,AddAnchor,Str,Args} =
 		case FormatData of
-		    {_HdOrFt,S,A} -> {false,S,A};
-		    {S,A}         -> {true,S,A}
+		    {hd,S,A} -> {false,true,S,A};
+		    {_ft,S,A} -> {false,false,S,A};
+		    {S,A} -> {true,false,S,A}
 		end,
 	    try io_lib:format(lists:flatten(Str), Args) of
 		IoStr when Escapable, EscChars, IoList == [] ->
@@ -941,9 +947,9 @@ create_io_fun(FromPid, CtLogFd, EscChars) ->
 		IoStr when Escapable, EscChars ->
 		    [IoList,"\n",escape_chars(IoStr)];
 		IoStr when IoList == [] ->
-		    IoStr;
+		    IoStr++[anchor_link(LogIndex) || AddAnchor];
 		IoStr ->
-		    [IoList,"\n",IoStr]
+		    [IoList,"\n",IoStr]++[anchor_link(LogIndex) || AddAnchor]
 	    catch
 		_:_Reason ->
 		    io:format(CtLogFd, "Logging fails! Str: ~tp, Args: ~tp~n",
@@ -954,6 +960,13 @@ create_io_fun(FromPid, CtLogFd, EscChars) ->
 	    end
     end.
 
+anchor_link(undefined) ->
+    [];
+anchor_link(LogIndex) ->
+    IdLink = ["e-", integer_to_list(LogIndex)],
+    ["<a id=", IdLink, " class=\"link-to-entry\" ",
+     "href=\"#", IdLink, "\">&#x1f517;</a>"].
+
 escape_chars([Bin | Io]) when is_binary(Bin) ->
     [Bin | escape_chars(Io)];
 escape_chars([List | Io]) when is_list(List) ->
@@ -971,12 +984,13 @@ escape_chars([]) ->
 escape_chars(Bin) ->
     Bin.
 
-print_to_log(sync, FromPid, Category, TCGL, Content, EscChars, State) ->
+print_to_log(sync, FromPid, Category, TCGL, Content, EscChars,
+	     #logger_state{log_index=LogIndex}=State) ->
     %% in some situations (exceptions), the printout is made from the
     %% test server IO process and there's no valid group leader to send to
     CtLogFd = State#logger_state.ct_log_fd,
     if FromPid /= TCGL ->
-	    IoFun = create_io_fun(FromPid, CtLogFd, EscChars),
+	    IoFun = create_io_fun(FromPid, CtLogFd, EscChars, LogIndex),
 	    IoList = lists:foldl(IoFun, [], Content),
 	    try tc_io_format(TCGL, "~ts", [IoList]) of
 		ok -> ok
@@ -984,19 +998,20 @@ print_to_log(sync, FromPid, Category, TCGL, Content, EscChars, State) ->
 		_:_ ->
 		    io:format(TCGL,"~ts", [IoList])
 	    end;
-       true ->
+	true ->
 	    unexpected_io(FromPid, Category, ?MAX_IMPORTANCE, Content,
 			  CtLogFd, EscChars)
     end,
-    State;
+    State#logger_state{log_index=LogIndex+1};
 
-print_to_log(async, FromPid, Category, TCGL, Content, EscChars, State) ->
+print_to_log(async, FromPid, Category, TCGL, Content, EscChars,
+	     #logger_state{log_index=LogIndex}=State) ->
     %% in some situations (exceptions), the printout is made from the
     %% test server IO process and there's no valid group leader to send to
     CtLogFd = State#logger_state.ct_log_fd,
     Printer =
 	if FromPid /= TCGL ->
-		IoFun = create_io_fun(FromPid, CtLogFd, EscChars),
+		IoFun = create_io_fun(FromPid, CtLogFd, EscChars, LogIndex),
 		fun() ->
                         ct_util:mark_process(),
 			test_server:permit_io(TCGL, self()),
@@ -1035,12 +1050,13 @@ print_to_log(async, FromPid, Category, TCGL, Content, EscChars, State) ->
 				      Content, CtLogFd, EscChars)
 		end
 	end,
-    case State#logger_state.async_print_jobs of
+    State1 = State#logger_state{log_index = LogIndex+1},
+    case State1#logger_state.async_print_jobs of
 	[] ->
 	    {_Pid,Ref} = spawn_monitor(Printer),
-	    State#logger_state{async_print_jobs = [Ref]};
+	    State1#logger_state{async_print_jobs = [Ref]};
 	Queue ->
-	    State#logger_state{async_print_jobs = [Printer|Queue]}
+	    State1#logger_state{async_print_jobs = [Printer|Queue]}
     end.
 
 print_next(PrintFun) ->
-- 
2.31.1

Places

File 0227-common_test-add-anchor-links-to-log.patch of Package erlang (Revision 00188dd62c257ad2e14e824eab72d7ee)

Places