From e78be5c09eda6a8738d07d801dd8935f3eaa5400 Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Thu, 29 Sep 2011 00:21:27 +0200
Subject: Add documentation on timetraps and start flags

---
 lib/common_test/doc/src/common_test_app.xml    | 32 +++++++++++++++++++-------
 lib/common_test/doc/src/write_test_chapter.xml | 14 +++++++----
 lib/common_test/src/ct.erl                     |  2 +-
 3 files changed, 35 insertions(+), 13 deletions(-)

diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index 57b032b3fd..f58b2ab0a9 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -133,9 +133,15 @@
 	    {require,Name,Required} | {userdata,UserData} |
 	    {silent_connections,Conns} | {stylesheet,CSSFile} | 
 	    {ct_hooks, CTHs}</v>
-	<v> Time = MilliSec | {seconds,integer()} | {minutes,integer()}
-	  | {hours,integer()}</v>
+	<v> Time = TimeVal | TimeFunc</v>
+	<v> TimeVal = MilliSec | {seconds,integer()} | {minutes,integer()} |
+	    {hours,integer()}</v>
+	<v> TimeFunc = {Mod,Func,Args} | Fun</v>
 	<v> MilliSec = integer()</v>
+	<v> Mod = atom()</v>
+	<v> Func = atom()</v>
+	<v> Args = list()</v>
+	<v> Fun = fun()</v>
 	<v> Required = Key | {Key,SubKeys}</v>
 	<v> Key = atom()</v>
 	<v> SubKeys = SubKey | [SubKey]</v>
@@ -161,7 +167,9 @@
 	  test case is allowed to take (including <c>init_per_testcase/2</c>
 	  and <c>end_per_testcase/2</c>). If the timetrap time is
 	  exceeded, the test case fails with reason
-	  <c>timetrap_timeout</c>.</p>
+	  <c>timetrap_timeout</c>. If a <c>TimeFunc</c> function is specified,
+	  it will be called initially and must return a value on
+	  <c>TimeVal</c> format.</p>
 	
 	<p>The <c>require</c> tag specifies configuration variables
 	  that are required by test cases in the suite. If the required
@@ -248,7 +256,7 @@
 	</type>
 	<desc>	
 	  
-	  <p> MANDATORY (only if one or more groups are defined) </p>
+	  <p> OPTIONAL </p>
 	  
 	  <p>This function is called before execution of a test case group.
 	  It typically contains initialization which is common for
@@ -279,7 +287,7 @@
 	</type>
 	
 	<desc>	
-	  <p> MANDATORY (only if one or more groups are defined) </p>
+	  <p> OPTIONAL </p>
 	  
 	  <p>This function is called after the execution of a test case group is finished.
 	    It is meant to be used for cleaning up after <c>init_per_group/2</c>.
@@ -353,9 +361,15 @@
 	<v> Info = {timetrap,Time} | {require,Required} | 
 	    {require,Name,Required} | {userdata,UserData} |
 	    {silent_connections,Conns}</v>
-	<v> Time = MilliSec | {seconds,integer()} | {minutes,integer()}
-	  | {hours,integer()}</v>
+	<v> Time = TimeVal | TimeFunc</v>
+	<v> TimeVal = MilliSec | {seconds,integer()} | {minutes,integer()} |
+	    {hours,integer()}</v>
+	<v> TimeFunc = {Mod,Func,Args} | Fun</v>
 	<v> MilliSec = integer()</v>
+	<v> Mod = atom()</v>
+	<v> Func = atom()</v>
+	<v> Args = list()</v>
+	<v> Fun = fun()</v>
 	<v> Required = Key | {Key,SubKeys}</v>
 	<v> Key = atom()</v>
 	<v> SubKeys = SubKey | [SubKey]</v>
@@ -378,7 +392,9 @@
 	  exceeded, the test case fails with reason
 	  <c>timetrap_timeout</c>. <c>init_per_testcase/2</c>
 	  and <c>end_per_testcase/2</c> are included in the
-	  timetrap time.</p>
+	  timetrap time. If a <c>TimeFunc</c> function is specified,
+	  it will be called before the test case (or <c>init_per_testcase/2</c>)
+	  and must return a value on <c>TimeVal</c> format.</p>
 	
 	<p>The <c>require</c> tag specifies configuration variables
 	  that are required by the test case. If the required
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 3f9fdb7121..e35888e68f 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -280,6 +280,8 @@
 	    the timetrap time is exceeded, the test case fails with
 	    reason <c>timetrap_timeout</c>. Note that <c>init_per_testcase</c> 
 	    and <c>end_per_testcase</c> are included in the timetrap time.
+	    Please see the <seealso marker="write_test_chapter#timetraps">Timetrap</seealso>
+	    section for more details.
 	  </p>
 	</item>
 	<tag><em><c>userdata</c></em></tag>
@@ -699,8 +701,8 @@
   </section>
 
   <section>
-    <title>Timetrap timeouts</title>
     <marker id="timetraps"></marker>
+    <title>Timetrap timeouts</title>
     <p>The default time limit for a test case is 30 minutes, unless a
       <c>timetrap</c> is specified either by the suite info function
       or a test case info function. The timetrap timeout value defined
@@ -723,6 +725,13 @@
       multipled by <c>multiply_timetraps</c>, and possibly scaled up if
       <c>scale_timetraps</c> is enabled, the function <c>ct:sleep/1</c>
       may be called.</p>
+    <p>A function (<c>fun</c> or <c>MFA</c>) may be specified as timetrap value
+      in the suite- and test case info function, e.g:</p>
+      <p><c>{timetrap,{test_utils,get_timetrap_value,[?MODULE,system_start]}}</c></p>
+      <p>The function will be called initially by Common Test (before execution
+	of the suite or the test case) and must return a time value such as an
+	integer (millisec), or a <c>{SecMinOrHourTag,Time}</c> tuple. More
+	information can be found in the <c>common_test</c> reference manual.</p>
   </section>
 
   <section>
@@ -818,6 +827,3 @@
     </list>
   </section>
 </chapter>
-
-
-
diff --git a/lib/common_test/src/ct.erl b/lib/common_test/src/ct.erl
index 4c215d1b1e..f3c2029734 100644
--- a/lib/common_test/src/ct.erl
+++ b/lib/common_test/src/ct.erl
@@ -151,7 +151,7 @@ run(TestDirs) ->
 %%%               {refresh_logs,LogDir} | {logopts,LogOpts} | {basic_html,Bool} |
 %%%               {ct_hooks, CTHs}
 %%%   TestDirs = [string()] | string()
-%%%   Suites = [string()] | string()
+%%%   Suites = [string()] | [atom()] | string() | atom()
 %%%   Cases = [atom()] | atom()
 %%%   Groups = [atom()] | atom()
 %%%   TestSpecs = [string()] | string()
-- 
cgit v1.2.3