From 390843117229d7d6e1e5f167aca9ea2ebe6df5f2 Mon Sep 17 00:00:00 2001 From: Peter Andersson Date: Wed, 21 Mar 2012 16:03:46 +0100 Subject: Update ct_master to use the Common Test CSS file for the logs OTP-9973 --- lib/common_test/src/ct_logs.erl | 25 ++--- lib/common_test/src/ct_master.erl | 13 ++- lib/common_test/src/ct_master_logs.erl | 175 ++++++++++++++++++++----------- lib/common_test/test/ct_master_SUITE.erl | 99 +++++++++-------- lib/common_test/test/ct_test_support.erl | 16 ++- 5 files changed, 206 insertions(+), 122 deletions(-) diff --git a/lib/common_test/src/ct_logs.erl b/lib/common_test/src/ct_logs.erl index 0cd9b5f7cb..012f947fdd 100644 --- a/lib/common_test/src/ct_logs.erl +++ b/lib/common_test/src/ct_logs.erl @@ -36,6 +36,7 @@ -export([make_last_run_index/0]). -export([make_all_suites_index/1,make_all_runs_index/1]). -export([get_ts_html_wrapper/3]). +-export([xhtml/2, locate_default_css_file/0, make_relative/1]). %% Logging stuff directly from testcase -export([tc_log/3,tc_log/4,tc_log_async/3,tc_print/3,tc_pal/3,ct_log/3, @@ -1246,18 +1247,18 @@ header1(Title, SubTitle) -> ["\n", "\n"]), - "\n", - "\n", - "" ++ Title ++ " " ++ SubTitle ++ "\n", - "\n", - xhtml("", - [""]), - "\n", - body_tag(), - "\n", - "

" ++ Title ++ "

\n", - "\n", - SubTitleHTML,"\n"]. + "\n", + "\n", + "" ++ Title ++ " " ++ SubTitle ++ "\n", + "\n", + xhtml("", + [""]), + "\n", + body_tag(), + "\n", + "

" ++ Title ++ "

\n", + "\n", + SubTitleHTML,"\n"]. index_footer() -> ["\n" diff --git a/lib/common_test/src/ct_master.erl b/lib/common_test/src/ct_master.erl index 2ea2ba106a..0d32bb0072 100644 --- a/lib/common_test/src/ct_master.erl +++ b/lib/common_test/src/ct_master.erl @@ -25,6 +25,7 @@ -export([run/1,run/3,run/4]). -export([run_on_node/2,run_on_node/3]). -export([run_test/1,run_test/2]). +-export([basic_html/1]). -export([abort/0,abort/1,progress/0]). @@ -277,7 +278,17 @@ abort(Node) when is_atom(Node) -> progress() -> call(progress). - +%%%----------------------------------------------------------------- +%%% @spec basic_html(Bool) -> ok +%%% Bool = true | false +%%% +%%% @doc If set to true, the ct_master logs will be written on a +%%% primitive html format, not using the Common Test CSS style +%%% sheet. +basic_html(Bool) -> + application:set_env(common_test_master, basic_html, Bool), + ok. + %%%----------------------------------------------------------------- %%% MASTER, runs on central controlling node. %%%----------------------------------------------------------------- diff --git a/lib/common_test/src/ct_master_logs.erl b/lib/common_test/src/ct_master_logs.erl index 244faace06..8fd346670f 100644 --- a/lib/common_test/src/ct_master_logs.erl +++ b/lib/common_test/src/ct_master_logs.erl @@ -23,7 +23,8 @@ %%% node.

-module(ct_master_logs). --export([start/2, make_all_runs_index/0, log/3, nodedir/2, stop/0]). +-export([start/2, make_all_runs_index/0, log/3, nodedir/2, + stop/0]). -record(state, {log_fd, start_time, logdir, rundir, nodedir_ix_fd, nodes, nodedirs=[]}). @@ -32,6 +33,7 @@ -define(all_runs_name, "master_runs.html"). -define(nodedir_index_name, "index.html"). -define(details_file_name,"details.info"). +-define(css_default, "ct_default.css"). -define(table_color,"lightblue"). %%%-------------------------------------------------------------------- @@ -87,6 +89,40 @@ init(Parent,LogDir,Nodes) -> RunDirAbs = filename:join(LogDir,RunDir), file:make_dir(RunDirAbs), write_details_file(RunDirAbs,{node(),Nodes}), + + case basic_html() of + true -> + put(basic_html, true); + BasicHtml -> + put(basic_html, BasicHtml), + %% copy stylesheet to log dir (both top dir and test run + %% dir) so logs are independent of Common Test installation + CTPath = code:lib_dir(common_test), + CSSFileSrc = filename:join(filename:join(CTPath, "priv"), + ?css_default), + CSSFileDestTop = filename:join(LogDir, ?css_default), + CSSFileDestRun = filename:join(RunDirAbs, ?css_default), + case file:copy(CSSFileSrc, CSSFileDestTop) of + {error,Reason0} -> + io:format(user, "ERROR! "++ + "CSS file ~p could not be copied to ~p. "++ + "Reason: ~p~n", + [CSSFileSrc,CSSFileDestTop,Reason0]), + exit({css_file_error,CSSFileDestTop}); + _ -> + case file:copy(CSSFileSrc, CSSFileDestRun) of + {error,Reason1} -> + io:format(user, "ERROR! "++ + "CSS file ~p could not be copied to ~p. "++ + "Reason: ~p~n", + [CSSFileSrc,CSSFileDestRun,Reason1]), + exit({css_file_error,CSSFileDestRun}); + _ -> + ok + end + end + end, + make_all_runs_index(LogDir), CtLogFd = open_ct_master_log(RunDirAbs), NodeStr = @@ -164,8 +200,9 @@ open_ct_master_log(Dir) -> "\n", []), io:format(Fd, - "

Progress Log

\n" - "

\n",[]),
+	      xhtml("
Progress Log
\n\n",
+		    "
Progress Log
\n\n"),
+	      []),
     Fd.
 
 close_ct_master_log(Fd) ->
@@ -178,18 +215,10 @@ config_table(Vars) ->
 
 config_table_header() ->
     ["Configuration\n",
-     "\n"),
      "\n"].
 
-%%
-%% keep for possible later use
-%%
-%%config_table1([{Key,Value}|Vars]) ->
-%%    ["\n",
-%%     "\n" | 
-%%     config_table1(Vars)];
-
 config_table1([]) ->
     ["Key Value
", atom_to_list(Key), " ",io_lib:format("~p",[Value]),"\n"].
 
@@ -210,10 +239,10 @@ open_nodedir_index(Dir,StartTime) ->
 print_nodedir(Node,RunDir,Fd) ->
     Index = filename:join(RunDir,"index.html"),
     io:format(Fd,
-	      ["\n"
-	       "",atom_to_list(Node),"\n",
-	       "",Index,"\n",
-	       "\n"],[]),
+	      ["\n"
+	       "",atom_to_list(Node),"\n",
+	       "",Index,"\n",
+	       "\n"],[]),
     ok.
 
 close_nodedir_index(Fd) ->
@@ -222,12 +251,12 @@ close_nodedir_index(Fd) ->
 
 nodedir_index_header(StartTime) ->
     [header("Log Files " ++ format_time(StartTime)) |
-     ["\n",
-      "Common Test Master Log",
-      "\n",
-      "\n",
-      "\n",
+     ["\n",
+      "Common Test Master Log",
+      xhtml(["Node Log
\n"], "\n"),
+      "\n",
+      "\n",
       "\n"]].
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -279,20 +308,20 @@ runentry(Dir) ->
 		{"unknown",""}
 	end,
     Index = filename:join(Dir,?nodedir_index_name),
-    ["\n"
-     "\n",
-     "\n",
-     "\n",
-     "\n"].
+    ["\n"
+     "\n",
+     "\n",
+     "\n",
+     "\n"].
 
 all_runs_header() ->
     [header("Master Test Runs") |
-     ["\n",
-      "Node Log
",timestamp(Dir)," ",MasterStr," ",NodesStr,"
",timestamp(Dir)," ",MasterStr," ",NodesStr,"\n"
-      "\n"
-      "\n"
-      "\n"
+     ["\n",
+      xhtml(["History Master Host Test Nodes
\n"], "\n"),
+      "\n"
+      "\n"
+      "\n"
       "\n"]].
 
 timestamp(Dir) ->
@@ -318,44 +347,46 @@ read_details_file(Dir) ->
 %%%--------------------------------------------------------------------
 
 header(Title) ->
-    ["\n"
-     "\n"
-     "\n",
-     "\n",
-
-     "" ++ Title ++ "\n",
-     "\n",
-
-     "\n",
-
+    CSSFile = xhtml(fun() -> "" end, 
+		    fun() -> make_relative(locate_default_css_file()) end),
+    [xhtml(["\n",
+	    "\n"],
+	   ["\n",
+	    "\n"]),
+     "\n",
+     "\n",
+     "" ++ Title ++ "\n",
+     "\n",
+     xhtml("",
+	   [""]),
+     "\n",
      body_tag(),
-
-     "\n",
-
-     "\n",
-     "" ++ Title ++ "\n",
-     "\n",
-
-     "\n"].
+     "\n",
+     "" ++ Title ++ "\n",
+     "\n"].
 
 index_footer() ->
-    ["History Master Host Test Nodes \n"
-     "\n" | footer()].
+    ["\n"
+     "\n" | footer()].
 
 footer() ->
-     ["
\n"
-     "\n"
-     "\n"
+    ["
\n",
+     xhtml("
\n", "
\n"),
+     xhtml("\n", "
"),
      "Copyright © ", year(),
-     " Open Telecom Platform
\n"
-     "Updated: ", current_time(), "
\n"
-     "\n"
-     "\n"
+     " Open Telecom Platform",
+     xhtml("
\n", "
\n"),
+     "Updated: ", current_time(), "",
+     xhtml("
\n", "
\n"),
+     xhtml("\n", "\n"),
+     "\n"
      "\n"].
 
 body_tag() ->
-    "\n".
+    xhtml("\n",
+	  "\n").
 
 current_time() ->
     format_time(calendar:local_time()).
@@ -404,6 +435,23 @@ log_timestamp(Now) ->
     lists:flatten(io_lib:format("~2.2.0w:~2.2.0w:~2.2.0w",
 				[H,M,S])).
 
+basic_html() ->
+    case application:get_env(common_test_master, basic_html) of
+	{ok,true} ->
+	    true;
+	_ ->
+	    false
+    end.
+
+xhtml(HTML, XHTML) ->
+    ct_logs:xhtml(HTML, XHTML).
+
+locate_default_css_file() ->
+    ct_logs:locate_default_css_file().
+
+make_relative(Dir) ->
+    ct_logs:make_relative(Dir).
+
 force_write_file(Name,Contents) ->
     force_delete(Name),
     file:write_file(Name,Contents).
@@ -452,3 +500,4 @@ cast(Msg) ->
 	_Pid ->
 	    ?MODULE ! Msg
     end.
+
diff --git a/lib/common_test/test/ct_master_SUITE.erl b/lib/common_test/test/ct_master_SUITE.erl
index 1471cc1e0c..d8cb6318c1 100644
--- a/lib/common_test/test/ct_master_SUITE.erl
+++ b/lib/common_test/test/ct_master_SUITE.erl
@@ -98,7 +98,7 @@ end_per_group(_GroupName, Config) ->
 %%--------------------------------------------------------------------
 %% TEST CASES
 %%--------------------------------------------------------------------
-ct_master_test(Config) when is_list(Config)->
+ct_master_test(Config) when is_list(Config) ->
     NodeNames = proplists:get_value(node_names, Config),
     DataDir = ?config(data_dir, Config),
     PrivDir = ?config(priv_dir, Config),
@@ -106,19 +106,14 @@ ct_master_test(Config) when is_list(Config)->
     FileName = filename:join(PrivDir, "ct_master_spec.spec"),
     Suites = [master_SUITE],
     TSFile = make_spec(DataDir, FileName, NodeNames, Suites, Config),
+
     ERPid = ct_test_support:start_event_receiver(Config),
-    spawn(ct@ancalagon,
-	  fun() ->
-		  dbg:tracer(),dbg:p(all,c),
-		  dbg:tpl(erlang, spawn_link, 4,x),
-		  receive ok -> ok end
-	  end),
 
-    [{TSFile, ok}] = run_test(ct_master_test, FileName, Config),
+    [{TSFile,ok}] = run_test(ct_master_test, FileName, Config),
 
     Events = ct_test_support:get_events(ERPid, Config),
 
-    ct_test_support:log_events(groups_suite_1, 
+    ct_test_support:log_events(ct_master_test, 
 			       reformat(Events, ?eh),
 			       PrivDir, []),
 
@@ -134,48 +129,59 @@ ct_master_test(Config) when is_list(Config)->
 %%%-----------------------------------------------------------------
 %%% HELP FUNCTIONS
 %%%-----------------------------------------------------------------
-make_spec(DataDir, FileName, NodeNames, Suites, Config)->
-    {ok, HostName} = inet:gethostname(),
+make_spec(DataDir, FileName, NodeNames, Suites, Config) ->
+    {ok,HostName} = inet:gethostname(),
 
-    N = lists:map(fun(NodeName)->
+    N = lists:map(fun(NodeName) ->
 	    {node, NodeName, list_to_atom(atom_to_list(NodeName)++"@"++HostName)}
 	end,
 	NodeNames),
 
-    C = lists:map(fun(NodeName)->
-	Rnd = random:uniform(2),
-	if Rnd == 1->
-	    {config, NodeName, filename:join(DataDir, "master/config.txt")};
-	true->
-	    {userconfig, NodeName, {ct_config_xml, filename:join(DataDir, "master/config.xml")}}
-        end
-	end,
-	NodeNames),
-
-    NS = lists:map(fun(NodeName)->
-	     {init, NodeName, [
-				{node_start, [{startup_functions, []}, {monitor_master, true}]},
-				{eval, {erlang, nodes, []}}
-			      ]
-	     }
-	 end,
-	 NodeNames),
-
+    C = lists:map(
+	  fun(NodeName) ->
+		  Rnd = random:uniform(2),
+		  if Rnd == 1->
+			  {config,NodeName,filename:join(DataDir,
+							 "master/config.txt")};
+		     true ->
+			  {userconfig,NodeName,
+			   {ct_config_xml,filename:join(DataDir,
+							"master/config.xml")}}
+		  end
+	  end,
+	  NodeNames),
+    
+    CM = [{config,master,filename:join(DataDir,"master/config.txt")}],
+
+    NS = lists:map(
+	   fun(NodeName) ->
+		   {init,NodeName,[
+				   {node_start,[{startup_functions,[]},
+						{monitor_master,true}]},
+				   {eval,{erlang,nodes,[]}}
+				  ]
+		   }
+	   end,
+	   NodeNames),
+    
     S = [{suites, NodeNames, filename:join(DataDir, "master"), Suites}],
-
+    
     PrivDir = ?config(priv_dir, Config),
-    LD = lists:map(fun(NodeName)->
-	     {logdir, NodeName, get_log_dir(os:type(),PrivDir, NodeName)}
-         end,
-	 NodeNames) ++ [{logdir, master, PrivDir}],
+
+    LD = lists:map(
+	   fun(NodeName) ->
+		   {logdir,NodeName,get_log_dir(os:type(),PrivDir, NodeName)}
+	   end,
+	   NodeNames) ++ [{logdir,master,PrivDir}],
+
     EvHArgs = [{cbm,ct_test_support},{trace_level,?config(trace_level,Config)}],
     EH = [{event_handler,master,[?eh],EvHArgs}],
-
+    
     Include = [{include,filename:join([DataDir,"master/include"])}],
+    
+    ct_test_support:write_testspec(N++Include++EH++C++CM++S++LD++NS, FileName).
 
-    ct_test_support:write_testspec(N++Include++EH++C++S++LD++NS, FileName).
-
-get_log_dir({win32,_}, _PrivDir, NodeName)->
+get_log_dir({win32,_}, _PrivDir, NodeName) ->
     case filelib:is_dir(?TEMP_DIR) of
 	false ->
 	    file:make_dir(?TEMP_DIR);
@@ -188,8 +194,15 @@ get_log_dir(_,PrivDir,NodeName) ->
     file:make_dir(LogDir),
     LogDir.
 
-run_test(_Name, FileName, Config)->
-    [{FileName, ok}] = ct_test_support:run(ct_master, run, [FileName], Config).
+run_test(_Name, FileName, Config) ->
+    %% run the test twice, using different html versions
+    [{FileName,ok}] = ct_test_support:run({ct_master,run,[FileName]},
+					  [{ct_master,basic_html,[true]}],
+					  Config),
+    timer:sleep(5000),
+    [{FileName,ok}] = ct_test_support:run({ct_master,run,[FileName]},
+					  [{ct_master,basic_html,[false]}],
+					  Config).
 
 reformat(Events, EH) ->
     ct_test_support:reformat(Events, EH).
@@ -220,5 +233,5 @@ add_host(NodeName) ->
     {ok, HostName} = inet:gethostname(),
     list_to_atom(atom_to_list(NodeName)++"@"++HostName).
     
-expected_events(_)->
+expected_events(_) ->
     [].
diff --git a/lib/common_test/test/ct_test_support.erl b/lib/common_test/test/ct_test_support.erl
index 6df02d12b7..42d4a1630d 100644
--- a/lib/common_test/test/ct_test_support.erl
+++ b/lib/common_test/test/ct_test_support.erl
@@ -29,7 +29,7 @@
 -export([init_per_suite/1, init_per_suite/2, end_per_suite/1,
 	 init_per_testcase/2, end_per_testcase/2,
 	 write_testspec/2, write_testspec/3,
-	 run/2, run/4, get_opts/1, wait_for_ct_stop/1]).
+	 run/2, run/3, run/4, get_opts/1, wait_for_ct_stop/1]).
 
 -export([handle_event/2, start_event_receiver/1, get_events/2,
 	 verify_events/3, reformat/2, log_events/4,
@@ -223,7 +223,7 @@ get_opts(Config) ->
 
 %%%-----------------------------------------------------------------
 %%% 
-run(Opts, Config) ->
+run(Opts, Config) when is_list(Opts) ->
     CTNode = proplists:get_value(ct_node, Config),
     Level = proplists:get_value(trace_level, Config),
     %% use ct interface
@@ -256,9 +256,19 @@ run(Opts, Config) ->
     end.
 
 run(M, F, A, Config) ->
+    run({M,F,A}, [], Config).
+
+run({M,F,A}, InitCalls, Config) ->
     CTNode = proplists:get_value(ct_node, Config),
     Level = proplists:get_value(trace_level, Config),
-    test_server:format(Level, "~nCalling ~w:~w(~p) on ~p~n",
+    lists:foreach(
+      fun({IM,IF,IA}) ->
+	      test_server:format(Level, "~nInit call ~w:~w(~p) on ~p...~n",
+				 [IM, IF, IA, CTNode]),
+	      Result = rpc:call(CTNode, IM, IF, IA),
+	      test_server:format(Level, "~n...with result: ~p~n", [Result])
+      end, InitCalls),
+    test_server:format(Level, "~nStarting test with ~w:~w(~p) on ~p~n",
 		       [M, F, A, CTNode]),
     rpc:call(CTNode, M, F, A).
 
-- 
cgit v1.2.3

Node	Log
",timestamp(Dir),"	",MasterStr,"	",NodesStr,"
",timestamp(Dir),"	",MasterStr,"	",NodesStr,"