From a9c315929d96c7d0d0e5e79f8fc0ba0c7f17e94d Mon Sep 17 00:00:00 2001 From: Andrey Pampukha Date: Mon, 15 Mar 2010 15:26:02 +0100 Subject: Changed return value tags for config file handling Return value tags modified and various documentation updates made (work in progress). --- lib/common_test/doc/src/run_test_chapter.xml | 3 +++ 1 file changed, 3 insertions(+) (limited to 'lib/common_test/doc/src/run_test_chapter.xml') diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index d731d18783..b7e9ab88e3 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -111,11 +111,14 @@ -dir ]]> -suite ]]> + -suite ]]> + -suite -group -case ]]>

Examples:

$ run_test -config $CFGS/sys1.cfg $CFGS/sys2.cfg -dir $SYS1_TEST $SYS2_TEST

+

$ run_test -userconfig ct_config_xml $CFGS/sys1.xml $CFGS/sys2.xml -dir $SYS1_TEST $SYS2_TEST

$ run_test -suite $SYS1_TEST/setup_SUITE $SYS2_TEST/config_SUITE

$ run_test -suite $SYS1_TEST/setup_SUITE -case start stop

$ run_test -suite $SYS1_TEST/setup_SUITE -group installation -case start stop

-- cgit v1.2.3 From 2c711e660df6683eee9cdfeb204e02f093153c36 Mon Sep 17 00:00:00 2001 From: Andrey Pampukha Date: Thu, 25 Mar 2010 11:42:26 +0100 Subject: Add test suites for ct_master Also includes minor documentation updates. --- lib/common_test/doc/src/run_test_chapter.xml | 3 +++ 1 file changed, 3 insertions(+) (limited to 'lib/common_test/doc/src/run_test_chapter.xml') diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index b7e9ab88e3..00cf4adf52 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -370,6 +370,9 @@ {config, ConfigFiles}. {config, NodeRefs, ConfigFiles}. + + {userconfig, {CallbackModule, ConfigStrings}}. + {userconfig, NodeRefs, {CallbackModule, ConfigStrings}}. {alias, DirAlias, Dir}. -- cgit v1.2.3 From ebcab814cabc74407f48aba1b41327df80586fcd Mon Sep 17 00:00:00 2001 From: Andrey Pampukha Date: Thu, 15 Apr 2010 12:57:04 +0200 Subject: Document ct_slave and 'eval' terms --- lib/common_test/doc/src/run_test_chapter.xml | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'lib/common_test/doc/src/run_test_chapter.xml') diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index 00cf4adf52..f5dc477c6f 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -383,6 +383,9 @@ {event_handler, NodeRefs, EventHandlers}. {event_handler, EventHandlers, InitArgs}. {event_handler, NodeRefs, EventHandlers, InitArgs}. + + {eval, [{Module, Function, Arguments}]}. + {eval, [NodeAlias], [{Module, Function, Arguments}]}.

Test terms:

@@ -455,9 +458,20 @@
       Secondly, the test for system t2 should run. The included suites are
 	t2B and t2C. Included are also test cases test4, test1 and test7 in suite
 	t2A. Note that the test cases will be executed in the specified order.
-      Lastly, all suites for systems t3 are to be completely skipped and this 
+      Lastly, all suites for systems t3 are to be completely skipped and this
 	should be explicitly noted in the log files.
     
+    
It is possible to evaluate any function(s) during processing of the test
+      specification. This feature may be used e.g. to add some directories to
+      the code path, initialise some ETS table etc. New eval terms can be
+      used for this purpose.
+      If only a list of functions is given, then all functions from the list
+      will be consequently applied on the current node. If at least one node
+      alias is given, then the functions will be called remotely on all nodes
+      specified. Please note that in case when node is defined to be started by
+      the CT Master, the evaluation will be deferred.
+      See the Automatic startup of
+      the test target nodes chapter for details.

     
It is possible for the user to provide a test specification that
       includes (for Common Test) unrecognizable terms. If this is desired,
       the -allow_user_terms flag should be used when starting tests with
-- 
cgit v1.2.3


From 1327bd8956b2d0f6b5a9201ce9ecf361f94733aa Mon Sep 17 00:00:00 2001
From: Andrey Pampukha 
Date: Mon, 19 Apr 2010 17:28:07 +0200
Subject: Move 'node_start' and 'eval' terms into new 'init' term

node_start+eval -> init(node_start, eval)
Also include some documentation updates.
---
 lib/common_test/doc/src/run_test_chapter.xml | 16 +++++-----------
 1 file changed, 5 insertions(+), 11 deletions(-)

(limited to 'lib/common_test/doc/src/run_test_chapter.xml')

diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index f5dc477c6f..44b4077ec4 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -384,8 +384,8 @@
       {event_handler, EventHandlers, InitArgs}.
       {event_handler, NodeRefs, EventHandlers, InitArgs}.
 
-      {eval, [{Module, Function, Arguments}]}.
-      {eval, [NodeAlias], [{Module, Function, Arguments}]}.
+      {init, Options}.
+      {init, [NodeAlias], Options}.

Test terms:

@@ -461,15 +461,9 @@
       Lastly, all suites for systems t3 are to be completely skipped and this
 	should be explicitly noted in the log files.
     
-    
It is possible to evaluate any function(s) during processing of the test
-      specification. This feature may be used e.g. to add some directories to
-      the code path, initialise some ETS table etc. New eval terms can be
-      used for this purpose.
-      If only a list of functions is given, then all functions from the list
-      will be consequently applied on the current node. If at least one node
-      alias is given, then the functions will be called remotely on all nodes
-      specified. Please note that in case when node is defined to be started by
-      the CT Master, the evaluation will be deferred.
+    
It is possible to specify initialization options for nodes defined in the
+      test specification. Currently, there are options to start the node and/or to
+      evaluate any function on the node.
       See the Automatic startup of
       the test target nodes chapter for details.

     
It is possible for the user to provide a test specification that
-- 
cgit v1.2.3


From 5cf552a62742c6ddc974ba5491188576d512254e Mon Sep 17 00:00:00 2001
From: Peter Andersson 
Date: Mon, 24 May 2010 17:38:19 +0200
Subject: Add run_test program for Common Test

Common Test may now be started with the program run_test instead of the legacy shell script with the same name.

Minor updates have also been made to the Webtool application.
---
 lib/common_test/doc/src/run_test_chapter.xml | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

(limited to 'lib/common_test/doc/src/run_test_chapter.xml')

diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index 44b4077ec4..917f3374db 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -102,10 +102,10 @@
   
 
   

-    Running tests from the UNIX command line
+    Running tests from the OS command line
     
-    
The script run_test can be used for running tests from
-      the Unix/Linux command line, e.g.
+    
The run_test program can be used for running tests from
+      the OS command line, e.g.
     

     
        -dir ]]>
@@ -168,7 +168,7 @@
 	     the current working directory of the Erlang Runtime System during the test run!

     
     
-    
For details on how to generate the run_test script, see the 
+    
For more information about the run_test program, see the
       Installation chapter.
     

   

@@ -177,7 +177,7 @@
     Running tests from the Web based GUI
     
     
The web based GUI, VTS, is started with the run_test
-      script. From the GUI you can load config files, and select
+      program. From the GUI you can load config files, and select
       directories, suites and cases to run. You can also state the
       config files, directories, suites and cases on the command line
       when starting the web based GUI.
@@ -201,10 +201,11 @@
       
Example:

       

       
Note that the browser must run as a separate OS process or VTS will hang!

-      
If no specific browser start command is specified, netscape will
+      
If no specific browser start command is specified, Firefox will
         be the default browser on Unix platforms and Internet Explorer on Windows.
-	If Common Test fails to start a browser automatically, start your 
-	favourite browser manually instead and type in the URL that Common Test
+	If Common Test fails to start a browser automatically, or 'none' is
+	specified as the value for -browser (i.e. -browser none), start your
+	favourite browser manually and type in the URL that Common Test
 	displays in the shell.
    
   
   
@@ -214,7 +215,7 @@
     
Common Test provides an Erlang API for running tests. The main (and most
       flexible) function for specifying and executing tests is called
       ct:run_test/1. This function takes the same start parameters as
-      the run_test script described above, only the flags are instead
+      the run_test program described above, only the flags are instead
       given as options in a list of key-value tuples. E.g. a test specified 
       with run_test like:

       
$ run_test -suite ./my_SUITE -logdir ./results
 
@@ -240,7 +241,7 @@
       manually and call ct:install/1 to install any configuration
       data you might need (use [] as argument otherwise), then
       call ct:start_interactive/0 to start Common Test. If you use
-      the run_test script, you may start the Erlang shell and Common Test
+      the run_test program, you may start the Erlang shell and Common Test
       in the same go by using the -shell and, optionally, the -config
       flag:
     

-- 
cgit v1.2.3


From 7b33aa92bb2558ba04a6436203638fd46592b8d2 Mon Sep 17 00:00:00 2001
From: Peter Andersson 
Date: Thu, 27 May 2010 00:46:37 +0200
Subject: Improve documentation and fix minor problems

General documentation and code updates.
---
 lib/common_test/doc/src/run_test_chapter.xml | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

(limited to 'lib/common_test/doc/src/run_test_chapter.xml')

diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index 917f3374db..7fd3174e71 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -354,13 +354,17 @@
 
     
Below is the test specification syntax. Test specifications can
       be used to run tests both in a single test host environment and in 
-      a distributed Common Test environment. Node parameters are only relevant in the 
-      latter (see the chapter about running Common Test in distributed mode for information). 
-      For details on the event_handler term, see the 
+      a distributed Common Test environment (Large Scale Testing). The init term,
+      as well as node parameters, are only relevant in the latter (see the
+      Large Scale Testing
+      chapter for information). For details on the event_handler term, see the
       Event Handling
       chapter.

       
Config terms:

     
+      {init, InitOptions}.
+      {init, [NodeAlias], InitOptions}.
+
       {node, NodeAlias, Node}.
  
       {cover, CoverSpecFile}.
@@ -384,9 +388,6 @@
       {event_handler, NodeRefs, EventHandlers}.
       {event_handler, EventHandlers, InitArgs}.
       {event_handler, NodeRefs, EventHandlers, InitArgs}.
-
-      {init, Options}.
-      {init, [NodeAlias], Options}.
     

       
Test terms:

     
@@ -404,6 +405,7 @@
     

       
Types:

     
+      InitOptions   = term()
       NodeAlias     = atom()
       Node          = node()
       NodeRef       = NodeAlias | Node | master
-- 
cgit v1.2.3


From 2d7ba88ebbb59a473dbcefd0f9dee1f1b816935e Mon Sep 17 00:00:00 2001
From: Peter Andersson 
Date: Tue, 8 Jun 2010 14:44:05 +0200
Subject: Misc documentation updates

---
 lib/common_test/doc/src/run_test_chapter.xml | 31 +++++++++++++++++++++-------
 1 file changed, 24 insertions(+), 7 deletions(-)

(limited to 'lib/common_test/doc/src/run_test_chapter.xml')

diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index 7fd3174e71..54e9a3174c 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -97,8 +97,12 @@
       the  option with 
       . With automatic compilation
       disabled, the user is responsible for compiling the test suite modules 
-      (and any help modules) before the test run. Common Test will only verify 
-      that the specified test suites exist before starting the tests.
 
+      (and any help modules) before the test run. If the modules can not be loaded
+      from the local file system during startup of Common Test, the user needs to
+      pre-load the modules before starting the test. Common Test will only verify
+      that the specified test suites exist (i.e. that they are, or can be, loaded).
+      This is useful e.g. if the test suites are transferred and loaded as binaries via
+      RPC from a remote node.

   
 
   

@@ -139,8 +143,14 @@
 	Code Coverage Analysis).
       ]]>, to install 
         event handlers.
+      ]]>, to install
+        event handlers including start arguments.
       , specifies include directories (see above).
       , disables the automatic test suite compilation feature (see above).
+      ]]>, extends timetrap
+	  timeout values.
+      ]]>, enables automatic timetrap
+	  timeout scaling.
       ]]>, tells Common Test to repeat the tests n times (see below). 
       ]]>, tells Common Test to repeat the tests for duration of time (see below). 
       ]]>, tells Common Test to repeat the tests until stop_time (see below). 
@@ -243,11 +253,12 @@
       call ct:start_interactive/0 to start Common Test. If you use
       the run_test program, you may start the Erlang shell and Common Test
       in the same go by using the -shell and, optionally, the -config
-      flag:
+      and/or -userconfig flag. Examples:
     

     
       run_test -shell
-      ]]>
+      
+      
     
     
     
If no config file is given with the run_test command,
@@ -272,7 +283,8 @@
        2> ct_telnet:open(unix_telnet).
        {ok,<0.105.0>}
        4> ct_telnet:cmd(unix_telnet, "ls .").
-       {ok,["ls .","file1  ...",...]}

+       {ok,["ls .","file1  ...",...]}
+

Everything that Common Test normally prints in the test case logs, will in the interactive mode be written to a log named @@ -362,10 +374,13 @@ chapter.

Config terms:

+      {node, NodeAlias, Node}.
+
       {init, InitOptions}.
       {init, [NodeAlias], InitOptions}.
 
-      {node, NodeAlias, Node}.
+      {multiply_timetraps, N}.
+      {scale_timetraps, Bool}.
  
       {cover, CoverSpecFile}.
       {cover, NodeRef, CoverSpecFile}.
@@ -405,11 +420,13 @@

Types:

-      InitOptions   = term()
       NodeAlias     = atom()
+      InitOptions   = term()
       Node          = node()
       NodeRef       = NodeAlias | Node | master
       NodeRefs      = all_nodes | [NodeRef] | NodeRef
+      N             = integer()
+      Bool          = true | false
       CoverSpecFile = string()
       IncludeDirs   = string() | [string()]
       ConfigFiles   = string() | [string()]
-- 
cgit v1.2.3