path: root/lib/common_test/doc/src/ref_man.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE application SYSTEM "application.dtd">

<application xmlns:xi="http://www.w3.org/2001/XInclude">
  <header>
    <copyright>
      <year>2003</year><year>2013</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      The contents of this file are subject to the Erlang Public License,
      Version 1.1, (the "License"); you may not use this file except in
      compliance with the License. You should have received a copy of the
      Erlang Public License along with this software. If not, it can be
      retrieved online at http://www.erlang.org/.

      Software distributed under the License is distributed on an "AS IS"
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      the License for the specific language governing rights and limitations
      under the License.

    </legalnotice>

    <title>Common Test Reference Manual</title>
    <prepared>Peter Andersson</prepared>
    <docno></docno>
    <date></date>
    <rev></rev>
    <file>ref_man.xml</file>
  </header>
  <description>
      <p><em>Common Test</em> is a portable application for automated 
      testing. It is suitable for black-box testing of target
      systems of any type (i.e. not necessarily implemented in Erlang),
      as well as for white-box testing of Erlang/OTP programs.
      Black-box testing is performed via standard O&amp;M 
      interfaces (such as SNMP, HTTP, Corba, Telnet, etc) and,
      if required, via user specific interfaces (often called test 
      ports). White-box testing of Erlang/OTP programs is easily
      accomplished by calling the target API functions directly
      from the test case functions. Common Test also integrates 
      usage of the OTP cover tool for code coverage analysis of 
      Erlang/OTP programs.</p>
      
      <p>Common Test executes test suite programs automatically,
      without operator interaction. Test progress and results is
      printed to logs on HTML format, easily browsed with a standard
      web browser. Common Test also sends notifications about progress
      and results via an OTP event manager to event handlers plugged
      in to the system. This way users can integrate their own
      programs for e.g. logging, database storing or supervision with
      Common Test.</p>

      <p>Common Test provides libraries that contain useful support 
      functions to fill various testing needs and requirements. 
      There is for example support for flexible test declarations 
      by means of so called test specifications. There is also support 
      for central configuration and control of multiple 
      independent test sessions (towards different target systems)
      running in parallel.</p>

      <p>Common Test is implemented as a framework based on the OTP Test 
      Server application.</p>
  </description>
  <xi:include href="common_test_app.xml"/>
  <xi:include href="ct_run.xml"/>
  <!-- If you make modifications in the module list below,
       you also need to update CT_MODULES in Makefile. -->
  <xi:include href="ct.xml"/>
  <xi:include href="ct_master.xml"/>
  <xi:include href="ct_cover.xml"/>
  <xi:include href="ct_ftp.xml"/>
  <xi:include href="ct_ssh.xml"/>
  <xi:include href="ct_netconfc.xml"/>
  <xi:include href="ct_rpc.xml"/>
  <xi:include href="ct_snmp.xml"/>
  <xi:include href="ct_telnet.xml"/>
  <xi:include href="unix_telnet.xml"/>
  <xi:include href="ct_slave.xml"/>
  <xi:include href="ct_hooks.xml"/>
</application>