X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcommon%2FREADME.md;h=11e2a978048e563f769613fd3c3ab62efbf0adb9;hb=79e37003f5c94bfe12d197727dd31334e50397a6;hp=a267a49254aa2d7af17eb6ff02bd4b16b1e71612;hpb=0ed89abe5fcff73493b84d1fe1831487249d77e4;p=nonrtric.git diff --git a/test/common/README.md b/test/common/README.md index a267a492..11e2a978 100644 --- 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 [release] [auto-clean] [--stop-at-error] [--ricsim-prefix ] [--use-local-image +] [--use-snapshot-image +] [--use-staging-image +] [--use-release-image +] [--image-repo ] [--repo-policy local\|remote] [--cluster-timeout ]` | +| `remote\|remote-remove docker\|kube --env-file [release] [auto-clean] [--stop-at-error] [--ricsim-prefix ] [--use-local-image +] [--use-snapshot-image +] [--use-staging-image +] [--use-release-image +] [--image-repo ] [--repo-policy local\|remote] [--cluster-timeout ] [--print-stats]` | | parameter | description | |-|-| @@ -150,6 +150,10 @@ 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 | +| `--override ` | Override setting from the file supplied by --env-file | +| `--pre-clean` | Clean kube resouces when running docker and vice versa | +| `--gen-stats` | Collect container/pod runtime statistics | | `help` | Print this info along with the test script description and the list of app short names supported | ## Function: setup_testenvironment ## @@ -199,17 +203,6 @@ Print the value of the timer (in seconds) previously started by 'start_timer'. ( | --------- | ----------- | | `` | Any text message to be printed along with the timer result.(It is good practice to use same args for this function as for the `start_timer`) | -## Function: print_and_reset_timer ## - -Print the value of the timer (in seconds) previously started by 'start_timer'. Also reset the timer to 0. The result of the timer as well as the args to the function will also be printed in the test report. -| arg list | -|--| -| `` | - -| parameter | description | -| --------- | ----------- | -| `` | Any text message to be printed along with the timer result.(It is good practice to use same args for this function as for the `start_timer`) | - ## Function: deviation ## Mark a test as a deviation from the requirements. The list of deviations will be printed in the test report. @@ -1037,6 +1030,48 @@ Check the contents of all ric events received for a callback id. | `EMPTY` | Indicator for an empty list | | `` | Id of the ric | +## Function: cr_api_check_all_ecs_events() ## + +Check the contents of all current status events for one id from ECS + +| arg list | +|--| +| ` [ EMPTY \| ( )+ ]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the callback destination | +| `EMPTY` | Indicator for an empty list | +| `` | Status string | + +## Function: cr_api_check_all_ecs_subscription_events() ## + +Check the contents of all current subscription events for one id from ECS + +| arg list | +|--| +| ` [ EMPTY | ( )+ ]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the callback destination | +| `EMPTY` | Indicator for an empty list | +| `` | Id of the data type | +| `` | Path to typeschema file | +| `` | Status string | + + +## Function: cr_api_reset() ## + +Reset the callback receiver + +| arg list | +|--| +| - | + + # Description of functions in ecs_api_functions.sh # ## Function: use_ecs_rest_http ## @@ -1661,6 +1696,64 @@ To also test the response payload add the expected status. | `` |Id of the producer | | `` | Timeout | + +## Function: ecs_api_idc_get_subscription_ids() ## +Test of GET '/data-consumer/v1/info-type-subscription' with the returned list of subscription ids + +| arg list | +|--| +| ` |NOOWNER [ EMPTY | +]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the owner | +| `` | Indicator for empty owner | +| `` | Indicated for empty list of subscription ids | +| `` |Id of the subscription | + +## Function: ecs_api_idc_get_subscription() ## +Test of GET '/data-consumer/v1/info-type-subscription/{subscriptionId}' with the subscription information + +| arg list | +|--| +| ` [ ]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` |Id of the subscription | +| `` | Id of the owner | +| `` | Url for status notifications | + + +## Function: ecs_api_idc_put_subscription() ## +Test of PUT '/data-consumer/v1/info-type-subscription/{subscriptionId}' with the subscription information + +| arg list | +|--| +| ` ` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` |Id of the subscription | +| `` | Id of the owner | +| `` | Url for status notifications | + +## Function: ecs_api_idc_delete_subscription() ## +Test of DELETE /data-consumer/v1/info-type-subscription/{subscriptionId} + +| arg list | +|--| +| ` ` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` |Id of the subscription | + + ## Function: ecs_api_admin_reset() ## Test of GET '/status'.