X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2F4_APIs_and_Services%2F4.4_AGL_Test_Framework%2F5_Reference%2F1_BindingTestFunctions%2FBindingTestFunctions.md;fp=docs%2F4_APIs_and_Services%2F4.4_AGL_Test_Framework%2F5_Reference%2F1_BindingTestFunctions%2FBindingTestFunctions.md;h=0ca593e99adc5ccf27c135a261c78c028ce15cf5;hb=4aad369c9728061c97b3de792286e743ee884b09;hp=0000000000000000000000000000000000000000;hpb=619a7e48085be1538c3b01eb93dcb9dc95bf0436;p=AGL%2Fdocumentation.git

diff --git a/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/1_BindingTestFunctions/BindingTestFunctions.md b/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/1_BindingTestFunctions/BindingTestFunctions.md
new file mode 100644
index 0000000..0ca593e
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/1_BindingTestFunctions/BindingTestFunctions.md
@@ -0,0 +1,121 @@
+---
+edit_link: ''
+title: Binding Test Functions
+origin_url: >-
+  https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/0_BindingTestFunctions.md?h=master
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/app-afb-test-developer-guides-api-services-book.yml -->
+
+# Binding Test functions
+
+* **_AFT.testVerbStatusSuccess(testName, api, verb, args, setUp, tearDown)**
+
+    Simply test that the call of a verb successfully returns.
+
+    *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.testVerbStatusError(testName, api, verb, args, setUp, tearDown)**
+
+    The inverse than above.
+
+    *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.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
+    is equals to the *expectedResponse*.
+
+    *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.testVerbResponseEqualsError(testName, api, verb, args, expectedResponse, setUp, tearDown)**
+
+    The inverse than above.
+
+    *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.testVerbCb(testName, api, verb, args, expectedResponse, callback, setUp, tearDown)**
+
+    Test the call of a verb with a custom callback. From this callback you
+    will need to make some assertions on what you need (verb JSON return object
+    content mainly).
+
+    If you don't need to test the response simply specify an empty LUA table.
+
+    *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.testVerbCbError(testName, api, verb, args, expectedResponse, callback, setUp, tearDown)**
+
+    Should return success on failure.
+
+    *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.testEvtReceived(testName, eventName, timeout, setUp, tearDown)**
+
+    Prior to be able to check that an event has been received, you have to
+    register the event with the test framework using **_AFT.addEventToMonitor**
+    function.
+
+    Check if an event has been correctly received in time (timeout in µs). An event
+    name use the application framework naming scheme: **api/event_name**.
+
+* **_AFT.testEvtNotReceived(testName, eventName, timeout, setUp, tearDown)**
+
+    Prior to be able to check that an event has not been received, you have to
+    register the event with the test framework using **_AFT.addEventToMonitor**
+    function.
+
+    Check if an event has not been correctly received in time (timeout in µs). An
+    event name use the application framework naming scheme: **api/event_name**.
+
+* **_AFT.testGrpEvtReceived(testName, eventGrp, timeout, setUp, tearDown)**
+
+    Prior to be able to check that a group of event (a table of event) has been
+    received, you have to register the event with the test framework using
+    **_AFT.addEventToMonitor** function.
+
+    The table has to have this format:
+```lua
+    eventGrp = {["api/event_name_1"]=1,["api/event_name_2"]=2,["api/event_name_3"]=5}
+```
+    As you can see, in the table, event names are table keys and the value stored are
+    the number of time that the events have to be received.
+
+    Check if events has been correctly received in time (timeout in µs). An
+    event name use the application framework naming scheme: **api/event_name**.