From 2ef840647acadb489d54332f6a218dcf2e629ff9 Mon Sep 17 00:00:00 2001 From: tmanevik Date: Wed, 18 Nov 2015 18:24:10 +0100 Subject: Common Test: Editorial changes 1 Conflicts: lib/common_test/doc/src/ct_hooks_chapter.xml lib/common_test/doc/src/event_handler_chapter.xml lib/common_test/doc/src/run_test_chapter.xml --- lib/common_test/doc/src/ct_hooks_chapter.xml | 679 ++++++++++++++------------- 1 file changed, 346 insertions(+), 333 deletions(-) (limited to 'lib/common_test/doc/src/ct_hooks_chapter.xml') diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml index 3905e23dcc..8f48756ada 100644 --- a/lib/common_test/doc/src/ct_hooks_chapter.xml +++ b/lib/common_test/doc/src/ct_hooks_chapter.xml @@ -34,28 +34,28 @@ General

- The Common Test Hook (henceforth called CTH) framework allows - extensions of the default behaviour of Common Test by means of hooks - before and after all test suite calls. CTHs allow advanced Common Test - users to abstract out behaviour which is common to multiple test suites - without littering all test suites with library calls. Some example - usages are: logging, starting and monitoring external systems, - building C files needed by the tests and much more!

- -

In brief, Common Test Hooks allows you to:

- - - Manipulate the runtime config before each suite - configuration call - Manipulate the return of all suite configuration calls and in - extension the result of the test themselves. + The Common Test Hook (CTH) framework allows + extensions of the default behavior of Common Test using hooks + before and after all test suite calls. CTHs allow advanced Common Test + users to abstract out behavior that is common to multiple test suites + without littering all test suites with library calls. this can be used + for logging, starting, and monitoring external systems, + building C files needed by the tests, and so on.

+ +

In brief, CTH allows you to do the following:

+ + + Manipulate the runtime configuration before each suite + configuration call. + Manipulate the return of all suite configuration calls, and in + extension, the result of the tests themselves. -

The following sections describe how to use CTHs, when they are run - and how to manipulate your test results in a CTH

+

The following sections describe how to use CTHs, when they are run, + and how to manipulate the test results in a CTH.

-

When executing within a CTH all timetraps are shutoff. So - if your CTH never returns, the entire test run will be stalled!

+

When executing within a CTH, all timetraps are shut off. So + if your CTH never returns, the entire test run is stalled.

 @@ -63,144 +63,148 @@
Installing a CTH -

There are multiple ways to install a CTH in your test run. You can do it - for all tests in a run, for specific test suites and for specific groups +

A CTH can be installed in multiple ways in your test run. You can do it + for all tests in a run, for specific test suites, and for specific groups within a test suite. If you want a CTH to be present in all test suites - within your test run there are three different ways to accomplish that. + within your test run, there are three ways to accomplish that, as follows:

- + Add -ct_hooks as an argument to ct_run. - To add multiple CTHs using this method append them to each other - using the keyword and, i.e. + To add multiple CTHs using this method, append them to each other + using the keyword and, that is, ct_run -ct_hooks cth1 [{debug,true}] and cth2 .... - Add the ct_hooks tag to your + Add tag ct_hooks to your - Test Specification - Add the ct_hooks tag to your call to - ct:run_test/1 + Test Specification. + Add tag ct_hooks to your call to + ct:run_test/1. -

You can also add CTHs within a test suite. This is done by returning - {ct_hooks,[CTH]} in the config list from +

CTHs can also be added within a test suite. This is done by returning + {ct_hooks,[CTH]} in the configuration list from suite/0, - init_per_suite/1 or + init_per_suite/1, or - init_per_group/2. CTH in this case can be either - only the module name of the CTH or a tuple with the module name and the - initial arguments and optionally the hook priority of the CTH. Eg: - {ct_hooks,[my_cth_module]} or - {ct_hooks,[{my_cth_module,[{debug,true}]}]} or - {ct_hooks,[{my_cth_module,[{debug,true}],500}]} -

+ init_per_group/2.

+ +

In this case, CTH can either be only the module name of the CTH + or a tuple with the module name and the initial arguments, and optionally + the hook priority of the CTH. For example, one of the following:

+ + {ct_hooks,[my_cth_module]} + {ct_hooks,[{my_cth_module,[{debug,true}]}]} + {ct_hooks,[{my_cth_module,[{debug,true}],500}]} +
Overriding CTHs -

By default each installation of a CTH will cause a new instance of it - to be activated. This can cause problems if you want to be able to - override CTHs in test specifications while still having them in the - suite info function. The +

By default, each installation of a CTH causes a new instance of it + to be activated. This can cause problems if you want to override + CTHs in test specifications while still having them in the + suite information function. The id/1 callback exists to address this problem. By returning the same - id in both places, Common Test knows that this CTH - has already been installed and will not try to install it again.

+ id in both places, Common Test knows that this CTH + is already installed and does not try to install it again.

- CTH Execution order -

By default each CTH installed will be executed in the order which + CTH Execution Order +

By default, each CTH installed is executed in the order that they are installed for init calls, and then reversed for end calls. - This is not always wanted so common_test allows + This is not always desired, so Common Test allows the user to specify a priority for each hook. The priority can either - be specified in the CTH init/2 - function or when installing the hook. The priority given at - installation will override the priority returned by the CTH.

+ be specified in the CTH function + init/2 or when + installing the hook. The priority specified at installation overrides the + priority returned by the CTH.

CTH Scope -

Once the CTH is installed into a certain test run it will be there until +

Once the CTH is installed into a certain test run it remains there until its scope is expired. The scope of a CTH depends on when it is - installed. - The init/2 is - called at the beginning of the scope and the - terminate/1 - function is called when the scope ends.

+ installed, see the following table. + Function init/2 is + called at the beginning of the scope and function + terminate/1 + is called when the scope ends.

- CTH Installed in + CTH installed in CTH scope begins before CTH scope ends after ct_run - the first test suite is to be run. - the last test suite has been run. + the first test suite is to be run + the last test suite has been run ct:run_test - the first test suite is to be run. - the last test suite has been run. + the first test suite is run + the last test suite has been run Test Specification - the first test suite is to be run. - the last test suite has been run. + the first test suite is run + the last test suite has been run suite/0 - pre_init_per_suite/3 is called. + pre_init_per_suite/3 is called - post_end_per_suite/4 has been called for that test suite. + post_end_per_suite/4 has been called for that test suite init_per_suite/1 - post_init_per_suite/4 is called. + post_init_per_suite/4 is called - post_end_per_suite/4 has been called for that test suite. + post_end_per_suite/4 has been called for that test suite init_per_group/2 - post_init_per_group/4 is called. + post_init_per_group/4 is called - post_end_per_group/4 has been called for that group. + post_end_per_group/4 has been called for that group Scope of a CTH
CTH Processes and Tables -

CTHs are run with the same process scoping as normal test suites - i.e. a different process will execute the init_per_suite hooks then the - init_per_group or per_testcase hooks. So if you want to spawn a - process in the CTH you cannot link with the CTH process as it will exit - after the post hook ends. Also if you for some reason need an ETS - table with your CTH, you will have to spawn a process which handles - it.

+

CTHs are run with the same process scoping as normal test suites, + that is, a different process executes the init_per_suite hooks then the + init_per_group or per_testcase hooks. So if you want to spawn a + process in the CTH, you cannot link with the CTH process, as it exits + after the post hook ends. Also, if you for some reason need an ETS + table with your CTH, you must spawn a process that handles it.

- External configuration data and Logging -

It's possible in the CTH to read configuration data values - by calling ct:get_config/1/2/3 (as explained in the - - External configuration data - chapter). The config variables in question must, as always, first have been - required by means of a suite-, group-, or test case info function, - or the ct:require/1/2 function. Note that the latter can also be used - in CT hook functions.

-

The CT hook functions may call any of the logging functions available + External Configuration Data and Logging +

Configuration data values in the CTH can be read + by calling + ct:get_config/1,2,3 + (as explained in section + Requiring and Reading Configuration Data). + The configuration variables in question must, as always, first have been + required by a suite-, group-, or test case information function, + or by function ct:require/1/2. + The latter can also be used in CT hook functions.

+

The CT hook functions can call any logging function in the ct interface to print information to the log files, or to add comments in the suite overview page.

@@ -209,306 +213,315 @@
- - Manipulating tests -

It is through CTHs possible to manipulate the results of tests and - configuration functions. The main purpose of doing this with CTHs is to - allow common patterns to be abstracted out from test test suites and applied to - multiple test suites without duplicating any code. All of the callback - functions for a CTH follow a common interface, this interface is - described below.

- -

Common Test will always call all available hook functions, even pre- and post - hooks for configuration functions that are not implemented in the suite. + + Manipulating Tests +

Through CTHs the results of tests and configuration functions can be manipulated. + The main purpose to do this with CTHs is to allow common + patterns to be abstracted out from test suites and applied to + multiple test suites without duplicating any code. All the callback + functions for a CTH follow a common interface described hereafter.

+ +

Common Test always calls all available hook functions, even pre- + and post hooks for configuration functions that are not implemented in the suite. For example, pre_init_per_suite(x_SUITE, ...) and - post_init_per_suite(x_SUITE, ...) will be called for test suite - x_SUITE, even if it doesn't export init_per_suite/1. This feature - makes it possible to use hooks as configuration fallbacks, or even - completely replace all configuration functions with hook functions.

+ post_init_per_suite(x_SUITE, ...) are called for test suite + x_SUITE, even if it does not export init_per_suite/1. + With this feature hooks can be used as configuration fallbacks, and all + configuration functions can be replaced with hook functions.

Pre Hooks

- It is possible in a CTH to hook in behaviour before - init_per_suite, - init_per_group, - init_per_testcase, - end_per_group and - end_per_suite. + In a CTH, the behavior can be hooked in before the following functions:

+ + + init_per_suite + init_per_group + init_per_testcase + end_per_group + end_per_suite + + +

This is done in the CTH functions called pre_<name of function>. - All of these functions take the same three arguments: Name, - Config and CTHState. The return value of the CTH function - is always a combination of an result for the suite/group/test and an - updated CTHState. If you want the test suite to continue on - executing you should return the config list which you want the test to - use as the result. If you for some reason want to skip/fail the test, - return a tuple with skip or fail and a reason as the - result. Example: -

- pre_init_per_suite(SuiteName, Config, CTHState) -> - case db:connect() of - {error,_Reason} -> - {{fail, "Could not connect to DB"}, CTHState}; - {ok, Handle} -> - {[{db_handle, Handle} | Config], CTHState#state{ handle = Handle }} - end. -

If using multiple CTHs, the first part of the return tuple will be - used as input for the next CTH. So in the case above the next CTH might + These functions take the same three arguments, Name, + Config, and CTHState. The return value of the CTH function + is always a combination of a result for the suite/group/test and an + updated CTHState.

+ +

To let the test suite continue on executing, return the configuration + list that you want the test to use as the result. To skip or + fail the test, return a tuple with skip or fail, and a reason + as the result.

+ +

Example:

+ + pre_init_per_suite(SuiteName, Config, CTHState) -> + case db:connect() of + {error,_Reason} -> + {{fail, "Could not connect to DB"}, CTHState}; + {ok, Handle} -> + {[{db_handle, Handle} | Config], CTHState#state{ handle = Handle }} + end. + +

If you use multiple CTHs, the first part of the return tuple is + used as input for the next CTH. So in the previous example the next CTH can get {fail,Reason} as the second parameter. If you have many CTHs - which interact, it might be a good idea to not let each CTH return - fail or skip. Instead return that an action should be taken - through the Config list and implement a CTH which at the end takes - the correct action.

 + interacting, do not let each CTH return fail or skip. + Instead, return that an action is to be taken through the Config + list and implement a CTH that, at the end, takes the correct action.
Post Hooks -

It is also possible in a CTH to hook in behaviour after - init_per_suite, - init_per_group, - end_per_testcase, - end_per_group and - end_per_suite. - This is done in the CTH functions called post_<name of function>. - All of these function take the same four arguments: Name, - Config, Return and CTHState. Config in this +

In a CTH, behavior can be hooked in after the following functions:

+ + init_per_suite + init_per_group + end_per_testcase + end_per_group + end_per_suite + + +

+ This is done in the CTH functions called post_<name of function>. + These functions take the same four arguments, Name, + Config, Return, and CTHState. Config in this case is the same Config as the testcase is called with. Return is the value returned by the testcase. If the testcase - failed by crashing, Return will be + fails by crashing, Return is {'EXIT',{{Error,Reason},Stacktrace}}.

-

The return value of the CTH function is always a combination of an +

The return value of the CTH function is always a combination of a result for the suite/group/test and an updated CTHState. If - you want the callback to not affect the outcome of the test you should + you do not want the callback to affect the outcome of the test, return the Return data as it is given to the CTH. You can also - modify the result of the test. By returning the Config list - with the tc_status element removed you can recover from a test + modify the test result. By returning the Config list + with element tc_status removed, you can recover from a test failure. As in all the pre hooks, it is also possible to fail/skip - the test case in the post hook. Example:

- - post_end_per_testcase(_TC, Config, {'EXIT',{_,_}}, CTHState) -> - case db:check_consistency() of - true -> - %% DB is good, pass the test. - {proplists:delete(tc_status, Config), CTHState}; - false -> - %% DB is not good, mark as skipped instead of failing - {{skip, "DB is inconsisten!"}, CTHState} - end; -post_end_per_testcase(_TC, Config, Return, CTHState) -> - %% Do nothing if tc does not crash. - {Return, CTHState}. - -

Recovering from a testcase failure using CTHs should only be done as - a last resort. If used wrongly it could become very difficult to - determine which tests pass or fail in a test run

 + the test case in the post hook.

+ +

Example:

+ + post_end_per_testcase(_TC, Config, {'EXIT',{_,_}}, CTHState) -> + case db:check_consistency() of + true -> + %% DB is good, pass the test. + {proplists:delete(tc_status, Config), CTHState}; + false -> + %% DB is not good, mark as skipped instead of failing + {{skip, "DB is inconsisten!"}, CTHState} + end; + post_end_per_testcase(_TC, Config, Return, CTHState) -> + %% Do nothing if tc does not crash. + {Return, CTHState}. + +

Do recover from a testcase failure using CTHs only a last resort. + If used wrongly, it can be very difficult to determine which tests that + pass or fail in a test run.
- - Skip and Fail hooks + Skip and Fail Hooks

After any post hook has been executed for all installed CTHs, on_tc_fail - or on_tc_skip - might be called if the testcase failed or was skipped - respectively. You cannot affect the outcome of the tests any further at - this point. + or on_tc_skip + is called if the testcase failed or was skipped, respectively. + You cannot affect the outcome of the tests any further at this point.

- - Synchronizing external user applications with Common Test + + Synchronizing External User Applications with Common Test

CTHs can be used to synchronize test runs with external user applications. - The init function may e.g. start and/or communicate with an application that - has the purpose of preparing the SUT for an upcoming test run, or maybe + The init function can, for example, start and/or communicate with an application that + has the purpose of preparing the SUT for an upcoming test run, or initialize a database for saving test data to during the test run. The - terminate function may similarly order such an application to reset the SUT + terminate function can similarly order such an application to reset the SUT after the test run, and/or tell the application to finish active sessions and terminate. Any system error- or progress reports generated during the init- or - termination stage will be saved in the - Pre- - and post test I/O log. (This is also true for any printouts made + termination stage are saved in the + Pre- and Post Test I/O Log. + (This is also true for any printouts made with ct:log/2 and ct:pal/2).

-

In order to ensure that Common Test doesn't start executing tests, or + +

To ensure that Common Test does not start executing tests, or closes its log files and shuts down, before the external application - is ready for it, Common Test may be synchronized with the application. - During startup and shutdown, Common Test can be suspended, simply by + is ready for it, Common Test can be synchronized with the application. + During startup and shutdown, Common Test can be suspended, simply by having a CTH evaluate a receive expression in the init- or terminate function. The macros ?CT_HOOK_INIT_PROCESS (the process executing the hook init function) and ?CT_HOOK_TERMINATE_PROCESS (the process executing - the hook terminate function), each specifies the name of the correct Common Test - process to send a message to in order to return from the receive. + the hook terminate function) each specifies the name of the correct Common Test + process to send a message to. This is done to return from the receive. These macros are defined in ct.hrl.

- + Example CTH -

The CTH below will log information about a test run into a format - parseable by file:consult/1. +

The following CTH logs information about a test run into a format + parseable by file:consult/1 + (in Kernel):

- %%% @doc Common Test Example Common Test Hook module. --module(example_cth). - -%% Callbacks --export([id/1]). --export([init/2]). - --export([pre_init_per_suite/3]). --export([post_init_per_suite/4]). --export([pre_end_per_suite/3]). --export([post_end_per_suite/4]). - --export([pre_init_per_group/3]). --export([post_init_per_group/4]). --export([pre_end_per_group/3]). --export([post_end_per_group/4]). - --export([pre_init_per_testcase/3]). --export([post_end_per_testcase/4]). - --export([on_tc_fail/3]). --export([on_tc_skip/3]). - --export([terminate/1]). - --record(state, { file_handle, total, suite_total, ts, tcs, data }). - -%% @doc Return a unique id for this CTH. -id(Opts) -> - proplists:get_value(filename, Opts, "/tmp/file.log"). - -%% @doc Always called before any other callback function. Use this to initiate -%% any common state. -init(Id, Opts) -> - {ok,D} = file:open(Id,[write]), - {ok, #state{ file_handle = D, total = 0, data = [] }}. - -%% @doc Called before init_per_suite is called. -pre_init_per_suite(Suite,Config,State) -> - {Config, State#state{ suite_total = 0, tcs = [] }}. - -%% @doc Called after init_per_suite. -post_init_per_suite(Suite,Config,Return,State) -> - {Return, State}. - -%% @doc Called before end_per_suite. -pre_end_per_suite(Suite,Config,State) -> - {Config, State}. - -%% @doc Called after end_per_suite. -post_end_per_suite(Suite,Config,Return,State) -> - Data = {suites, Suite, State#state.suite_total, lists:reverse(State#state.tcs)}, - {Return, State#state{ data = [Data | State#state.data] , - total = State#state.total + State#state.suite_total } }. - -%% @doc Called before each init_per_group. -pre_init_per_group(Group,Config,State) -> - {Config, State}. - -%% @doc Called after each init_per_group. -post_init_per_group(Group,Config,Return,State) -> - {Return, State}. - -%% @doc Called after each end_per_group. -pre_end_per_group(Group,Config,State) -> - {Config, State}. - -%% @doc Called after each end_per_group. -post_end_per_group(Group,Config,Return,State) -> - {Return, State}. - -%% @doc Called before each test case. -pre_init_per_testcase(TC,Config,State) -> - {Config, State#state{ ts = now(), total = State#state.suite_total + 1 } }. - -%% @doc Called after each test case. -post_end_per_testcase(TC,Config,Return,State) -> - TCInfo = {testcase, TC, Return, timer:now_diff(now(), State#state.ts)}, - {Return, State#state{ ts = undefined, tcs = [TCInfo | State#state.tcs] } }. - -%% @doc Called after post_init_per_suite, post_end_per_suite, post_init_per_group, -%% post_end_per_group and post_end_per_testcase if the suite, group or test case failed. -on_tc_fail(TC, Reason, State) -> - State. - -%% @doc Called when a test case is skipped by either user action -%% or due to an init function failing. -on_tc_skip(TC, Reason, State) -> - State. - -%% @doc Called when the scope of the CTH is done -terminate(State) -> - io:format(State#state.file_handle, "~p.~n", - [{test_run, State#state.total, State#state.data}]), - file:close(State#state.file_handle), - ok. + + %%% @doc Common Test Example Common Test Hook module. + -module(example_cth). + + %% Callbacks + -export([id/1]). + -export([init/2]). + + -export([pre_init_per_suite/3]). + -export([post_init_per_suite/4]). + -export([pre_end_per_suite/3]). + -export([post_end_per_suite/4]). + + -export([pre_init_per_group/3]). + -export([post_init_per_group/4]). + -export([pre_end_per_group/3]). + -export([post_end_per_group/4]). + + -export([pre_init_per_testcase/3]). + -export([post_end_per_testcase/4]). + + -export([on_tc_fail/3]). + -export([on_tc_skip/3]). + + -export([terminate/1]). + + -record(state, { file_handle, total, suite_total, ts, tcs, data }). + + %% @doc Return a unique id for this CTH. + id(Opts) -> + proplists:get_value(filename, Opts, "/tmp/file.log"). + + %% @doc Always called before any other callback function. Use this to initiate + %% any common state. + init(Id, Opts) -> + {ok,D} = file:open(Id,[write]), + {ok, #state{ file_handle = D, total = 0, data = [] }}. + + %% @doc Called before init_per_suite is called. + pre_init_per_suite(Suite,Config,State) -> + {Config, State#state{ suite_total = 0, tcs = [] }}. + + %% @doc Called after init_per_suite. + post_init_per_suite(Suite,Config,Return,State) -> + {Return, State}. + + %% @doc Called before end_per_suite. + pre_end_per_suite(Suite,Config,State) -> + {Config, State}. + + %% @doc Called after end_per_suite. + post_end_per_suite(Suite,Config,Return,State) -> + Data = {suites, Suite, State#state.suite_total, lists:reverse(State#state.tcs)}, + {Return, State#state{ data = [Data | State#state.data] , + total = State#state.total + State#state.suite_total } }. + + %% @doc Called before each init_per_group. + pre_init_per_group(Group,Config,State) -> + {Config, State}. + + %% @doc Called after each init_per_group. + post_init_per_group(Group,Config,Return,State) -> + {Return, State}. + + %% @doc Called after each end_per_group. + pre_end_per_group(Group,Config,State) -> + {Config, State}. + + %% @doc Called after each end_per_group. + post_end_per_group(Group,Config,Return,State) -> + {Return, State}. + + %% @doc Called before each test case. + pre_init_per_testcase(TC,Config,State) -> + {Config, State#state{ ts = now(), total = State#state.suite_total + 1 } }. + + %% @doc Called after each test case. + post_end_per_testcase(TC,Config,Return,State) -> + TCInfo = {testcase, TC, Return, timer:now_diff(now(), State#state.ts)}, + {Return, State#state{ ts = undefined, tcs = [TCInfo | State#state.tcs] } }. + + %% @doc Called after post_init_per_suite, post_end_per_suite, post_init_per_group, + %% post_end_per_group and post_end_per_testcase if the suite, group or test case failed. + on_tc_fail(TC, Reason, State) -> + State. + + %% @doc Called when a test case is skipped by either user action + %% or due to an init function failing. + on_tc_skip(TC, Reason, State) -> + State. + + %% @doc Called when the scope of the CTH is done + terminate(State) -> + io:format(State#state.file_handle, "~p.~n", + [{test_run, State#state.total, State#state.data}]), + file:close(State#state.file_handle), + ok.
- - Built-in CTHs -

Common Test is delivered with a couple of general purpose CTHs that - can be enabled by the user to provide some generic testing functionality. - Some of these are enabled by default when starting running common_test, - they can be disabled by setting enable_builtin_hooks to - false on the command line or in the test specification. In the - table below there is a list of all current CTHs which are delivered with - Common Test.

- - - - CTH Name - Is Built-in - Description - - - cth_log_redirect - yes - Captures all error_logger and SASL logging events and prints them - to the current test case log. If an event can not be associated with a - testcase it will be printed in the common test framework log. This will - happen for testcases which are run in parallel and events which occur - inbetween testcases. You can configure the level of - SASL events report - using the normal SASL mechanisms. - - - cth_surefire - no -

Captures all test results and outputs them as surefire - XML into a file. The file which is created is by default - called junit_report.xml. The file name can be changed by - setting the path option for this hook, e.g.

- - -ct_hooks cth_surefire [{path,"/tmp/report.xml"}] - -

If the url_base option is set, an additional - attribute named url will be added to each - testsuite and testcase XML element. The value will - be constructed from the url_base and a relative path - to the test suite or test case log respectively, e.g.

- - -ct_hooks cth_surefire [{url_base, "http://myserver.com/"}] -

will give a url attribute value similar to

- - "http://myserver.com/ct_run.ct@myhost.2012-12-12_11.19.39/ -x86_64-unknown-linux-gnu.my_test.logs/run.2012-12-12_11.19.39/suite.log.html" - -

Surefire XML can for instance be used by Jenkins to display test - results.

 - -
+ + Built-In CTHs +

Common Test is delivered with some general-purpose CTHs that + can be enabled by the user to provide generic testing functionality. + Some of these CTHs are enabled by default when common_test is started to run. + They can be disabled by setting enable_builtin_hooks to + false on the command line or in the test specification. The following + two CTHs are delivered with Common Test:

+ + + cth_log_redirect + +

Built-in

+

Captures all error_logger and SASL logging + events and prints them to the current test case log. If an event cannot be + associated with a test case, it is printed in the Common Test framework log. + This happens for test cases running in parallel and events occuring + in-between test cases. You can configure the level of + SASL events report + using the normal SASL mechanisms.

+ + cth_surefire + +

Not built-in

+

Captures all test results and outputs them as surefire + XML into a file. The created file is by default + called junit_report.xml. The file name can be changed by + setting option path for this hook, for example:

+ +

-ct_hooks cth_surefire [{path,"/tmp/report.xml"}]

+ +

If option url_base is set, an extra + attribute named url is added to each + testsuite and testcase XML element. The value + is constructed from url_base and a relative path + to the test suite or test case log, respectively, for example:

+ +

-ct_hooks cth_surefire [{url_base, "http://myserver.com/"}]

+ +

gives an URL attribute value similar to

+ +

"http://myserver.com/ct_run.ct@myhost.2012-12-12_11.19.39/ +x86_64-unknown-linux-gnu.my_test.logs/run.2012-12-12_11.19.39/suite.log.html"

+ +

Surefire XML can, for example, be used by Jenkins to display test + results.

+ +
-- cgit v1.2.3