X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=example%2Fdiameter%2Flauncher%2Fresources%2FHELP.md;h=7a50b52fc919af482790d7162cabe838feb25003;hb=e14f6ba5183403d7bbf589ef87b0643b12a0f72c;hp=40f1a5e16bd3b3293b1c48210db59e8cc34d6bb1;hpb=080dc0740d8b02011dee032f5d44eeb5f2ffe23f;p=anna.git

diff --git a/example/diameter/launcher/resources/HELP.md b/example/diameter/launcher/resources/HELP.md
index 40f1a5e..7a50b52 100644
--- a/example/diameter/launcher/resources/HELP.md
+++ b/example/diameter/launcher/resources/HELP.md
@@ -278,7 +278,7 @@ Burst mode only allows single interface interaction. For multiple interface (ori
 
 Adds a new step to the test case with provided identifier. If provided identifier is not registered yet, a new test case will be created with that value and the step will be added as the first. For a specific 'id', the steps are stored in order as they are programmed. Check possible runtime exceptions when adding a new step because those which fail, will be ignored/skipped during test case programming giving an incomplete sequence invalid for the testing purpose.
 
-<id>: integer number, normally monotonically increased for each test case. Some external script/procedure shall clone a test case template in order to build a collection of independent and coherent test cases (normally same type) with different context values (Session-Id, Subscriber-Id, etc.).
+<id>: integer number, normally monotonically increased for each test case. Some external script/procedure shall clone a test case template in order to build a collection of independent and coherent test cases (normally same type) with different context values (Session-Id, Subscriber-Id, etc.). If 0 provided, `id` will be calculated as the current number of test cases plus 1 (normally valid when identification started on value of 1 and no holes were created).
 
 <command>: commands to be executed for the test id provided. Each command programmed constitutes a test case 'step', numbered from 1 to N, with an exception for 'description' which is used to describe the test case:
 
@@ -539,7 +539,7 @@ Implemented status codes: *200* (ok), *400* (bad request) and *405* (method not
 
 > curl -v --request GET localhost:8000<uri>
 
-You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
+You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*anna-adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
 
 > nghttp -v -H ":method: GET" "<uri>"
 
@@ -579,7 +579,7 @@ Retrieve statistics xml report (will be *base64-encoded* at response).
 
 > curl -v --request POST -H "Content-Type: application/json" localhost:8000<uri> -d@test.json
 
-You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
+You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*anna-adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
 
 > nghttp -v -H ":method: POST" -d test.json "<uri>"
 
@@ -840,7 +840,7 @@ Selects a context working node by mean a registered name (origin-host). If empty
 }
 ```
 
-**Response body**: 
+**Response body**:
 
 ```
 {
@@ -1242,8 +1242,27 @@ Sends diameter expressed in hexadecimal string (no spaces, no colons, i.e.: `010
 ### FSM testing
 
 ADML implements a bulting *Finite State Machine* to plan testing flows with a great flexibility.
+Every operation will receive a response which  `json` content is as follows:
+
+```json
+{
+    "result":"true",
+    "response":"<test id>"
+}
+```
+
+or
+
+```json
+{
+    "result":"false",
+    "response":"<error hint>"
+}
+```
+
+In case of success operation, the value of the affected test identifier carried in `response` field is useful when zero value was provided to automatically reserve the next test case. In case of error, a brief error description will be carried in that field.
 
-#### POST /testid-description
+#### POST /testid-description/{id}
 
 **Request body**:
 
@@ -1262,7 +1281,7 @@ ADML implements a bulting *Finite State Machine* to plan testing flows with a gr
 }
 ```
 
-#### POST /testid-ip-limit
+#### POST /testid-ip-limit/{id}
 
 In-Progress limit is the maximum number of tests which can be executed in parallel.
 This operation allows a specific test to set this global pool behaviour.
@@ -1288,7 +1307,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-timeout
+#### POST /testid-timeout/{id}
 
 **Request body**:
 
@@ -1307,7 +1326,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-sendmsg2e
+#### POST /testid-sendmsg2e/{id}
 
 **Request body**:
 
@@ -1327,7 +1346,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-sendmsg2c
+#### POST /testid-sendmsg2c/{id}
 
 **Request body**:
 
@@ -1347,7 +1366,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-delay
+#### POST /testid-delay/{id}
 
 **Request body**:
 
@@ -1366,7 +1385,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-sh-command
+#### POST /testid-sh-command/{id}
 
 **Request body**:
 
@@ -1385,7 +1404,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfe-hex
+#### POST /testid-waitfe-hex/{id}
 
 **Request body**:
 
@@ -1405,7 +1424,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfc-hex
+#### POST /testid-waitfc-hex/{id}
 
 **Request body**:
 
@@ -1425,7 +1444,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfe-msg
+#### POST /testid-waitfe-msg/{id}
 
 **Request body**:
 
@@ -1445,7 +1464,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfc-msg
+#### POST /testid-waitfc-msg/{id}
 
 **Request body**:
 
@@ -1465,7 +1484,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfe
+#### POST /testid-waitfe/{id}
 
 **Request body**:
 
@@ -1494,7 +1513,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfc
+#### POST /testid-waitfc/{id}
 
 **Request body**:
 
@@ -1523,7 +1542,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-### EXECUTION ACTIONS
+### FSM TESTING EXECUTION ACTIONS
 
 #### POST /test-ttps
 
@@ -1774,7 +1793,13 @@ Makes interactive a specific test case id. The amount of 0, implies no execution
 
 #### POST /test-clear
 
-**Request body**: none
+**Request body**:
+
+```
+{
+     ["id":[test identifier (integer: all by default (-1))]]
+}
+```
 
 **Response body**:
 
@@ -1903,5 +1928,26 @@ As it could be very large, it will be dumped on provided target directory, '*/tm
 }
 ```
 
+### DYNAMIC PROCEDURE
+
+Used for system test. Arguments are determined by the way in a specific dynamic library is designed/documented.
+
+#### POST /dynamic
+
+**Request body**:
+
+```
+{
+    "arguments": <diameter arguments json object>
+}
+```
+
+**Response body**:
 
+```
+{
+    "result":"<true or false>",
+    "response":"<response>"
+}
+```