# Introduction #
-This dir contains most scripts needed for the auto-test environment. There are scripts with functions to adapt to the apis of the components of the Non-RT RIC; Policy Managerment Service, Information Coordinator Service , A1 simulator as well as other components and simulators. The test environment supports both test with docker and kubernetes.
+This dir contains most scripts needed for the auto-test environment. There are scripts with functions to adapt to the apis of the components of the Non-RT RIC; Policy Management Service, Information Coordinator Service , A1 simulator as well as other components and simulators. The test environment supports both test with docker and kubernetes.
Some of the scripts can also be used for other kinds of tests, for example basic tests.
## Overview for common test scripts and files ##
+`a1pms_api_functions.sh` \
+Contains functions for adapting towards the Policy Management Service (A1PMS) API.
+
`api_curl.sh` \
-A common curl based function for the agent and ics apis. Also partly used for the Callback receiver and RAPP Catalogue apis.
+A common curl based function for the a1pms and ics apis. Also partly used for the Callback receiver and RAPP Catalogue apis.
-`cbs_api_function.sh` \
-All functions are implemented in `consul_api_function.sh`.
+`authsidecar_api_functions.sh` \
+Image handling functions for the auth_token_fetch image.
`chartmus_api_functions.sh` \
Contains functions for managing a Chartmuseum instance.
`clean-kube.sh` \
Cleans all services, deployments, pods, replica set etc started by the test environment in kubernetes.
-`compare_json.py` \
-A python script to compare two json obects for equality. Note that the comparsion always sort json-arrays before comparing (that is, it does not care about the order of items within the array). In addition, the target json object may specify individual parameter values where equality is 'dont care'.
+`clean-kube_ns.sh` \
+Cleans all namespaces created by the test environment in kubernetes.
-`consul_api_function.sh` \
-Contains functions for managing Consul and CBS.
+`compare_json.py` \
+A python script to compare two json objects for equality. Note that the comparison always sort json-arrays before comparing (that is, it does not care about the order of items within the array). In addition, the target json object may specify individual parameter values where equality is 'don't care'.
`count_json_elements.py` \
A python script calculate the length of json array or size of a json dictionary'.
A python script to create a batch of policies. The script is intended to run in a number of processes to create policies in parallel.
`create_rics_json.py` \
-A python script to create a json file from a formatted string of ric info. Helper for the test enviroment.
+A python script to create a json file from a formatted string of ric info. Helper for the test environment.
`delete_policies_process.py` \
A python script to delete a batch of policies. The script is intended to run in a number of processes to delete policies in parallel.
`dmaapadp_api_function.sh`
-Contains funnctions for managing the Dmaap Adaptor Service.
+Contains functions for managing the Dmaap Adapter.
`dmaapmed_api_function.sh`
-Contains funnctions for managing the Dmaap Mediator Service.
+Contains functions for managing the Dmaap Mediator Service.
`dmaapmr_api_function.sh`
All functions are implemented in `mr_api_functions.sh`.
`extract_sdnc_reply.py` \
A python script to extract the information from an sdnc (A1 Controller) reply json. Helper for the test environment.
+`format_endpoint_stats.sh` \
+This script formats API statistics into a test report - data is collected only if the flag `--endpoint-stats` is given to the test script .
+
`genstat.sh` \
This script collects container statistics to a file. Works both in docker and kubernetes (only for docker runtime).
`ics_api_functions.sh` \
Contains functions for adapting towards the Information Coordinator Service API.
+`istio_api_functions.sh` \
+Contains functions for istio configurations.
+
`kafkapc_api_functions.sh` \
Contains functions for managing the kafka producer/consumer. Kafka is started by the dmaap message router component.
+`keycloak_api_functions.sh` \
+Contains functions for keycloak configuration.
+
`kube_proxy_api_functions.sh` \
Contains functions for managing the Kube Proxy - to gain access to all services pod inside a kube cluster or all containers in a private docker network.
`ngw_api_functions.sh` \
Contains functions for managing the Non-RT RIC Gateway
-`pa_api_functions.sh` \
-Contains functions for adapting towards the Policy Management Service (PMS) API, also via dmaap (using a message-router stub interface)
-
`prodstub_api_functions.sh` \
Contains functions for adapting towards the Producer stub interface - simulates a producer.
`ricsim_api_functions.sh` \
Contains functions for adapting towards the RIC (A1) simulator admin API.
+`ricmediatorsim_api_functions.sh` \
+Contains functions for adapting towards the ricmediator simulator (A1) API.
+
`sdnc_api_functions.sh` \
Contains functions for adaping towards the SDNC (used as an A1 controller).
Used by the auto test scripts/suites but could be used for other test script as well. The test cases shall be started with the file for the intended target using command line argument '--env-file'.
`testcase_common.sh` \
-Common functions for auto test cases in the auto-test dir. This script is the foundation of test auto environment which sets up images and enviroment variables needed by this script as well as the script adapting to the APIs.
+Common functions for auto test cases in the auto-test dir. This script is the foundation of test auto environment which sets up images and environment variables needed by this script as well as the script adapting to the APIs.
The included functions are described in detail further below.
`testengine_config.sh` \
-Configuration file to setup the applications (components and simulators) the test enviroment handles.
+Configuration file to setup the applications (components and simulators) the test environment handles.
`testsuite_common.sh` \
Common functions for running two or more auto test scripts as a suite.
Integration a new application to the test environment involves the following steps.
-* Choose a short name for the application. Should be a uppcase name. For example, the NonRTRIC Gateway has NGW as short name.
+* Choose a short name for the application. Should be a uppercase name. For example, the NonRTRIC Gateway has NGW as short name.
This short name shall be added to the testengine_config.sh. See that file for detailed instructions.
+Depending if the image is a locally built simulator image or an official image, the following env vara may need to be updated with the app short name: `PROJECT_IMAGES_APP_NAMES ORAN_IMAGES_APP_NAMES ORAN_IMAGES_APP_NAMES`.
+
* Create a file in this directory using the pattern `<application-name>_api_functions.sh`.
-This file must implement the following functions used by the test engine. Note that functions must include the application short name in the function name. If the application does not run in kubernetes, then the last three functions in the list can be omitted.
+This file must implement the following functions used by the test engine. Note that functions must include the application short name in the function name. If the application does not run in kubernetes, then the functions with kube prefix does not need to be implemented.
| Function |
|--|
| __<app-short_name>_kube_delete_all |
| __<app-short_name>_store_docker_logs |
| __<app-short_name>_initial_setup |
-| __<app-short_name>_statisics_setup |
+| __<app-short_name>_statistics_setup |
| __<app-short_name>_test_requirements |
In addition, all other functions used for testing of the application shall also be added to the file. For example functions to start the application, setting interface parameters as well as functions to send rest call towards the api of the application and validating the result.
-* Add the application variables to api_curl.sh. This file contains a generic function to make rest calls to an api. It also supports switching betweeen direct rest calls or rest calls via messsage router.
+* Add the application variables to api_curl.sh. This file contains a generic function to make rest calls to an api. It also supports switching between direct rest calls or rest calls via message router.
* Create a directory beneath in the simulator-group dir. This new directory shall contain docker-compose files, config files (with or without variable substitutions) and kubernetes resource files.
-All docker-compose files and all kubernetes resource files need to defined special lables. These lables are used by the test enginge to identify containers and resources started and used by the test engine.
+All docker-compose files and all kubernetes resource files need to defined special labels. These labels are used by the test engine to identify containers and resources started and used by the test engine.
| Label for docker compose | Description |
|--|--|
| 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>] [--print-stats]` |
+| `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>+]`
+` [--use-external-image <app-nam>+]`
+` [--image-repo <repo-address>]`
+` [--repo-policy local\|remote]`
+` [--cluster-timeout <timeout-in-seconds>]`
+` [--print-stats]`
+` [--override <override-environment-filename>]`
+` [--pre-clean]`
+` [--gen-stats]`
+` [--delete-namespaces]`
+` [--delete-containers]`
+` [--endpoint-stats]`
+` [--kubeconfig <config-file>]`
+` [--host-path-dir <local-host-dir>]`
+` [--kubecontext <context-name>]`
+` [--docker-host <docker-host-url>]`
+` [--docker-proxy <host-or-ip>] `
+` ["--target-platform <platform> ]` |
| parameter | description |
|-|-|
| `remote` | Use images from remote repositories. Can be overridden for individual images using the '--use_xxx' flags |
| `remote-remove` | Same as 'remote' but will also try to pull fresh images from remote repositories |
| `docker` | Use docker environment for test |
-| `kuber` | Use kubernetes environment for test. Requires a kubernetes minikube installation |
+| `kube` | Use kubernetes environment for test. Requires access to a local or remote kubernetes cluster (or or more nodes). For example docker desktop, minikube, external kubernetes cluster, google cloud etc |
| `--env-file` | The script will use the supplied file to read environment variables from |
| `release` | If this flag is given the script will use release version of the images |
| `auto-clean` | If the function 'auto_clean_containers' is present in the end of the test script then all containers will be stopped and removed. If 'auto-clean' is not given then the function has no effect |
| `--use-snapshot-image` | The script will use images from the nexus snapshot repo for the supplied apps, space separated list of app short names |
| `--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 |
+| `--use-external-image` | The script will use images from an external 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 only locally built images) or 'remote' (push locally built images and images from nexus repo). Default is 'local' |
+| `--repo-policy` | Policy controlling which images to re-tag and push to image repo in param --image-repo. Can be set to 'local' (push only 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 <file>` | Override setting from the file supplied by --env-file |
-| `--pre-clean` | Clean kube resouces when running docker and vice versa |
+| `--pre-clean` | Clean kube resources when running docker and vice versa |
| `--gen-stats` | Collect container/pod runtime statistics |
-| `--delete-namespaces` | Delete kubernetes namespaces before starting tests - but only those created by the test scripts. Kube mode only. Ignored if running with prestarted apps. |
+| `--delete-namespaces` | Delete kubernetes namespaces before starting tests - but only those created by the test scripts. Kube mode only. Ignored if running with pre-started apps. |
| `--delete-containers` | Delete docker containers before starting tests - but only those created by the test scripts. Docker mode only. |
| `--endpoint-stats` | Collect http endpoint statistics |
+| `--kubeconfig` | Kubernetes config file for kubectl, when running with non local kubernetes |
+| `--host-path-dir` | Path for storing persistent data in kubernetes. Must be available on all nodes. Default is `/tmp` |
+| `--kubecontext` | Kubernetes context name for kubectl, when running with non local kubernetes |
+| `--docker-host` | Url to docker host, host and port. For non local docker |
+| `--docker-proxy` | Host or IP of the docker instance, for non local docker |
+| `--target-platform` | Build and pull images for this target platform |
+
+
| `help` | Print this info along with the test script description and the list of app short names supported |
## Function: setup_testenvironment ##
|--|
| None |
-# Description of functions in chartmus_api_function.sh #
+# Description of functions in a1pms_api_functions.sh #
-## Function: start_chart_museum ##
+## General ##
-Start the Chart Museum
+Both A1PMS version 1 and 2 are supported. The version is controlled by the env variable `$A1PMS_VERSION` set in the test env file.
+For api function in version 2, an url prefix is added if configured.
+
+## Function: use_a1pms_rest_http ##
+
+Use http for all API calls to the A1PMS. This is the default.
| arg list |
|--|
| None |
-## Function: chartmus_upload_test_chart ##
+## Function: use_a1pms_rest_https ##
-Upload a package chart to chartmusem
+Use https for all API calls to the A1PMS.
| arg list |
|--|
-| `<chart-name>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<chart-name>` | Name of the chart to upload |
+| None |
-## Function: chartmus_delete_test_chart ##
+## Function: use_a1pms_dmaap_http ##
-Delete a chart in chartmusem
+Send and receive all API calls to the A1PMS over Dmaap via the MR over http.
| arg list |
|--|
-| `<chart-name> [<version>]` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<chart-name>` | Name of the chart to delete |
-| `<version>` | Chart version, default is 0.1.0 |
-
+| None |
-# Description of functions in consul_api_function.sh #
+## Function: use_a1pms_dmaap_https ##
-## Function: consul_config_app ##
+Send and receive all API calls to the A1PMS over Dmaap via the MR over https.
+| arg list |
+|--|
+| None |
-Function to load a json config from a file into consul for the Policy Agent
+## Function: start_a1pms ##
+Start the A1PMS container or corresponding kube resources depending on docker/kube mode.
| arg list |
|--|
-| `<json-config-file>` |
+| `<logfile-prefix>` |
+| (docker) `PROXY\|NOPROXY <config-file>` |
+| (kube) `PROXY\|NOPROXY <config-file> [ <data-file> ]` |
| parameter | description |
| --------- | ----------- |
-| `<json-config-file>` | The path to the json file to be loaded to Consul/CBS |
+| `PROXY` | Configure with http proxy, if proxy is started |
+| `NOPROXY` | Configure without http proxy |
+| `<config-file>`| Path to application.yaml |
+| `<data-file>` | Optional path to application_configuration.json |
-## Function: start_consul_cbs ##
+## Function: stop_a1pms ##
-Start the Consul and CBS containers
+Stop the a1pms container (docker) or scale it to zero (kubernetes).
| arg list |
|--|
-| None |
-
-# Description of functions in cp_api_function.sh #
+| None |
-## Function: use_control_panel_http ##
+## Function: start_stopped_a1pms ##
-Set http as the protocol to use for all communication to the Control Panel
+Start a previously stopped a1pms container (docker) or scale it to 1 (kubernetes).
| arg list |
|--|
-| None |
+| None |
-## Function: use_control_panel_https ##
+## Function: prepare_a1pms_config ##
-Set https as the protocol to use for all communication to the Control Panel
+Function to prepare an a1pms config based on the previously configured (and started simulators). Note that all simulator must be running and the test script has to configure if http or https shall be used for the components (this is done by the functions 'use_simulator_http', 'use_simulator_https', 'use_sdnc_http', 'use_sdnc_https', 'use_mr_http', 'use_mr_https')
| arg list |
|--|
-| None |
+| `SDNC|NOSDNC <output-file>` |
-## Function: start_control_panel ##
+| parameter | description |
+| --------- | ----------- |
+| `SDNC` | Configure with controller |
+| `NOSDNC` | Configure without controller |
+| `<output-file>` | The path to the json output file containing the prepared config. This file is used in 'a1pms_load_config' |
-Start the Control Panel container
+## Function: a1pms_load_config ##
+
+Load the config into a config map (kubernetes only).
| arg list |
|--|
-| None |
+| `<data-file>` |
-# Description of functions in cr_api_functions.sh #
+| parameter | description |
+| --------- | ----------- |
+| `<data-file>` | Path to application_configuration.json |
-## Function: use_cr_http ##
+## Function: set_a1pms_debug ##
-Use http for getting event from CR. The admin API is not affected. This is the default.
+Configure the A1PMS log on debug level. The A1PMS must be running.
| arg list |
|--|
| None |
-## Function: use_cr_https ##
+## Function: set_a1pms_trace ##
-Use https for getting event from CR. The admin API is not affected.
-Note: Not yet used as callback event is not fully implemented/deciced.
+Configure the A1PMS log on trace level. The A1PMS must be running.
| arg list |
|--|
| None |
-## Function: start_cr ##
+## Function: use_a1pms_retries ##
-Start the Callback Receiver container in docker or kube depending on start mode.
+Configure the A1PMS to make up-to 5 retries if an API call returns any of the specified http return codes.
| arg list |
|--|
-| None |
+| `[<response-code>]*` |
-## Function: cr_equal ##
+## Function: check_a1pms_logs ##
-Tests if a variable value in the Callback Receiver (CR) simulator is equal to a target value.
-Without the timeout, the test sets pass or fail immediately depending on if the variable is equal to the target or not.
-With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes equal to the target value or not.
-See the 'cr' dir for more details.
+Check the A1PMS log for any warnings and errors and print the count of each.
| arg list |
|--|
-| `<cr-path-id> <variable-name> <target-value> [ <timeout-in-sec> ]` |
+| None |
-| parameter | description |
-| --------- | ----------- |
-| `<cr-path-id>` | Variable index to CR |
-| `<variable-name>` | Variable name in the CR |
-| `<target-value>` | Target value for the variable |
-| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
+## Function: a1pms_equal ##
-## Function: cr_greater_or_equal ##
-Tests if a variable value in the Callback Receiver (CR) simulator is equal to or greater than a target value.
-Without the timeout, the test sets pass or fail immediately depending on if the variable is equal to or greater than the target or not.
-With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes equal to the target value or not.
+Tests if the array length of a json array in the A1PMS simulator is equal to a target value.
+Without the timeout, the test sets pass or fail immediately depending on if the array length is equal to the target or not.
+With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the array length becomes equal to the target value or not.
See the 'cr' dir for more details.
+
| arg list |
|--|
-| `<cr-path-id> <variable-name> <target-value> [ <timeout-in-sec> ]` |
+| `<variable-name> <target-value> [ <timeout-in-sec> ]` |
| parameter | description |
| --------- | ----------- |
-| `<cr-path-id>` | Variable index to CR |
-| `<variable-name>` | Variable name in the CR |
-| `<target-value>` | Target value for the variable |
-| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
+| `<variable-name>` | Relative url. Example 'json:policy_types' - checks the json array length of the url /policy_types |
+| `<target-value>` | Target value for the length |
+| `<timeout-in-sec>` | Max time to wait for the length to reach the target value |
-## Function: cr_contains_str ##
+## Function: a1pms_api_get_policies ##
-Tests if a variable value in the CR contains a target string.
-Without the timeout, the test sets pass or fail immediately depending on if the variable contains the target string or not.
-With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value contains the target string or not.
-See the 'a1-interface' repo for more details.
+Test of GET '/policies' or V2 GET '/v2/policy-instances' and optional check of the array of returned policies.
+To test the response code only, provide the response code parameter as well as the following three parameters.
+To also test the response payload add the 'NOID' for an expected empty array or repeat the last five/seven parameters for each expected policy.
| arg list |
|--|
-| `<cr-path-id> <variable-name> <target-value> [ <timeout-in-sec> ]` |
-
-
-| parameter | description |
-| --------- | ----------- |
-| `<cr-path-id>` | Variable index to CR |
-| `<variable-name>` | Variable name in the CR |
-| `<target-value>` | Target substring for the variable |
-| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
-
-## Function: cr_read ##
+| `<response-code> <ric-id>\|NORIC <service-id>\|NOSERVICE <policy-type-id>\|NOTYPE [ NOID \| [<policy-id> <ric-id> <service-id> EMPTY\|<policy-type-id> <template-file>]*]` |
-Reads the value of a variable in the CR simulator. The value is intended to be passed to a env variable in the test script.
-See the 'mrstub' dir for more details.
-| arg list |
+| arg list V2 |
|--|
-| `<cr-path-id> <variable-name>` |
+| `<response-code> <ric-id>\|NORIC <service-id>\|NOSERVICE <policy-type-id>\|NOTYPE [ NOID \| [<policy-id> <ric-id> <service-id> EMPTY\|<policy-type-id> <transient> <notification-url> <template-file>]*]` |
| parameter | description |
| --------- | ----------- |
-| `<cr-path-id>` | Variable index to CR |
-| `<variable-name>` | Variable name in the CR |
+| `<response-code>` | Expected http response code |
+| `<ric-id>` | Id of the ric |
+| `NORIC` | Indicator that no ric is provided |
+| `<service-id>` | Id of the service |
+| `NOSERVICE` | Indicator that no service id is provided |
+| `<policy-type-id>` | Id of the policy type |
+| `NOTYPE` | Indicator that no type id is provided |
+| `NOID` | Indicator that no policy id is provided - indicate empty list of policies|
+| `<policy-id>` | Id of the policy |
+| `EMPTY` | Indicate for the special empty policy type |
+| `transient` | Transient, true or false |
+| `notification-url` | Url for notifications |
+| `<template-file>` | Path to the template file for the policy (same template used when creating the policy) |
-## Function: cr_delay_callback ##
+## Function: a1pms_api_get_policy ##
-Function to configure write delay on callbacks. Delay given in seconds. Setting remains until removed.
+Test of GET '/policy' or V2 GET '/v2/policies/{policy_id}' and optional check of the returned json payload.
+To test the the response code only, provide the expected response code and policy id.
+To test the contents of the returned json payload, add a path to the template file used when creating the policy.
| arg list |
|--|
-| `<response-code> <cr-path-id> [<delay-in-seconds>]`|
+| `<response-code> <policy-id> [<template-file>]` |
+
+| arg list V2|
+|--|
+| `<response-code> <policy-id> [ <template-file> <service-name> <ric-id> <policytype-id>\|NOTYPE <transient> <notification-url>\|NOURL ]` |
| parameter | description |
| --------- | ----------- |
| `<response-code>` | Expected http response code |
-| `<cr-path-id>` | Variable index to CR |
-| `<delay-in-seconds>` | Delay in seconds. If omitted, the delay is removed |
+| `<policy-id>` | Id of the policy |
+| `<template-file>` | Path to the template file for the policy (same template used when creating the policy) |
+| `<service-id>` | Id of the service |
+| `<ric-id>` | Id of the ric |
+| `<policy-type-id>` | Id of the policy type |
+| `NOTYPE` | Indicator that no type id is provided |
+| `transient` | Transient, true or false |
+| `notification-url` | Url for notifications |
-## Function: cr_api_check_all_sync_events ##
+## Function: a1pms_api_put_policy ##
-Check the contents of all ric events received for a callback id.
+Test of PUT '/policy' or V2 PUT '/policies'.
+If more than one policy shall be created, add a count value to indicate the number of policies to create. Note that if more than one policy shall be created the provided policy-id must be numerical (will be used as the starting id).
| arg list |
|--|
-| `<response-code> <cr-path-id> <id> [ EMPTY \| ( <ric-id> )+ ]` |
+| `<response-code> <service-name> <ric-id> <policytype-id> <policy-id> <transient> <template-file> [<count>]` |
+
+| arg list V2 |
+|--|
+| `<response-code> <service-name> <ric-id> <policytype-id>\|NOTYPE <policy-id> <transient>\|NOTRANSIENT <notification-url>\|NOURL <template-file> [<count>]` |
| parameter | description |
| --------- | ----------- |
| `<response-code>` | Expected http response code |
-| `<cr-path-id>` | Variable index for CR |
-| `<id>` | Id of the callback destination |
-| `EMPTY` | Indicator for an empty list |
+| `<service-id>` | Id of the service |
| `<ric-id>` | Id of the ric |
+| `<policy-type-id>` | Id of the policy type |
+| `<policy-id>` | Id of the policy. This value shall be a numeric value if more than one policy shall be created |
+| `transient>` | Transient 'true' or 'false'. 'NOTRANSIENT' can be used to indicate using the default value (no transient value provided) |
+| `notification-url` | Url for notifications |
+|`NOURL`| Indicator for no url |
+| `<template-file>` | Path to the template file for the policy |
+| `<count>` | An optional count (default is 1). If a value greater than 1 is given, the policy ids will use the given policy id as the first id and add 1 to that id for each new policy |
-## Function: cr_api_check_all_ics_events ##
+## Function: a1pms_api_put_policy_batch ##
-Check the contents of all current status events for one id from ICS
+This tests the same as function 'a1pms_api_put_policy' except that all put requests are sent to dmaap in one go and then the responses are polled one by one.
+If the a1pms api is not configured to use dmaap (see 'use_a1pms_dmaap', 'use_a1pms_rest_http' and 'use_a1pms_rest_https'), an error message is printed.
+For arg list and parameters, see 'a1pms_api_put_policy'.
+
+## Function: a1pms_api_put_policy_parallel ##
+
+This tests the same as function 'a1pms_api_put_policy' except that the policy created is spread out over a number of processes and it only uses the a1pms rest API. The total number of policies created is determined by the product of the parameters 'number-of-rics' and 'count'. The parameter 'number-of-threads' should not be evenly divisible by the product of the parameters 'number-of-rics' and 'count' - this is to ensure that one process does not handle the creation of all the policies in one ric.
| arg list |
|--|
-| `<response-code> <cr-path-id> <id> [ EMPTY \| ( <status> )+ ]` |
+| `<response-code> <service-name> <ric-id-base> <number-of-rics> <policytype-id> <policy-start-id> <transient> <template-file> <count-per-ric> <number-of-threads>`
+
+| arg list |
+|--|
+| `<response-code> <service-name> <ric-id-base> <number-of-rics> <policytype-id> <policy-start-id> <transient> <notification-url>\|NOURL <template-file> <count-per-ric> <number-of-threads>`
| parameter | description |
| --------- | ----------- |
| `<response-code>` | Expected http response code |
-| `<cr-path-id>` | Variable index for CR |
-| `<id>` | Id of the callback destination |
-| `EMPTY` | Indicator for an empty list |
-| `<status>` | Status string |
+| `<service-id>` | Id of the service |
+| `<ric-id-base>` | The base id of the rics, ie ric id without the sequence number. The sequence number is added during processing |
+| `<number-of-rics>` | The number of rics, assuming the first index is '1'. The index is added to the 'ric-id-base' id |
+| `<policy-type-id>` | Id of the policy type |
+| `<policy-start-id>` | Id of the policy. This value shall be a numeric value and will be the id of the first policy |
+| `transient>` | Transient 'true' or 'false'. 'NOTRANSIENT' can be used to indicate using the default value (no transient value provide) |
+| `notification-url` | Url for notifications |
+| `<template-file>` | Path to the template file for the policy |
+| `<count-per-ric>` | Number of policies per ric |
+| `<number-of-threads>` | Number of threads (processes) to run in parallel |
-## Function: cr_api_check_all_ics_subscription_events ##
+## Function: a1pms_api_delete_policy ##
-Check the contents of all current subscription events for one id from ICS
+This tests the DELETE '/policy' or V2 DELETE '/v2/policies/{policy_id}'. Removes the indicated policy or a 'count' number of policies starting with 'policy-id' as the first id.
| arg list |
|--|
-| `<response-code> <cr-path-id> <id> [ EMPTY | ( <type-id> <schema> <registration-status> )+ ]` |
+| `<response-code> <policy-id> [<count>]`
| parameter | description |
| --------- | ----------- |
| `<response-code>` | Expected http response code |
-| `<cr-path-id>` | Variable index for CR |
-| `<id>` | Id of the callback destination |
-| `EMPTY` | Indicator for an empty list |
-| `<type-id>` | Id of the data type |
-| `<schema>` | Path to typeschema file |
-| `<registration-status>` | Status string |
+| `<policy-id>` | Id of the policy |
+| `<count>` | An optional count of policies to delete. The 'policy-id' will be the first id to be deleted. |
-## Function: cr_api_reset ##
+## Function: a1pms_api_delete_policy_batch ##
-Reset the callback receiver
+This tests the same as function 'a1pms_api_delete_policy' except that all delete requests are sent to dmaap in one go and then the responses are polled one by one.
+If the a1pms api is not configured to used dmaap (see 'use_a1pms_dmaap', 'use_a1pms_rest_http' and 'use_a1pms_rest_https'), an error message is printed.
+For arg list and parameters, see 'a1pms_api_delete_policy'.
+
+## Function: a1pms_api_delete_policy_parallel ##
+
+This tests the same as function 'a1pms_api_delete_policy' except that the policy deleted is spread out over a number of processes and it only uses the a1pms rest API. The total number of policies deleted is determined by the product of the parameters 'number-of-rics' and 'count'. The parameter 'number-of-threads' shall be selected to be not evenly divisible by the product of the parameters 'number-of-rics' and 'count' - this is to ensure that one process does not handle the deletion of all the policies in one ric.
| arg list |
|--|
-| `<cr-path-id>` |
+| `<response-code> <ric-id-base> <number-of-rics> <policy-start-id> <count-per-ric> <number-of-threads>`
| parameter | description |
| --------- | ----------- |
-| `<cr-path-id>` | Variable index for CR |
+| `<response-code>` | Expected http response code |
+| `<ric-id-base>` | The base id of the rics, ie ric id without the sequence number. The sequence number is added during processing |
+| `<number-of-rics>` | The number of rics, assuming the first index is '1' |
+| `<policy-start-id>` | Id of the policy. This value shall be a numeric value and will be the id of the first policy |
+| `<count-per-ric>` | Number of policies per ric |
+| `<number-of-threads>` | Number of threads (processes) to run in parallel |
-## Function: cr_api_check_all_genric_json_events ##
+## Function: a1pms_api_get_policy_ids ##
-Check the contents of all json events for path
+Test of GET '/policy_ids' or V2 GET '/v2/policies'.
+To test response code only, provide the response code parameter as well as the following three parameters.
+To also test the response payload add the 'NOID' for an expected empty array or repeat the 'policy-instance-id' for each expected policy id.
| arg list |
|--|
-| `<response-code> <cr-path-id> <topic-url> (EMPTY | <json-msg>+ )` |
+| `<response-code> <ric-id>\|NORIC <service-id>\|NOSERVICE <type-id>\|NOTYPE ([<policy-instance-id]*\|NOID)` |
| parameter | description |
| --------- | ----------- |
| `<response-code>` | Expected http response code |
-| `<cr-path-id>` | Variable index for CR |
-| `<topic-url>` | Topic url |
-| `EMPTY` | Indicator for an empty list |
-| `json-msg` | Json msg string to compare with |
-
-## Function: cr_api_check_single_genric_json_event ##
-
-Check a single (oldest) json event (or none if empty) for path
-
+| `<ric-id>` | Id of the ric |
+| `NORIC` | Indicator that no ric is provided |
+| `<service-id>` | Id of the service |
+| `NOSERVICE` | Indicator that no service id is provided |
+| `type-id>` | Id of the policy type |
+| `NOTYPE` | Indicator that no type id is provided |
+| `NOID` | Indicator that no policy id is provided - indicate empty list of policies|
+| `<policy-instance-id>` | Id of the policy |
+
+## Function: a1pms_api_get_policy_schema ##
+
+Test of V2 GET '/v2/policy-types/{policyTypeId}' and optional check of the returned json schema.
+To test the response code only, provide the expected response code and policy type id.
+To test the contents of the returned json schema, add a path to a schema file to compare with.
+
+| arg list |
+|--|
+| `<response-code> <policy-type-id> [<schema-file>]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<policy-type-id>` | Id of the policy type |
+| `<schema-file>` | Path to the schema file for the policy type |
+
+## Function: a1pms_api_get_policy_schema ##
+
+Test of GET '/policy_schema' and optional check of the returned json schema.
+To test the response code only, provide the expected response code and policy type id.
+To test the contents of the returned json schema, add a path to a schema file to compare with.
+
+| arg list |
+|--|
+| `<response-code> <policy-type-id> [<schema-file>]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<policy-type-id>` | Id of the policy type |
+| `<schema-file>` | Path to the schema file for the policy type |
+
+## Function: a1pms_api_get_policy_schemas ##
+
+Test of GET '/policy_schemas' and optional check of the returned json schemas.
+To test the response code only, provide the expected response code and ric id (or NORIC if no ric is given).
+To test the contents of the returned json schema, add a path to a schema file to compare with (or NOFILE to represent an empty '{}' type)
+
+| arg list |
+|--|
+| `<response-code> <ric-id>\|NORIC [<schema-file>\|NOFILE]*` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<ric-id>` | Id of the ric |
+| `NORIC` | No ric id given |
+| `<schema-file>` | Path to the schema file for the policy type |
+| `NOFILE` | Indicate the template for an empty type |
+
+## Function: a1pms_api_get_policy_status ##
+
+Test of GET '/policy_status' or V2 GET '/policies/{policy_id}/status'.
+
+| arg list |
+|--|
+| `<response-code> <policy-id> (STD\|STD2 <enforce-status>\|EMPTY [<reason>\|EMPTY])\|(OSC <instance-status> <has-been-deleted>)` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<policy-id>` | Id of the policy |
+| `STD` | Indicator of status of Standarized A1 |
+| `STD2` | Indicator of status of Standarized A1 version 2 |
+| `<enforce-status>` | Enforcement status |
+| `<reason>` | Optional reason |
+| `EMPTY` | Indicator of empty string status or reason |
+| `OSC` | Indicator of status of Non-Standarized OSC A1 |
+| `<instance-status>` | Instance status |
+| `<has-been-deleted>` | Deleted status, true or false |
+
+## Function: a1pms_api_get_policy_types ##
+
+Test of GET '/policy_types' or V2 GET '/v2/policy-types' and optional check of the returned ids.
+To test the response code only, provide the expected response code and ric id (or NORIC if no ric is given).
+To test the contents of the returned json payload, add the list of expected policy type id (or 'EMPTY' for the '{}' type)
+
+| arg list |
+|--|
+| `<response-code> [<ric-id>\|NORIC [<policy-type-id>\|EMPTY [<policy-type-id>]*]]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<ric-id>` | Id of the ric |
+| `NORIC` | No ric id given |
+| `<policy-type-id>` | Id of the policy type |
+| `EMPTY` | Indicate the empty type |
+
+## Function: a1pms_api_get_status ##
+
+Test of GET /status or V2 GET /status
+
+| arg list |
+|--|
+| `<response-code>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+
+## Function: a1pms_api_get_ric ##
+
+Test of GET '/ric' or V2 GET '/v2/rics/ric'
+To test the response code only, provide the expected response code and managed element id.
+To test the returned ric id, provide the expected ric id.
+
+| arg list |
+|--|
+| `<reponse-code> <managed-element-id> [<ric-id>]` |
+
+| arg list V2 |
+|--|
+| `<reponse-code> <management-element-id>\|NOME <ric-id>\|<NORIC> [<string-of-ricinfo>]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<managed-element-id>` | Id of the managed element |
+| `NOME` | Indicator for no ME |
+| `ric-id` | Id of the ric |
+| `NORIC` | Indicator no RIC |
+| `string-of-ricinfo` | String of ric info |
+
+## Function: a1pms_api_get_rics ##
+
+Test of GET '/rics' or V2 GET '/v2/rics' and optional check of the returned json payload (ricinfo).
+To test the response code only, provide the expected response code and policy type id (or NOTYPE if no type is given).
+To test also the returned payload, add the formatted string of info in the returned payload.
+Format of ricinfo: <br>`<ric-id>:<list-of-mes>:<list-of-policy-type-ids>`<br>
+Example <br>`<space-separate-string-of-ricinfo> = "ricsim_g1_1:me1_ricsim_g1_1,me2_ricsim_g1_1:1,2,4 ricsim_g1_1:me2_........."`
+
+| arg list |
+|--|
+| `<reponse-code> <policy-type-id>\|NOTYPE [<space-separate-string-of-ricinfo>]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<policy-type-id>` | Policy type id of the ric |
+| `NOTYPE>` | No type given |
+| `<space-separate-string-of-ricinfo>` | A space separated string of ric info - needs to be quoted |
+
+## Function: a1pms_api_put_service ##
+
+Test of PUT '/service' or V2 PUT '/service'.
+| arg list |
+|--|
+| `<response-code> <service-name> <keepalive-timeout> <callbackurl>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<service-name>` | Service name |
+| `<keepalive-timeout>` | Timeout value |
+| `<callbackurl>` | Callback url |
+
+## Function: a1pms_api_get_services ##
+
+Test of GET '/service' or V2 GET '/v2/services' and optional check of the returned json payload.
+To test only the response code, omit all parameters except the expected response code.
+To test the returned json, provide the parameters after the response code.
+
+| arg list |
+|--|
+| `<response-code> [ (<query-service-name> <target-service-name> <keepalive-timeout> <callbackurl>) \| (NOSERVICE <target-service-name> <keepalive-timeout> <callbackurl> [<target-service-name> <keepalive-timeout> <callbackurl>]* )]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<query-service-name>` | Service name for the query |
+| `<target-service-name>` | Target service name|
+| `<keepalive-timeout>` | Timeout value |
+| `<callbackurl>` | Callback url |
+| `NOSERVICE` | Indicator of no target service name |
+
+## Function: a1pms_api_get_service_ids ##
+
+Test of GET '/services' or V2 GET /'v2/services'. Only check of service ids.
+
+| arg list |
+|--|
+| `<response-code> [<service-name>]*` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<service-name>` | Service name |
+
+## Function: a1pms_api_delete_services ##
+
+Test of DELETE '/services' or V2 DELETE '/v2/services/{serviceId}'
+
+| arg list |
+|--|
+| `<response-code> [<service-name>]*` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<service-name>` | Service name |
+
+## Function: a1pms_api_put_services_keepalive ##
+
+Test of PUT '/services/keepalive' or V2 PUT '/v2/services/{service_id}/keepalive'
+
+| arg list |
+|--|
+| `<response-code> <service-name>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<service-name>` | Service name |
+
+## Function: a1pms_api_put_configuration ##
+
+Test of PUT '/v2/configuration'
+
+| arg list |
+|--|
+| `<response-code> <config-file>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<config-file>` | Path json config file |
+
+## Function: a1pms_api_get_configuration ##
+
+Test of GET '/v2/configuration'
+
+| arg list |
+|--|
+| `<response-code> [<config-file>]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<config-file>` | Path json config file to compare the retrieved config with |
+
+## Function: a1pms_kube_pvc_reset ##
+Admin reset to remove all policies and services
+All types and instances etc are removed - types and instances in a1 sims need to be removed separately
+NOTE - only works in kubernetes and the pod should not be running
+
+| arg list |
+|--|
+| None |
+
+
+# Description of functions in authsidecar_api_function.sh #
+Only common API functions in this file.
+
+
+## Function: start_chart_museum ##
+
+Start the Chart Museum
+| arg list |
+|--|
+| None |
+
+## Function: chartmus_upload_test_chart ##
+
+Upload a package chart to chartmusem
+| arg list |
+|--|
+| `<chart-name>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<chart-name>` | Name of the chart to upload |
+
+## Function: chartmus_delete_test_chart ##
+
+Delete a chart in chartmusem
+| arg list |
+|--|
+| `<chart-name> [<version>]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<chart-name>` | Name of the chart to delete |
+| `<version>` | Chart version, default is 0.1.0 |
+
+# Description of functions in cp_api_function.sh #
+
+## Function: use_control_panel_http ##
+
+Set http as the protocol to use for all communication to the Control Panel
+| arg list |
+|--|
+| None |
+
+## Function: use_control_panel_https ##
+
+Set https as the protocol to use for all communication to the Control Panel
+| arg list |
+|--|
+| None |
+
+## Function: start_control_panel ##
+
+Start the Control Panel container
+| arg list |
+|--|
+| None |
+
+# Description of functions in cr_api_functions.sh #
+
+## Function: use_cr_http ##
+
+Use http for getting event from CR. The admin API is not affected. This is the default.
+| arg list |
+|--|
+| None |
+
+## Function: use_cr_https ##
+
+Use https for getting event from CR. The admin API is not affected.
+Note: Not yet used as callback event is not fully implemented/deciced.
+| arg list |
+|--|
+| None |
+
+## Function: start_cr ##
+
+Start the Callback Receiver container in docker or kube depending on start mode.
+| arg list |
+|--|
+| None |
+
+## Function: cr_equal ##
+
+Tests if a variable value in the Callback Receiver (CR) simulator is equal to a target value.
+Without the timeout, the test sets pass or fail immediately depending on if the variable is equal to the target or not.
+With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes equal to the target value or not.
+See the 'cr' dir for more details.
+| arg list |
+|--|
+| `<cr-path-id> <variable-name> <target-value> [ <timeout-in-sec> ]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<cr-path-id>` | Variable index to CR |
+| `<variable-name>` | Variable name in the CR |
+| `<target-value>` | Target value for the variable |
+| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
+
+## Function: cr_greater_or_equal ##
+Tests if a variable value in the Callback Receiver (CR) simulator is equal to or greater than a target value.
+Without the timeout, the test sets pass or fail immediately depending on if the variable is equal to or greater than the target or not.
+With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes equal to the target value or not.
+See the 'cr' dir for more details.
+| arg list |
+|--|
+| `<cr-path-id> <variable-name> <target-value> [ <timeout-in-sec> ]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<cr-path-id>` | Variable index to CR |
+| `<variable-name>` | Variable name in the CR |
+| `<target-value>` | Target value for the variable |
+| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
+
+## Function: cr_contains_str ##
+
+Tests if a variable value in the CR contains a target string.
+Without the timeout, the test sets pass or fail immediately depending on if the variable contains the target string or not.
+With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value contains the target string or not.
+See the 'a1-interface' repo for more details.
+
+| arg list |
+|--|
+| `<cr-path-id> <variable-name> <target-value> [ <timeout-in-sec> ]` |
+
+
+| parameter | description |
+| --------- | ----------- |
+| `<cr-path-id>` | Variable index to CR |
+| `<variable-name>` | Variable name in the CR |
+| `<target-value>` | Target substring for the variable |
+| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
+
+## Function: cr_read ##
+
+Reads the value of a variable in the CR simulator. The value is intended to be passed to a env variable in the test script.
+See the 'mrstub' dir for more details.
+| arg list |
+|--|
+| `<cr-path-id> <variable-name>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<cr-path-id>` | Variable index to CR |
+| `<variable-name>` | Variable name in the CR |
+
+## Function: cr_delay_callback ##
+
+Function to configure write delay on callbacks. Delay given in seconds. Setting remains until removed.
+
+| arg list |
+|--|
+| `<response-code> <cr-path-id> [<delay-in-seconds>]`|
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<cr-path-id>` | Variable index to CR |
+| `<delay-in-seconds>` | Delay in seconds. If omitted, the delay is removed |
+
+## Function: cr_api_check_all_sync_events ##
+
+Check the contents of all ric events received for a callback id.
+
+| arg list |
+|--|
+| `<response-code> <cr-path-id> <id> [ EMPTY \| ( <ric-id> )+ ]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<cr-path-id>` | Variable index for CR |
+| `<id>` | Id of the callback destination |
+| `EMPTY` | Indicator for an empty list |
+| `<ric-id>` | Id of the ric |
+
+## Function: cr_api_check_all_ics_events ##
+
+Check the contents of all current status events for one id from ICS
+
+| arg list |
+|--|
+| `<response-code> <cr-path-id> <id> [ EMPTY \| ( <status> )+ ]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<cr-path-id>` | Variable index for CR |
+| `<id>` | Id of the callback destination |
+| `EMPTY` | Indicator for an empty list |
+| `<status>` | Status string |
+
+## Function: cr_api_check_all_ics_subscription_events ##
+
+Check the contents of all current subscription events for one id from ICS
+
+| arg list |
+|--|
+| `<response-code> <cr-path-id> <id> [ EMPTY | ( <type-id> <schema> <registration-status> )+ ]` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<cr-path-id>` | Variable index for CR |
+| `<id>` | Id of the callback destination |
+| `EMPTY` | Indicator for an empty list |
+| `<type-id>` | Id of the data type |
+| `<schema>` | Path to typeschema file |
+| `<registration-status>` | Status string |
+
+## Function: cr_api_reset ##
+
+Reset the callback receiver
+
+| arg list |
+|--|
+| `<cr-path-id>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<cr-path-id>` | Variable index for CR |
+
+## Function: cr_api_check_all_generic_json_events ##
+
+Check the contents of all json events for path
+
+| arg list |
+|--|
+| `<response-code> <cr-path-id> <topic-url> (EMPTY | <json-msg>+ )` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<cr-path-id>` | Variable index for CR |
+| `<topic-url>` | Topic url |
+| `EMPTY` | Indicator for an empty list |
+| `json-msg` | Json msg string to compare with |
+
+## Function: cr_api_check_single_generic_json_event ##
+
+Check a single (oldest) json event (or none if empty) for path
+
| arg list |
|--|
| `<response-code> <cr-path-id> <topic-url> (EMPTY | <json-msg> )` |
| `EMPTY` | Indicator for no msg |
| `json-msg` | Json msg string to compare with |
-## Function: cr_api_check_single_genric_event_md5 ##
+## Function: cr_api_check_single_generic_event_md5 ##
Check a single (oldest) json in md5 format (or none if empty) for path.
Note that if a json message is given, it shall be compact, no ws except inside string.
| `EMPTY` | Indicator for no msg |
| `data-msg` | msg string to compare with |
-## Function: cr_api_check_single_genric_event_md5_file ##
+## Function: cr_api_check_single_generic_event_md5_file ##
Check a single (oldest) event in md5 format (or none if empty) for path.
Note that if a file with json message is given, the json shall be compact, no ws except inside string and not newlines.
|--|
| None |
-# Description of functions in httpproxy_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 |
-|--|
-| None |
-
# Description of functions in helmmanager_api_functions.sh #
## Function: use_helm_manager_http ##
| `<repo-name>`| Name of the repo |
| `<repo-url>`| Full url to the repo. Url must be accessible by the container |
+# Description of functions in httpproxy_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 |
+|--|
+| None |
+
# Description of functions in ics_api_functions.sh #
| arg list |
|--|
-| `<response-code> <subscription-id> <owner-id> <status-uri>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<subscription-id>` |Id of the subscription |
-| `<owner-id>` | Id of the owner |
-| `<status-uri>` | Url for status notifications |
-
-## Function: ics_api_idc_delete_subscription ##
-Test of DELETE /data-consumer/v1/info-type-subscription/{subscriptionId}
-
-| arg list |
-|--|
-| `<response-code> <subscription-id>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<subscription-id>` |Id of the subscription |
-
-
-## Function: ics_api_admin_reset ##
-
-Test of GET '/status'.
-
-| arg list |
-|--|
-| `<response-code> [ <type> ]` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<type>` | Type id, if the interface supports type in url |
-
-## Function: ics_kube_pvc_reset ##
-
-Admin reset to remove all data in ics; jobs, producers etc
-NOTE - only works in kubernetes and the pod should not be running
-
-| arg list |
-|--|
-| None |
-
-# Description of functions in kafkapc_api_functions.sh #
-
-## Function: use_kafkapc_http ##
-
-Use http for all calls to the KAFKAPC.
-| arg list |
-|--|
-| None |
-
-## Function: use_kafkapc_https ##
-
-Use https for all calls to the KAFKAPC.
-| arg list |
-|--|
-| None |
-
-## Function: start_kafkapc ##
-
-Start the KAFKAPC container in docker or kube depending on start mode
-| arg list |
-|--|
-| None |
-
-## Function: kafkapc_equal ##
-
-Tests if a variable value in the KAFKAPC is equal to a target value.
-Without the timeout, the test sets pass or fail immediately depending on if the variable is equal to the target or not.
-With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes equal to the target value or not.
-See the 'mrstub' dir for more details.
-| arg list |
-|--|
-| `<variable-name> <target-value> [ <timeout-in-sec> ]` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<variable-name>` | Variable name in the KAFKAPC |
-| `<target-value>` | Target value for the variable |
-| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
-
-## Function: kafkapc_api_reset ##
-
-Deep reset of KAFKAPC. Note that kafka itself is not affected, i.e. created topic still exist in kafka.
-| arg list |
-|--|
-| None |
-
-## Function: kafkapc_api_create_topic ##
-
-Create a topic in kafka via kafkapc.
-| `<response-code> <topic-name> <mime-type>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic-name>` | Name of the topic |
-| `<mime-type>` | Mime type of the data to send to the topic. Data on the topic is expected to be of this type |
-
-## Function: kafkapc_api_get_topic ##
-
-Create a from kafkapc.
-| `<response-code> <topic-name> <mime-type>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic-name>` | Name of the topic |
-| `<mime-type>` | Mime type of the topic |
-
-## Function: kafkapc_api_start_sending ##
-
-Start sending msg from the msg queue to kafka for a topic.
-| `<response-code> <topic-name>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic-name>` | Name of the topic |
-
-## Function: kafkapc_api_start_receiving ##
-
-Start receiving msg from a kafka topic to the msg queue in kafkapc.
-| `<response-code> <topic-name>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic-name>` | Name of the topic |
-
-## Function: kafkapc_api_stop_sending ##
-
-Stop sending msg from the msg queue to kafka for a topic.
-| `<response-code> <topic-name>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic-name>` | Name of the topic |
-
-## Function: kafkapc_api_stop_receiving ##
-
-Stop receiving msg from a kafka topic to the msg queue in kafkapc.
-| `<response-code> <topic-name>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic-name>` | Name of the topic |
-
-## Function: kafkapc_api_post_msg ##
-
-Send a message on a topic.
-| arg list |
-|--|
-| `<response-code> <topic> <mime-type> <msg>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic>` | Topic name |
-| `<mime-type>` | Mime type of the msg |
-| `<msg>` | String msg to send |
-
-## Function: kafkapc_api_get_msg ##
-
-Get a message on a topic.
-| arg list |
-|--|
-| `<response-code> <topic> ([ <mime-type> <msg> ] | NOMSG )` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic>` | Topic name |
-| `<mime-type>` | Mime type of the msg |
-| `<msg>` | String msg to receive |
-| `NOMSG` | Indicated for no msg |
-
-## Function: kafkapc_api_post_msg_from_file ##
-
-Send a message in a file on a topic.
-| arg list |
-|--|
-| `<response-code> <topic> <mime-type> <file>` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic>` | Topic name |
-| `<mime-type>` | Mime type of the msg |
-| `<file>` | Filepath to the string msg to send |
-
-## Function: kafkapc_api_get_msg_from_file ##
-
-Get a message on a topic.
-| arg list |
-|--|
-| `<response-code> <topic> <mime-type> <file> ` |
+| `<response-code> <subscription-id> <owner-id> <status-uri>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Http response code |
-| `<topic>` | Topic name |
-| `<mime-type>` | Mime type of the msg |
-| `<file>` | Filepath to the string msg to receive |
+| `<response-code>` | Expected http response code |
+| `<subscription-id>` |Id of the subscription |
+| `<owner-id>` | Id of the owner |
+| `<status-uri>` | Url for status notifications |
-## Function: kafkapc_api_generate_json_payload_file ##
+## Function: ics_api_idc_delete_subscription ##
+Test of DELETE /data-consumer/v1/info-type-subscription/{subscriptionId}
-Create json file with dummy data for payload.
| arg list |
|--|
-| `<size-in-kb> <filename>` |
+| `<response-code> <subscription-id>` |
| parameter | description |
| --------- | ----------- |
-| `<size-in-kb>` | Generated size in kb |
-| `<filename>` | Path to output file |
+| `<response-code>` | Expected http response code |
+| `<subscription-id>` |Id of the subscription |
-## Function: kafkapc_api_generate_text_payload_file ##
-Create file with dummy text data for payload.
+## Function: ics_api_admin_reset ##
+
+Test of GET '/status'.
+
| arg list |
|--|
-| `<size-in-kb> <filename>` |
+| `<response-code> [ <type> ]` |
| parameter | description |
| --------- | ----------- |
-| `<size-in-kb>` | Generated size in kb |
-| `<filename>` | Path to output file |
+| `<response-code>` | Expected http response code |
+| `<type>` | Type id, if the interface supports type in url |
-# Description of functions in kubeproxy_api_functions.sh #
+## Function: ics_kube_pvc_reset ##
-## Function: use_kube_proxy_http ##
+Admin reset to remove all data in ics; jobs, producers etc
+NOTE - only works in kubernetes and the pod should not be running
-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 |
+# Description of functions in istio_api_functions.sh #
-## Function: start_kube_proxy ##
+## Function: istio_enable_istio_namespace ##
+Enable istio on a namespace
-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.
| arg list |
|--|
-| None |
+| `<namespace>` |
-# Description of functions in localhelm_api_functions.sh #
+| parameter | description |
+| --------- | ----------- |
+| `namespace` | Namespace name to enable istio on |
-## Function: localhelm_create_test_chart ##
+## Function: istio_req_auth_by_jwksuri ##
+Set isto authentication by jwks uri
-Create a dummy chart using helm
| arg list |
|--|
-| `chart-name` |
+| `<app-name> <namespace> <realm>>` |
| parameter | description |
| --------- | ----------- |
-| `chart-name` | Name of the chart |
+| `<app-name>` | App-name, short name |
+| `<namespace>` | Namespace of app |
+| `<realm>` | Name of realm |
-## Function: localhelm_package_test_chart ##
+## Function: istio_req_auth_by_jwks ##
+Set isto authentication by jwks keys (inline)
-Package a dummy chart using helm
| arg list |
|--|
-| `chart-name` |
+| `<app> <namespace> <issuer> <key>` |
| parameter | description |
| --------- | ----------- |
-| `chart-name` | Name of the chart |
+| `<app-name>` | App-name, short name |
+| `<namespace>` | Namespace of app |
+| `<issuer>` | Name of issuer |
+| `key` | Inline key |
-## Function: localhelm_installed_chart_release ##
+## Function: istio_auth_policy_by_realm ##
+Set isio authorization by realm
-Check if a chart is installed or not using helm
| arg list |
|--|
-| `INSTALLED|NOTINSTALLED <release-name> <name-space> |
+| `<app> <namespace> <realam> [<client-id> <client-role>]` |
| parameter | description |
| --------- | ----------- |
-| `INSTALLED` | Expecting installed chart |
-| `NOTINSTALLED` | Expecting a not installed chart |
-| `release-name` | Name of the release |
-| `name-space` | Expected namespace |
+| `<app-name>` | App-name, short name |
+| `<namespace>` | Namespace of app |
+| `<realm>` | Name of realm |
+| `<client-id>` | Client id to authorize |
+| `<client-role>` | Client role to authorize |
-# Description of functions in mr_api_functions.sh #
-## Function: use_mr_http ##
+## Function: istio_auth_policy_by_issuer ##
+Set isio authorization by issuer
-Use http for all Dmaap calls to the MR. This is the default. The admin API is not affected. Note that this function shall be called before preparing the config for Consul.
| arg list |
|--|
-| None |
+| `<app> <namespace> <issuer>` |
-## Function: use_mr_https ##
+| parameter | description |
+| --------- | ----------- |
+| `<app-name>` | App-name, short name |
+| `<namespace>` | Namespace of app |
+| `<issuer>` | Name of issuer |
-Use https for all Dmaap call to the MR. The admin API is not affected. Note that this function shall be called before preparing the config for Consul.
+
+# Description of functions in kafkapc_api_functions.sh #
+
+## Function: use_kafkapc_http ##
+
+Use http for all calls to the KAFKAPC.
| arg list |
|--|
| None |
-## Function: start_mr ##
+## Function: use_kafkapc_https ##
-Start the Message Router stub interface container in docker or kube depending on start mode
+Use https for all calls to the KAFKAPC.
| arg list |
|--|
| None |
-## Function: dmaap_api_print_topics ##
-
-Prints the current list of topics in DMAAP MR
+## Function: start_kafkapc ##
+Start the KAFKAPC container in docker or kube depending on start mode
| arg list |
|--|
| None |
-## Function: mr_equal ##
+## Function: kafkapc_equal ##
-Tests if a variable value in the Message Router (MR) simulator is equal to a target value.
+Tests if a variable value in the KAFKAPC is equal to a target value.
Without the timeout, the test sets pass or fail immediately depending on if the variable is equal to the target or not.
With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes equal to the target value or not.
See the 'mrstub' dir for more details.
| parameter | description |
| --------- | ----------- |
-| `<variable-name>` | Variable name in the MR |
+| `<variable-name>` | Variable name in the KAFKAPC |
| `<target-value>` | Target value for the variable |
| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
-## Function: mr_greater ##
+## Function: kafkapc_api_reset ##
-Tests if a variable value in the Message Router (MR) simulator is greater than a target value.
-Without the timeout, the test sets pass or fail immediately depending on if the variable is greater than the target or not.
-With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes greater than the target value or not.
-See the 'mrstub' dir for more details.
+Deep reset of KAFKAPC. Note that kafka itself is not affected, i.e. created topic still exist in kafka.
| arg list |
|--|
-| `<variable-name> <target-value> [ <timeout-in-sec> ]` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<variable-name>` | Variable name in the MR |
-| `<target-value>` | Target value for the variable |
-| `<timeout-in-sec>` | Max time to wait for the variable to become grater than the target value |
+| None |
-## Function: mr_read ##
+## Function: kafkapc_api_create_topic ##
-Reads the value of a variable in the Message Router (MR) simulator. The value is intended to be passed to a env variable in the test script.
-See the 'mrstub' dir for more details.
-| arg list |
-|--|
-| `<variable-name>` |
+Create a topic in kafka via kafkapc.
+| `<response-code> <topic-name> <mime-type>` |
| parameter | description |
| --------- | ----------- |
-| `<variable-name>` | Variable name in the MR |
+| `<response-code>` | Http response code |
+| `<topic-name>` | Name of the topic |
+| `<mime-type>` | Mime type of the data to send to the topic. Data on the topic is expected to be of this type |
-## Function: mr_print ##
+## Function: kafkapc_api_get_topic ##
-Prints the value of a variable in the Message Router (MR) simulator.
-See the 'mrstub' dir for more details.
-| arg list |
-|--|
-| `<variable-name>` |
+Create a from kafkapc.
+| `<response-code> <topic-name> <mime-type>` |
| parameter | description |
| --------- | ----------- |
-| `<variable-name>` | Variable name in the MR |
+| `<response-code>` | Http response code |
+| `<topic-name>` | Name of the topic |
+| `<mime-type>` | Mime type of the topic |
-## Function: mr_api_send_json ##
+## Function: kafkapc_api_start_sending ##
-Send json to topic in mr-stub.
-| arg list |
-|--|
-| `<topic-url> <json-msg>` |
+Start sending msg from the msg queue to kafka for a topic.
+| `<response-code> <topic-name>` |
| parameter | description |
| --------- | ----------- |
-| `<topic-url>` | Topic url |
-| `<json-msg>` | Json msg as string |
+| `<response-code>` | Http response code |
+| `<topic-name>` | Name of the topic |
-## Function: mr_api_send_text ##
+## Function: kafkapc_api_start_receiving ##
-Send text to topic in mr-stub.
-| arg list |
-|--|
-| `<topic-url> <text-msg>` |
+Start receiving msg from a kafka topic to the msg queue in kafkapc.
+| `<response-code> <topic-name>` |
| parameter | description |
| --------- | ----------- |
-| `<topic-url>` | Topic url |
-| `<text-msg>` | Text (string) msg |
-
-
+| `<response-code>` | Http response code |
+| `<topic-name>` | Name of the topic |
-## Function: mr_api_send_json_file ##
+## Function: kafkapc_api_stop_sending ##
-Send json to topic in mr-stub.
-| arg list |
-|--|
-| `<topic-url> <json-file>` |
+Stop sending msg from the msg queue to kafka for a topic.
+| `<response-code> <topic-name>` |
| parameter | description |
| --------- | ----------- |
-| `<topic-url>` | Topic url |
-| `<json-file>` | Path to file with json msg as string |
+| `<response-code>` | Http response code |
+| `<topic-name>` | Name of the topic |
-## Function: mr_api_send_text_file ##
+## Function: kafkapc_api_stop_receiving ##
-Send text to topic in mr-stub.
-| arg list |
-|--|
-| `<topic-url> <text-file>` |
+Stop receiving msg from a kafka topic to the msg queue in kafkapc.
+| `<response-code> <topic-name>` |
| parameter | description |
| --------- | ----------- |
-| `<topic-url>` | Topic url |
-| `<text-file>` | Path to file with text msg as string |
+| `<response-code>` | Http response code |
+| `<topic-name>` | Name of the topic |
-## Function: mr_api_generate_json_payload_file ##
+## Function: kafkapc_api_post_msg ##
-Create json file with dummy data for payload.
+Send a message on a topic.
| arg list |
|--|
-| `<size-in-kb> <filename>` |
+| `<response-code> <topic> <mime-type> <msg>` |
| parameter | description |
| --------- | ----------- |
-| `<size-in-kb>` | Generated size in kb |
-| `<filename>` | Path to output file |
+| `<response-code>` | Http response code |
+| `<topic>` | Topic name |
+| `<mime-type>` | Mime type of the msg |
+| `<msg>` | String msg to send |
-## Function: mr_api_generate_text_payload_file ##
+## Function: kafkapc_api_get_msg ##
-Create file with dummy text data for payload.
+Get a message on a topic.
| arg list |
|--|
-| `<size-in-kb> <filename>` |
+| `<response-code> <topic> ([ <mime-type> <msg> ] | NOMSG )` |
| parameter | description |
| --------- | ----------- |
-| `<size-in-kb>` | Generated size in kb |
-| `<filename>` | Path to output file |
-
-# Description of functions in ngw_api_functions.sh #
-
-## Function: use_gateway_http ##
-
-Use http for all calls to the gateway. This is set by default.
-| arg list |
-|--|
-| None |
+| `<response-code>` | Http response code |
+| `<topic>` | Topic name |
+| `<mime-type>` | Mime type of the msg |
+| `<msg>` | String msg to receive |
+| `NOMSG` | Indicated for no msg |
-## Function: use_gateway_https ##
+## Function: kafkapc_api_post_msg_from_file ##
-Use https for all calls to the gateway.
+Send a message in a file on a topic.
| arg list |
|--|
-| None |
-
-## Function: set_gateway_debug ##
+| `<response-code> <topic> <mime-type> <file>` |
-Set debug level logging in the gateway
-| arg list |
-|--|
-| None |
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Http response code |
+| `<topic>` | Topic name |
+| `<mime-type>` | Mime type of the msg |
+| `<file>` | Filepath to the string msg to send |
-## Function: set_gateway_trace ##
+## Function: kafkapc_api_get_msg_from_file ##
-Set debug level logging in the trace
+Get a message on a topic.
| arg list |
|--|
-| None |
-
-## Function: start_gateway ##
+| `<response-code> <topic> <mime-type> <file> ` |
-Start the the gateway container in docker or kube depending on start mode
-| arg list |
-|--|
-| None |
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Http response code |
+| `<topic>` | Topic name |
+| `<mime-type>` | Mime type of the msg |
+| `<file>` | Filepath to the string msg to receive |
-## Function: gateway_pms_get_status ##
+## Function: kafkapc_api_generate_json_payload_file ##
-Sample test of pms api (status)
-Only response code tested - not payload
+Create json file with dummy data for payload.
| arg list |
|--|
-| `<response-code>` |
+| `<size-in-kb> <filename>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
+| `<size-in-kb>` | Generated size in kb |
+| `<filename>` | Path to output file |
-## Function: gateway_ics_get_types ##
+## Function: kafkapc_api_generate_text_payload_file ##
-Sample test of ics api (get types)
-Only response code tested - not payload
+Create file with dummy text data for payload.
| arg list |
|--|
-| `<response-code>` |
+| `<size-in-kb> <filename>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-
-# Description of functions in pa_api_functions.sh #
-
-## General ##
+| `<size-in-kb>` | Generated size in kb |
+| `<filename>` | Path to output file |
-Both PMS version 1 and 2 are supported. The version is controlled by the env variable `$PMS_VERSION` set in the test env file.
-For api function in version 2, an url prefix is added if configured.
+# Description of functions in keycloak_api_functions.sh #
-## Function: use_agent_rest_http ##
+## Function: start_keycloak ##
-Use http for all API calls to the Policy Agent. This is the default.
+Start the KEYCLOAK app in docker or kube depending on start mode
| arg list |
|--|
| None |
-## Function: use_agent_rest_https ##
+## Function: keycloak_api_obtain_admin_token ##
-Use https for all API calls to the Policy Agent.
+Get the admin token to use for subsequent rest calls to keycloak
| arg list |
|--|
| None |
-## Function: use_agent_dmaap_http ##
+## Function: keycloak_api_create_realm ##
-Send and recieve all API calls to the Policy Agent over Dmaap via the MR over http.
+Create a realm
| arg list |
|--|
-| None |
-
-## Function: use_agent_dmaap_https ##
+| `<realm-name> <enabled> <token-expiry>` |
-Send and recieve all API callss to the Policy Agent over Dmaap via the MR over https.
-| arg list |
-|--|
-| None |
+| parameter | description |
+| --------- | ----------- |
+| `realm-name` | Name of the realm |
+| `enabled` | Enabled, true or false |
+| `token-expiry` | Token lifespan in seconds |
-## Function: start_policy_agent ##
+## Function: keycloak_api_update_realm ##
-Start the Policy Agent container or corresponding kube resources depending on docker/kube mode.
+Update a realm
| arg list |
|--|
-| `<logfile-prefix>` |
-| (docker) `PROXY\|NOPROXY <config-file>` |
-| (kube) `PROXY\|NOPROXY <config-file> [ <data-file> ]` |
+| `<realm-name> <enabled> <token-expiry>` |
| parameter | description |
| --------- | ----------- |
-| `PROXY` | Configure with http proxy, if proxy is started |
-| `NOPROXY` | Configure without http proxy |
-| `<config-file>`| Path to application.yaml |
-| `<data-file>` | Optional path to application_configuration.json |
+| `realm-name` | Name of the realm |
+| `enabled` | Enabled, true or false |
+| `token-expiry` | Token lifespan in seconds |
-## Function: stop_policy_agent ##
+## Function: keycloak_api_create_confidential_client ##
-Stop the pms container (docker) or scale it to zero (kubernetes).
+Create a client
| arg list |
|--|
-| None |
-
-## Function: start_stopped_policy_agent ##
+| `<realm-name> <client-name>` |
-Start a previousely stopped pms container (docker) or scale it to 1 (kubernetes).
-| arg list |
-|--|
-| None |
+| parameter | description |
+| --------- | ----------- |
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
-## Function: prepare_consul_config ##
+## Function: keycloak_api_generate_client_secret ##
-Function to prepare a Consul config based on the previously configured (and started simulators). Note that all simulator must be running and the test script has to configure if http or https shall be used for the components (this is done by the functions 'use_simulator_http', 'use_simulator_https', 'use_sdnc_http', 'use_sdnc_https', 'use_mr_http', 'use_mr_https')
+Generate secret for client
| arg list |
|--|
-| `SDNC|NOSDNC <output-file>` |
+| `<realm-name> <client-name>` |
| parameter | description |
| --------- | ----------- |
-| `SDNC` | Configure with controller |
-| `NOSDNC` | Configure without controller |
-| `<output-file>` | The path to the json output file containing the prepared config. This file is used in 'consul_config_app' |
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
-## Function: agent_load_config ##
+## Function: keycloak_api_get_client_secret ##
-Load the config into a config map (kubernetes only).
+Get a secret for client
| arg list |
|--|
-| `<data-file>` |
+| `<realm-name> <client-name>` |
| parameter | description |
| --------- | ----------- |
-| `<data-file>` | Path to application_configuration.json |
-
-## Function: set_agent_debug ##
-
-Configure the Policy Agent log on debug level. The Policy Agent must be running.
-| arg list |
-|--|
-| None |
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
-## Function: set_agent_trace ##
+## Function: keycloak_api_create_client_roles ##
-Configure the Policy Agent log on trace level. The Policy Agent must be running.
+Create client roles
| arg list |
|--|
-| None |
-
-## Function: use_agent_retries ##
+| `<realm-name> <client-name> <role>+` |
-Configure the Policy Agent to make upto 5 retries if an API calls return any of the specified http return codes.
-| arg list |
-|--|
-| `[<response-code>]*` |
+| parameter | description |
+| --------- | ----------- |
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
+| `role` | Name of the role |
-## Function: check_policy_agent_logs ##
+## Function: keycloak_api_map_client_roles ##
-Check the Policy Agent log for any warnings and errors and print the count of each.
+Map roles to a client
| arg list |
|--|
-| None |
+| `<realm-name> <client-name> <role>+` |
-## Function: api_equal ##
+| parameter | description |
+| --------- | ----------- |
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
+| `role` | Name of the role |
-Tests if the array length of a json array in the Policy Agent simulator is equal to a target value.
-Without the timeout, the test sets pass or fail immediately depending on if the array length is equal to the target or not.
-With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the array length becomes equal to the target value or not.
-See the 'cr' dir for more details.
+## Function: keycloak_api_get_client_token ##
+Get a client token
| arg list |
|--|
-| `<variable-name> <target-value> [ <timeout-in-sec> ]` |
+| `<realm-name> <client-name>` |
| parameter | description |
| --------- | ----------- |
-| `<variable-name>` | Relative url. Example 'json:policy_types' - checks the json array length of the url /policy_types |
-| `<target-value>` | Target value for the length |
-| `<timeout-in-sec>` | Max time to wait for the length to reach the target value |
-
-## Function: api_get_policies ##
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
-Test of GET '/policies' or V2 GET '/v2/policy-instances' and optional check of the array of returned policies.
-To test the response code only, provide the response code parameter as well as the following three parameters.
-To also test the response payload add the 'NOID' for an expected empty array or repeat the last five/seven parameters for each expected policy.
+## Function: keycloak_api_read_client_token ##
+Read a client token
| arg list |
|--|
-| `<response-code> <ric-id>\|NORIC <service-id>\|NOSERVICE <policy-type-id>\|NOTYPE [ NOID \| [<policy-id> <ric-id> <service-id> EMPTY\|<policy-type-id> <template-file>]*]` |
-
-| arg list V2 |
-|--|
-| `<response-code> <ric-id>\|NORIC <service-id>\|NOSERVICE <policy-type-id>\|NOTYPE [ NOID \| [<policy-id> <ric-id> <service-id> EMPTY\|<policy-type-id> <transient> <notification-url> <template-file>]*]` |
+| `<realm-name> <client-name>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<ric-id>` | Id of the ric |
-| `NORIC` | Indicator that no ric is provided |
-| `<service-id>` | Id of the service |
-| `NOSERVICE` | Indicator that no service id is provided |
-| `<policy-type-id>` | Id of the policy type |
-| `NOTYPE` | Indicator that no type id is provided |
-| `NOID` | Indicator that no policy id is provided - indicate empty list of policies|
-| `<policy-id>` | Id of the policy |
-| `EMPTY` | Indicate for the special empty policy type |
-| `transient` | Transient, true or false |
-| `notification-url` | Url for notifications |
-| `<template-file>` | Path to the template file for the policy (same template used when creating the policy) |
-
-## Function: api_get_policy ##
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
-Test of GET '/policy' or V2 GET '/v2/policies/{policy_id}' and optional check of the returned json payload.
-To test the the response code only, provide the expected response code and policy id.
-To test the contents of the returned json payload, add a path to the template file used when creating the policy.
+## Function: keycloak_api_read_client_secret ##
+Read the secret for client
| arg list |
|--|
-| `<response-code> <policy-id> [<template-file>]` |
-
-| arg list V2|
-|--|
-| `<response-code> <policy-id> [ <template-file> <service-name> <ric-id> <policytype-id>\|NOTYPE <transient> <notification-url>\|NOURL ]` |
+| `<realm-name> <client-name>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<policy-id>` | Id of the policy |
-| `<template-file>` | Path to the template file for the policy (same template used when creating the policy) |
-| `<service-id>` | Id of the service |
-| `<ric-id>` | Id of the ric |
-| `<policy-type-id>` | Id of the policy type |
-| `NOTYPE` | Indicator that no type id is provided |
-| `transient` | Transient, true or false |
-| `notification-url` | Url for notifications |
+| `realm-name` | Name of the realm |
+| `client-name` | Name of the client |
-## Function: api_put_policy ##
+# Description of functions in kubeproxy_api_functions.sh #
-Test of PUT '/policy' or V2 PUT '/policies'.
-If more than one policy shall be created, add a count value to indicate the number of policies to create. Note that if more than one policy shall be created the provided policy-id must be numerical (will be used as the starting id).
+## 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 |
|--|
-| `<response-code> <service-name> <ric-id> <policytype-id> <policy-id> <transient> <template-file> [<count>]` |
-
-| arg list V2 |
-|--|
-| `<response-code> <service-name> <ric-id> <policytype-id>\|NOTYPE <policy-id> <transient>\|NOTRANSIENT <notification-url>\|NOURL <template-file> [<count>]` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<service-id>` | Id of the service |
-| `<ric-id>` | Id of the ric |
-| `<policy-type-id>` | Id of the policy type |
-| `<policy-id>` | Id of the policy. This value shall be a numeric value if more than one policy shall be created |
-| `transient>` | Transient 'true' or 'false'. 'NOTRANSIENT' can be used to indicate using the default value (no transient value provided) |
-| `notification-url` | Url for notifications |
-|`NOURL`| Indicator for no url |
-| `<template-file>` | Path to the template file for the policy |
-| `<count>` | An optional count (default is 1). If a value greater than 1 is given, the policy ids will use the given policy id as the first id and add 1 to that id for each new policy |
-
-## Function: api_put_policy_batch ##
+| None |
-This tests the same as function 'api_put_policy' except that all put requests are sent to dmaap in one go and then the responses are polled one by one.
-If the agent api is not configured to use dmaap (see 'use_agent_dmaap', 'use_agent_rest_http' and 'use_agent_rest_https'), an error message is printed.
-For arg list and parameters, see 'api_put_policy'.
+## Function: use_kube_proxy_https ##
-## Function: api_put_policy_parallel ##
+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 |
-This tests the same as function 'api_put_policy' except that the policy create is spread out over a number of processes and it only uses the agent rest API. The total number of policies created is determined by the product of the parameters 'number-of-rics' and 'count'. The parameter 'number-of-threads' shall be selected to be not evenly divisible by the product of the parameters 'number-of-rics' and 'count' - this is to ensure that one process does not handle the creation of all the policies in one ric.
+## 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.
| arg list |
|--|
-| `<response-code> <service-name> <ric-id-base> <number-of-rics> <policytype-id> <policy-start-id> <transient> <template-file> <count-per-ric> <number-of-threads>`
+| None |
+
+# Description of functions in localhelm_api_functions.sh #
+## Function: localhelm_create_test_chart ##
+
+Create a dummy chart using helm
| arg list |
|--|
-| `<response-code> <service-name> <ric-id-base> <number-of-rics> <policytype-id> <policy-start-id> <transient> <notification-url>\|NOURL <template-file> <count-per-ric> <number-of-threads>`
+| `chart-name` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<service-id>` | Id of the service |
-| `<ric-id-base>` | The base id of the rics, ie ric id without the sequence number. The sequence number is added during processing |
-| `<number-of-rics>` | The number of rics, assuming the first index is '1'. The index is added to the 'ric-id-base' id |
-| `<policy-type-id>` | Id of the policy type |
-| `<policy-start-id>` | Id of the policy. This value shall be a numeric value and will be the id of the first policy |
-| `transient>` | Transient 'true' or 'false'. 'NOTRANSIENT' can be used to indicate using the default value (no transient value provide) |
-| `notification-url` | Url for notifications |
-| `<template-file>` | Path to the template file for the policy |
-| `<count-per-ric>` | Number of policies per ric |
-| `<number-of-threads>` | Number of threads (processes) to run in parallel |
-
-## Function: api_delete_policy ##
+| `chart-name` | Name of the chart |
-This tests the DELETE '/policy' or V2 DELETE '/v2/policies/{policy_id}'. Removes the indicated policy or a 'count' number of policies starting with 'policy-id' as the first id.
+## Function: localhelm_package_test_chart ##
+Package a dummy chart using helm
| arg list |
|--|
-| `<response-code> <policy-id> [<count>]`
+| `chart-name` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<policy-id>` | Id of the policy |
-| `<count>` | An optional count of policies to delete. The 'policy-id' will be the first id to be deleted. |
-
-## Function: api_delete_policy_batch ##
-
-This tests the same as function 'api_delete_policy' except that all delete requests are sent to dmaap in one go and then the responses are polled one by one.
-If the agent api is not configured to used dmaap (see 'use_agent_dmaap', 'use_agent_rest_http' and 'use_agent_rest_https'), an error message is printed.
-For arg list and parameters, see 'api_delete_policy'.
-
-## Function: api_delete_policy_parallel ##
+| `chart-name` | Name of the chart |
-This tests the same as function 'api_delete_policy' except that the policy delete is spread out over a number of processes and it only uses the agent rest API. The total number of policies deleted is determined by the product of the parameters 'number-of-rics' and 'count'. The parameter 'number-of-threads' shall be selected to be not evenly divisible by the product of the parameters 'number-of-rics' and 'count' - this is to ensure that one process does not handle the deletion of all the policies in one ric.
+## Function: localhelm_installed_chart_release ##
+Check if a chart is installed or not using helm
| arg list |
|--|
-| `<response-code> <ric-id-base> <number-of-rics> <policy-start-id> <count-per-ric> <number-of-threads>`
+| `INSTALLED|NOTINSTALLED <release-name> <name-space> |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<ric-id-base>` | The base id of the rics, ie ric id without the sequence number. The sequence number is added during processing |
-| `<number-of-rics>` | The number of rics, assuming the first index is '1' |
-| `<policy-start-id>` | Id of the policy. This value shall be a numeric value and will be the id of the first policy |
-| `<count-per-ric>` | Number of policies per ric |
-| `<number-of-threads>` | Number of threads (processes) to run in parallel |
+| `INSTALLED` | Expecting installed chart |
+| `NOTINSTALLED` | Expecting a not installed chart |
+| `release-name` | Name of the release |
+| `name-space` | Expected namespace |
-## Function: api_get_policy_ids ##
+# Description of functions in mr_api_functions.sh #
-Test of GET '/policy_ids' or V2 GET '/v2/policies'.
-To test response code only, provide the response code parameter as well as the following three parameters.
-To also test the response payload add the 'NOID' for an expected empty array or repeat the 'policy-instance-id' for each expected policy id.
+## Function: use_mr_http ##
+
+Use http for all Dmaap calls to the MR. This is the default. The admin API is not affected.
| arg list |
|--|
-| `<response-code> <ric-id>\|NORIC <service-id>\|NOSERVICE <type-id>\|NOTYPE ([<policy-instance-id]*\|NOID)` |
+| None |
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<ric-id>` | Id of the ric |
-| `NORIC` | Indicator that no ric is provided |
-| `<service-id>` | Id of the service |
-| `NOSERVICE` | Indicator that no service id is provided |
-| `type-id>` | Id of the policy type |
-| `NOTYPE` | Indicator that no type id is provided |
-| `NOID` | Indicator that no policy id is provided - indicate empty list of policies|
-| `<policy-instance-id>` | Id of the policy |
+## Function: use_mr_https ##
-## Function: api_get_policy_schema ##
+Use https for all Dmaap call to the MR. The admin API is not affected. Note that this function shall be called before preparing the config for Consul.
+| arg list |
+|--|
+| None |
-Test of V2 GET '/v2/policy-types/{policyTypeId}' and optional check of the returned json schema.
-To test the response code only, provide the expected response code and policy type id.
-To test the contents of the returned json schema, add a path to a schema file to compare with.
+## Function: start_mr ##
+Start the Message Router stub interface container in docker or kube depending on start mode
| arg list |
|--|
-| `<response-code> <policy-type-id> [<schema-file>]` |
+| None |
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<policy-type-id>` | Id of the policy type |
-| `<schema-file>` | Path to the schema file for the policy type |
+## Function: dmaap_api_print_topics ##
-## Function: api_get_policy_schema ##
+Prints the current list of topics in DMAAP MR
-Test of GET '/policy_schema' and optional check of the returned json schema.
-To test the response code only, provide the expected response code and policy type id.
-To test the contents of the returned json schema, add a path to a schema file to compare with.
+| arg list |
+|--|
+| None |
+## Function: mr_equal ##
+
+Tests if a variable value in the Message Router (MR) simulator is equal to a target value.
+Without the timeout, the test sets pass or fail immediately depending on if the variable is equal to the target or not.
+With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes equal to the target value or not.
+See the 'mrstub' dir for more details.
| arg list |
|--|
-| `<response-code> <policy-type-id> [<schema-file>]` |
+| `<variable-name> <target-value> [ <timeout-in-sec> ]` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<policy-type-id>` | Id of the policy type |
-| `<schema-file>` | Path to the schema file for the policy type |
-
-## Function: api_get_policy_schemas ##
+| `<variable-name>` | Variable name in the MR |
+| `<target-value>` | Target value for the variable |
+| `<timeout-in-sec>` | Max time to wait for the variable to reach the target value |
-Test of GET '/policy_schemas' and optional check of the returned json schemas.
-To test the response code only, provide the expected response code and ric id (or NORIC if no ric is given).
-To test the contents of the returned json schema, add a path to a schema file to compare with (or NOFILE to represent an empty '{}' type)
+## Function: mr_greater ##
+Tests if a variable value in the Message Router (MR) simulator is greater than a target value.
+Without the timeout, the test sets pass or fail immediately depending on if the variable is greater than the target or not.
+With the timeout, the test waits up to the timeout seconds before setting pass or fail depending on if the variable value becomes greater than the target value or not.
+See the 'mrstub' dir for more details.
| arg list |
|--|
-| `<response-code> <ric-id>\|NORIC [<schema-file>\|NOFILE]*` |
+| `<variable-name> <target-value> [ <timeout-in-sec> ]` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<ric-id>` | Id of the ric |
-| `NORIC` | No ric id given |
-| `<schema-file>` | Path to the schema file for the policy type |
-| `NOFILE` | Indicate the template for an empty type |
-
-## Function: api_get_policy_status ##
+| `<variable-name>` | Variable name in the MR |
+| `<target-value>` | Target value for the variable |
+| `<timeout-in-sec>` | Max time to wait for the variable to become grater than the target value |
-Test of GET '/policy_status' or V2 GET '/policies/{policy_id}/status'.
+## Function: mr_read ##
+Reads the value of a variable in the Message Router (MR) simulator. The value is intended to be passed to a env variable in the test script.
+See the 'mrstub' dir for more details.
| arg list |
|--|
-| `<response-code> <policy-id> (STD\|STD2 <enforce-status>\|EMPTY [<reason>\|EMPTY])\|(OSC <instance-status> <has-been-deleted>)` |
+| `<variable-name>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<policy-id>` | Id of the policy |
-| `STD` | Indicator of status of Standarized A1 |
-| `STD2` | Indicator of status of Standarized A1 version 2 |
-| `<enforce-status>` | Enforcement status |
-| `<reason>` | Optional reason |
-| `EMPTY` | Indicator of empty string status or reason |
-| `OSC` | Indicator of status of Non-Standarized OSC A1 |
-| `<instance-status>` | Instance status |
-| `<has-been-deleted>` | Deleted status, true or false |
-
-## Function: api_get_policy_types ##
+| `<variable-name>` | Variable name in the MR |
-Test of GET '/policy_types' or V2 GET '/v2/policy-types' and optional check of the returned ids.
-To test the response code only, provide the expected response code and ric id (or NORIC if no ric is given).
-To test the contents of the returned json payload, add the list of expected policy type id (or 'EMPTY' for the '{}' type)
+## Function: mr_print ##
+Prints the value of a variable in the Message Router (MR) simulator.
+See the 'mrstub' dir for more details.
| arg list |
|--|
-| `<response-code> [<ric-id>\|NORIC [<policy-type-id>\|EMPTY [<policy-type-id>]*]]` |
+| `<variable-name>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<ric-id>` | Id of the ric |
-| `NORIC` | No ric id given |
-| `<policy-type-id>` | Id of the policy type |
-| `EMPTY` | Indicate the empty type |
-
-## Function: api_get_status ##
+| `<variable-name>` | Variable name in the MR |
-Test of GET /status or V2 GET /status
+## Function: mr_api_send_json ##
+Send json to topic in mr-stub.
| arg list |
|--|
-| `<response-code>` |
+| `<topic-url> <json-msg>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-
-## Function: api_get_ric ##
+| `<topic-url>` | Topic url |
+| `<json-msg>` | Json msg as string |
-Test of GET '/ric' or V2 GET '/v2/rics/ric'
-To test the response code only, provide the expected response code and managed element id.
-To test the returned ric id, provide the expected ric id.
+## Function: mr_api_send_text ##
+Send text to topic in mr-stub.
| arg list |
|--|
-| `<reponse-code> <managed-element-id> [<ric-id>]` |
-
-| arg list V2 |
-|--|
-| `<reponse-code> <management-element-id>\|NOME <ric-id>\|<NORIC> [<string-of-ricinfo>]` |
+| `<topic-url> <text-msg>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<managed-element-id>` | Id of the managed element |
-| `NOME` | Indicator for no ME |
-| `ric-id` | Id of the ric |
-| `NORIC` | Indicator no RIC |
-| `string-of-ricinfo` | String of ric info |
+| `<topic-url>` | Topic url |
+| `<text-msg>` | Text (string) msg |
-## Function: api_get_rics ##
-Test of GET '/rics' or V2 GET '/v2/rics' and optional check of the returned json payload (ricinfo).
-To test the response code only, provide the expected response code and policy type id (or NOTYPE if no type is given).
-To test also the returned payload, add the formatted string of info in the returned payload.
-Format of ricinfo: <br>`<ric-id>:<list-of-mes>:<list-of-policy-type-ids>`<br>
-Example <br>`<space-separate-string-of-ricinfo> = "ricsim_g1_1:me1_ricsim_g1_1,me2_ricsim_g1_1:1,2,4 ricsim_g1_1:me2_........."`
+## Function: mr_api_send_json_file ##
+
+Send json to topic in mr-stub.
| arg list |
|--|
-| `<reponse-code> <policy-type-id>\|NOTYPE [<space-separate-string-of-ricinfo>]` |
+| `<topic-url> <json-file>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<policy-type-id>` | Policy type id of the ric |
-| `NOTYPE>` | No type given |
-| `<space-separate-string-of-ricinfo>` | A space separated string of ric info - needs to be quoted |
+| `<topic-url>` | Topic url |
+| `<json-file>` | Path to file with json msg as string |
-## Function: api_put_service ##
+## Function: mr_api_send_text_file ##
-Test of PUT '/service' or V2 PUT '/service'.
+Send text to topic in mr-stub.
| arg list |
|--|
-| `<response-code> <service-name> <keepalive-timeout> <callbackurl>` |
+| `<topic-url> <text-file>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<service-name>` | Service name |
-| `<keepalive-timeout>` | Timeout value |
-| `<callbackurl>` | Callback url |
-
-## Function: api_get_services ##
+| `<topic-url>` | Topic url |
+| `<text-file>` | Path to file with text msg as string |
-Test of GET '/service' or V2 GET '/v2/services' and optional check of the returned json payload.
-To test only the response code, omit all parameters except the expected response code.
-To test the returned json, provide the parameters after the response code.
+## Function: mr_api_generate_json_payload_file ##
+Create json file with dummy data for payload.
| arg list |
|--|
-| `<response-code> [ (<query-service-name> <target-service-name> <keepalive-timeout> <callbackurl>) \| (NOSERVICE <target-service-name> <keepalive-timeout> <callbackurl> [<target-service-name> <keepalive-timeout> <callbackurl>]* )]` |
+| `<size-in-kb> <filename>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<query-service-name>` | Service name for the query |
-| `<target-service-name>` | Target service name|
-| `<keepalive-timeout>` | Timeout value |
-| `<callbackurl>` | Callback url |
-| `NOSERVICE` | Indicator of no target service name |
-
-## Function: api_get_service_ids ##
+| `<size-in-kb>` | Generated size in kb |
+| `<filename>` | Path to output file |
-Test of GET '/services' or V2 GET /'v2/services'. Only check of service ids.
+## Function: mr_api_generate_text_payload_file ##
+Create file with dummy text data for payload.
| arg list |
|--|
-| `<response-code> [<service-name>]*` |
+| `<size-in-kb> <filename>` |
| parameter | description |
| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<service-name>` | Service name |
+| `<size-in-kb>` | Generated size in kb |
+| `<filename>` | Path to output file |
-## Function: api_delete_services ##
+# Description of functions in ngw_api_functions.sh #
-Test of DELETE '/services' or V2 DELETE '/v2/services/{serviceId}'
+## Function: use_gateway_http ##
+Use http for all calls to the gateway. This is set by default.
| arg list |
|--|
-| `<response-code> [<service-name>]*` |
-
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<service-name>` | Service name |
-
-## Function: api_put_services_keepalive ##
+| None |
-Test of PUT '/services/keepalive' or V2 PUT '/v2/services/{service_id}/keepalive'
+## Function: use_gateway_https ##
+Use https for all calls to the gateway.
| arg list |
|--|
-| `<response-code> <service-name>` |
+| None |
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<service-name>` | Service name |
+## Function: set_gateway_debug ##
-## Function: api_put_configuration ##
+Set debug level logging in the gateway
+| arg list |
+|--|
+| None |
-Test of PUT '/v2/configuration'
+## Function: set_gateway_trace ##
+Set debug level logging in the trace
| arg list |
|--|
-| `<response-code> <config-file>` |
+| None |
-| parameter | description |
-| --------- | ----------- |
-| `<response-code>` | Expected http response code |
-| `<config-file>` | Path json config file |
+## Function: start_gateway ##
-## Function: api_get_configuration ##
+Start the the gateway container in docker or kube depending on start mode
+| arg list |
+|--|
+| None |
-Test of GET '/v2/configuration'
+## Function: gateway_a1pms_get_status ##
+Sample test of a1pms api (status)
+Only response code tested - not payload
| arg list |
|--|
-| `<response-code> [<config-file>]` |
+| `<response-code>` |
| parameter | description |
| --------- | ----------- |
| `<response-code>` | Expected http response code |
-| `<config-file>` | Path json config file to compare the retrieved config with |
-## Function: pms_kube_pvc_reset ##
-Admin reset to remove all policies and services
-All types and instances etc are removed - types and instances in a1 sims need to be removed separately
-NOTE - only works in kubernetes and the pod should not be running
+## Function: gateway_ics_get_types ##
+Sample test of ics api (get types)
+Only response code tested - not payload
| arg list |
|--|
-| None |
+| `<response-code>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
# Description of functions in prodstub_api_functions.sh #
| `<response-code>` | Expected http response code |
| `<service-id>` | Id of the service |
+
+# Description of functions in ricmediatorsim_api_functions.sh #
+
+The functions below only use the admin interface of the ricmediator, no usage of the A1 interface.
+
+## Function: use_ricmediator_simulator_http ##
+
+Use http for all API calls (A1) toward the simulator. This is the default. Admin API calls to the simulator are not affected. Note that this function shall be called before preparing the config for A1PMS.
+| arg list |
+|--|
+| None |
+
+## Function: use_ricmediator_simulator_https ##
+
+Use https for all API calls (A1) toward the simulator. Admin API calls to the simulator are not affected. Note that this function shall be called before preparing the config for A1PMS.
+| arg list |
+|--|
+| None |
+
+## Function: start_ricmediator_simulators ##
+
+Start a group of simulator where a group may contain 1 more simulators. Started in docker or kube depending on start mode
+| arg list |
+|--|
+| `ricsim_g1\|ricsim_g2\|ricsim_g3 <count> <interface-id>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `ricsim_g1\|ricsim_g2\|ricsim_g3` | Base name of the simulator. Each instance will have an postfix instance id added, starting on '1'. For examplle 'ricsim_g1_1', 'ricsim_g1_2' etc |
+|`<count>`| And integer, 1 or greater. Specifies the number of simulators to start|
+|`<interface-id>`| Shall be the interface id of the simulator. See the repo 'a1-interface' for the available ids. |
+
+## Function: get_kube_ricmediatorsim_host ##
+
+Translate ric name to kube host name.
+| arg list |
+|--|
+| `<ric-name>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<ric-name>` | The name of the ric to translate into a host name (ip) |
+
+## Function: nearsim_generate_policy_uuid ##
+
+Geneate a UUID prefix to use along with the policy instance number when creating/deleting policies. Sets the env var UUID.
+UUID is then automatically added to the policy id in GET/PUT/DELETE.
+| arg list |
+|--|
+| None |
+
+
+## Function: ricmediatorsim_put_policy_type ##
+
+Loads a policy type to the simulator
+
+| arg list |
+|--|
+| `<response-code> <ric-id> <policy-type-id> <policy-type-file>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<ric-id>` | Id of the ric |
+| `<policy-type-id>` | Id of the policy type |
+| `<policy-type-file>` | Path to the schema file of the policy type |
+
+## Function: ricmediatorsim_delete_policy_type ##
+
+Deletes a policy type from the simulator
+
+| arg list |
+|--|
+| `<response-code> <ric-id> <policy_type_id>` |
+
+| parameter | description |
+| --------- | ----------- |
+| `<response-code>` | Expected http response code |
+| `<ric-id>` | Id of the ric |
+| `<policy-type-id>` | Id of the policy type |
+
+
# Description of functions in ricsim_api_functions.sh #
The functions below only use the admin interface of the simulator, no usage of the A1 interface.
## Function: use_simulator_http ##
-Use http for all API calls (A1) toward the simulator. This is the default. Admin API calls to the simulator are not affected. Note that this function shall be called before preparing the config for Consul.
+Use http for all API calls (A1) toward the simulator. This is the default. Admin API calls to the simulator are not affected. Note that this function shall be called before preparing the config for A1PMS.
| arg list |
|--|
| None |
## Function: use_simulator_https ##
-Use https for all API calls (A1) toward the simulator. Admin API calls to the simulator are not affected. Note that this function shall be called before preparing the config for Consul.
+Use https for all API calls (A1) toward the simulator. Admin API calls to the simulator are not affected. Note that this function shall be called before preparing the config for A1PMS.
| arg list |
|--|
| None |
| --------- | ----------- |
| `<ric-name>` | The name of the ric to translate into a host name (ip) |
-## Function: generate_policy_uuid ##
+## Function: sim_generate_policy_uuid ##
Geneate a UUID prefix to use along with the policy instance number when creating/deleting policies. Sets the env var UUID.
UUID is then automatically added to the policy id in GET/PUT/DELETE.
## Function: use_sdnc_http ##
-Use http for all API calls towards the SDNC A1 Controller. This is the default. Note that this function shall be called before preparing the config for Consul.
+Use http for all API calls towards the SDNC A1 Controller. This is the default. Note that this function shall be called before preparing the config for A1PMS.
| arg list |
|--|
| None |
## Function: use_sdnc_https ##
-Use https for all API calls towards the SDNC A1 Controller. Note that this function shall be called before preparing the config for Consul.
+Use https for all API calls towards the SDNC A1 Controller. Note that this function shall be called before preparing the config for A1PMS.
| arg list |
|--|
| None |
## License
-Copyright (C) 2020 Nordix Foundation. All rights reserved.
+Copyright (C) 2020-2023 Nordix Foundation. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Code Review / nonrtric.git / blobdiff