aboutsummaryrefslogtreecommitdiffstats
path: root/lib/test_server/doc
diff options
context:
space:
mode:
Diffstat (limited to 'lib/test_server/doc')
-rw-r--r--lib/test_server/doc/src/basics_chapter.xml12
-rw-r--r--lib/test_server/doc/src/part.xml4
-rw-r--r--lib/test_server/doc/src/part_notes.xml4
-rw-r--r--lib/test_server/doc/src/part_notes_history.xml4
-rw-r--r--lib/test_server/doc/src/ref_man.xml4
-rw-r--r--lib/test_server/doc/src/test_server.xml11
-rw-r--r--lib/test_server/doc/src/test_server_app.xml5
-rw-r--r--lib/test_server/doc/src/test_server_ctrl.xml55
-rw-r--r--lib/test_server/doc/src/test_spec_chapter.xml5
-rw-r--r--lib/test_server/doc/src/write_framework_chapter.xml13
-rw-r--r--lib/test_server/doc/src/write_test_chapter.xml3
11 files changed, 28 insertions, 92 deletions
diff --git a/lib/test_server/doc/src/basics_chapter.xml b/lib/test_server/doc/src/basics_chapter.xml
index a96cc88075..2e60d412e9 100644
--- a/lib/test_server/doc/src/basics_chapter.xml
+++ b/lib/test_server/doc/src/basics_chapter.xml
@@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -105,14 +105,14 @@
<p>The Test Server consists of three parts:
</p>
<list type="bulleted">
- <item>The part that executes the test suites on target and
+ <item>The part that executes the test suites and
provides support for the test suite author is called
<c>test_server</c>. This is described in the chapter about
writing test cases in this user's guide, and in the reference
manual for the <c>test_server</c> module.</item>
<item>The controlling part, which provides the low level
- operator interface, starts and stops the target node (if remote
- target) and slave nodes and writes log files, is called
+ operator interface, starts and stops slave nodes and writes
+ log files, is called
<c>test_server_ctrl</c>. The Test Server Controller should not
be used directly when running tests. Instead a framework built
on top of it should be used. More information
@@ -176,9 +176,7 @@
shall return an empty list, a test specification or
<c>{skip,Reason}</c>. If an empty list is returned, it means
that the test case shall be executed, and so it must also have
- an execution clause. Note that the specification clause is
- always executed on the controller node, i.e. not on the target
- node.
+ an execution clause.
</item>
<tag><em>test case</em></tag>
<item>A single test included in a test suite. Typically it tests
diff --git a/lib/test_server/doc/src/part.xml b/lib/test_server/doc/src/part.xml
index fdcd3d274e..a20835e035 100644
--- a/lib/test_server/doc/src/part.xml
+++ b/lib/test_server/doc/src/part.xml
@@ -4,7 +4,7 @@
<part xmlns:xi="http://www.w3.org/2001/XInclude">
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -30,7 +30,7 @@
<description>
<p><em>Test Server</em> is a portable test server for
automated application testing. The server can run test suites
- on local or remote targets and log progress and results to HTML
+ and log progress and results to HTML
pages. The main purpose of Test Server is to act as engine
inside customized test tools. A callback interface for
such framework applications is provided.</p>
diff --git a/lib/test_server/doc/src/part_notes.xml b/lib/test_server/doc/src/part_notes.xml
index 2347f64ca1..abf949dfda 100644
--- a/lib/test_server/doc/src/part_notes.xml
+++ b/lib/test_server/doc/src/part_notes.xml
@@ -4,7 +4,7 @@
<part xmlns:xi="http://www.w3.org/2001/XInclude">
<header>
<copyright>
- <year>2004</year><year>2009</year>
+ <year>2004</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -30,7 +30,7 @@
<description>
<p>The <em>Test Server</em> is a portable test server for
application testing. The test server can run automatic test suites
- on local or remote target and log progress and results to HTML
+ and log progress and results to HTML
pages. It also provides some support for test suite authors.</p>
<p>For information about older versions, see
<url href="part_notes_history_frame.html">Release Notes History</url>.</p>
diff --git a/lib/test_server/doc/src/part_notes_history.xml b/lib/test_server/doc/src/part_notes_history.xml
index 556d172755..4746f583b9 100644
--- a/lib/test_server/doc/src/part_notes_history.xml
+++ b/lib/test_server/doc/src/part_notes_history.xml
@@ -4,7 +4,7 @@
<part>
<header>
<copyright>
- <year>2006</year><year>2009</year>
+ <year>2006</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -30,7 +30,7 @@
<description>
<p>The <em>Test Server</em> is a portable test server for
application testing. The test server can run automatic test suites
- on local or remote target and log progress and results to HTML
+ and log progress and results to HTML
pages. It also provides some support for test suite authors.</p>
</description>
<include file="notes_history"></include>
diff --git a/lib/test_server/doc/src/ref_man.xml b/lib/test_server/doc/src/ref_man.xml
index 17d6093dc0..ca0b38e0c8 100644
--- a/lib/test_server/doc/src/ref_man.xml
+++ b/lib/test_server/doc/src/ref_man.xml
@@ -4,7 +4,7 @@
<application xmlns:xi="http://www.w3.org/2001/XInclude">
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -31,7 +31,7 @@
<description>
<p><em>Test Server</em> is a portable test server for
automated application testing. The server can run test suites
- on local or remote targets and log progress and results to HTML
+ and log progress and results to HTML
pages. The main purpose of Test Server is to act as engine
inside customized test tools. A callback interface for
such framework applications is provided.</p>
diff --git a/lib/test_server/doc/src/test_server.xml b/lib/test_server/doc/src/test_server.xml
index 841cbfbe91..5ef43dd628 100644
--- a/lib/test_server/doc/src/test_server.xml
+++ b/lib/test_server/doc/src/test_server.xml
@@ -5,7 +5,7 @@
<header>
<copyright>
<year>2007</year>
- <year>2012</year>
+ <year>2013</year>
<holder>Ericsson AB, All Rights Reserved</holder>
</copyright>
<legalnotice>
@@ -73,8 +73,8 @@
<d>This is the same as returned from <c>os:type/0</c></d>
</type>
<desc>
- <p>This function can be called on controller or target node, and
- it will always return the OS type of the target node.</p>
+ <p>This function is equivalent to <c>os:type/0</c>. It is kept
+ for backwards compatibility.</p>
</desc>
</func>
<func>
@@ -465,9 +465,7 @@ Tries running clock_sanity_check() up to 8 times,and
<taglist>
<tag><c>{remote, true}</c></tag>
<item>Start the node on a remote host. If not specified, the
- node will be started on the local host (with some
- exceptions, as for the case of VxWorks, where
- all nodes are started on a remote host). Test cases that
+ node will be started on the local host. Test cases that
require a remote host will fail with a reasonable comment if
no remote hosts are available at the time they are run.
</item>
@@ -748,7 +746,6 @@ Only valid for peer nodes. Note that slave nodes always
test case or <c>{skip,Comment}</c>. The syntax of a test
specification is described in the Test Server User's Guide.
</p>
- <p><em>Note that the specification clause always is executed on the controller host.</em></p>
<p>The <em>execution clause</em> (argument <c>Config</c>) is
only called if the specification clause returns an empty list.
The execution clause is the real test case. Here you must call
diff --git a/lib/test_server/doc/src/test_server_app.xml b/lib/test_server/doc/src/test_server_app.xml
index 924cdc886b..ea4b5ffecf 100644
--- a/lib/test_server/doc/src/test_server_app.xml
+++ b/lib/test_server/doc/src/test_server_app.xml
@@ -4,7 +4,7 @@
<appref>
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -36,14 +36,13 @@
<description>
<p><em>Test Server</em> is a portable test server for
automated application testing. The server can run test suites
- on local or remote targets and log progress and results to HTML
+ and log progress and results to HTML
pages. The main purpose of Test Server is to act as engine
inside customized test tools. A callback interface for
such framework applications is provided.</p>
<p>In brief the test server supports:</p>
<list type="bulleted">
<item>Running multiple, concurrent test suites</item>
- <item>Running tests on remote and even diskless targets</item>
<item>Test suites may contain other test suites, in a tree fashion</item>
<item>Logging of the events in a test suite, on both suite and case levels</item>
<item>HTML presentation of test suite results</item>
diff --git a/lib/test_server/doc/src/test_server_ctrl.xml b/lib/test_server/doc/src/test_server_ctrl.xml
index af96f1fe7e..9252cdce4f 100644
--- a/lib/test_server/doc/src/test_server_ctrl.xml
+++ b/lib/test_server/doc/src/test_server_ctrl.xml
@@ -5,7 +5,7 @@
<header>
<copyright>
<year>2007</year>
- <year>2012</year>
+ <year>2013</year>
<holder>Ericsson AB, All Rights Reserved</holder>
</copyright>
<legalnotice>
@@ -57,64 +57,19 @@
<funcs>
<func>
<name>start() -> Result</name>
- <name>start(ParameterFile) -> Result</name>
<fsummary>Starts the test server.</fsummary>
<type>
<v>Result = ok | {error, {already_started, pid()}</v>
- <v>ParameterFile = atom() | string()</v>
</type>
<desc>
- <p>This function starts the test server. If the parameter file
- is given, it indicates that the target is remote. In that case
- the target node is started and a socket connection is
- established between the controller and the target node.
- </p>
- <p>The parameter file is a text file containing key-value
- tuples. Each tuple must be followed by a dot-newline
- sequence. The following key-value tuples are allowed:
- </p>
- <taglist>
- <tag><c>{type,PlatformType}</c></tag>
- <item>This is an atom indicating the target platform type,
- currently supported: <c>PlatformType = vxworks</c> <br></br>
-Mandatory
- </item>
- <tag><c>{target,TargetHost}</c></tag>
- <item>This is the name of the target host, can be atom or
- string.
- <br></br>
-Mandatory
- </item>
- <tag><c>{slavetargets,SlaveTargets}</c></tag>
- <item>This is a list of available hosts where slave nodes
- can be started. The hostnames are given as atoms or strings.
- <br></br>
-Optional, default <c>SlaveTargets = []</c></item>
- <tag><c>{longnames,Bool}</c></tag>
- <item>This indicates if longnames shall be used, i.e. if the
- <c>-name</c> option should be used for the target node
- instead of <c>-sname</c> <br></br>
-Optional, default <c>Bool = false</c></item>
- <tag><c>{master, {MasterHost, MasterCookie}}</c></tag>
- <item>If target is remote and the target node is started as
- a slave node, this option indicates which master and
- cookie to use. The given master
- will also be used as master for slave nodes started with
- <c>test_server:start_node/3</c>. It is expected that the
- <c>erl_boot_server</c> is started on the master node before
- the <c>test_server_ctrl:start/1</c> function is called.
- <br></br>
-Optional, if not given the test server controller node
- is used as master and the <c>erl_boot_server</c> is
- automatically started.</item>
- </taglist>
+ <p>This function starts the test server.</p>
</desc>
</func>
<func>
<name>stop() -> ok</name>
<fsummary>Stops the test server immediately.</fsummary>
<desc>
- <p>This stops the test server (both controller and target) and
+ <p>This stops the test server and
all its activity. The running test suite (if any) will be
halted.</p>
</desc>
@@ -685,10 +640,6 @@ test_server_ctrl:cross_cover_analyse(Level,[{s1,S1LogDir},{s2,S2LogDir}])
default name. This does not apply to <c>SPEC</c> which keeps
its names.
</item>
- <tag><c>PARAMETERS parameterfile</c></tag>
- <item>Specifies the parameter file to use when starting
- remote target
- </item>
<tag><c>COVER app cover_file analyse</c></tag>
<item>Indicates that the test should be run with cover
analysis. <c>app</c>, <c>cover_file</c> and <c>analyse</c>
diff --git a/lib/test_server/doc/src/test_spec_chapter.xml b/lib/test_server/doc/src/test_spec_chapter.xml
index 3a7730d61e..c197e03bed 100644
--- a/lib/test_server/doc/src/test_spec_chapter.xml
+++ b/lib/test_server/doc/src/test_spec_chapter.xml
@@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -99,8 +99,7 @@
function fails, all tests in the test suite are skipped. The
difference between this "make case" and a normal conf case is
that for the make case, <c>Init</c> and <c>Fin</c> are given with
- arguments (<c>{Mod,Func,Args}</c>), and that they are executed
- on the controller node (i.e. not on target).
+ arguments (<c>{Mod,Func,Args}</c>).
</item>
<tag><c>Case</c></tag>
<item>This can only be used inside a module, i.e. not a test
diff --git a/lib/test_server/doc/src/write_framework_chapter.xml b/lib/test_server/doc/src/write_framework_chapter.xml
index 8a20e9afec..5c1c657d9e 100644
--- a/lib/test_server/doc/src/write_framework_chapter.xml
+++ b/lib/test_server/doc/src/write_framework_chapter.xml
@@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -46,15 +46,8 @@
<title>Interfacing the test server controller from Erlang</title>
<p>Using the test server from Erlang means that you have to start
the test server and then add test jobs. Use
- <c>test_server_ctrl:start/0</c> to start a local target or
- <c>test_server_ctrl:start/1</c> to start a remote target. The test
- server is stopped by <c>test_server_ctrl:stop/0</c>.
- </p>
- <p>The argument to <c>test_server_ctrl:start/1</c> is the name of a
- parameter file. The parameter file specifies what type of target
- to start and where to start it, as well as some additional
- parameters needed for different target types. See the reference
- manual for a detailed description of all valid parameters.
+ <c>test_server_ctrl:start/0</c> to start the test server, and
+ <c>test_server_ctrl:stop/0</c> to stop it.
</p>
<section>
diff --git a/lib/test_server/doc/src/write_test_chapter.xml b/lib/test_server/doc/src/write_test_chapter.xml
index 12f0dfc361..086ed2a18d 100644
--- a/lib/test_server/doc/src/write_test_chapter.xml
+++ b/lib/test_server/doc/src/write_test_chapter.xml
@@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -130,7 +130,6 @@
case. If the test specification is an empty list, this indicates
that the test case is a leaf test case, i.e. one to be executed.
</p>
- <p><em>Note that the specification clause of a test case is executed on the test server controller host. This means that if target is remote, the specification clause is probably executed on a different platform than the one tested.</em></p>
<p>The execution clause implements the actual test case. It takes
one argument, <c>Config</c>, which contain configuration
information like <c>data_dir</c> and <c>priv_dir</c>. See <seealso marker="#data_priv_dir">Data and Private Directories</seealso> for
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-12 09:54:31 +0000