X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcommon%2FREADME.md;h=bdb2f0dc6865af4f4638bfbd23891b440c4ab5ec;hb=9d8fafb7f03db136ded73eddcc717a87a4b1df27;hp=85535199bcb4f1a3ab33dfef0510f1f77cdc5ec4;hpb=cb28fdff6d977773c123db418ab0b5f6861f5335;p=nonrtric.git diff --git a/test/common/README.md b/test/common/README.md index 85535199..bdb2f0dc 100644 --- a/test/common/README.md +++ b/test/common/README.md @@ -129,7 +129,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 [release] [auto-clean] [--stop-at-error] [--ricsim-prefix ] [--use-local-image +] [--use-snapshot-image +] [--use-staging-image +] [--use-release-image +] [--image-repo ]` | | parameter | description | |-|-| @@ -147,6 +147,7 @@ The script can be started with these arguments | `--use-staging-image` | The script will use images from the nexus staging repo for the supplied apps, space separated list of app short names | | `--use-release-image` | The script will use images from the nexus release repo for the supplied apps, space separated list of app short names | | `--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 | | `help` | Print this info along with the test script description and the list of app short names supported | @@ -1307,6 +1308,121 @@ Test of GET '/status'. | --------- | ----------- | | `` | Expected http response code | +## Function: ecs_api_idc_get_type_ids() ## +Test of GET '/data-consumer/v1/info-types' and an optional check of the returned list of type ids. +To test the response code only, provide the response code. +To also test the response payload add list of expected type ids (or EMPTY if the list is expected to be empty). + +| arg list | +|--| +| ` [ EMPTY | +]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the Info type | +| `EMPTY` | The expected list of type ids shall be empty | + +## Function: ecs_api_idc_get_job_ids() ## +Test of GET '/data-consumer/v1/info-jobs' and optional check of the array of returned job ids. +To test the response code only, provide the response code parameter as well as a type id and an owner id. +To also test the response payload add the 'EMPTY' for an expected empty array or repeat the last parameter for each expected job id. + +| arg list | +|--| +| ` |NOOWNER [ EMPTY | + ]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the Info type | +| `` | Id of the job owner | +| `NOOWNER` | No owner is given | +| `` | Id of the expected job | +| `EMPTY` | The expected list of job id shall be empty | + +## Function: ecs_api_idc_get_job() ## +Test of GET '/data-consumer/v1/info-jobs/{infoJobId}' and optional check of the returned job. +To test the response code only, provide the response code, type id and job id. +To also test the response payload add the remaining parameters. + +| arg list | +|--| +| ` [ ]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the Info type | +| `` | Id of the job | +| `` | Expected target url for the job | +| `` | Expected owner for the job | +| `` | Path to a job template for job parameters of the job | + +## Function: ecs_api_idc_put_job() ## +Test of PUT '​/data-consumer/v1/info-jobs/{infoJobId}'. +To test, provide all the specified parameters. + +| arg list | +|--| +| ` [VALIDATE]` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the Info type | +| `` | Id of the job | +| `` | Target url for the job | +| `` | Owner of the job | +| `` | Path to a job template for job parameters of the job | +| `VALIIDATE` | Indicator to preform type validation at creation | + +## Function: ecs_api_idc_delete_job() ## +Test of DELETE '/A1-EI​/v1​/eitypes​/{eiTypeId}​/eijobs​/{eiJobId}'. +To test, provide all the specified parameters. + +| arg list | +|--| +| ` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the EI type | +| `` | Id of the job | + +## Function: ecs_api_idc_get_type() ## +Test of GET '/data-consumer/v1/info-types/{infoTypeId} and optional check of the returned schema. +To test the response code only, provide the response code parameter as well as the type-id. +To also test the response payload add a path to the expected schema file. + +| arg list | +|--| +| ` []` | + +| parameter | description | +| --------- | ----------- | +| `` | Expected http response code | +| `` | Id of the Info type | +| `` | Path to a schema file to compare with the returned schema | + +## 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. +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 | + + ## Function: ecs_api_admin_reset() ## Test of GET '/status'. @@ -1375,6 +1491,18 @@ Only response code tested - not payload # Description of functions in http_proxy_api_functions.sh # +## Function: use_http_proxy_http ## +Use http for all proxy requests. Note that this only applicable to the actual proxy request, the proxied protocol can still be http and https. +| arg list | +|--| +| None | + +## Function: use_http_proxy_https ## +Use https for all proxy requests. Note that this only applicable to the actual proxy request, the proxied protocol can still be http and https. +| arg list | +|--| +| None | + ## Function: start_http_proxy ## Start the http proxy container in docker or kube depending on running mode. | arg list | @@ -1383,6 +1511,18 @@ Start the http proxy container in docker or kube depending on running mode. # Description of functions in kube_proxy_api_functions.sh # +## Function: use_kube_proxy_http ## +Use http for all proxy requests. Note that this only applicable to the actual proxy request, the proxied protocol can still be http and https. +| arg list | +|--| +| None | + +## Function: use_kube_proxy_https ## +Use https for all proxy requests. Note that this only applicable to the actual proxy request, the proxied protocol can still be http and https. +| arg list | +|--| +| None | + ## Function: start_kube_proxy ## Start the kube proxy container in kube. This proxy enabled the test env to access all services and pods in a kube cluster. No proxy is started if the function is called in docker mode.