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. Some of the scripts can also be used for other kinds of tests, for example basic tests.

Overview for common test scripts and files

api_curl.sh
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.

chartmus_api_functions.sh
Contains functions for managing a Chartmuseum instance.

clean-docker.sh
Cleans all containers started by the test environment in docker.

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'.

consul_api_function.sh
Contains functions for managing Consul and CBS.

count_json_elements.py
A python script calculate the length of json array or size of a json dictionary'.

count_json_elements.py
A python script returning the number of items in a json array.

cp_api_function.sh
Contains functions for managing the Control Panel.

cr_api_functions.sh
Contains functions for adapting towards the Callback receiver for checking received callback events.

create_policies_process.py
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.

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.

dmaapmed_api_function.sh Contains funnctions for managing the Dmaap Mediator Service.

dmaapmr_api_function.sh All functions are implemented in mr_api_functions.sh.

do_curl_function.sh A script for executing a curl call with a specific url and optional payload. It also compare the response with an expected result in terms of response code and optional returned payload. Intended to be used by test script (for example basic test scripts of other components)

extract_sdnc_reply.py
A python script to extract the information from an sdnc (A1 Controller) reply json. Helper for the test environment.

genstat.sh
This script collects container statistics to a file. Works both in docker and kubernetes (only for docker runtime).

helmmanager_api_functions.sh
Contains functions for managing and testing of the Helm Manager.

http_proxy_api_functions.sh
Contains functions for managing the Http Proxy.

ics_api_functions.sh
Contains functions for adapting towards the Information Coordinator Service API.

kafkapc_api_functions.sh
Contains functions for managing the kafka producer/consumer. Kafka is started by the dmaap message router component.

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.

localhelm_api_functions.sh
Contains functions for helm access on localhost.

mr_api_functions.sh
Contains functions for managing the MR Stub and the Dmaap Message Router

ngw_api_functions.sh
Contains functions for managing the Non-RT RIC Gateway

a1pms_api_functions.sh
Contains functions for adapting towards the Policy Management Service (A1PMS) 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.

pvccleaner_api_functions.sh
Contains functions for managing the PVC Cleaner (used for reset mounted volumes in kubernetes).

rc_api_functions.sh
Contains functions for adapting towards the RAPP Catalogue.

ricsim_api_functions.sh
Contains functions for adapting towards the RIC (A1) simulator admin API.

sdnc_api_functions.sh
Contains functions for adaping towards the SDNC (used as an A1 controller).

test_env*.sh
Common env variables for test in the auto-test dir. All configuration of port numbers, image names and version etc shall be made in this file. 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. 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.

testsuite_common.sh
Common functions for running two or more auto test scripts as a suite.

Integration of a new applicaton

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. This short name shall be added to the testengine_config.sh. See that file for detailed instructions.

• 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.

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.

• 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.

• Add mandatory image(s) and image tag(s) to the appropriate environment files for each release in the file(s) test_env_<system>-<release-name>. In addition, all other needed environment shall also be defined in these file.

Description of functions in testcase_common.sh

Script args

The script can be started with these arguments

Function: setup_testenvironment

Main function to setup the test environment before any tests are started. Must be called right after sourcing all component scripts. | arg list | |--| | None |

Function: print_result

Print a test report of an auto-test script. | arg list | |--| | None |

Function: start_timer

Start a timer for time measurement. Only one timer can be running. | arg list | |--| | <timer-message-to-print> | | None - but any args will be printed (It is good practice to use same args for this function as for the print_timer) |

Function: print_timer

Print the value of the timer (in seconds) previously started by 'start_timer'. (Note that timer is still running after this function). The result of the timer as well as the arg to 'start_timer' will also be printed in the test report. | arg list | |--| | None |

Function: deviation

Mark a test as a deviation from the requirements. The list of deviations will be printed in the test report. | arg list | |--| | <deviation-message-to-print> |

Function: clean_environment

Stop and remove all containers (docker) or resources (kubernetes). Containers not part of the test are not affected (docker only). Removes all resources started by previous kube tests (kube only). | arg list | |--| | None |

Function: auto_clean_containers

Same function as 'clean_environment'. This function has effect only if the test script is started with arg auto-clean. This intention is to use this function as the last step in an auto-test script. | arg list | |--| | None |

Function: sleep_wait

Make the script sleep for a number of seconds. | arg list | |--| | <sleep-time-in-sec> [<any-text-in-quotes-to-be-printed>] |

Function: store_logs

Take a snap-shot of all logs for all running containers/pods and stores them in ./logs/<ATC-id>. All logs will get the specified prefix in the file name. In general, one of the last steps in an auto-test script shall be to call this function. If logs shall be taken several times during a test script, different prefixes shall be used each time. | arg list | |--| | <logfile-prefix> |

Description of functions in testsuite_common.sh

Function: suite_setup

Sets up the test suite and prints out a heading. | arg list | |--| | None |

suite_complete

Print out the overall result of the executed test cases. | arg list | |--| | None |

Description of functions in chartmus_api_function.sh

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> |

Function: chartmus_delete_test_chart

Delete a chart in chartmusem | arg list | |--| | <chart-name> [<version>] |

Description of functions in consul_api_function.sh

Function: consul_config_app

Function to load a json config from a file into consul for the A1PMS

Function: start_consul_cbs

Start the Consul and CBS containers | arg list | |--| | None |

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> ] |

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> ] |

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.

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> |

Function: cr_delay_callback

Function to configure write delay on callbacks. Delay given in seconds. Setting remains until removed.

Function: cr_api_check_all_sync_events

Check the contents of all ric events received for a callback id.

Function: cr_api_check_all_ics_events

Check the contents of all current status events for one id from ICS

Function: cr_api_check_all_ics_subscription_events

Check the contents of all current subscription events for one id from ICS

Function: cr_api_reset

Reset the callback receiver

Function: cr_api_check_all_genric_json_events

Check the contents of all json events for path

Function: cr_api_check_single_genric_json_event

Check a single (oldest) json event (or none if empty) for path

Function: cr_api_check_single_genric_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. The MD5 will generate different hash if whitespace is present or not in otherwise equivalent json.

Function: cr_api_check_single_genric_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. The MD5 will generate different hash if ws/newlines is present or not in otherwise equivalent json

Description of functions in dmaapadp_api_functions.sh

Function: use_dmaapadp_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.

Function: use_dmaapadp_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.

Function: start_dmaapadp

Start the dmaap adator service container in docker or kube depending on running mode.

Function: set_dmaapadp_trace

Configure the dmaap adaptor service log on trace level. The app must be running. | arg list | |--| | None |

Description of functions in dmaapmed_api_functions.sh

Function: use_dmaapmed_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.

Function: use_dmaapmed_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.

Function: start_dmaapmed

Start the dmaap mediator service container in docker or kube depending on running mode.

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

Use http for all API calls to the Helm Manager. This is the default protocol. | arg list | |--| | None |

Function: use_helm_manager_https

Use https for all API calls to the Helm Manager. | arg list | |--| | None |

Function: start_helm_manager

Start the Helm Manager container in docker or kube depending on running mode. | arg list | |--| | None |

Function: helm_manager_api_get_charts

Get all charts and compare the expected contents. | arg list | |--| | <response-code> [ EMPTY | ( <chart> <version> <namespace> <release> <repo> )+ ] |

Function: helm_manager_api_post_repo

Add repo to the helm manager. | arg list | |--| | <response-code> <repo-name> <repo-protocol> <repo-address> <repo-port> |

Function: helm_manager_api_post_onboard_chart

Onboard a chart to the helm manager. | arg list | |--| | <response-code> <repo> <chart> <version> <release> <namespace> |

Function: helm_manager_api_post_install_chart

Install an onboarded chart. | arg list | |--| | <response-code> <chart> <version> |

Function: helm_manager_api_uninstall_chart

Uninstall a chart. | arg list | |--| | <response-code> <chart> <version> |

Function: helm_manager_api_delete_chart

Delete a chart. | arg list | |--| | <response-code> <chart> <version> |

Function: helm_manager_api_exec_add_repo

Add repo in helm manager by helm using exec. | arg list | |--| | <repo-name> <repo-url> |

Description of functions in ics_api_functions.sh

Function: use_ics_rest_http

Use http for all API calls to the ICS. This is the default protocol. | arg list | |--| | None |

Function: use_ics_rest_https

Use https for all API calls to the ICS. | arg list | |--| | None |

Function: use_ics_dmaap_http

Send and recieve all API calls to the ICS over Dmaap via the MR using http. | arg list | |--| | None |

Function: use_ics_dmaap_https

Send and recieve all API calls to the ICS over Dmaap via the MR using https. | arg list | |--| | None |

Function: start_ics

Start the ICS container in docker or kube depending on running mode. | arg list | |--| | PROXY|NOPROXY <config-file> |

Function: stop_ics

Stop the ICS container. | arg list | |--| | None |

Function: start_stopped_ics

Start a previously stopped ics. | arg list | |--| | None |

Function: set_ics_debug

Configure the ICS log on debug level. The ICS must be running. | arg list | |--| | None |

Function: set_ics_trace

Configure the ICS log on trace level. The ICS must be running. | arg list | |--| | None |

Function: use_ics_retries

Perform curl retries when making direct call to ICS for the specified http response codes Speace separated list of http response codes | arg list | |--| | [<response-code>]* |

Function: check_ics_logs

Check the ICS log for any warnings and errors and print the count of each. | arg list | |--| | None |

Function: ics_equal

Tests if a variable value in the ICS 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 'a1-interface' repo for more details.

Function: ics_api_a1_get_job_ids

Test of GET '/A1-EI/v1/eitypes/{eiTypeId}/eijobs' and optional check of the array of returned job ids. To test the response code only, provide the response code parameter as well as a type id and an owner id. To also test the response payload add the 'EMPTY' for an expected empty array or repeat the last parameter for each expected job id.

Function: ics_api_a1_get_type

Test of GET '/A1-EI/v1/eitypes/{eiTypeId}' and optional check of the returned schema. To test the response code only, provide the response code parameter as well as the type-id. To also test the response payload add a path to the expected schema file.

Function: ics_api_a1_get_type_ids

Test of GET '/A1-EI/v1/eitypes' and optional check of returned list of type ids. To test the response code only, provide the response only. To also test the response payload add the list of expected type ids (or EMPTY if the list is expected to be empty).

Function: ics_api_a1_get_job_status

Test of GET '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}/status' and optional check of the returned status. To test the response code only, provide the response code, type id and job id. To also test the response payload add the expected status.

Function: ics_api_a1_get_job

Test of GET '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}' and optional check of the returned job. To test the response code only, provide the response code, type id and job id. To also test the response payload add the remaining parameters.

Function: ics_api_a1_delete_job

Test of DELETE '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}'. To test, provide all the specified parameters.

Function: ics_api_a1_put_job

Test of PUT '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}'. To test, provide all the specified parameters.

Function: ics_api_edp_get_type_ids

Test of GET '/ei-producer/v1/eitypes' or '/data-producer/v1/info-types' depending on ics version and an optional check of the returned list of type ids. To test the response code only, provide the response code. To also test the response payload add list of expected type ids (or EMPTY if the list is expected to be empty).

Function: ics_api_edp_get_producer_status

Test of GET '/ei-producer/v1/eiproducers/{eiProducerId}/status' or '/data-producer/v1/info-producers/{infoProducerId}/status' depending on ics version and optional check of the returned status. To test the response code only, provide the response code and producer id. To also test the response payload add the expected status.

Function: ics_api_edp_get_producer_ids

Test of GET '/ei-producer/v1/eiproducers' and optional check of the returned producer ids. To test the response code only, provide the response. To also test the response payload add the list of expected producer-ids (or EMPTY if the list of ids is expected to be empty).

Function: ics_api_edp_get_producer_ids_2

Test of GET '/ei-producer/v1/eiproducers' or '/data-producer/v1/info-producers' depending on ics version and optional check of the returned producer ids. To test the response code only, provide the response. To also test the response payload add the type (if any) and a list of expected producer-ids (or EMPTY if the list of ids is expected to be empty).

Function: ics_api_edp_get_type

Test of GET '/ei-producer/v1/eitypes/{eiTypeId}' and optional check of the returned type. To test the response code only, provide the response and the type-id. To also test the response payload add a path to a job schema file and a list expected producer-id (or EMPTY if the list of ids is expected to be empty).

Function: ics_api_edp_get_type_2

Test of GET '/ei-producer/v1/eitypes/{eiTypeId}' or '/data-producer/v1/info-types/{infoTypeId}' depending on ics version and optional check of the returned type. To test the response code only, provide the response and the type-id. To also test the response payload add a path to a job schema file.

Function: ics_api_edp_put_type_2

Test of PUT '/ei-producer/v1/eitypes/{eiTypeId}' or '/data-producer/v1/info-types/{infoTypeId}' depending on ics version and optional check of the returned type.

Function: ics_api_edp_delete_type_2

Test of DELETE '/ei-producer/v1/eitypes/{eiTypeId}' or '/data-producer/v1/info-types/{infoTypeId}' depending on ics version and optional check of the returned type.

Function: ics_api_edp_get_producer

Test of GET '/ei-producer/v1/eiproducers/{eiProducerId}' and optional check of the returned producer. To test the response code only, provide the response and the producer-id. To also test the response payload add the remaining parameters defining thee producer.

Function: ics_api_edp_get_producer_2

Test of GET '/ei-producer/v1/eiproducers/{eiProducerId}' or '/data-producer/v1/info-producers/{infoProducerId}' depending on ics version and optional check of the returned producer. To test the response code only, provide the response and the producer-id. To also test the response payload add the remaining parameters defining thee producer.

Function: ics_api_edp_delete_producer

Test of DELETE '/ei-producer/v1/eiproducers/{eiProducerId}' or '/data-producer/v1/info-producers/{infoProducerId}' depending on ics version. To test, provide all parameters.

Function: ics_api_edp_put_producer

Test of PUT '/ei-producer/v1/eiproducers/{eiProducerId}'. To test, provide all parameters. The list of type/schema pair may be empty.

Function: ics_api_edp_put_producer_2

Test of PUT '/ei-producer/v1/eiproducers/{eiProducerId}' or '/data-producer/v1/info-producers/{infoProducerId}' depending on ics version. To test, provide all parameters. The list of type/schema pair may be empty.

Function: ics_api_edp_get_producer_jobs

Test of GET '/ei-producer/v1/eiproducers/{eiProducerId}/eijobs' and optional check of the returned producer job. To test the response code only, provide the response and the producer-id. To also test the response payload add the remaining parameters.

Function: ics_api_edp_get_producer_jobs_2

Test of GET '/ei-producer/v1/eiproducers/{eiProducerId}/eijobs' or '/data-producer/v1/info-producers/{infoProducerId}/info-jobs' depending on ics version and optional check of the returned producer job. To test the response code only, provide the response and the producer-id. To also test the response payload add the remaining parameters.

Function: ics_api_service_status

Test of GET '/status'.

Function: ics_api_idc_get_type_ids

Test of GET '/data-consumer/v1/info-types' and an optional check of the returned list of type ids. To test the response code only, provide the response code. To also test the response payload add list of expected type ids (or EMPTY if the list is expected to be empty).

Function: ics_api_idc_get_job_ids

Test of GET '/data-consumer/v1/info-jobs' and optional check of the array of returned job ids. To test the response code only, provide the response code parameter as well as a type id and an owner id. To also test the response payload add the 'EMPTY' for an expected empty array or repeat the last parameter for each expected job id.

Function: ics_api_idc_get_job

Test of GET '/data-consumer/v1/info-jobs/{infoJobId}' and optional check of the returned job. To test the response code only, provide the response code, type id and job id. To also test the response payload add the remaining parameters.

Function: ics_api_idc_put_job

Test of PUT '/data-consumer/v1/info-jobs/{infoJobId}'. To test, provide all the specified parameters.

Function: ics_api_idc_delete_job

Test of DELETE '/A1-EI/v1/eitypes/{eiTypeId}/eijobs/{eiJobId}'. To test, provide all the specified parameters.

Function: ics_api_idc_get_type

Test of GET '/data-consumer/v1/info-types/{infoTypeId} and optional check of the returned schema. To test the response code only, provide the response code parameter as well as the type-id. To also test the response payload add a path to the expected schema file.

Function: ics_api_idc_get_job_status

Test of GET '/data-consumer/v1/info-jobs/{infoJobId}/status' and optional check of the returned status and timeout. To test the response code only, provide the response code and job id. To also test the response payload add the expected status.

Function: ics_api_idc_get_job_status2

Test of GET '/data-consumer/v1/info-jobs/{infoJobId}/status' with returned producers and optional check of the returned status and timeout. To test the response code only, provide the response code and job id. To also test the response payload add the expected status.

Function: ics_api_idc_get_subscription_ids

Test of GET '/data-consumer/v1/info-type-subscription' with the returned list of subscription ids

Function: ics_api_idc_get_subscription

Test of GET '/data-consumer/v1/info-type-subscription/{subscriptionId}' with the subscription information

Function: ics_api_idc_put_subscription

Test of PUT '/data-consumer/v1/info-type-subscription/{subscriptionId}' with the subscription information

Function: ics_api_idc_delete_subscription

Test of DELETE /data-consumer/v1/info-type-subscription/{subscriptionId}

Function: ics_api_admin_reset

Test of GET '/status'.

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

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> ] |

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> |

Function: kafkapc_api_get_topic

Create a from kafkapc. | <response-code> <topic-name> <mime-type> |

Function: kafkapc_api_start_sending

Start sending msg from the msg queue to kafka for a topic. | <response-code> <topic-name> |

Function: kafkapc_api_start_receiving

Start receiving msg from a kafka topic to the msg queue in kafkapc. | <response-code> <topic-name> |

Function: kafkapc_api_stop_sending

Stop sending msg from the msg queue to kafka for a topic. | <response-code> <topic-name> |

Function: kafkapc_api_stop_receiving

Stop receiving msg from a kafka topic to the msg queue in kafkapc. | <response-code> <topic-name> |

Function: kafkapc_api_post_msg

Send a message on a topic. | arg list | |--| | <response-code> <topic> <mime-type> <msg> |

Function: kafkapc_api_get_msg

Get a message on a topic. | arg list | |--| | <response-code> <topic> ([ <mime-type> <msg> ] | NOMSG ) |

Function: kafkapc_api_post_msg_from_file

Send a message in a file on a topic. | arg list | |--| | <response-code> <topic> <mime-type> <file> |

Function: kafkapc_api_get_msg_from_file

Get a message on a topic. | arg list | |--| | <response-code> <topic> <mime-type> <file> |

Function: kafkapc_api_generate_json_payload_file

Create json file with dummy data for payload. | arg list | |--| | <size-in-kb> <filename> |

Function: kafkapc_api_generate_text_payload_file

Create file with dummy text data for payload. | arg list | |--| | <size-in-kb> <filename> |

Description of functions in kubeproxy_api_functions.sh

Function: use_kube_proxy_http

Use http for all proxy requests. Note that this only applicable to the actual proxy request, the proxied protocol can still be http and https. | arg list | |--| | None |

Function: use_kube_proxy_https

Use https for all proxy requests. Note that this only applicable to the actual proxy request, the proxied protocol can still be http and https. | arg list | |--| | None |

Function: start_kube_proxy

Start the kube proxy container in kube. This proxy enabled the test env to access all services and pods in a kube cluster. No proxy is started if the function is called in docker mode. | arg list | |--| | None |

Description of functions in localhelm_api_functions.sh

Function: localhelm_create_test_chart

Create a dummy chart using helm | arg list | |--| | chart-name |

Function: localhelm_package_test_chart

Package a dummy chart using helm | arg list | |--| | chart-name |

Function: localhelm_installed_chart_release

Check if a chart is installed or not using helm | arg list | |--| | `INSTALLED|NOTINSTALLED |

Description of functions in mr_api_functions.sh

Function: use_mr_http

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 |

Function: use_mr_https

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 |

Function: start_mr

Start the Message Router stub interface container in docker or kube depending on start mode | arg list | |--| | None |

Function: dmaap_api_print_topics

Prints the current list of topics in DMAAP MR

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 | |--| | <variable-name> <target-value> [ <timeout-in-sec> ] |

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 | |--| | <variable-name> <target-value> [ <timeout-in-sec> ] |

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 | |--| | <variable-name> |

Function: mr_print

Prints the value of a variable in the Message Router (MR) simulator. See the 'mrstub' dir for more details. | arg list | |--| | <variable-name> |

Function: mr_api_send_json

Send json to topic in mr-stub. | arg list | |--| | <topic-url> <json-msg> |

Function: mr_api_send_text

Send text to topic in mr-stub. | arg list | |--| | <topic-url> <text-msg> |

Function: mr_api_send_json_file

Send json to topic in mr-stub. | arg list | |--| | <topic-url> <json-file> |

Function: mr_api_send_text_file

Send text to topic in mr-stub. | arg list | |--| | <topic-url> <text-file> |

Function: mr_api_generate_json_payload_file

Create json file with dummy data for payload. | arg list | |--| | <size-in-kb> <filename> |

Function: mr_api_generate_text_payload_file

Create file with dummy text data for payload. | arg list | |--| | <size-in-kb> <filename> |

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 |

Function: use_gateway_https

Use https for all calls to the gateway. | arg list | |--| | None |

Function: set_gateway_debug

Set debug level logging in the gateway | arg list | |--| | None |

Function: set_gateway_trace

Set debug level logging in the trace | arg list | |--| | None |

Function: start_gateway

Start the the gateway container in docker or kube depending on start mode | arg list | |--| | None |

Function: gateway_a1pms_get_status

Sample test of a1pms api (status) Only response code tested - not payload | arg list | |--| | <response-code> |

Function: gateway_ics_get_types

Sample test of ics api (get types) Only response code tested - not payload | arg list | |--| | <response-code> |

Description of functions in a1pms_api_functions.sh

General

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: use_a1pms_rest_https

Use https for all API calls to the A1PMS. | arg list | |--| | None |

Function: use_a1pms_dmaap_http

Send and recieve all API calls to the A1PMS over Dmaap via the MR over http. | arg list | |--| | None |

Function: use_a1pms_dmaap_https

Send and recieve all API callss to the A1PMS over Dmaap via the MR over https. | arg list | |--| | None |

Function: start_a1pms

Start the A1PMS container or corresponding kube resources depending on docker/kube mode. | arg list | |--| | <logfile-prefix> | | (docker) PROXY\|NOPROXY <config-file> | | (kube) PROXY\|NOPROXY <config-file> [ <data-file> ] |

Function: stop_a1pms

Stop the a1pms container (docker) or scale it to zero (kubernetes). | arg list | |--| | None |

Function: start_stopped_a1pms

Start a previousely stopped a1pms container (docker) or scale it to 1 (kubernetes). | arg list | |--| | None |

Function: prepare_consul_config

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') | arg list | |--| | SDNC|NOSDNC <output-file> |

Function: a1pms_load_config

Load the config into a config map (kubernetes only). | arg list | |--| | <data-file> |

Function: set_a1pms_debug

Configure the A1PMS log on debug level. The A1PMS must be running. | arg list | |--| | None |

Function: set_a1pms_trace

Configure the A1PMS log on trace level. The A1PMS must be running. | arg list | |--| | None |

Function: use_a1pms_retries

Configure the A1PMS to make upto 5 retries if an API calls return any of the specified http return codes. | arg list | |--| | [<response-code>]* |

Function: check_a1pms_logs

Check the A1PMS log for any warnings and errors and print the count of each. | arg list | |--| | None |

Function: a1pms_equal

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.

Function: a1pms_api_get_policies

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: a1pms_api_get_policy

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: a1pms_api_put_policy

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: a1pms_api_put_policy_batch

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 create 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' 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: a1pms_api_delete_policy

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: a1pms_api_delete_policy_batch

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 delete 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.

Function: a1pms_api_get_policy_ids

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: 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.

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.

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)

Function: a1pms_api_get_policy_status

Test of GET '/policy_status' or V2 GET '/policies/{policy_id}/status'.

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)

Function: a1pms_api_get_status

Test of GET /status or V2 GET /status

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.

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:
<ric-id>:<list-of-mes>:<list-of-policy-type-ids>
Example
<space-separate-string-of-ricinfo> = "ricsim_g1_1:me1_ricsim_g1_1,me2_ricsim_g1_1:1,2,4 ricsim_g1_1:me2_........."

Function: a1pms_api_put_service

Test of PUT '/service' or V2 PUT '/service'. | arg list | |--| | <response-code> <service-name> <keepalive-timeout> <callbackurl> |

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.

Function: a1pms_api_get_service_ids

Test of GET '/services' or V2 GET /'v2/services'. Only check of service ids.

Function: a1pms_api_delete_services

Test of DELETE '/services' or V2 DELETE '/v2/services/{serviceId}'

Function: a1pms_api_put_services_keepalive

Test of PUT '/services/keepalive' or V2 PUT '/v2/services/{service_id}/keepalive'

Function: a1pms_api_put_configuration

Test of PUT '/v2/configuration'

Function: a1pms_api_get_configuration

Test of GET '/v2/configuration'

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

Description of functions in prodstub_api_functions.sh

Function: use_prod_stub_http

Use http for the API. The admin API is not affected. This is the default protocol. | arg list | |--| | None |

Function: use_prod_stub_https

Use https for the API. The admin API is not affected. | arg list | |--| | None |

Function: start_prod_stub

Start the Producer stub container in docker or kube depending on start mode | arg list | |--| | None |

Function: prodstub_arm_producer

Preconfigure the prodstub with a producer. The producer supervision response code is optional, if not given the response code will be set to 200.

Function: prodstub_arm_job_create

Preconfigure the prodstub with a job or update an existing job. Optional create/update job response code, if not given the response code will be set to 200/201 depending on if the job has been previously created or not.

Function: prodstub_arm_job_delete

Preconfigure the prodstub with a job. Optional delete job response code, if not given the response code will be set to 204/404 depending on if the job exists or not.

Function: prodstub_arm_type

Preconfigure the prodstub with a type for a producer. Can be called multiple times to add more types.

Function: prodstub_disarm_type

Remove a type for the producer in the rodstub. Can be called multiple times to remove more types.

Function: prodstub_check_jobdata

Check a job in the prodstub towards the list of provided parameters.

Function: prodstub_check_jobdata_2

Check a job in the prodstub towards the list of provided parameters.

Function: prodstub_check_jobdata_3

Check a job in the prodstub towards the list of provided parameters.

Function: prodstub_delete_jobdata

Delete the job parameters, job data, for a job.

Function: prodstub_equal

Tests if a variable value in the prodstub 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.

Description of functions in rc_api_function.sh

Function: use_rapp_catalogue_http

Use http for the API. This is the default protocol. | arg list | |--| | None |

Function: use_rapp_catalogue_https

Use https for the API. | arg list | |--| | None |

Function: start_rapp_catalogue

Start the rapp catalogue container in docker or kube depending on start mode | arg list | |--| | None |

Function: rc_equal

Tests if a variable value in the RAPP Catalogue 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 | |--| | <variable-name> <target-value> [ <timeout-in-sec> ] |

Function: rapp_cat_api_get_services

Check all registered services.

Function: rapp_cat_api_put_service

Register a services.

Function: rapp_cat_api_get_service

Check a registered service.

Function: rapp_cat_api_delete_service

Check a registered service.

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. | 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. | arg list | |--| | None |

Function: start_ric_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> |

Function: get_kube_sim_host

Translate ric name to kube host name. | arg list | |--| | <ric-name> |

Function: 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: sim_equal

Tests if a variable value in the RIC 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 'a1-interface' repo for more details.

Function: sim_print

Prints the value of a variable in the RIC simulator. See the 'a1-interface' repo for more details.

Function: sim_contains_str

Tests if a variable value in the RIC simulator 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.

Function: sim_put_policy_type

Loads a policy type to the simulator

Function: sim_delete_policy_type

Deletes a policy type from the simulator

Function: sim_post_delete_instances

Deletes all instances (and status), for one ric

Function: sim_post_delete_all

Deletes all types, instances (and status), for one ric

Function: sim_post_forcedresponse

Sets (or resets) response code for next (one) A1 message, for one ric. The intention is to simulate error response on the A1 interface.

Function: sim_post_forcedelay

Sets (or resets) A1 response delay, for one ric The intention is to delay responses on the A1 interface. Setting remains until removed.

Description of functions in sdnc_api_functions.sh

The file contains a selection of the possible API tests towards the SDNC (a1-controller)

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. | 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. | arg list | |--| | None |

Function: start_sdnc

Start the SDNC A1 Controller container and its database container | arg list | |--| | None |

Function: stop_sdnc

Stop the SDNC A1 Controller container and its database container | arg list | |--| | None |

Function: start_stopped_sdnc

Start a previously stopped SDNC | arg list | |--| | None |

Function: check_sdnc_logs

Check the SDNC log for any warnings and errors and print the count of each. | arg list | |--| | None |

Function: controller_api_get_A1_policy_ids

Test of GET policy ids towards OSC or STD type simulator. To test response code only, provide the response code, 'OSC' + policy type or 'STD' To test the response payload, include the ids of the expexted response.

Function: controller_api_get_A1_policy_type

Test of GET a policy type (OSC only)

Function: controller_api_delete_A1_policy

Deletes a policy instance

Function: controller_api_put_A1_policy

Creates a policy instance

Function: controller_api_get_A1_policy_status

Checks the status of a policy

License

Copyright (C) 2020 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

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.