Standardisation of names

[nonrtric.git] / near-rt-ric-simulator / auto-test / README.md

diff --git a/near-rt-ric-simulator/auto-test/README.md b/near-rt-ric-simulator/auto-test/README.md
index 319137a..9aac651 100644 (file)
--- a/near-rt-ric-simulator/auto-test/README.md
+++ b/near-rt-ric-simulator/auto-test/README.md
@@ -1,17 +1,17 @@
 
 ## Automated test Description
-This auto-test repo stores test script for automated test cases for policy agent. 
-Each of the testcase script will bring up a containerized test enviroment for Policy Agent, 
-CBS, consul, and simulator(TBD)
+This auto-test repo stores test script for automated test cases for Policy Agent.
+Each of the testcase script will bring up a containerized test enviroment for Policy Agent,
+CBS, consul, and simulator(TBD).
 
-### Overveiw
+### Overview
 
 Right now, test cases are written in bash scripts. \
 Each test case script(ex. `FTC1.sh)` will call functions defined in `../common`. \
 The environment vriables are set in`test_env.sh`. \
-The automated test support both local build policy agent image testing and remote image stored in Nexus.   
+The automated test support both local build Policy Agent image testing and remote image stored in Nexus.
 ```
-# Lcal image 
+# Local image
 export POLICY_AGENT_LOCAL_IMAGE=o-ran-sc/nonrtric-policy-agent
 # Remote image
 export POLICY_AGENT_REMOTE_IMAGE=nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-policy-agent
@@ -21,9 +21,9 @@ export POLICY_AGENT_REMOTE_IMAGE=nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-pol
 
 ### Logs
 All log files are stored at `logs/<testcase id>`. \
-The logs include the application.log and the container log from policy agent, the container logs from each simulator and the 
+The logs include the application.log and the container log from Policy Agent, the container logs from each simulator and the
 test case log (same as the screen output). \
-In the test cases the logs are stored with a prefix so the logs can be stored at different steps during the test. 
+In the test cases the logs are stored with a prefix so the logs can be stored at different steps during the test.
 All test cases contains an entry to save all logs with prefix 'END' at the end of each test case.
 
 ### Manual
@@ -38,7 +38,7 @@ remote: test image: nexus3.o-ran-sc.org:10004/o-ran-sc/nonrtric-policy-agent
 
 ### Test case file
 A test case file contains a number of steps to verify a certain functionality.
-A description of the test case should be given to the ``TC_ONELINE_DESCR`` var. The description will be printed in 
+A description of the test case should be given to the ``TC_ONELINE_DESCR`` var. The description will be printed in
 the test result.
 
 The empty template for a test case files looks like this:
@@ -51,7 +51,7 @@ The empty template for a test case files looks like this:
 
 TC_ONELINE_DESCR="<test case description>"
 
-. ../common/testcase_common.sh $1 
+. ../common/testcase_common.sh $1
 
 #### TEST BEGIN ####
 
@@ -66,5 +66,5 @@ store_logs          END
 ```
 -----------------------------------------------------------
 
-The ../common/testcase_common.sh contains all functions needed for the test case file. See the README.md file in 
+The ../common/testcase_common.sh contains all functions needed for the test case file. See the README.md file in
 the ../common dir for a description of all available functions.
\ No newline at end of file