1## Features of OpenBMC Test Automation ## 2 3**Interface Feature List** 4* REST 5* DMTF Redfish 6* Out-of-band IPMI 7* SSH to BMC and Host OS 8 9**Key Feature List** 10* Power on/off 11* Reboot Host 12* Reset BMC 13* Code update BMC and host 14* Power management 15* Fan controller 16* HTX bootme 17* XCAT execution 18* Network 19* IPMI support (generic and DCMI compliant) 20* Factory reset 21* RAS (Reliability, availability and serviceability) 22* Web UI testing 23* Secure boot 24* SNMP (Simple Network Management Protocol) 25* Remote Logging via Rsyslog 26* LDAP (Lightweight Directory Access Protocol) 27* Certificate 28* Local User Management(Redfish/IPMI) 29* DateTime 30* Event Logging 31 32**Debugging Supported List** 33* SOL collection 34* FFDC collection 35* Error injection from host 36 37## Installation Setup Guide ## 38* [Robot Framework Install Instruction](https://github.com/robotframework/robotframework/blob/master/INSTALL.rst) 39 40* Miscellaneous 41Packages required to be installed for OpenBmc Automation. 42Install the packages and it's dependencies via `pip` 43 44 REST base packages: 45 ``` 46 $ pip install -U requests 47 $ pip install -U robotframework-requests 48 $ pip install -U robotframework-httplibrary 49 ``` 50 51 Python redfish library packages: 52 For more detailed intstructions see [python-redfish-library](https://github.com/DMTF/python-redfish-library) 53 ``` 54 $ pip install redfish 55 ``` 56 57 SSH and SCP base packages: 58 For more detailed installation instructions see [robotframework-sshlibrary](https://pypi.python.org/pypi/robotframework-sshlibrary) 59 ``` 60 $ pip install robotframework-sshlibrary 61 $ pip install robotframework-scplibrary 62 ``` 63 64 Installing tox: 65 ``` 66 $ pip install -U tox 67 ``` 68 69If using Python 3.x, use the corresponding `pip3` to install packages. 70 71## OpenBMC Test Development ## 72 73These documents contain details on developing OpenBMC test code and debugging. 74 75 - [MAINTAINERS](MAINTAINERS): OpenBMC test code maintainers information. 76 - [CONTRIBUTING.md](CONTRIBUTING.md): Coding guidelines. 77 - [REST-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md): Quick reference for some common 78 curl commands required for legacy REST testing. 79 - [REDFISH-cheatsheet.md](https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md): Quick reference for some common 80 curl commands required for redfish testing. 81 - [README.md](https://github.com/openbmc/phosphor-webui/blob/master/README.md): Web UI setup reference. 82 - [Tools.md](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_tools.md): Reference information for helper tools. 83 - [Corporate CLA and Individual CLA](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server): Submitting changes via Gerrit server 84 85## Testing Setup Steps ## 86 87To verify the installation setup is completed and ready to execute. 88 89* Download the openbmc-test-automation repository: 90 ``` 91 $ git clone https://github.com/openbmc/openbmc-test-automation 92 $ cd openbmc-test-automation 93 ``` 94* Execute basic setup test run: 95 ``` 96 $ robot -v OPENBMC_HOST:xx.xx.xx.xx templates/test_openbmc_setup.robot 97 ``` 98 where xx.xx.xx.xx is the BMC hostname or IP. 99 100## Test Layout ## 101 102There are several sub-directories within the openbmc-test-automation base which 103contain test suites, tools, templates, etc. These sub-directories are 104classified as follows: 105 106`tests/`: Contains the general test cases for OpenBMC stack functional 107 verification. The "tests" subdirectory uses legacy REST and will be 108 deprecated at some point and therefore no longer supported. 109 110`extended/`: Contains test cases for boot testing, code update testing using legacy REST, etc. 111 112`systest/`: Contains test cases for HTX bootme testing. 113 114`xcat/`: Contains test cases for XCAT automation. 115 116`gui/`: Contains test cases for web UI and security scanning tool automation. 117 118`snmp/`: Contains test cases for SNMP (Simple Network Management Protocol) 119 configuration testing. 120 121`openpower/ras/`: Contains test cases for RAS (Reliability, Availability and 122 Serviceability) for an OpenPOWER system. 123 124`openpower/secureboot/`: Contains test cases for secure boot testing on a 125 secure boot feature enabled OpenPOWER system only. 126 127`tools/`: Contains various tools. 128 129`templates/`: Contains sample code examples and setup testing. 130 131`test_list/`: Contains the argument files used for skipping test cases 132 (e.g "skip_test", "skip_test_extended", etc.) or 133 grouping them (e.g "HW_CI", "CT_basic_run", etc.). 134 135 136## Redfish Test Layout ## 137 138OpenBMC is moving steadily towards DTMF Redfish, which is an open industry standard 139specification and schema that meets the expectations of end users for simple, 140modern and secure management of scalable platform hardware. 141 142`redfish/`: Contains test cases for DMTF Redfish-related feature supported on OpenBMC. 143 144`redfish/extended/`: Contains test cases for combined legacy REST and DMTF Redfish-related 145 feature supported on OpenBMC. 146 147 148 149## Quickstart ## 150To run openbmc-automation first you need to install the prerequisite Python 151packages which will help to invoke tests through tox (Note that tox 152version 2.3.1 or greater is required) or via Robot CLI command. 153 154**Robot Command Line** 155 156* Execute all test suites for `tests/`: 157 ``` 158 $ robot -v OPENBMC_HOST:xx.xx.xx.xx tests 159 ``` 160 161* Execute a test suite: 162 ``` 163 $ robot -v OPENBMC_HOST:xx.xx.xx.xx tests/test_basic_poweron.robot 164 ``` 165 166* Initialize the following environment variables which will be used during testing: 167 ``` 168 $ export OPENBMC_HOST=<openbmc machine ip address> 169 $ export OPENBMC_PASSWORD=<openbmc password> 170 $ export OPENBMC_USERNAME=<openbmc username> 171 $ export OPENBMC_MODEL=[./data/Witherspoon.py, ./data/Palmetto.py, etc] 172 $ export IPMI_COMMAND=<Dbus/External> 173 $ export IPMI_PASSWORD=<External IPMI password> 174 ``` 175 176* For QEMU tests, set the following environment variables as well: 177 ``` 178 $ export SSH_PORT=<ssh port number> 179 $ export HTTPS_PORT=<https port number> 180 ``` 181 182* Run tests: 183 ``` 184 $ tox tests 185 ``` 186 187* How to run individual test: 188 189 One specific test: 190 ``` 191 $ tox -e default -- --include Power_On_Test tests/test_basic_poweron.robot 192 ``` 193 No preset environment variables, default configuration for all supported 194 systems: 195 ``` 196 $ OPENBMC_HOST=x.x.x.x tox -e default -- tests 197 ``` 198 No preset environment variables, one test case from a test suite: 199 ``` 200 $ OPENBMC_HOST=x.x.x.x tox -e default -- --include Power_On_Test tests/test_basic_poweron.robot 201 ``` 202 No preset environment variables, the entire test suite: 203 ``` 204 $ OPENBMC_HOST=x.x.x.x tox -e default -- tests 205 ``` 206 207 No preset environment variables, the entire test suite excluding test 208 cases using argument file: 209 ``` 210 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/skip_test tests 211 ``` 212 213 Exclude test list for supported systems: 214 ``` 215 Palmetto: test_lists/skip_test_palmetto 216 Witherspoon: test_lists/skip_test_witherspoon 217 ``` 218 219 220* Run IPMI tests: 221 222 Running only out-of-band IPMI tests: 223 ``` 224 $ robot -v IPMI_COMMAND:External -v OPENBMC_HOST:x.x.x.x --argumentfile test_lists/witherspoon/skip_inband_ipmi tests/ipmi/ 225 ``` 226 227 Running only inband IPMI tests: 228 ``` 229 $ robot -v IPMI_COMMAND:Inband -v OPENBMC_HOST:x.x.x.x -v OS_HOST:x.x.x.x -v OS_USERNAME:xxxx -v OS_PASSWORD:xxxx --argumentfile test_lists/witherspoon/skip_oob_ipmi tests/ipmi/ 230 ``` 231 232 233* Run GUI tests: 234 235 By default, GUI runs with Firefox browser and headless mode. Example with chrome browser and header mode: 236 ``` 237 $ robot -v OPENBMC_HOST:x.x.x.x -v GUI_BROWSER:gc -v GUI_MODE:header gui/test/ 238 ``` 239 240 Run GUI default CI test bucket: 241 ``` 242 $ robot -v OPENBMC_HOST:x.x.x.x --argumentfile test_lists/BMC_WEB_CI gui/test/ 243 ``` 244 245* Run LDAP tests: 246 247 Before using LDAP test functions, be sure appropriate LDAP user(s) and group(s) have been created on your LDAP server. 248 Note: There are multiple ways to create LDAP users / groups and all depend on your LDAP server. 249 One common way for openldap is ldapadd / ldapmodify refer https://linux.die.net/man/1/ldapadd 250 For ldapsearch, refer to "https://linux.die.net/man/1/ldapsearch". 251 Microsoft ADS: refer to https://searchwindowsserver.techtarget.com/definition/Microsoft-Active-Directory-Domain-Services-AD-DS 252 253 Note: Currently, LDAP test automation for Redfish API is in progress. The format to invoke LDAP test is as follows: 254 ``` 255 $ cd redfish/account_service/ 256 $ robot -v OPENBMC_HOST:x.x.x.x -v LDAP_SERVER_URI:<ldap(s)//LDAP Hostname / IP> -v LDAP_BIND_DN:<LDAP Bind DN> -v LDAP_BASE_DN:<LDAP Base DN> -v LDAP_BIND_DN_PASSWORD:<LDAP Bind password> -v LDAP_SEARCH_SCOPE:<LDAP search scope> -v LDAP_SERVER_TYPE:<LDAP server type> -v LDAP_USER:<LDAP user-id> -v LDAP_USER_PASSWORD:<LDAP PASSWORD> -v GROUP_NAME:<Group Name> -v GROUP_PRIVILEGE:<Privilege> ./test_ldap_configuration.robot 257 ``` 258 259* How to run CI and CT bucket test: 260 261 Default CI test bucket list: 262 ``` 263 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests 264 ``` 265 266 Default CI smoke test bucket list: 267 ``` 268 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/CT_basic_run tests 269 ``` 270 271* Run extended tests: 272 273 For-loop test (default iteration is 10): 274 ``` 275 $ robot -v OPENBMC_HOST:x.x.x.x -v OPENBMC_SYSTEMMODEL:xxxxxx -v ITERATION:n -v LOOP_TEST_COMMAND:xxxxxx extended/full_suite_regression.robot 276 ``` 277 278 Example using tox testing a test suite for 5 iterations "witherspoon": 279 ``` 280 OPENBMC_HOST=x.x.x.x LOOP_TEST_COMMAND="tests/test_fw_version.robot" ITERATION=5 OPENBMC_SYSTEMMODEL=witherspoon tox -e witherspoon -- ./extended/full_suite_regression.robot 281 ``` 282 283**Jenkins jobs tox commands** 284* HW CI tox command: 285 ``` 286 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests 287 ``` 288 289## Code Update ## 290 291Currently supported BMC and PNOR update formats are UBI and non-UBI. 292For code update information, please refer to [code-update.md](https://github.com/openbmc/docs/blob/master/code-update/code-update.md) 293 294 295* UBI Format * 296 297 For BMC code update, download the system type *.ubi.mdt.tar image from 298 https://openpower.xyz/job/openbmc-build/ and run as follows: 299 300 For Witherspoon system: 301 ``` 302 $ cd extended/code_update/ 303 $ robot -v OPENBMC_HOST:x.x.x.x -v IMAGE_FILE_PATH:<image path>/obmc-phosphor-image-witherspoon.ubi.mtd.tar --include REST_BMC_Code_Update bmc_code_update.robot 304 ``` 305 306 For host code update, download the system type *.pnor.squashfs.tar image 307 from https://openpower.xyz/job/openpower-op-build/ and run as follows: 308 309 For Witherspoon system: 310 ``` 311 $ cd extended/code_update/ 312 $ robot -v OPENBMC_HOST:x.x.x.x -v IMAGE_FILE_PATH:<image path>/witherspoon.pnor.squashfs.tar --include REST_Host_Code_Update host_code_update.robot 313 ``` 314 315* Non-UBI Format * 316 317 For BMC code update, download the system type *all.tar image from 318 https://openpower.xyz/job/openbmc-build/ and run as follows: 319 320 For a Zaius system: 321 ``` 322 $ cd extended/code_update/ 323 $ robot -v OPENBMC_HOST:x.x.x.x -v FILE_PATH:<image path>/zaius-<date time>.all.tar --include Initiate_Code_Update_BMC update_bmc.robot 324 ``` 325 326 For host code update, download the system type *.pnor from 327 https://openpower.xyz/job/openpower-op-build/ and run as follows: 328 329 For a Zaius system: 330 ``` 331 $ cd extended/ 332 $ robot -v OPENBMC_HOST:x.x.x.x -v PNOR_IMAGE_PATH:<image path>/zaius.pnor test_bios_update.robot 333 ``` 334