The O-RAN SC A1 simulator simulates the A1 as a generic REST API that can receive and send northbound messages. The simulator validates the payload and applies policy.
The simulator supports multiple A1 interface versions (version of the open API YAML file):
| YAML file version | Version ID |
|---|---|
| OSC 2.1.0, | OSC_2.1.0 |
| A1 Standard 1.1.3, | STD_1.1.3 |
| A1 Standard 2.0.0, | STD_2.0.0 |
All versions are supported by the same container. See the section 'Configuring the simulator' below for details about how to start the simulator with the intended version ID.
The overall folder structure is (relative to the location of this README file):
| Dir | Description |
|---|---|
| . | Dockerfile and README |
| api | The open API YAML for each supported version |
| src | Python source code for each supported version |
| test | Basic test using script |
| tests | Basic test using pytest unit test |
| certificate | A self-signed certificate and a key |
The simulator handles the requests defined in the A1 open API YAML file. All these requests are implemented in the a1.py file in the source folder. In addition, a number of administrative functions are also supported and implemented by the main.py in the source folder.
The section below outlines the supported open API REST operations as well as the administrative REST operations. For the documentation of the common parts in the admin API, see Common Functions.
The simulator normally opens port 8085 for HTTP. If a certificate and a key are provided, the simulator will open port 8185 for HTTPS instead. Port 8185 is only opened if a valid certificate and key are found.
The certificate and key should be placed in the same directory and the directory should be mounted to /usr/src/app/cert in the container.
| Port | Protocol |
|---|---|
| 8085 | HTTP |
| 8185 | HTTPS |
The directory certificate contains a self-signed certificate. Use the script generate_cert_and_key.sh to generate a new certificate and key. The password of the certificate must be set to 'test'.
The same URLs are available on both the HTTP port 8085 and the HTTPS port 8185. If using curl and HTTPS, the flag -k should be given to make curl ignore checking the certificate.
For the complete YAML specification, see openapi.yaml.
Swagger UI at: http://localhost:8085/ui/
For the documentation of the admin API, see OSC_2.1.0.
For the complete YAML specification, see STD_A1.yaml.
URIs for A1:
| Function | Path and parameters |
|---|---|
| GET all policy identities | http://localhost:8085/A1-P/v1/policies |
| PUT a policy instance(create or update it) | http://localhost:8085/A1-P/v1/policies/{policyId} |
| GET a policy | http://localhost:8085/A1-P/v1/policies/{policyId} |
| DELETE a policy instance | http://localhost:8085/A1-P/v1/policies/{policyId} |
| GET a policy status | http://localhost:8085/A1-P/v1/policies/{policyid}/status |
Swagger UI at: http://localhost:8085/A1-P/v1/ui/
For the documentation of the admin API, see A1 Standard 1.1.3.
| Function | Path and parameters |
|---|---|
| GET, a basic healthcheck | http://localhost:8085/ |
| GET, a list of all supported interfaces | http://localhost:8085/container_interfaces |
| POST, delete all policy instances | http://localhost:8085/deleteinstances |
| POST, full reset | http://localhost:8085/deleteall |
| POST, force a specific response code for an A1 operation | http://localhost:8085/forceresponse?code=<http-code> |
| POST, force delayed response of all A1 operations | http://localhost:8085/forcedelay?delay=<seconds> |
| PUT, set status and optional reason | http://localhost:8085/status?status=<status>[&reason=<reason>] |
| POST, send status for policy | http://localhost:8085/sendstatus?policyid=<policyid> |
| GET a counter (counter-name: 'num_instances', 'num_types'(always 0), 'interface' or 'remote_hosts') |
http://localhost:8085/counter/<counter-name> |
| Turn on HTTP header and payload logging | http://localhost:8085/payload_logging/on |
| Turn off HTTP header and payload logging | http://localhost:8085/payload_logging/off |
For the complete YAML specification, see STD_A1.yaml.
| Function | Path and parameters |
|---|---|
| GET all policy identities | http://localhost:8085/A1-P/v2/policies |
| PUT a policy instance(create or update it) | http://localhost:8085/A1-P/v2/policies/{policyId} |
| GET a policy | http://localhost:8085/A1-P/v2/policies/{policyId} |
| DELETE a policy instance | http://localhost:8085/A1-P/v2/policies/{policyId} |
| GET a policy status | http://localhost:8085/A1-P/v2/policies/{policyid}/status |
Swagger UI at: http://localhost:8085/A1-P/v2/ui/
For the documentation of the admin API, see A1 Standard 2.0.0.
| Function | Path and parameters |
|---|---|
| GET, a basic healthcheck | http://localhost:8085/ |
| GET, a list of all supported interfaces | http://localhost:8085/container_interfaces |
| POST, delete all policy instances | http://localhost:8085/deleteinstances |
| POST, full reset | http://localhost:8085/deleteall |
| POST, force a specific response code for an A1 operation | http://localhost:8085/forceresponse?code=<http-code> |
| POST, force delayed response of all A1 operations | http://localhost:8085/forcedelay?delay=<seconds> |
| PUT, set status and optional reason | http://localhost:8085/status?status=<status>[&reason=<reason>] |
| POST, send status for policy | http://localhost:8085/sendstatus?policyid=<policyid> |
| GET a counter (counter-name: 'num_instances', 'num_types'(always 0), 'interface' or 'remote_hosts') |
http://localhost:8085/counter/<counter-name> |
| Turn on HTTP header and payload logging | http://localhost:8085/payload_logging/on |
| Turn off HTTP header and payload logging | http://localhost:8085/payload_logging/off |
The simulator needs some mandatory environment variables to be set.
| Env variable | Description | Example |
|---|---|---|
| A1_VERSION | MANDATORY: need to be passed to the container at start to select the desired interface version. The variable shall be set to one of the version-ids shown in the table in the first section. | A1_VERSION=STD_1.1.3 |
| REMOTE_HOSTS_LOGGING | OPTIONAL: can be set (any value is ok) and the the counter remote_hosts will log the host names of all remote hosts that has accessed the A1 URIs. If host names cannot be resolved, the ip address of the remote host is logged instead. This logging is default off so must be configured to be enabled. If not configured, the counter remote_hosts will return a fixed text indicating that host name logging is not enabled. Use this feature with caution, remote host lookup may take time in certain environments. | REMOTE_HOSTS_LOGGING=1 |
| DUPLICATE_CHECK | OPTIONAL: can be set to '1' to turn on duplicate check of policy json. A duplicate policy is when the policy json is exactly same as for a different policy id of the same type. This function is default set off if the variable is not set at all or set to '0'. | DUPLICATE_CHECK=0 |
The simulator can also run using the https protocol. The enable https, a valid certificate and key need to provided. There is self-signed certificate available in the certificate dir and that dir shall be mounted to the container to make it available
By default, this image has default certificates under /usr/src/app/cert file "cert.crt" is the certificate file file "key.crt" is the key file file "generate_cert_and_key.sh" is a shell script to generate certificate and key file "pass" stores the password when you run the shell script
Start the a1-interface container without specifing external certificates:
docker run --rm -it -p 8085:8085 -p 8185:8185 -e A1_VERSION=STD_1.1.3 -e REMOTE_HOSTS_LOGGING=1 -e DUPLICATE_CHECK=0 a1testIt will listen to https 8185 port(using default certificates) by default. Http can be enabled on port 8085 using an environment variable "ALLOW_HTTP". If this environment variable is left out or set to false, the nginx server will send "444 Connection Closed Without Response" when making a call using http. Example command to enable http:
docker run -it -p 8085:8085 -p 8185:8185 -e A1_VERSION=OSC_2.1.0 -e ALLOW_HTTP=true -e DUPLICATE_CHECK=0 a1testThis certificates/key can be overriden by mounting a volume when using "docker run" or "docker-compose" In 'docker run', use field: --volume "$PWD/certificate:/usr/src/app/cert" a1test
In 'docker-compose.yml', use field:
volumes:
- ./certificate:/usr/src/app/cert:roIn docker run the full command could look like this:
docker run -it -p 8085:8085 -p 8185:8185 -e A1_VERSION=STD_1.1.3 -e ALLOW_HTTP=true -e REMOTE_HOSTS_LOGGING=1 -e DUPLICATE_CHECK=0 --volume /PATH_TO_CERT_DIR/certificate:/usr/src/app/cert a1testhttp port 8085 and https port 8185
The variable for A1 version is set with the '-e' flag.
With logging of remote host enabled -e REMOTE_HOSTS_LOGGING=1
With policy json duplicate check set to off (0)
With certificate dir mounted --volume /PATH_TO_CERT_DIR/certificate:/usr/src/app/cert
To access the Healthcheck endpoint, you can use curl:
curl http://localhost:8085/a1-p/healthcheckTo access the Swagger UI, open the following URL in your web browser:
The openapi specifications are stored in the 'api/<version>/'. If adding/replacing with a new file, make sure to copy the 'operationId' parameter for each operation to the new file.
See also Basic test and code coverage.
First, download the sim/a1-interface repo on gerrit: git clone "https://gerrit.o-ran-sc.org/oransc/sim/a1-interface"
Go to the main directory, 'a1-interface/near-rt-ric-simulator'. There is a folder 'test/version/' for each supported simulator version. This folder contains a script to build and start the simulator (as a container in interactive mode), a script for basic testing as well as json files for the test script.
Go to the test folder of the selected version, 'test/version/'.
Note that test can be performed both using the nonsecure http port and the secure https port.
Build and start the simulator containers: STD_1.1.3 and OSC_2.1.0, using:
./build_and_start.sh duplicate-check|ignore-duplicateBuild and start the simulator container version STD_2.0.0, using two alternatives: ext-srv or kafka-srv. However, both can not be used at the same time to start A1 sim.
In order to start with ext-srv:
./build_and_start.sh duplicate-check|ignore-duplicate ext-srv|ext-srv-secure|ignore-ext-srvIn order to start with kafka-srv:
./build_and_start.sh duplicate-check|ignore-duplicate kafka-srv|kafka-srv-secure publish-resp|ignore-publishSTD_2.0.0 version is now including an external server that is a Python server building RESTful API. The external server supports HTTP/HTTPS protocols. The description of the start parameters are explained below: ext-srv: Runs external server that supports HTTP protocol only. ext-srv-secure: Runs external server that supports HTTPS protocol as well. ignore-ext-srv: Ignores external server to run.
STD_2.0.0 version also includes an kafka message dispatcher that is a Python server building RESTful APIs. The kafka server supports HTTP/HTTPS protocols. The description of the start parameters are explained below: kafka-srv: Runs kafka server that supports HTTP protocol only. kafka-srv-secure: Runs kafka server that supports HTTPS protocol as well. publish-resp: The flag controls the dispatcher module to decide auto responding to each requests for test purposes only. ignore-publish: If the A1 sim is being started using ignore flag, then the dispatcher module will look for a respone message published by south-bound module.
This will build and start the container in interactive mode. The built container only resides in the local docker repository. Note, the default port is 8085 for http and 8185 for https. When running the simulator as a container, the defualt ports can be re-mapped to any port on the localhost.
In a second terminal, go to the same folder and run the basic test script, basic_test.sh nonsecure|secure or commands.sh nonsecure|secure duplicate-check|ignore-duplicate for STD_1.1.3 and OSC_2.1.0 versions.
For the STD_2.0.0 version, in a second terminal, go to the same folder and run the basic test script for external server activated case:
./basic_test.sh nonsecure|secure duplicate-check|ignore-duplicate ext-srv|ext-srv-secure|ignore-ext-srvThe description of the test script parameters are explained below: nonsecure|secure: Runs test cases with either support of HTTP/HTTPS protocol. duplicate-check|ignore-duplicate: Runs test cases with either support of duplicate/ignore-duplicate flag for the policies. ext-srv|ext-srv-secure|ignore-ext-srv: If the simulator started with ext-srv or ext-srv-secure parameter, then one of these options can be used. Otherwise, ignore-ext-srv parameter should be used.
For the STD_2.0.0 version, in a second terminal, go to the same folder and run the basic test script for kafka dispatcher server activated case:
./basic_test.sh nonsecure|secure duplicate-check|ignore-duplicate ext-srv|ext-srv-secure|ignore-ext-srvThe description of the test script parameters are explained below: nonsecure|secure: Runs test cases with either support of HTTP/HTTPS protocol. duplicate-check|ignore-duplicate: Runs test cases with either support of duplicate/ignore-duplicate flag in accordance with the one which used while starting A1 sim. ext-srv|ext-srv-secure|ignore-ext-srv: If the simulator started with kafka-srv or kafka-srv-secure parameter, then ignore-ext-srv option should be used.
Note that the arg for duplicate check must match in both scripts. This script runs a number of tests towards the simulator to make sure it works properply.
Basic test, or unit test, using a python script is also supported. This test basically the same thing as the bash script mentioned in the section above. Follow the instruction of how to clone the repo described in that section. Only http is tested as the internal flask server is only using http (https is part of the webserver inteface).
Navigate to 'near-rt-ric-simulator/tests'. Choose the version to test and use that file for test.
Use python3 -m pytest <filename> to run unit test only with no coverage check. Before running that command, the dependencies which are pytest and connexion should be installed in your virtual environment. If the latest connexion version arises DeprecationWarning, you may try to install connexion with version 2.6.0.
Or use coverage run -m pytest <filename> to run unit test and produce coverage data.
List coverage data by coverage report -m --include=../../* - the include flag makes the list to only contain coverage data from the simulator python file.
To use the 'coverage' cmd, coverage need to be installed use pip install coverage
Copyright (C) 2023 Nordix Foundation. 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.
For more information about license please see the LICENSE file for details.