Adapted function test for E release

[nonrtric.git] / test / common / README.md

diff --git a/test/common/README.md b/test/common/README.md
index 4edfcbb..8f37377 100644 (file)
--- a/test/common/README.md
+++ b/test/common/README.md
@@ -130,7 +130,7 @@ The script can be started with these arguments
 
 | arg list |
 |--|
-| `remote\|remote-remove docker\|kube --env-file <environment-filename> [release] [auto-clean] [--stop-at-error] [--ricsim-prefix <prefix> ] [--use-local-image <app-nam>+]  [--use-snapshot-image <app-nam>+] [--use-staging-image <app-nam>+] [--use-release-image <app-nam>+] [--image-repo <repo-address>] [--repo-policy local\|remote] [--cluster-timeout <timeout-in-seconds>]` |
+| `remote\|remote-remove docker\|kube --env-file <environment-filename> [release] [auto-clean] [--stop-at-error] [--ricsim-prefix <prefix> ] [--use-local-image <app-nam>+]  [--use-snapshot-image <app-nam>+] [--use-staging-image <app-nam>+] [--use-release-image <app-nam>+] [--image-repo <repo-address>] [--repo-policy local\|remote] [--cluster-timeout <timeout-in-seconds>]  [--print-stats]` |
 
 | parameter | description |
 |-|-|
@@ -150,6 +150,7 @@ The script can be started with these arguments
 | `--image-repo` |  Url to optional image repo. Only locally built images will be re-tagged and pushed to this repo |
 | `-repo-policy` |  Policy controlling which images to re-tag and push to image repo in param --image-repo. Can be set to 'local' (push on locally built images) or 'remote' (push locally built images and images from nexus repo). Default is 'local' |
 | `--cluster-timeout` |  Optional timeout for cluster where it takes time to obtain external ip/host-name. Timeout in seconds |
+| `--print-stats` |  Prints the number of tests, failed tests, failed configuration and deviations after each individual test or config |
 | `help` | Print this info along with the test script description and the list of app short names supported |
 
 ## Function: setup_testenvironment ##
@@ -1626,20 +1627,40 @@ To also test the response payload add a path to the expected schema file.
 
 ## Function: ecs_api_idc_get_job_status() ##
 
-Test of GET '/data-consumer/v1/info-jobs/{infoJobId}/status' and optional check of the returned status.
-To test the response code only, provide the response code, type id and job id.
+Test of GET '/data-consumer/v1/info-jobs/{infoJobId}/status' and optional check of the returned status and timeout.
+To test the response code only, provide the response code and job id.
 To also test the response payload add the expected status.
 
 | arg list |
 |--|
-| `<response-code> <type-id> <job-id> [<status>]` |
+| `<response-code> <job-id> [<status> [ <timeout>]]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<job-id>` | Id of the job  |
+| `<status>` | Expected status  |
+| `<timeout>` | Timeout |
+
+## Function: ecs_api_idc_get_job_status2() ##
+
+Test of GET '/data-consumer/v1/info-jobs/{infoJobId}/status' with returned producers and optional check of the returned status and timeout.
+To test the response code only, provide the response code and job id.
+To also test the response payload add the expected status.
+
+| arg list |
+|--|
+| `<response-code> <job-id> [<status> EMPTYPROD|( <prod-count> <producer-id>+ ) [<timeout>]]` |
 
 | parameter | description |
 | --------- | ----------- |
 | `<response-code>` | Expected http response code |
-| `<type-id>` | Id of the Info type  |
 | `<job-id>` | Id of the job  |
 | `<status>` | Expected status  |
+| `<EMPTYPROD>` | Indicated for empty list of producer  |
+| `<prod-count>` | Number of expected producer  |
+| `<producer-id>` |Id of the producer  |
+| `<timeout>` | Timeout |
 
 ## Function: ecs_api_admin_reset() ##