From 6a5c264882058cf0786aba4418079b8552eea1cb Mon Sep 17 00:00:00 2001
From: Peter Andersson
Date: Wed, 2 Apr 2014 02:11:43 +0200
Subject: Document changes in the CT hooks API and the event message protocol
OTP-11732
---
lib/common_test/doc/src/ct_hooks.xml | 50 +++++++++++++++++++++---------------
1 file changed, 30 insertions(+), 20 deletions(-)
(limited to 'lib/common_test/doc/src/ct_hooks.xml')
diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml
index 859ff9df14..cab6dfea51 100644
--- a/lib/common_test/doc/src/ct_hooks.xml
+++ b/lib/common_test/doc/src/ct_hooks.xml
@@ -450,12 +450,15 @@
- Module:on_tc_fail(TestcaseName, Reason, CTHState) ->
+ Module:on_tc_fail(TestName, Reason, CTHState) ->
NewCTHState
Called after the CTH scope ends
- TestcaseName = init_per_suite | end_per_suite |
- init_per_group | end_per_group | atom()
+ TestName = init_per_suite | end_per_suite |
+ {init_per_group,GroupName} | {end_per_group,GroupName} |
+ {FuncName,GroupName} | FuncName
+ FuncName = atom()
+ GroupName = atom()
Reason = term()
CTHState = NewCTHState = term()
@@ -463,14 +466,16 @@
OPTIONAL
- This function is called whenever a testcase fails.
- It is called after the post function has been called for
- the testcase which failed. i.e.
- if init_per_suite fails this function is called after
+
This function is called whenever a test case (or config function)
+ fails. It is called after the post function has been called for
+ the failed test case. I.e. if init_per_suite fails, this function
+ is called after
- post_init_per_suite, and if a testcase fails it is called
+ post_init_per_suite, and if a test case fails, it is called
after
- post_end_per_testcase.
+ post_end_per_testcase. If the failed test case belongs
+ to a test case group, the first argument is a tuple
+ {FuncName,GroupName}, otherwise simply the function name.
The data which comes with the Reason follows the same format as the
FailReason
@@ -481,12 +486,14 @@
- Module:on_tc_skip(TestcaseName, Reason, CTHState) ->
+ Module:on_tc_skip(TestName, Reason, CTHState) ->
NewCTHState
Called after the CTH scope ends
- TestcaseName = end_per_suite | {init_per_group,GroupName} |
- {end_per_group,GroupName} | atom()
+ TestName = init_per_suite | end_per_suite |
+ {init_per_group,GroupName} | {end_per_group,GroupName} |
+ {FuncName,GroupName} | FuncName
+ FuncName = atom()
GroupName = atom()
Reason = {tc_auto_skip | tc_user_skip, term()}
CTHState = NewCTHState = term()
@@ -495,14 +502,17 @@
OPTIONAL
- This function is called whenever a testcase is skipped.
- It is called after the post function has been called for the
- testcase which was skipped.
- i.e. if init_per_group is skipped this function is called after
- post_init_per_group
- , and if a testcase is skipped it is called after
- post_end_per_testcase
- .
+ This function is called whenever a test case (or config function)
+ is skipped. It is called after the post function has been called
+ for the skipped test case. I.e. if init_per_group is skipped, this
+ function is called after
+
+ post_init_per_group, and if a test case is skipped,
+ it is called after
+
+ post_end_per_testcase. If the skipped test case belongs to a
+ test case group, the first argument is a tuple {FuncName,GroupName},
+ otherwise simply the function name.
The data which comes with the Reason follows the same format as
tc_auto_skip
--
cgit v1.2.3