From 3d087911ef3ecd769333b822c337bbbb76877871 Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Wed, 20 Mar 2019 16:48:41 +0100
Subject: [ct] Add {testcase,TC,RepeatProps} syntax for repeating test cases

---
 lib/common_test/doc/src/common_test_app.xml    | 17 ++++++++++-------
 lib/common_test/doc/src/ct_hooks.xml           | 14 ++++++++------
 lib/common_test/doc/src/write_test_chapter.xml | 18 ++++++++++--------
 3 files changed, 28 insertions(+), 21 deletions(-)

(limited to 'lib/common_test/doc/src')

diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index a3b3f927eb..5fa87901f6 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -72,14 +72,15 @@
       <fsummary>Returns the list of all test case groups and test cases
 	in the module.</fsummary>
       <type>
-	<v>Tests = [TestCase | {group,GroupName} | {group,GroupName,Properties} | {group,GroupName,Properties,SubGroups}]</v>
+	<v>Tests = [TestCase | {testcase,TestCase,TCRepeatProps} | {group,GroupName} | {group,GroupName,Properties} | {group,GroupName,Properties,SubGroups}]</v>
 	<v>TestCase = atom()</v>
+	<v>TCRepeatProps = [{repeat,N} | {repeat_until_ok,N} | {repeat_until_fail,N}]</v>
 	<v>GroupName = atom()</v>
-	<v>Properties = [parallel | sequence | Shuffle | {RepeatType,N}] | default</v>
+	<v>Properties = [parallel | sequence | Shuffle | {GroupRepeatType,N}] | default</v>
 	<v>SubGroups = [{GroupName,Properties} | {GroupName,Properties,SubGroups}]</v>
 	<v>Shuffle = shuffle | {shuffle,Seed}</v>
 	<v>Seed = {integer(),integer(),integer()}</v>
-	<v>RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
+	<v>GroupRepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
 	<v>N = integer() | forever</v>
 	<v>Reason = term()</v>
       </type>
@@ -91,7 +92,8 @@
           test suite module to be executed. This list also specifies the
           order the cases and groups are executed by <c>Common Test</c>.
           A test case is represented by an atom,
-	  the name of the test case function. A test case group is
+	  the name of the test case function, or a <c>testcase</c> tuple
+	  indicating that the test case shall be repeated. A test case group is
 	  represented by a <c>group</c> tuple, where <c>GroupName</c>,
 	  an atom, is the name of the group (defined in
 	  <seealso marker="#Module:groups-0"><c>groups/0</c></seealso>).
@@ -121,12 +123,13 @@
         <v>GroupDefs = [Group]</v>
         <v>Group = {GroupName,Properties,GroupsAndTestCases}</v>
         <v>GroupName = atom()</v>
-        <v>Properties = [parallel | sequence | Shuffle | {RepeatType,N}]</v>
-        <v>GroupsAndTestCases = [Group | {group,GroupName} | TestCase]</v>
+        <v>Properties = [parallel | sequence | Shuffle | {GroupRepeatType,N}]</v>
+        <v>GroupsAndTestCases = [Group | {group,GroupName} | TestCase | {testcase,TestCase,TCRepeatProps}]</v>
         <v>TestCase = atom()</v>
+	<v>TCRepeatProps = [{repeat,N} | {repeat_until_ok,N} | {repeat_until_fail,N}]</v>
         <v>Shuffle = shuffle | {shuffle,Seed}</v>
         <v>Seed = {integer(),integer(),integer()}</v>
-        <v>RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
+        <v>GroupRepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
         <v>N = integer() | forever</v>
       </type>
 
diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml
index 613b694796..03dfceaa1f 100644
--- a/lib/common_test/doc/src/ct_hooks.xml
+++ b/lib/common_test/doc/src/ct_hooks.xml
@@ -116,12 +116,13 @@
         <v>GroupDefs = NewGroupDefs = [Group]</v>
         <v>Group = {GroupName,Properties,GroupsAndTestCases}</v>
         <v>GroupName = atom()</v>
-        <v>Properties = [parallel | sequence | Shuffle | {RepeatType,N}]</v>
-        <v>GroupsAndTestCases = [Group | {group,GroupName} | TestCase]</v>
+        <v>Properties = [parallel | sequence | Shuffle | {GroupRepeatType,N}]</v>
+        <v>GroupsAndTestCases = [Group | {group,GroupName} | TestCase | {testcase,TestCase,TCRepeatProps}]</v>
         <v>TestCase = atom()</v>
+	<v>TCRepeatProps = [{repeat,N} | {repeat_until_ok,N} | {repeat_until_fail,N}]</v>
         <v>Shuffle = shuffle | {shuffle,Seed}</v>
         <v>Seed = {integer(),integer(),integer()}</v>
-        <v>RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
+        <v>GroupRepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
         <v>N = integer() | forever</v>
       </type>
       <desc>
@@ -169,18 +170,19 @@
       <type>
         <v>SuiteName = atom()</v>
 	<v>Return = NewReturn = Tests | {skip,Reason}</v>
-	<v>Tests = [TestCase | {group,GroupName} | {group,GroupName,Properties} | {group,GroupName,Properties,SubGroups}]</v>
+	<v>Tests = [TestCase | {testcase,TestCase,TCRepeatProps} | {group,GroupName} | {group,GroupName,Properties} | {group,GroupName,Properties,SubGroups}]</v>
 	<v>TestCase = atom()</v>
+	<v>TCRepeatProps = [{repeat,N} | {repeat_until_ok,N} | {repeat_until_fail,N}]</v>
 	<v>GroupName = atom()</v>
 	<v>Properties = GroupProperties | default</v>
 	<v>SubGroups = [{GroupName,Properties} | {GroupName,Properties,SubGroups}]</v>
 	<v>Shuffle = shuffle | {shuffle,Seed}</v>
 	<v>Seed = {integer(),integer(),integer()}</v>
-	<v>RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
+	<v>GroupRepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail | repeat_until_any_ok | repeat_until_any_fail</v>
 	<v>N = integer() | forever</v>
         <v>GroupDefs = NewGroupDefs = [Group]</v>
         <v>Group = {GroupName,GroupProperties,GroupsAndTestCases}</v>
-        <v>GroupProperties = [parallel | sequence | Shuffle | {RepeatType,N}]</v>
+        <v>GroupProperties = [parallel | sequence | Shuffle | {GroupRepeatType,N}]</v>
         <v>GroupsAndTestCases = [Group | {group,GroupName} | TestCase]</v>
 	<v>Reason = term()</v>
       </type>
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 82dc06834f..5eed748b08 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -455,8 +455,10 @@
  GroupDefs = [GroupDef]
  GroupDef = {GroupName,Properties,GroupsAndTestCases}
  GroupName = atom()
- GroupsAndTestCases = [GroupDef | {group,GroupName} | TestCase]
- TestCase = atom()</pre>
+ GroupsAndTestCases = [GroupDef | {group,GroupName} | TestCase |
+                      {testcase,TestCase,TCRepeatProps}]
+ TestCase = atom()
+ TCRepeatProps = [{repeat,N} | {repeat_until_ok,N} | {repeat_until_fail,N}]</pre>
 
     <p><c>GroupName</c> is the name of the group and must be unique within
     the test suite module. Groups can be nested, by including a group definition 
@@ -464,11 +466,11 @@
     <c>Properties</c> is the list of execution 
     properties for the group. The possible values are as follows:</p>
     <pre>
- Properties = [parallel | sequence | Shuffle | {RepeatType,N}]
+ Properties = [parallel | sequence | Shuffle | {GroupRepeatType,N}]
  Shuffle = shuffle | {shuffle,Seed}
  Seed = {integer(),integer(),integer()}
- RepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail |
-              repeat_until_any_ok | repeat_until_any_fail
+ GroupRepeatType = repeat | repeat_until_all_ok | repeat_until_all_fail |
+                   repeat_until_any_ok | repeat_until_any_fail
  N = integer() | forever</pre>
 
     <p><em>Explanations:</em></p>
@@ -481,8 +483,8 @@
     Dependencies Between Test Cases and Suites.</p></item>
        <tag><c>shuffle</c></tag>
        <item><p>The cases in the group are executed in random order.</p></item>
-       <tag><c>repeat</c></tag>
-       <item><p>Orders <c>Common Test</c> to repeat execution of the cases in the 
+       <tag><c>repeat, repeat_until_*</c></tag>
+       <item><p>Orders <c>Common Test</c> to repeat execution of all the cases in the 
        group a given number of times, or until any, or all, cases fail or succeed.</p></item>
      </taglist>
       
@@ -496,7 +498,7 @@
     <c>{group,GroupName}</c> to the <c>all/0</c> list.</p>
     <p><em>Example:</em></p>
     <pre>
- all() -> [testcase1, {group,group1}, testcase2, {group,group2}].</pre>
+ all() -> [testcase1, {group,group1}, {testcase,testcase2,[{repeat,10}]}, {group,group2}].</pre>
 
     <p>Execution properties with a group tuple in 
     <c>all/0</c>: <c>{group,GroupName,Properties}</c> can also be specified. 
-- 
cgit v1.2.3