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