From cfea5eea406ba3af96588ff458e55de9a149d9c5 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Sun, 1 Apr 2012 20:14:41 +0200 Subject: Prepare release --- lib/common_test/doc/src/notes.xml | 302 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 302 insertions(+) (limited to 'lib/common_test/doc/src/notes.xml') diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml index da0b6b2d65..050b8774ca 100644 --- a/lib/common_test/doc/src/notes.xml +++ b/lib/common_test/doc/src/notes.xml @@ -32,6 +32,308 @@ notes.xml +
Common_Test 1.6.1 + +
Fixed Bugs and Malfunctions + + +

+ Common Test adds the test suite directories to the code + path before executing the tests. These directories should + also be removed from the code path at the end of the test + run, which, prior to this fix, was not performed.

+

+ Own Id: OTP-9595

+ + +

+ An entry is now created in the index.html file (i.e. the + overview file for the test run) for each repeated test + during a test run. This was previously not the case. Note + that in the top level (logdir) index file, however, only + the last test result is listed. For example, given the + test spec: + [{merge_tests,false},{dirs,"test1"},{dirs,"test1"}]. In + the index file for the test run (under + Logdir/ct_run.Node.Date.Time), both tests are listed. In + the top level index file (under Logdir), only the last + test is listed (one has to find the previous results + through the all_runs.html file).

+

+ Own Id: OTP-9634 Aux Id: seq11924

+ + +

+ After a test case timeout or abortion, the + end_per_testcase function executes on a new dedicated + process. The group leader for this process should be set + to the IO server for the test case, which was not done + properly. The result of this error was that no warnings + about end_per_testcase failing or timing out were ever + printed in the test case log. Also, help functions such + as e.g. test_server:stop_node/1, attempting to + synchronize with the IO server, would hang. The fault has + been corrected.

+

+ Own Id: OTP-9666

+ + +

+ The ct:get_status/0 function would cause the calling + process to receive 'DOWN' messages if no tests were + running at the time of the call. This bug has been fixed.

+

+ Own Id: OTP-9830 Aux Id: seq11975

+ + +

+ A deadlock situation could occur if Common Test is + forwarding error_handler printouts to Test Server at the + same time a new test case is starting. This error has + been fixed.

+

+ Own Id: OTP-9894

+ + +

+ A link to the ct_run program is now created, as expected, + in the installation bin directory (default + /usr/local/bin) during 'make install'.

+

+ Own Id: OTP-9898

+ + +

+ Using the repeat, duration or until option with + ct:run_test/1, would cause an infinite loop. This has + been fixed.

+

+ Own Id: OTP-9899

+ + +

+ Two or more test cases executing in parallel and printing + to screen at the same time with ct:pal/2/3 or + ct:print/2/3 could write into each other's "slots" and + create a mess of mixed strings. In order to avoid this, + only a single IO message is now ever sent per printout + call.

+

+ Own Id: OTP-9900 Aux Id: OTP-9904

+ + +

+ When a test case was killed because of a timetrap + timeout, the current location (suite, case and line) was + not printed correctly in the log files. This has been + corrected.

+

+ Own Id: OTP-9930 Aux Id: seq12002

+ + +

+ The wrong exit location was printed in the log file when + ct:fail/1 or ct_fail/2 was called.

+

+ Own Id: OTP-9933 Aux Id: seq12002

+ + +

+ Test Server and Common Test would add new error handlers + with each test run and fail to remove previously added + ones. In the case of Test Server, this would only happen + if SASL was not running on the test node. This has been + fixed.

+

+ Own Id: OTP-9941 Aux Id: seq12009

+ + +

+ If a test case process was terminated due to an exit + signal from a linked process, Test Server failed to + report the correct name of the suite and case to the + framework. This has been corrected.

+

+ Own Id: OTP-9958 Aux Id: OTP-9855

+ + +

+ When starting a test with ct_run and adding a directory + to the code path using -pa or -pz (preceding -erl_args), + Common Test would delete any existing directory in the + code path with the same base name (see + filename:basename/1) as the directory being added. This + has been fixed.

+

+ Own Id: OTP-9964

+ + +

+ If passing two or more directories with the same base + name (see filename:basename/1) to Common Test with ct_run + -pa, only one of the directories would actually be added.

+

+ Own Id: OTP-9975 Aux Id: seq12019

+ + +

+ Configuration data required by the group info function + was deleted before the call to post_end_per_group, which + made it impossible for the hook function to read and use + the data in question. This has been fixed.

+

+ Own Id: OTP-9989

+ + +

+ Disabling built-in hooks in a test specification was + ignored, this has now been fixed.

+

+ Own Id: OTP-10009

+ + +

+ Various typographical errors corrected in documentation + for common_test, driver, erl_driver and windows + installation instructions. (Thanks to Tuncer Ayaz)

+

+ Own Id: OTP-10037

+ + +
+ + +
Improvements and New Features + + +

+ A new optional feature has been introduced that enables + Common Test to generate priv_dir directory names that are + unique for each test case or config function. The name of + the option/flag is 'create_priv_dir' and it can be set to + value 'auto_per_run' (which is the default, existing, + behaviour), or 'auto_per_tc' or 'manual_per_tc'. If + 'auto_per_tc' is used, Test Server creates a dedicated + priv_dir automatically for each test case (which can be + very expensive in case of many and/or repeated cases). If + 'manual_per_tc' is used, the user needs to create the + priv_dir explicitly by calling the new function + ct:make_priv_dir/0.

+

+ Own Id: OTP-9659 Aux Id: seq11930

+ + +

+ A column for test case group name has been added to the + suite overview HTML log file.

+

+ Own Id: OTP-9730 Aux Id: seq11952

+ + +

+ It is now possible to use the post_end_per_testcase CT + hook function to print a comment for a test case in the + overview log file, even if the test case gets killed by a + timetrap or unknown exit signal, or if the + end_per_testcase function times out.

+

+ Own Id: OTP-9855 Aux Id: seq11979

+ + +

+ The pre- and post CT hook functions are now always called + for all configuration functions, even for configuration + functions that are not implemented in the test suite.

+

+ Own Id: OTP-9880 Aux Id: seq11993

+ + +

+ Common Test will now print error information (with a time + stamp) in the test case log file immediately when a test + case fails. This makes it easier to see when, in time, + the fault actually occured, and aid the job of locating + relevant trace and debug printouts in the log.

+

+ Own Id: OTP-9904 Aux Id: seq11985, OTP-9900

+ + +

+ Test Server has been modified to check the SASL + errlog_type parameter when receiving an error logger + event, so that it doesn't print reports of type that the + user has disabled.

+

+ Own Id: OTP-9955 Aux Id: seq12013

+ + +

+ The test specification term 'skip_groups' was implemented + in Common Test v1.6. It was never documented however, + which has now been attended to. Please see the Test + Specifications chapter in the User's Guide for + information.

+

+ Own Id: OTP-9972

+ + +

+ The Common Test Master has been updated to use a CSS + style sheet for the html log files.

+

+ Own Id: OTP-9973

+ + +

+ If the init_per_group/2 and end_per_group/2 functions are + not implemented in the test suite, Common Test calls it's + own local init- and end functions - previously named + ct_init_per_group/2 and ct_end_per_group/2 - when a group + is executed. These functions have been renamed + init_per_group/2 and end_per_group/2 respectively. Note + that this may affect any user event handler identifying + events by the old names.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-9986 Aux Id: OTP-9992

+ + +

+ By specifying a user defined function ({M,F,A} or fun) as + timetrap value, either by means of an info function or by + calling ct:timetrap/1, it is now possible to set a + timetrap that will be triggered when the user function + returns.

+

+ Own Id: OTP-9988 Aux Id: OTP-9501, seq11894

+ + +

+ If the optional configuration functions init_per_suite/1 + and end_per_suite/1 are not implemented in the test + suite, local Common Test versions of these functions are + called instead, and will be displayed in the overview log + file. Any printouts made by the pre- or + post_init_per_suite and pre- or post_end_per_suite hook + functions are saved in the log files for these functions.

+

+ Own Id: OTP-9992

+ + +

+ A hook has been added to common test which outputs + surefire XML for usage together with CI tools such as + Jenkins. To enable the hook pass '-ct_hooks cth_surefire' + to ct_run. See the CTH documentation for more details.

+

+ Own Id: OTP-9995

+ + +
+ +
+
Common_Test 1.6
Improvements and New Features -- cgit v1.2.3