README: Update CLI and test directory layout documentation.
Change-Id: I50fcf3a8636995970039b0573aa6b70d68b8923a
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/README.md b/README.md
index 9006f87..68e2839 100755
--- a/README.md
+++ b/README.md
@@ -53,10 +53,44 @@
```
where xx.xx.xx.xx is the BMC hostname or IP.
+## Test Layout ##
+
+There are several sub-directories within the openbmc-test-automation base which
+contain test suites, tools, templates, etc. These sub-directories are
+classified as follows:
+
+`tests/`: Contains the general test cases for OpenBMC stack functional
+ verification.
+
+`extended/`: Contains test cases for boot testing, network testing,
+ code update, RAS (Reliability, availability and serviceability)
+ testing, etc.
+
+`systest/`: Contains test cases for HTX bootme.
+
+`xcat/`: Contains test cases for XCAT automation.
+
+`tools/`: Contains various tools.
+
+`templates/`: Contains sample code examples and setup testing.
+`
+
## Quickstart ##
-To run openbmc-automation first you need to install the prerequisite python
-packages which will help to invoke tests through tox. Note that tox
-version 2.3.1 or greater is required.
+To run openbmc-automation first you need to install the prerequisite Python
+packages which will help to invoke tests through tox (Note that tox
+version 2.3.1 or greater is required) or via Robot CLI command.
+
+**Robot Command Line**
+
+* Execute all test suites for `tests/`:
+ ```
+ $ robot -v OPENBMC_HOST:xx.xx.xx.xx tests
+ ```
+* Execute a test suite:
+ ```
+ $ robot -v OPENBMC_HOST:xx.xx.xx.xx tests/test_basic_poweron.robot
+ ```
+**Tox Command Line**
Install the python dependencies for tox
```shell
@@ -74,23 +108,7 @@
$ export IPMI_PASSWORD=<External IPMI password>
```
-There are two different set of test suite existing based on the usage.
-The test suites are distinctly separated by directory as under
- tests/
- extended/
-
-`tests`: directory contains the general test cases
-
-`extended`: directory contains the use cases for new IP network testing, PDU,
-BIOS and BMC code update.
-
```shell
-Use Following Variables for networking test cases
-===========================================================
- $export NEW_BMC_IP=<openbmc machine ip address>
- $export NEW_SUBNET_MASK=<openbmc new subnet mask>
- $export NEW_GATEWAY=<openbmc new gateway>
-==========================================================
Use following parameters for PDU:
$ export PDU_IP=<PDU IP address>
@@ -101,11 +119,6 @@
for PDU_TYPE we support only synaccess at the moment
-Use following variables for syslog test cases
-==========================================================
- $ export SYSLOG_IP_ADDRESS=<remote syslog system ip>
- $ export SYSLOG_PORT=<remote syslog system port>
-
Use the following variables for Qemu test run
==========================================================
$ export SSH_PORT=<ssh port number>