Minor updates to README file
Add some notes on qemu testing and exclude lists.
Small formatting and capitalization changes.
Change-Id: Ic840f3a56c369bb9e1faaa90bae86760a253c4de
Signed-off-by: Matt Fischer <matthew.fischer@hpe.com>
diff --git a/README.md b/README.md
index 67b9204..5b8e1d5 100644
--- a/README.md
+++ b/README.md
@@ -88,10 +88,10 @@
$ pip install -U tox
```
-Installing expect:
+Installing expect (Ubuntu example):
```
- $ sudo apt-get install expect (Ubuntu example)
+ $ sudo apt-get install expect
```
## OpenBMC Test Development
@@ -133,14 +133,18 @@
To verify the installation setup is completed and ready to execute.
- Download the openbmc-test-automation repository:
+
```
$ git clone https://github.com/openbmc/openbmc-test-automation
$ cd openbmc-test-automation
```
+
- Execute basic setup test run:
+
```
$ robot -v OPENBMC_HOST:xx.xx.xx.xx templates/test_openbmc_setup.robot
```
+
where xx.xx.xx.xx is the BMC hostname or IP.
## Test Layout
@@ -245,60 +249,72 @@
-v OPENBMC_PASSWORD:<openbmc password>
```
-- For QEMU tests, set the following environment variables as well:
+- Testing in qemu:
+
+ Set extra environment variables:
```
$ export SSH_PORT=<ssh port number>
$ export HTTPS_PORT=<https port number>
```
+ Run the QEMU CI test suite (not all tests will pass in qemu):
+
+ ```
+ $ OPENBMC_HOST=x.x.x.x SSH_PORT=<port number> HTTPS_PORT=<port number> robot -A test_lists/QEMU_CI tests/
+ ```
+
- Run tests:
```
$ tox tests
```
-- How to run individual test:
-
- One specific test:
+- How to run an individual test:
```
$ tox -e default -- --include Power_On_Test tests/test_basic_poweron.robot
```
- No preset environment variables, default configuration for all supported
+- No preset environment variables, default configuration for all supported
systems:
```
$ OPENBMC_HOST=x.x.x.x tox -e default -- tests
```
- No preset environment variables, one test case from a test suite:
+- No preset environment variables, one test case from a test suite:
```
$ OPENBMC_HOST=x.x.x.x tox -e default -- --include Power_On_Test tests/test_basic_poweron.robot
```
- No preset environment variables, the entire test suite:
+- No preset environment variables, the entire test suite:
```
$ OPENBMC_HOST=x.x.x.x tox -e default -- tests
```
- No preset environment variables, the entire test suite excluding test cases
+- No preset environment variables, the entire test suite excluding test cases
using argument file:
```
$ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/skip_test tests
```
- Exclude test list for supported systems:
+- Exclude test list for supported systems:
```
Palmetto: test_lists/skip_test_palmetto
Witherspoon: test_lists/skip_test_witherspoon
```
+ Using the exclude lists (example for Witherspoon)
+
+ ```
+ $ robot -v OPENBMC_HOST:xx.xx.xx.xx -A test_lists/skip_test_witherspoon tests/
+ ```
+
- Run IPMI tests:
Running only out-of-band IPMI tests:
@@ -316,7 +332,7 @@
- Run GUI tests:
By default, GUI runs with Firefox browser and headless mode. Example with
- chrome browser and header mode:
+ Chrome browser and header mode:
```
$ robot -v OPENBMC_HOST:x.x.x.x -v GUI_BROWSER:gc -v GUI_MODE:header gui/test/
@@ -388,6 +404,7 @@
**Jenkins jobs tox commands**
- HW CI tox command:
+
```
$ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests
```