Merge branch 'dev' into major

1 files changed, 223 insertions, 0 deletions

diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml
index 826b3c598d..af96ef621f 100644
--- a/lib/common_test/doc/src/notes.xml
+++ b/lib/common_test/doc/src/notes.xml
@@ -32,6 +32,229 @@
     <file>notes.xml</file>
     </header>
 
+<section><title>Common_Test 1.5.5</title>
+
+    <section><title>Fixed Bugs and Malfunctions</title>
+      <list>
+        <item>
+          <p>
+	    An error in how comments are colored in the test suite
+	    overview html log file has been corrected. As result, a
+	    new framework callback function, format_comment/1, has
+	    been introduced.</p>
+          <p>
+	    Own Id: OTP-9237</p>
+        </item>
+        <item>
+          <p>
+	    Automatically generated init- and end-configuration
+	    functions for test case groups caused incorrect execution
+	    order of test cases. This has been corrected.</p>
+          <p>
+	    Own Id: OTP-9369</p>
+        </item>
+        <item>
+          <p>
+	    If multiple directories were specified with the 'logdir'
+	    flag/option, Common Test would crash. This has been fixed
+	    so that an error is properly reported instead.</p>
+          <p>
+	    Own Id: OTP-9370</p>
+        </item>
+        <item>
+          <p>
+	    If ct:log/2 was called with bad arguments, this could
+	    cause the Common Test IO handling process to crash. This
+	    fault has been corrected.</p>
+          <p>
+	    Own Id: OTP-9371 Aux Id: OTP-8933 </p>
+        </item>
+        <item>
+          <p>
+	    A bug has been fixed that made Test Server call the
+	    end_tc/3 framework function with an incorrect module name
+	    as first argument.</p>
+          <p>
+	    Own Id: OTP-9379 Aux Id: seq11863 </p>
+        </item>
+        <item>
+          <p>
+	    If a timetrap timeout occured during execution of of a
+	    function in a lib module (i.e. a function called directly
+	    or indirectly from a test case), the Suite argument in
+	    the end_tc/3 framework callback function would not
+	    correctly contain the name of the test suite, but the lib
+	    module. (This would only happen if the lib module was
+	    compiled with ct.hrl included). This error has been
+	    solved.</p>
+          <p>
+	    Own Id: OTP-9398</p>
+        </item>
+        <item>
+          <p>
+	    Corrections of the vts mode. It will now report errors
+	    (about e.g. incorrect config files) instead of crashing
+	    or hanging. Furthermore, the requirement that the test
+	    directory name must have a "_test" suffix has been
+	    removed. Also, a workaround has been implemented for the
+	    limitation that the file browser (in many web browsers)
+	    will only return the basic file name, not the full
+	    directory path (which made it impossible to have config
+	    files in other directories than the main test directory).</p>
+          <p>
+	    Own Id: OTP-9429</p>
+        </item>
+        <item>
+          <p>
+	    Add a proplist() type</p>
+          <p>
+	    Recently I was adding specs to an API and found that
+	    there is no canonical proplist() type defined. (Thanks to
+	    Ryan Zezeski)</p>
+          <p>
+	    Own Id: OTP-9499</p>
+        </item>
+        <item>
+          <p>
+	    It is now possible to use the 'step' flag/option to run
+	    the debugger for test suites that contain test case
+	    groups. This previously caused Common Test to crash. If
+	    'step config' is specified, breakpoints are now also
+	    automatically set on init_per_group and end_per_group.
+	    Note that breakpoints are always set automatically on
+	    test case functions and this is true also for grouped
+	    cases.</p>
+          <p>
+	    Own Id: OTP-9518 Aux Id: OTP-8933 </p>
+        </item>
+        <item>
+          <p>
+	    The test index page was not refreshed at the start of
+	    each test suite which made it impossible to follow test
+	    execution by means of refreshing the browser window (no
+	    links to follow). This has been fixed.</p>
+          <p>
+	    Own Id: OTP-9520 Aux Id: OTP-8933 </p>
+        </item>
+        <item>
+          <p>
+	    If a test suite would start with a test case group
+	    defined without the init_per_group/2 and end_per_group/2
+	    function, init_per_suite/1 would not execute initially
+	    and logging of the test run would fail. This error has
+	    been fixed.</p>
+          <p>
+	    Own Id: OTP-9584</p>
+        </item>
+        <item>
+          <p>
+	    The "Missing Suites" link from the top level index page
+	    was incorrect and has been fixed.</p>
+          <p>
+	    Own Id: OTP-9592</p>
+        </item>
+      </list>
+    </section>
+
+
+    <section><title>Improvements and New Features</title>
+      <list>
+        <item>
+          <p>
+	    Various corrections and updates to improve the handling
+	    and reporting of errors.</p>
+          <p>
+	    Own Id: OTP-8933</p>
+        </item>
+        <item>
+          <p>
+	    The dir and suite start option can now be used in
+	    combination. E.g. executing my_SUITE in directory
+	    my_tests can either be specified as "ct_run -suite
+	    my_tests/my_SUITE" or as "ct_run -dir my_tests -suite
+	    my_SUITE". Furthermore, the specification:
+	    ct:run_test([{suite,["./my_SUITE"]},{testcase,t1}]) is
+	    now interpreted as
+	    ct:run_test([{suite,"./my_SUITE"},{testcase,t1}]), i.e.
+	    only testcase t1 in test suite my_SUITE - not all cases -
+	    will be executed.</p>
+          <p>
+	    Own Id: OTP-9155</p>
+        </item>
+        <item>
+          <p>
+	    A new option, 'logopts', has been introduced, to make it
+	    possible to modify some aspects of the logging behaviour
+	    in Common Test (or Test Server). For example, whenever an
+	    io printout is made, test_server adds newline (\n) to the
+	    end of the output string. This may not always be a
+	    preferred action and can therefore be disabled by means
+	    of "ct_run ... -logopts no_nl" (or ct:run_test([...,
+	    {logopts,[no_nl]}])). A new framework callback function,
+	    get_logopts/0, has been introduced (see the ct_framework
+	    module for details).</p>
+          <p>
+	    Own Id: OTP-9372 Aux Id: OTP-9396 </p>
+        </item>
+        <item>
+          <p>
+	    A new option, 'logopts', has been introduced, to make it
+	    possible to modify some aspects of the logging behaviour
+	    in Common Test (or Test Server). For example, if the html
+	    version of the test suite source code should not be
+	    generated during the test run (and consequently be
+	    unavailable in the log file system), the feature may be
+	    disabled by means of "ct_run ... -logopts no_src" (or
+	    ct:run_test([..., {logopts,[no_src]}])). A new framework
+	    callback function, get_logopts/0, has been introduced
+	    (see the ct_framework module for details).</p>
+          <p>
+	    Own Id: OTP-9396 Aux Id: seq11869, OTP-9372 </p>
+        </item>
+        <item>
+          <p>
+	    CT Hooks can now be assigned a priority. The priority of
+	    a CTH determines when it should execute in relation to
+	    other CTHs. The CTH with the lowest priority will be
+	    executed first, CTHs with equal priority will be executed
+	    in the order which they were installed.</p>
+          <p>
+	    Own Id: OTP-9445</p>
+        </item>
+        <item>
+          <p>
+	    It is now possible to use a tuple {M,F,A}, or a fun, as
+	    timetrap specification in the suite info function or test
+	    case info functions. The function must return a valid
+	    timeout value, as documented in the common_test man page
+	    and in the User's Guide.</p>
+          <p>
+	    Own Id: OTP-9501 Aux Id: seq11894 </p>
+        </item>
+        <item>
+          <p>
+	    A new built-in common test hook has been added which
+	    captures error_logger and SASL event and prints them in
+	    the testcase log. To disable this (and any other built-in
+	    hooks) pass 'enable_builtin_hooks false' to common test.</p>
+          <p>
+	    Own Id: OTP-9543</p>
+        </item>
+        <item>
+          <p>
+	    Common Test now has the possibility to have built-in
+	    hooks which are started by default when any test is run.
+	    To disable built-in hooks pass 'enable_builtin_hooks
+	    false' to common test. See the common test hooks
+	    documentation for more details.</p>
+          <p>
+	    Own Id: OTP-9564</p>
+        </item>
+      </list>
+    </section>
+
+</section>
+
 <section><title>Common_Test 1.5.4</title>
 
     <section><title>Fixed Bugs and Malfunctions</title>