path: root/lib/test_server/doc/src/notes.xml

<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">

<chapter>
  <header>
    <copyright>
      <year>2004</year><year>2011</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>APPLICATION Release Notes</title>
    <prepared>Peter Andersson</prepared>
    <responsible>Peter Andersson</responsible>
    <docno></docno>
    <approved></approved>
    <checked></checked>
    <date>2007-11-30</date>
    <rev>A</rev>
    <file>notes.xml</file>
  </header>

<section><title>Test_Server 3.4.3</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Updated the ts*.config files to contain information
	    relevant to testing Erlang/OTP in an open source
	    environment.</p>
          <p>
	    Own Id: OTP-9017</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Alpha release of Common Test Hooks (CTH). CTHs allow the
	    users of common test to abtract out common behaviours
	    from test suites in a much more elegant and flexible way
	    than was possible before. Note that the addition of this
	    feature may introduce minor changes in the undocumented
	    behaviour of the interface inbetween common_test and
	    test_server.</p>
          <p>
	    *** POTENTIAL INCOMPATIBILITY ***</p>
          <p>
	    Own Id: OTP-8851</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.4.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>Miscellaneous updates</p>
          <p>
	    Own Id: OTP-8976</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.4.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Returning {return_group_result,failed} from end_per_group
	    in a group that is part of a sequence, did not cause the
	    proceeding cases (or groups) to get skipped. This has
	    been fixed.</p>
          <p>
	    Own Id: OTP-8753 Aux Id: seq11644 </p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Common Test has been updated to handle start options and
	    test specification terms for test case groups (and test
	    cases in groups). Also, an option named 'label', has been
	    added that associates the test run with a name that
	    Common Test prints in the overview HTML logs.</p>
          <p>
	    Own Id: OTP-8725 Aux Id: OTP-8727 </p>
        </item>
        <item>
          <p>
	    It is now possible to skip all tests in a suite, or a
	    group, by returning {fail,Reason} from the end_tc/5
	    framework function for init_per_suite, or init_per_group.</p>
          <p>
	    Own Id: OTP-8805 Aux Id: seq11664 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.4</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Returning {fail,Reason} from the framework end_tc
	    function was not handled properly by Test Server for all
	    test suite functions.</p>
          <p>
	    Own Id: OTP-8492 Aux Id: seq11502 </p>
        </item>
        <item>
          <p>
	    If the framework end_tc function would hang and get
	    aborted by Test Server, there was no indication of
	    failure in the logs. This has been fixed.</p>
          <p>
	    Own Id: OTP-8682 Aux Id: seq11504 </p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    It is now possible for the Test Server framework end_tc
	    function to change the status of the test case from ok or
	    auto-skipped to failed by returning {fail,Reason}.</p>
          <p>
	    Own Id: OTP-8495 Aux Id: seq11502 </p>
        </item>
        <item>
          <p>
	    Test Server will now call the end_per_testcase/2 function
	    even if the test case has been terminated explicitly
	    (with abort_current_testcase/1), or after a timetrap
	    timeout. Under these circumstances the return value of
	    end_per_testcase is completely ignored. Therefore the
	    function will not be able to change the reason for test
	    case termination by returning {fail,Reason}, nor will it
	    be able to save data with {save_config,Data}.</p>
          <p>
	    Own Id: OTP-8500 Aux Id: seq11521 </p>
        </item>
        <item>
          <p>
	    Previously, a repeat property of a test case group
	    specified the number of times the group should be
	    repeated after the main test run. I.e. {repeat,N} would
	    case the group to execute 1+N times. To be consistent
	    with the behaviour of the run_test repeat option, this
	    has been changed. N now specifies the absolute number of
	    executions instead.</p>
          <p>
	    Own Id: OTP-8689 Aux Id: seq11502 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.3.6</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    The Test Server parse transform did not handle bit string
	    comprehensions. This has been fixed.</p>
          <p>
	    Own Id: OTP-8458 Aux Id: OTP-8311 </p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    The tc_status value in the Config list for a test case
	    that has failed because of a timetrap timeout, has
	    changed from {tc_status,timeout} to
	    {tc_status,timetrap_timeout}.</p>
          <p>
	    Own Id: OTP-8302</p>
        </item>
        <item>
	    <p>The documentation is now possible to build in an open
	    source environment after a number of bugs are fixed and
	    some features are added in the documentation build
	    process. </p>
	    <p>- The arity calculation is updated.</p>
	    <p>- The module prefix used in the function names for
	    bif's are removed in the generated links so the links
	    will look like
	    "http://www.erlang.org/doc/man/erlang.html#append_element-2"
	    instead of
	    "http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2".</p>
	    <p>- Enhanced the menu positioning in the html
	    documentation when a new page is loaded.</p>
	    <p>- A number of corrections in the generation of man
	    pages (thanks to Sergei Golovan)</p>
	    <p>- The legal notice is taken from the xml book file so
	    OTP's build process can be used for non OTP
	    applications.</p>
          <p>
	    Own Id: OTP-8343</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.3.5</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    If the init_per_testcase/2 function fails, the test case
	    now gets marked and counted as auto skipped, not user
	    skipped (which would previously happen).</p>
          <p>
	    Own Id: OTP-8289</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    The documentation is now built with open source tools
	    (xsltproc and fop) that exists on most platforms. One
	    visible change is that the frames are removed.</p>
          <p>
	    Own Id: OTP-8201</p>
        </item>
        <item>
          <p>
	    It is now possible to fail a test case from the
	    end_per_testcase/2 function, by returning {fail,Reason}.</p>
          <p>
	    Own Id: OTP-8284</p>
        </item>
        <item>
          <p>
	    It is now possible to fail a test case by having the
	    end_tc/3 framework function return {fail,Reason} for the
	    test case.</p>
          <p>
	    Own Id: OTP-8285</p>
        </item>
        <item>
          <p>
	    The test_server framework API (e.g. the end_tc/3
	    function) has been modified. See the test_server_ctrl
	    documentation for details.</p>
          <p>
	    Own Id: OTP-8286 Aux Id: OTP-8285, OTP-8287 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.3.4</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    When running a suite starting with a test case group,
	    Test Server crashed if init_per_suite/1 exited or
	    returned skip. This has been fixed.</p>
          <p>
	    Own Id: OTP-8105 Aux Id: OTP-8089 </p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Various updates and fixes in Common Test and Test Server.</p>
          <p>
	    Own Id: OTP-8045 Aux Id: OTP-8089,OTP-8105,OTP-8163 </p>
        </item>
        <item>
          <p>
	    Errors in coverage data collection and analysis were
	    difficult to detect. The logging has been improved so
	    that more information about e.g. imported and missing
	    modules is printed to the html log files.</p>
          <p>
	    Own Id: OTP-8163 Aux Id: seq11374 </p>
        </item>
        <item>
          <p>
	    The Common Test HTML overview pages have been improved.
	    It is now possible to see if a test case has been skipped
	    explicitly or because a configuration function has
	    failed. Also, the history page (all_runs.html) now has
	    scrolling text displaying the test names. The old format
	    (showing names as a truncated string) can still be
	    generated by means of the flag/option 'basic_html'.</p>
          <p>
	    Own Id: OTP-8177</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.3.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Various corrections and improvements of Common Test and
	    Test Server.</p>
          <p>
	    Own Id: OTP-7981</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.3.1</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Minor updates and corrections.</p>
          <p>
	    Own Id: OTP-7897</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.3</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    The conf case in Test Server has been extended with
	    properties that make it possible to execute test cases in
	    parallel, in sequence and in shuffled order. It is now
	    also possible to repeat test cases according to different
	    criterias. The properties can be combined, making it
	    possible to e.g. repeat a conf case a certain number of
	    times and execute the test cases in different (random)
	    order every time. The properties are specified in a list
	    in the conf case definition: {conf, Properties, InitCase,
	    TestCases, EndCase}. The available properties are:
	    parallel, sequence, shuffle, repeat, repeat_until_all_ok,
	    repeat_until_any_ok, repeat_until_any_fail,
	    repeat_until_all_fail.</p>
          <p>
	    Own Id: OTP-7511 Aux Id: OTP-7839 </p>
        </item>
        <item>
	    <p>The test server starts Cover on nodes of the same
	    version as the test server itself only.</p>
          <p>
	    Own Id: OTP-7699</p>
        </item>
        <item>
          <p>
	    The Erlang mode for Emacs has been updated with new and
	    modified skeletons for Common Test and TS. Syntax for
	    test case groups in Common Test (and conf cases with
	    properties in TS) has been added and a new minimal Common
	    Test suite skeleton has been introduced.</p>
          <p>
	    Own Id: OTP-7856</p>
        </item>
      </list>
    </section>

</section>
<section><title>Test_Server 3.2.4.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
            The step functionality in Common Test (based on
            interaction with Debugger) was broken. This has been
            fixed, and some new step features have also been added.
            Please see the Common Test User's Guide for details.</p>
          <p>
            Own Id: OTP-7800 Aux Id: seq11106 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.2.4</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Miscellaneous updates.</p>
          <p>
	    Own Id: OTP-7527</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.2.3</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    When a testcase terminated due to a timetrap, io sent to
	    the group leader from framework:end_tc/3 (using
	    ct:pal/2/3 or ct:log/2/3) would cause deadlock. This has
	    been fixed.</p>
          <p>
	    Own Id: OTP-7447 Aux Id: seq11010 </p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Various updates and improvements, plus some minor bug
	    fixes, have been implemented in Common Test and Test
	    Server.</p>
          <p>
	    Own Id: OTP-7112</p>
        </item>
        <item>
          <p>
	    It is now possible, by means of the new function
	    ct:abort_current_testcase/1 or
	    test_server_ctrl:abort_current_testcase/1, to abort the
	    currently executing test case.</p>
          <p>
	    Own Id: OTP-7518 Aux Id: OTP-7112 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.2.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p><c>erlang:system_info/1</c> now accepts the
	    <c>logical_processors</c>, and <c>debug_compiled</c>
	    arguments. For more info see the, <c>erlang(3)</c>
	    documentation.</p> <p>The scale factor returned by
	    <c>test_server:timetrap_scale_factor/0</c> is now also
	    effected if the emulator uses a larger amount of
	    scheduler threads than the amount of logical processors
	    on the system. </p>
          <p>
	    Own Id: OTP-7175</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.2.1</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    When init_per_suite or end_per_suite terminated due to
	    runtime failure, test_server failed to format the line
	    number information properly and crashed. This error has
	    now been fixed.</p>
          <p>
	    Own Id: OTP-7091</p>
        </item>
      </list>
    </section>

</section>

<section><title>Test_Server 3.2.0</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    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 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>
	    Own Id: OTP-6989</p>
        </item>
      </list>
    </section>

</section>

</chapter>