X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=test%2Fcommon%2FREADME.md;h=6c277bd51985d0ee541ab41337e52d8ffb558bf5;hb=3cc0b58e9a786f619af2af318ef2028179ed2dab;hp=4edfcbb7696d4b46df2359b77a95030cb8fd1c27;hpb=330db2ab9b62777a96450527eb1978e15986a0d4;p=nonrtric.git diff --git a/test/common/README.md b/test/common/README.md index 4edfcbb7..6c277bd5 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,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 ## @@ -1037,6 +1038,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 ## @@ -1626,20 +1669,98 @@ 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 | |--| -| ` []` | +| ` [ [ ]]` | | parameter | description | | --------- | ----------- | | `` | Expected http response code | -| `` | Id of the Info type | | `` | Id of the job | | `` | Expected status | +| `` | 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 | +|--| +| ` [ EMPTYPROD|( + ) []]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the job | +| `` | Expected status | +| `` | Indicated for empty list of producer | +| `` | Number of expected producer | +| `` |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() ##