From 2559ebdeb9067e79c9eec2190e21a8f63fe5bd2e Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Mon, 25 Feb 2013 11:52:34 +0100 Subject: [test_server] Remove unused code related to remote targets After removing the functionality for remote target nodes in R16A, there was still some unused code left and some documentation that was not updated. This is now completed. --- lib/test_server/doc/src/basics_chapter.xml | 12 ++--- lib/test_server/doc/src/part.xml | 4 +- lib/test_server/doc/src/part_notes.xml | 4 +- lib/test_server/doc/src/part_notes_history.xml | 4 +- lib/test_server/doc/src/ref_man.xml | 4 +- lib/test_server/doc/src/test_server.xml | 11 ++--- lib/test_server/doc/src/test_server_app.xml | 5 +- lib/test_server/doc/src/test_server_ctrl.xml | 55 ++-------------------- lib/test_server/doc/src/test_spec_chapter.xml | 5 +- .../doc/src/write_framework_chapter.xml | 13 ++--- lib/test_server/doc/src/write_test_chapter.xml | 3 +- 11 files changed, 28 insertions(+), 92 deletions(-) (limited to 'lib/test_server/doc/src') 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 @@
- 20022009 + 20022013 Ericsson AB. All Rights Reserved. @@ -105,14 +105,14 @@

The Test Server consists of three parts:

- The part that executes the test suites on target and + The part that executes the test suites and provides support for the test suite author is called test_server. This is described in the chapter about writing test cases in this user's guide, and in the reference manual for the test_server module. 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 test_server_ctrl. 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 {skip,Reason}. 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. test case 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 @@
- 20022009 + 20022013 Ericsson AB. All Rights Reserved. @@ -30,7 +30,7 @@

Test Server 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.

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 @@
- 20042009 + 20042013 Ericsson AB. All Rights Reserved. @@ -30,7 +30,7 @@

The Test Server 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.

For information about older versions, see Release Notes History.

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 @@
- 20062009 + 20062013 Ericsson AB. All Rights Reserved. @@ -30,7 +30,7 @@

The Test Server 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.

 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 @@
- 20022009 + 20022013 Ericsson AB. All Rights Reserved. @@ -31,7 +31,7 @@

Test Server 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.

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 @@
2007 - 2012 + 2013 Ericsson AB, All Rights Reserved @@ -73,8 +73,8 @@ This is the same as returned from os:type/0 -

This function can be called on controller or target node, and - it will always return the OS type of the target node.

+

This function is equivalent to os:type/0. It is kept + for backwards compatibility.

 @@ -465,9 +465,7 @@ Tries running clock_sanity_check() up to 8 times,and {remote, true} 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. @@ -748,7 +746,6 @@ Only valid for peer nodes. Note that slave nodes always test case or {skip,Comment}. The syntax of a test specification is described in the Test Server User's Guide.

-

Note that the specification clause always is executed on the controller host.

The execution clause (argument Config) 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 @@

- 20022009 + 20022013 Ericsson AB. All Rights Reserved. @@ -36,14 +36,13 @@

Test Server 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.

In brief the test server supports:

Running multiple, concurrent test suites - Running tests on remote and even diskless targets Test suites may contain other test suites, in a tree fashion Logging of the events in a test suite, on both suite and case levels HTML presentation of test suite results 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 @@
2007 - 2012 + 2013 Ericsson AB, All Rights Reserved @@ -57,64 +57,19 @@ start() -> Result - start(ParameterFile) -> Result Starts the test server. Result = ok | {error, {already_started, pid()} - ParameterFile = atom() | string() -

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. -

-

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: -

- - {type,PlatformType} - This is an atom indicating the target platform type, - currently supported: PlatformType = vxworks

-Mandatory - - {target,TargetHost} - This is the name of the target host, can be atom or - string. -

-Mandatory - - {slavetargets,SlaveTargets} - This is a list of available hosts where slave nodes - can be started. The hostnames are given as atoms or strings. -

-Optional, default SlaveTargets = [] - {longnames,Bool} - This indicates if longnames shall be used, i.e. if the - -name option should be used for the target node - instead of -sname

-Optional, default Bool = false - {master, {MasterHost, MasterCookie}} - 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 - test_server:start_node/3. It is expected that the - erl_boot_server is started on the master node before - the test_server_ctrl:start/1 function is called. -

-Optional, if not given the test server controller node - is used as master and the erl_boot_server is - automatically started. - +

This function starts the test server.

 stop() -> ok Stops the test server immediately. -

This stops the test server (both controller and target) and +

This stops the test server and all its activity. The running test suite (if any) will be halted.

 @@ -685,10 +640,6 @@ test_server_ctrl:cross_cover_analyse(Level,[{s1,S1LogDir},{s2,S2LogDir}]) default name. This does not apply to SPEC which keeps its names. - PARAMETERS parameterfile - Specifies the parameter file to use when starting - remote target - COVER app cover_file analyse Indicates that the test should be run with cover analysis. app, cover_file and analyse 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 @@
- 20022009 + 20022013 Ericsson AB. All Rights Reserved. @@ -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, Init and Fin are given with - arguments ({Mod,Func,Args}), and that they are executed - on the controller node (i.e. not on target). + arguments ({Mod,Func,Args}). Case 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 @@
- 20022009 + 20022013 Ericsson AB. All Rights Reserved. @@ -46,15 +46,8 @@ Interfacing the test server controller from Erlang

Using the test server from Erlang means that you have to start the test server and then add test jobs. Use - test_server_ctrl:start/0 to start a local target or - test_server_ctrl:start/1 to start a remote target. The test - server is stopped by test_server_ctrl:stop/0. -

-

The argument to test_server_ctrl:start/1 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. + test_server_ctrl:start/0 to start the test server, and + test_server_ctrl:stop/0 to stop it.

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 @@
- 20022009 + 20022013 Ericsson AB. All Rights Reserved. @@ -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.

-

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.

The execution clause implements the actual test case. It takes one argument, Config, which contain configuration information like data_dir and priv_dir. See Data and Private Directories for -- cgit v1.2.3