summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorFrederic Marec <frederic.marec@iot.bzh>2019-05-23 09:23:52 +0200
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2019-05-28 11:26:22 +0000
commit6d9031afa5d5c8d921c53b5b1e752d1a8839f8d3 (patch)
tree0e6b6a7da0e4b84e6049cbd7ca58a489539ecdae /docs
parent257fef2c54620cc8b0496cbcbdbd51567ced3c07 (diff)
Add skipped functions Add testVerbStatusSkipped Add assertVerbStatusSkipped Add documentation Bug-AGL: SPEC-2447 Change-Id: I84dd96b29e4838d6a1b951dc2aa230b6da3c048a Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r--docs/Reference/0_BindingTestFunctions.md12
-rw-r--r--docs/Reference/1_BindingAssertFunctions.md6
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/Reference/0_BindingTestFunctions.md b/docs/Reference/0_BindingTestFunctions.md
index 8da86da..03905fa 100644
--- a/docs/Reference/0_BindingTestFunctions.md
+++ b/docs/Reference/0_BindingTestFunctions.md
@@ -20,6 +20,18 @@
(if set) functions, *tearDown* will be ran after your *testFunction* and
**_AFT.afterEach()** (if set) functions.
+* **_AFT.testVerbStatusSkipped(testName, api, verb, args, setUp, tearDown, msg)**
+
+ Skip a test.
+
+ *msg* is a message to indicate the reason why the test is skip,
+ it must contain your test name if you want to parse the output.
+ *setUp* and *tearDown* are functions that can be added to your context,
+ it works just like **_AFT.beforeEach()** and **_AFT.afterEach()**,
+ *setUp* will be ran before your *testFunction* and **_AFT.beforeEach()**
+ (if set) functions, *tearDown* will be ran after your *testFunction* and
+ **_AFT.afterEach()** (if set) functions.
+
* **_AFT.testVerbResponseEquals(testName, api, verb, args, expectedResponse, setUp, tearDown)**
Test that the call of a verb successfully returns and that verb's response
diff --git a/docs/Reference/1_BindingAssertFunctions.md b/docs/Reference/1_BindingAssertFunctions.md
index 918bd04..a007875 100644
--- a/docs/Reference/1_BindingAssertFunctions.md
+++ b/docs/Reference/1_BindingAssertFunctions.md
@@ -8,6 +8,12 @@
The inverse than above.
+* **_AFT.assertVerbStatusSkipped(api, verb, args, msg)**
+
+ Skip a test.
+
+ *msg* must contain your test name if you want to parse the output.
+
* **_AFT.assertVerbResponseEquals(api, verb, args, expectedResponse)**
Test that the call of a verb successfully returns and that verb's response