diff --git a/README.md b/README.md index 5599f3e5faf025eca5ea3f28a9625d72c5717a91..a73001ada8baa260fce04cb7bfc6fb746cfd018e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,5 @@ -Configuring the simulator - -Goto the main directory, near-rt-ric-simulator. +Configuring the simulator: Goto near-rt-ric-simulator directory. Note that test can be performed both using the nonsecure http port and the secure https port. -Build and start the simulator container using: ./build_and_start.sh 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 depending on version. This script runs a number of tests towards the simulator to make sure it works properply. - -Basic test and code coverage - -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 ' to run unit test only with no coverage check - -Or use 'coverage run -m pytest ' 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' +Use 'python3 main.py to run the server.