| --------------------- | ------------------- |
| 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 section 'Configuring the simulator' below for details about how to the start the simulator with the intended version id.
|. |Dockerfile and README |
|api |The open api yaml for each supported version |
|src |Python source code for each supported version |
-|test |Basic test |
+|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 that are 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.
| 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} |
+| 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](https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/simulator-api.html#a1-standard-1-1-3).
| POST, send status for policy | http://localhost:8085/sendstatus?policyid=<policyid> |
| GET a counter <br> (counter-name: 'num\_instances', 'num\_types'(always 0), 'interface' or 'remote\_hosts') | http://localhost:8085/counter/<counter-name> |
+# Supported operations in simulator A1 Standard 2.0.0
+
+For the complete yaml specification, see [ORAN_A1-p_V2.0.0_api.yaml](../near-rt-ric-simulator/api/STD_2.0.0/ORAN_A1-p_V2.0.0_api.yaml).
+
+URIs for A1:
+| Function | Path and parameters |
+| --------------------- | ------------------- |
+| GET all policy type identities | http://localhost:8085/A1-P/v2/policytypes |
+| GET a policy type | http://localhost:8085/A1-P/v2/policytypes/{policyTypeId} |
+| GET all policy identities | http://localhost:8085/A1-P/v2/policytypes/{policyTypeId}/policies |
+| PUT a policy instance(create or update it) | http://localhost:8085/A1-P/v2/policytypes/{policyTypeId}/policies/{policyId} |
+| GET a policy | http://localhost:8085/A1-P/v2/policytypes/{policyTypeId}/policies/{policyId} |
+| DELETE a policy instance | http://localhost:8085/A1-P/v2/policytypes/{policyTypeId}/policies/{policyId} |
+| GET a policy status | http://localhost:8085/A1-P/v2/policytypes/{policyTypeId}/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](https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface/en/latest/simulator-api.html#a1-standard-2-0-0).
+
+URIs for admin operations:
+| 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 |
+| PUT, create/update a policy type | http://localhost:8085/policytype?id=<policytypeid> |
+| DELETE, delete a policy type | http://localhost:8085/policytype?id=<policytypeid> |
+| GET, list of policy type id | http://localhost:8085/policytypes |
+| 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> |
+| POST, deliver data | http://localhost:8085/datadelivery |
+| GET a counter <br> (counter-name: 'num\_instances', 'num\_types'(always 0), 'interface', 'remote\_hosts' or 'datadelivery') | http://localhost:8085/counter/<counter-name> |
+
# Configuring the simulator
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'. This location contains one dir for each simulator version. Choose the version to test and go to that sub dir.
+Navigate to 'near-rt-ric-simulator/tests'. Choose the version to test and use that file for test.
-Use 'python3 -m unittest' to run unit test only with no coverage check
+Use 'python3 -m pytest <filename>' to run unit test only with no coverage check
-Or use 'coverage run -m unittest' to run unit test and produce coverage data.
+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'
Code Review / sim / a1-interface.git / blobdiff