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* IO storage and EEH (Enhanced Error Handling) testing 24* Secure boot 25* SNMP (Simple Network Management Protocol) 26* Remote Logging via Rsyslog 27* LDAP (Lightweight Directory Access Protocol) 28* Certificate 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](https://github.com/openbmc/docs/blob/master/MAINTAINERS): OpenBMC 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 testing. 77 - [README.md](https://github.com/openbmc/phosphor-webui/blob/master/README.md): Web UI setup reference. 78 - [Tools.md](https://github.com/openbmc/openbmc-test-automation/blob/master/docs/openbmc_test_tools.md): Reference information for helper tools. 79 - [Corporate CLA and Individual CLA](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server): Submitting changes via Gerrit server 80 81## Testing Setup Steps ## 82 83To verify the installation setup is completed and ready to execute. 84 85* Download the openbmc-test-automation repository: 86 ``` 87 $ git clone https://github.com/openbmc/openbmc-test-automation 88 $ cd openbmc-test-automation 89 ``` 90* Execute basic setup test run: 91 ``` 92 $ robot -v OPENBMC_HOST:xx.xx.xx.xx templates/test_openbmc_setup.robot 93 ``` 94 where xx.xx.xx.xx is the BMC hostname or IP. 95 96## Test Layout ## 97 98There are several sub-directories within the openbmc-test-automation base which 99contain test suites, tools, templates, etc. These sub-directories are 100classified as follows: 101 102`tests/`: Contains the general test cases for OpenBMC stack functional 103 verification. The "tests" subdirectory uses legacy REST and will be 104 deprecated at some point and therefore no longer supported. 105 106`extended/`: Contains test cases for boot testing, code update testing, etc. 107 108`systest/`: Contains test cases for HTX bootme, IO storage and EEH testing. 109 110`xcat/`: Contains test cases for XCAT automation. 111 112`gui/`: Contains test cases for web UI and security scanning tool automation. 113 114`network/`: Contains test cases for network testing. It covers IPv4 in static mode 115 and in DHCP mode. 116 117`snmp/`: Contains test cases for SNMP (Simple Network Management Protocol) 118 configuration testing. 119 120`remote_logging`: Contains test cases for remote logging via rsyslog. 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 146## Quickstart ## 147To run openbmc-automation first you need to install the prerequisite Python 148packages which will help to invoke tests through tox (Note that tox 149version 2.3.1 or greater is required) or via Robot CLI command. 150 151**Robot Command Line** 152 153* Execute all test suites for `tests/`: 154 ``` 155 $ robot -v OPENBMC_HOST:xx.xx.xx.xx tests 156 ``` 157 158* Execute a test suite: 159 ``` 160 $ robot -v OPENBMC_HOST:xx.xx.xx.xx tests/test_basic_poweron.robot 161 ``` 162 163* Initialize the following environment variables which will be used during testing: 164 ``` 165 $ export OPENBMC_HOST=<openbmc machine ip address> 166 $ export OPENBMC_PASSWORD=<openbmc password> 167 $ export OPENBMC_USERNAME=<openbmc username> 168 $ export OPENBMC_MODEL=[./data/Witherspoon.py, ./data/Palmetto.py, etc] 169 $ export IPMI_COMMAND=<Dbus/External> 170 $ export IPMI_PASSWORD=<External IPMI password> 171 ``` 172 173* For QEMU tests, set the following environment variables as well: 174 ``` 175 $ export SSH_PORT=<ssh port number> 176 $ export HTTPS_PORT=<https port number> 177 ``` 178 179* Run tests: 180 ``` 181 $ tox -e tests 182 ``` 183 184* How to run individual test: 185 186 One specific test: 187 ``` 188 $ tox -e default -- --include Power_On_Test tests/test_basic_poweron.robot 189 ``` 190 No preset environment variables, default configuration for all supported 191 systems: 192 ``` 193 $ OPENBMC_HOST=x.x.x.x tox -e default -- tests 194 ``` 195 No preset environment variables, one test case from a test suite: 196 ``` 197 $ OPENBMC_HOST=x.x.x.x tox -e default -- --include Power_On_Test tests/test_basic_poweron.robot 198 ``` 199 No preset environment variables, the entire test suite: 200 ``` 201 $ OPENBMC_HOST=x.x.x.x tox -e default -- tests 202 ``` 203 204 No preset environment variables, the entire test suite excluding test 205 cases using argument file: 206 ``` 207 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/skip_test tests 208 ``` 209 210 Exclude test list for supported systems: 211 ``` 212 Palmetto: test_lists/skip_test_palmetto 213 Witherspoon: test_lists/skip_test_witherspoon 214 ``` 215 216 217* Run IPMI tests: 218 219 Running only out-of-band IPMI tests: 220 ``` 221 $ robot -v IPMI_COMMAND:External -v OPENBMC_HOST:x.x.x.x --argumentfile test_lists/witherspoon/skip_inband_ipmi tests/ipmi/ 222 ``` 223 224 Running only inband IPMI tests: 225 ``` 226 $ 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/ 227 ``` 228 229 230* Run GUI tests: 231 232 By default, GUI runs with Firefox browser and headless mode. Example with chrome browser and header mode: 233 ``` 234 $ robot -v OPENBMC_HOST:x.x.x.x -v GUI_BROWSER:gc -v GUI_MODE:header gui/obmc_gui/test/ 235 ``` 236 237 Run GUI default CI test bucket: 238 ``` 239 $ robot -v OPENBMC_HOST:x.x.x.x --argumentfile test_lists/BMC_WEB_CI gui/obmc_gui/test/ 240 ``` 241 242* Run LDAP tests: 243 244 Before using LDAP test functions, be sure appropriate LDAP user(s) and group(s) have been created on your LDAP server. 245 Note: There are multiple ways to create LDAP users / groups and all depend on your LDAP server. 246 One common way for openldap is ldapadd / ldapmodify refer https://linux.die.net/man/1/ldapadd 247 For ldapsearch, refer to "https://linux.die.net/man/1/ldapsearch". 248 Microsoft ADS: refer to https://searchwindowsserver.techtarget.com/definition/Microsoft-Active-Directory-Domain-Services-AD-DS 249 ``` 250 $ cd tests_ldap/ 251 $ 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_user_ldap_management.robot 252 ``` 253 254* How to run CI and CT bucket test: 255 256 Default CI test bucket list: 257 ``` 258 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests 259 ``` 260 261 Default CI smoke test bucket list: 262 ``` 263 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/CT_basic_run tests 264 ``` 265 266* Run extended tests: 267 268 For-loop test (default iteration is 10): 269 ``` 270 $ 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 271 ``` 272 273 Example using tox testing a test suite for 5 iterations "witherspoon": 274 ``` 275 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 276 ``` 277 278**Jenkins jobs tox commands** 279* HW CI tox command: 280 ``` 281 $ OPENBMC_HOST=x.x.x.x tox -e default -- --argumentfile test_lists/HW_CI tests 282 ``` 283 284## Code Update ## 285 286Currently supported BMC and PNOR update formats are UBI and non-UBI. 287For code update information, please refer to [code-update.md](https://github.com/openbmc/docs/blob/master/code-update/code-update.md) 288 289 290* UBI Format * 291 292 For BMC code update, download the system type *.ubi.mdt.tar image from 293 https://openpower.xyz/job/openbmc-build/ and run as follows: 294 295 For Witherspoon system: 296 ``` 297 $ cd extended/code_update/ 298 $ 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 299 ``` 300 301 For host code update, download the system type *.pnor.squashfs.tar image 302 from https://openpower.xyz/job/openpower-op-build/ and run as follows: 303 304 For Witherspoon system: 305 ``` 306 $ cd extended/code_update/ 307 $ 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 308 ``` 309 310* Non-UBI Format * 311 312 For BMC code update, download the system type *all.tar image from 313 https://openpower.xyz/job/openbmc-build/ and run as follows: 314 315 For a Zaius system: 316 ``` 317 $ cd extended/code_update/ 318 $ 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 319 ``` 320 321 For host code update, download the system type *.pnor from 322 https://openpower.xyz/job/openpower-op-build/ and run as follows: 323 324 For a Zaius system: 325 ``` 326 $ cd extended/ 327 $ robot -v OPENBMC_HOST:x.x.x.x -v PNOR_IMAGE_PATH:<image path>/zaius.pnor test_bios_update.robot 328 ``` 329