1*** Settings *** 2Resource ../lib/resource.txt 3Resource ../lib/rest_client.robot 4Resource ../lib/connection_client.robot 5Library DateTime 6Library Process 7Library OperatingSystem 8Library gen_print.py 9Library gen_robot_print.py 10Library gen_cmd.py 11Library gen_robot_keyword.py 12 13*** Variables *** 14${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION 15${SYSTEM_SHUTDOWN_TIME} ${5} 16${dbuscmdBase} 17... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host 18${dbuscmdGet} 19... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get 20# Enable when ready with openbmc/openbmc-test-automation#203 21#${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string: 22${dbuscmdString}= string:"org.openbmc.settings.Host" string: 23 24# Assign default value to QUIET for programs which may not define it. 25${QUIET} ${0} 26${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4 27${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2 28${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9 29${HOST_SETTING} ${SETTINGS_URI}host0 30# /run/initramfs/ro associate filesystem should be 100% full always 31${bmc_file_system_usage_cmd}= 32... df -h | grep -v /run/initramfs/ro | cut -c 52-54 | grep 100 | wc -l 33 34${BOOT_TIME} ${0} 35${BOOT_COUNT} ${0} 36${count} ${0} 37${devicetree_base} /sys/firmware/devicetree/base/model 38 39# Initialize default debug value to 0. 40${DEBUG} ${0} 41 42*** Keywords *** 43 44Verify PNOR Update 45 [Documentation] Verify that the PNOR is not corrupted. 46 # Example: 47 # FFS: Flash header not found. Code: 100 48 # Error 100 opening ffs ! 49 50 Open Connection And Log In 51 ${pnor_info}= Execute Command On BMC ${pflash_cmd} 52 Should Not Contain Any ${pnor_info} Flash header not found Error 53 54Get BMC System Model 55 [Documentation] Get the BMC model from the device tree. 56 57 Open Connection And Log In 58 ${bmc_model} ${stderr}= Execute Command 59 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True 60 Should Be Empty ${stderr} 61 Should Not Be Empty ${bmc_model} 62 [Return] ${bmc_model} 63 64Verify BMC System Model 65 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}. 66 [Arguments] ${bmc_model} 67 68 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} / 69 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} . 70 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model} 71 ... ${tmp_bmc_model} ignore_case=True 72 [Return] ${ret} 73 74Wait For Host To Ping 75 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min 76 ... ${interval}=5 sec 77 78 # host The DNS name or IP of the host to ping. 79 # timeout The amount of time after which attempts to ping cease. 80 # interval The amount of time in between attempts to ping. 81 82 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host} 83 84Ping Host 85 [Arguments] ${host} 86 Should Not Be Empty ${host} msg=No host provided 87 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host} 88 Log RC: ${RC}\nOutput:\n${output} 89 Should be equal ${RC} ${0} 90 91Get Boot Progress 92 [Arguments] ${quiet}=${QUIET} 93 94 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress 95 ... value quiet=${quiet} 96 [Return] ${state} 97 98Is Power On 99 ${state}= Get Power State 100 Should be equal ${state} ${1} 101 102Is Power Off 103 ${state}= Get Power State 104 Should be equal ${state} ${0} 105 106Initiate Power On 107 [Documentation] Initiates the power on and waits until the Is Power On 108 ... keyword returns that the power state has switched to on. 109 [Arguments] ${wait}=${1} 110 111 @{arglist}= Create List 112 ${args}= Create Dictionary data=@{arglist} 113 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn 114 ... data=${args} 115 should be equal as strings ${resp.status_code} ${HTTP_OK} 116 117 # Does caller want to wait for power on status? 118 Run Keyword If '${wait}' == '${0}' Return From Keyword 119 Wait Until Keyword Succeeds 3 min 10 sec Is Power On 120 121Initiate Power Off 122 [Documentation] Initiates the power off and waits until the Is Power Off 123 ... keyword returns that the power state has switched to off. 124 @{arglist}= Create List 125 ${args}= Create Dictionary data=@{arglist} 126 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff 127 ... data=${args} 128 should be equal as strings ${resp.status_code} ${HTTP_OK} 129 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off 130 131Initiate OS Host Power Off 132 [Documentation] Initiate an OS reboot. 133 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME} 134 ... ${os_password}=${OS_PASSWORD} 135 136 # Description of arguments: 137 # os_host The DNS name or IP of the OS. 138 # os_username The username to be used to sign in to the OS. 139 # os_password The password to be used to sign in to the OS. 140 141 SSHLibrary.Open connection ${os_host} 142 Login ${os_username} ${os_password} 143 ${cmd_buf} Catenate shutdown 144 Start Command ${cmd_buf} 145 SSHLibrary.Close Connection 146 147Initiate OS Host Reboot 148 [Documentation] Initiate an OS reboot. 149 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME} 150 ... ${os_password}=${OS_PASSWORD} 151 152 # Description of arguments: 153 # os_host The DNS name or IP of the OS. 154 # os_username The username to be used to sign in to the OS. 155 # os_password The password to be used to sign in to the OS. 156 157 SSHLibrary.Open connection ${os_host} 158 Login ${os_username} ${os_password} 159 ${cmd_buf} Catenate reboot 160 Start Command ${cmd_buf} 161 SSHLibrary.Close Connection 162 163Initiate Auto Reboot 164 [Documentation] Initiate an auto reboot. 165 166 # Set the auto reboot policy. 167 Set Auto Reboot yes 168 # Set the watchdog timer. Note: 5000 = milliseconds which is 5 seconds. 169 Trigger Host Watchdog Error 5000 170 171Trigger Warm Reset 172 log to console "Triggering warm reset" 173 ${data}= create dictionary data=@{EMPTY} 174 ${resp}= openbmc post request 175 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data} 176 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK} 177 ${session_active}= Check If warmReset is Initiated 178 Run Keyword If '${session_active}' == '${True}' 179 ... Fail msg=warm reset didn't occur 180 181 Sleep ${SYSTEM_SHUTDOWN_TIME}min 182 Check If BMC Is Up 183 184Check OS 185 [Documentation] Attempts to ping the host OS and then checks that the host 186 ... OS is up by running an SSH command. 187 188 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME} 189 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET} 190 ... ${print_string}=${EMPTY} 191 [Teardown] SSHLibrary.Close Connection 192 193 # os_host The DNS name/IP of the OS host associated with our BMC. 194 # os_username The username to be used to sign on to the OS host. 195 # os_password The password to be used to sign on to the OS host. 196 # quiet Indicates whether this keyword should write to console. 197 # print_string A string to be printed before checking the OS. 198 199 rprint ${print_string} 200 201 # Attempt to ping the OS. Store the return code to check later. 202 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host} 203 204 SSHLibrary.Open connection ${os_host} 205 206 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username} 207 ... ${os_password} 208 ${err_msg1}= Sprint Error ${msg} 209 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1} 210 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg} 211 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True 212 ... return_rc=True 213 214 ${temp_msg}= Catenate Could not execute a command on the operating 215 ... system.\n 216 ${err_msg1}= Sprint Error ${temp_msg} 217 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1} 218 219 # If the return code returned by "Execute Command" is non-zero, this 220 # keyword will fail. 221 Should Be Equal ${rc} ${0} msg=${err_msg} 222 # We will likewise fail if there is any stderr data. 223 Should Be Empty ${stderr} 224 225 ${temp_msg}= Set Variable Could not ping the operating system.\n 226 ${err_msg1}= Sprint Error ${temp_msg} 227 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1} 228 # We will likewise fail if the OS did not ping, as we could SSH but not 229 # ping 230 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg} 231 232Wait for OS 233 [Documentation] Waits for the host OS to come up via calls to "Check OS". 234 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME} 235 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT} 236 ... ${quiet}=${0} 237 [Teardown] rprintn 238 239 # os_host The DNS name or IP of the OS host associated with our 240 # BMC. 241 # os_username The username to be used to sign on to the OS host. 242 # os_password The password to be used to sign on to the OS host. 243 # timeout The timeout in seconds indicating how long you're 244 # willing to wait for the OS to respond. 245 # quiet Indicates whether this keyword should write to console. 246 247 # The interval to be used between calls to "Check OS". 248 ${interval}= Set Variable 5 249 250 ${message}= Catenate Checking every ${interval} seconds for up to 251 ... ${timeout} seconds for the operating system to communicate. 252 rqprint_timen ${message} 253 254 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS 255 ... ${os_host} ${os_username} ${os_password} 256 ... print_string=\# 257 258 rqprintn 259 260 rqprint_timen The operating system is now communicating. 261 262Get BMC State Deprecated 263 [Documentation] Returns the state of the BMC as a string. (i.e: BMC_READY) 264 [Arguments] ${quiet}=${QUIET} 265 266 @{arglist}= Create List 267 ${args}= Create Dictionary data=@{arglist} 268 ${resp}= Call Method ${OPENBMC_BASE_URI}managers/System/ getSystemState 269 ... data=${args} quiet=${quiet} 270 Should be equal as strings ${resp.status_code} ${HTTP_OK} 271 ${content}= to json ${resp.content} 272 [Return] ${content["data"]} 273 274Get Power State 275 [Documentation] Returns the power state as an integer. Either 0 or 1. 276 [Arguments] ${quiet}=${QUIET} 277 278 @{arglist}= Create List 279 ${args}= Create Dictionary data=@{arglist} 280 281 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState 282 ... data=${args} quiet=${quiet} 283 Should be equal as strings ${resp.status_code} ${HTTP_OK} 284 ${content}= to json ${resp.content} 285 [Return] ${content["data"]} 286 287Clear BMC Record Log 288 [Documentation] Clears all the event logs on the BMC. This would be 289 ... equivalent to ipmitool sel clear. 290 @{arglist}= Create List 291 ${args}= Create Dictionary data=@{arglist} 292 ${resp}= Call Method 293 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args} 294 should be equal as strings ${resp.status_code} ${HTTP_OK} 295 296Copy PNOR to BMC 297 Import Library SCPLibrary WITH NAME scp 298 Open Connection for SCP 299 Log Copying ${PNOR_IMAGE_PATH} to /tmp 300 scp.Put File ${PNOR_IMAGE_PATH} /tmp 301 302Flash PNOR 303 [Documentation] Calls flash bios update method to flash PNOR image 304 [Arguments] ${pnor_image} 305 @{arglist}= Create List ${pnor_image} 306 ${args}= Create Dictionary data=@{arglist} 307 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update 308 ... data=${args} 309 should be equal as strings ${resp.status_code} ${HTTP_OK} 310 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing 311 312Get Flash BIOS Status 313 [Documentation] Returns the status of the flash BIOS API as a string. For 314 ... example 'Flashing', 'Flash Done', etc 315 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios 316 [Return] ${data['status']} 317 318Is PNOR Flashing 319 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR 320 ... flashing has started. 321 ${status}= Get Flash BIOS Status 322 Should Contain ${status} Flashing 323 324Is PNOR Flash Done 325 [Documentation] Get BIOS 'Flash Done' status. This indicates that the 326 ... PNOR flashing has completed. 327 ${status}= Get Flash BIOS Status 328 should be equal as strings ${status} Flash Done 329 330Is System State Host Booted 331 [Documentation] Checks whether system state is HOST_BOOTED. 332 ${state}= Get BMC State Deprecated 333 should be equal as strings ${state} HOST_BOOTED 334 335Is OS Starting 336 [Documentation] Check if boot progress is OS starting. 337 ${boot_progress}= Get Boot Progress 338 Should Be Equal ${boot_progress} FW Progress, Starting OS 339 340Is OS Off 341 [Documentation] Check if boot progress is "Off". 342 ${boot_progress}= Get Boot Progress 343 Should Be Equal ${boot_progress} Off 344 345Verify Ping and REST Authentication 346 ${l_ping}= Run Keyword And Return Status 347 ... Ping Host ${OPENBMC_HOST} 348 Run Keyword If '${l_ping}' == '${False}' 349 ... Fail msg=Ping Failed 350 351 ${l_rest}= Run Keyword And Return Status 352 ... Initialize OpenBMC 353 Run Keyword If '${l_rest}' == '${False}' 354 ... Fail msg=REST Authentication Failed 355 356 # Just to make sure the SSH is working for SCP 357 Open Connection And Log In 358 ${system} ${stderr}= Execute Command hostname return_stderr=True 359 Should Be Empty ${stderr} 360 361Check If BMC is Up 362 [Documentation] Wait for Host to be online. Checks every X seconds 363 ... interval for Y minutes and fails if timed out. 364 ... Default MAX timedout is 10 min, interval 10 seconds. 365 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min 366 ... ${interval}=10 sec 367 368 Wait Until Keyword Succeeds 369 ... ${max_timeout} ${interval} Verify Ping and REST Authentication 370 371 372Check If warmReset is Initiated 373 [Documentation] Ping would be still alive, so try SSH to connect 374 ... if fails the ports are down indicating reboot 375 ... is in progress 376 377 # Warm reset adds 3 seconds delay before forcing reboot 378 # To minimize race conditions, we wait for 7 seconds 379 Sleep 7s 380 ${alive}= Run Keyword and Return Status 381 ... Open Connection And Log In 382 Return From Keyword If '${alive}' == '${False}' ${False} 383 [Return] ${True} 384 385Flush REST Sessions 386 [Documentation] Removes all the active session objects 387 Delete All Sessions 388 389Initialize DBUS cmd 390 [Documentation] Initialize dbus string with property string to extract 391 [Arguments] ${boot_property} 392 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString} 393 ${cmd}= Catenate ${cmd}${boot_property} 394 Set Global Variable ${dbuscmd} ${cmd} 395 396Create OS Console File Path 397 [Documentation] Create OS console file path name and return it. 398 [Arguments] ${log_file_path}=${EMPTY} 399 400 # Description of arguements: 401 # file_path The caller's candidate value. If this value is ${EMPTY}, this 402 # keyword will compose a file path name. Otherwise, this 403 # keyword will use the caller's file_path value. In either 404 # case, the value will be returned. 405 406 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console 407 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}' 408 ... ${default_file_path} ${log_file_path} 409 410 [Return] ${log_file_path} 411 412Create OS Console Command String 413 [Documentation] Return a command string to start OS console logging. 414 415 # First make sure that the ssh_pw program is available. 416 ${cmd_buf}= Catenate which ssh_pw 2>&1 417 Rdpissuing ${cmd_buf} 418 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf} 419 Rdpvars rc output 420 Should Be Equal ${rc} ${0} msg=${output}\n 421 422 ${cmd_buf}= Catenate ssh_pw ${OPENBMC_PASSWORD} -p 2200 423 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST} 424 425 [Return] ${cmd_buf} 426 427Stop SOL Console Logging 428 [Documentation] Stop system console logging and return log output. 429 [Arguments] ${log_file_path}=${EMPTY} ${targ_file_path}=${EMPTY} 430 ... ${return_data}=${1} 431 432 # If there are muliple system console processes, they will all be stopped. 433 # If there is no existing log file this keyword will return an error 434 # message to that effect (and write that message to targ_file_path, if 435 # specified). 436 # NOTE: This keyword will not fail if there is no running system console 437 # process. 438 439 # Description of arguments: 440 # log_file_path The file path that was used to call "Start SOL 441 # Console Logging". See that keyword (above) for details. 442 # targ_file_path If specified, the file path to which the source 443 # file path (i.e. "log_file_path") should be copied. 444 # return_data If this is set to ${1}, this keyword will return the SOL 445 # data to the caller as a unicode string. 446 447 ${log_file_path}= Create OS Console File Path ${log_file_path} 448 # Find the pid of the active system console logging session (if any). 449 ${search_string}= Create OS Console Command String 450 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}' 451 ... | egrep -v grep | cut -c10-14) 452 Rdpissuing ${cmd_buf} 453 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf} 454 Rdpvars os_con_pid 455 # If rc is not zero it just means that there is no OS Console process 456 # running. 457 458 ${cmd_buf}= Catenate kill -9 ${os_con_pid} 459 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf} 460 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}' 461 ... Run And Return Rc And Output ${cmd_buf} 462 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output 463 464 Run Keyword If '${targ_file_path}' != '${EMPTY}' 465 ... Run Keyword And Ignore Error 466 ... Copy File ${log_file_path} ${targ_file_path} 467 468 ${output}= Set Variable ${EMPTY} 469 ${loc_quiet}= Evaluate ${debug}^1 470 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}' 471 ... Cmd Fnc cat ${log_file_path} quiet=${loc_quiet} print_output=${0} 472 473 [Return] ${output} 474 475Start SOL Console Logging 476 [Documentation] Start system console log to file. 477 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1} 478 479 # This keyword will first call "Stop SOL Console Logging". Only then will 480 # it start SOL console logging. The data returned by "Stop SOL Console 481 # Logging" will in turn be returned by this keyword. 482 483 # Description of arguments: 484 # log_file_path The file path to which system console log data should be 485 # written. Note that this path is taken to be a location 486 # on the machine where this program is running rather than 487 # on the Open BMC system. 488 # return_data If this is set to ${1}, this keyword will return any SOL 489 # data to the caller as a unicode string. 490 491 ${log_file_path}= Create OS Console File Path ${log_file_path} 492 493 ${log_output}= Stop SOL Console Logging ${log_file_path} 494 ... return_data=${return_data} 495 496 # Validate by making sure we can create the file. Problems creating the 497 # file would not be noticed by the subsequent ssh command because we fork 498 # the command. 499 Create File ${log_file_path} 500 ${sub_cmd_buf}= Create OS Console Command String 501 # Routing stderr to stdout so that any startup error text will go to the 502 # output file. 503 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 & 504 Rdpissuing ${cmd_buf} 505 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf} 506 # Because we are forking this command, we essentially will never get a 507 # non-zero return code or any output. 508 Should Be Equal ${rc} ${0} 509 510 [Return] ${log_output} 511 512Get Time Stamp 513 [Documentation] Get the current time stamp data 514 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f 515 [Return] ${cur_time} 516 517 518Verify BMC State 519 [Documentation] Get the BMC state and verify if the current 520 ... BMC state is as expected. 521 [Arguments] ${expected} 522 523 ${current}= Get BMC State Deprecated 524 Should Contain ${expected} ${current} 525 526Start Journal Log 527 [Documentation] Start capturing journal log to a file in /tmp using 528 ... journalctl command. By default journal log is collected 529 ... at /tmp/journal_log else user input location. 530 ... The File is appended with datetime. 531 [Arguments] ${file_path}=/tmp/journal_log 532 533 Open Connection And Log In 534 535 ${cur_time}= Get Time Stamp 536 Set Global Variable ${LOG_TIME} ${cur_time} 537 Start Command 538 ... journalctl -f > ${file_path}-${LOG_TIME} 539 Log Journal Log Started: ${file_path}-${LOG_TIME} 540 541 542Stop Journal Log 543 [Documentation] Stop journalctl process if its running. 544 ... By default return log from /tmp/journal_log else 545 ... user input location. 546 [Arguments] ${file_path}=/tmp/journal_log 547 548 Open Connection And Log In 549 550 ${rc}= 551 ... Execute Command 552 ... ps ax | grep journalctl | grep -v grep 553 ... return_stdout=False return_rc=True 554 555 Return From Keyword If '${rc}' == '${1}' 556 ... No journal log process running 557 558 ${output} ${stderr}= 559 ... Execute Command killall journalctl 560 ... return_stderr=True 561 Should Be Empty ${stderr} 562 563 ${journal_log} ${stderr}= 564 ... Execute Command 565 ... cat ${file_path}-${LOG_TIME} 566 ... return_stderr=True 567 Should Be Empty ${stderr} 568 569 Log ${journal_log} 570 571 Execute Command rm ${file_path}-${LOG_TIME} 572 573 [Return] ${journal_log} 574 575Mac Address To Hex String 576 [Documentation] Converts MAC address into hex format. 577 ... Example 578 ... Given the following MAC: 00:01:6C:80:02:78 579 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78 580 ... Description of arguments: 581 ... i_macaddress MAC address in the following format 582 ... 00:01:6C:80:02:78 583 [Arguments] ${i_macaddress} 584 585 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')} 586 [Return] ${mac_hex} 587 588IP Address To Hex String 589 [Documentation] Converts IP address into hex format. 590 ... Example: 591 ... Given the following IP: 10.3.164.100 592 ... This keyword will return: 0xa 0x3 0xa4 0xa0 593 ... Description of arguments: 594 ... i_ipaddress IP address in the following format 595 ... 10.10.10.10 596 [Arguments] ${i_ipaddress} 597 598 @{ip}= Split String ${i_ipaddress} . 599 ${index}= Set Variable ${0} 600 601 :FOR ${item} IN @{ip} 602 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes 603 \ Set List Value ${ip} ${index} ${hex} 604 \ ${index}= Set Variable ${index + 1} 605 ${ip_hex}= Catenate @{ip} 606 [Return] ${ip_hex} 607 608BMC CPU Performance Check 609 [Documentation] Minimal 10% of proc should be free in this instance 610 611 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd} 612 ... return_stderr=True 613 Should be empty ${stderr} 614 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} % 615 Should be true ${bmc_cpu_percentage} < 90 616 617BMC Mem Performance Check 618 [Documentation] Minimal 10% of memory should be free in this instance 619 620 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd} 621 ... return_stderr=True 622 Should be empty ${stderr} 623 624 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd} 625 ... return_stderr=True 626 Should be empty ${stderr} 627 628 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100 629 ${bmc_mem_percentage}= Evaluate 630 ... ${bmc_mem_percentage}/${bmc_mem_total_output} 631 Should be true ${bmc_mem_percentage} > 10 632 633BMC File System Usage Check 634 [Documentation] Check the file system space. None should be 100% full 635 ... except /run/initramfs/ro 636 ${bmc_fs_usage_output} ${stderr}= Execute Command 637 ... ${bmc_file_system_usage_cmd} return_stderr=True 638 Should Be Empty ${stderr} 639 Should Be True ${bmc_fs_usage_output}==0 640 641Check BMC CPU Performance 642 [Documentation] Minimal 10% of proc should be free in 3 sample 643 :FOR ${var} IN Range 1 4 644 \ BMC CPU Performance check 645 646Check BMC Mem Performance 647 [Documentation] Minimal 10% of memory should be free 648 649 :FOR ${var} IN Range 1 4 650 \ BMC Mem Performance check 651 652Check BMC File System Performance 653 [Documentation] Check for file system usage for 4 times 654 655 :FOR ${var} IN Range 1 4 656 \ BMC File System Usage check 657 658Get URL List 659 [Documentation] Return list of URLs under given URL. 660 [Arguments] ${openbmc_url} 661 # Description of argument(s): 662 # openbmc_url URL for list operation (e.g. 663 # /xyz/openbmc_project/inventory). 664 665 ${url_list}= Read Properties ${openbmc_url}/list 666 [Return] ${url_list} 667 668Get Endpoint Paths 669 [Documentation] Returns all url paths ending with given endpoint 670 ... Example: 671 ... Given the following endpoint: cpu 672 ... This keyword will return: list of all urls ending with 673 ... cpu - 674 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0, 675 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1 676 ... Description of arguments: 677 ... path URL path for enumeration 678 ... endpoint string for which url path ending 679 [Arguments] ${path} ${endpoint} 680 681 ${resp}= Read Properties ${path}/enumerate timeout=30 682 log Dictionary ${resp} 683 684 ${list}= Get Dictionary Keys ${resp} 685 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$ 686 [Return] ${resp} 687 688Check Zombie Process 689 [Documentation] Check if any defunct process exist or not on BMC 690 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l 691 ... return_stderr=True return_rc=True 692 Should Be True ${count}==0 693 Should Be Empty ${stderr} 694 695Prune Journal Log 696 [Documentation] Prune archived journal logs. 697 [Arguments] ${vacuum_size}=1M 698 699 # This keyword can be used to prevent the journal 700 # log from filling up the /run filesystem. 701 # This command will retain only the latest logs 702 # of the user specified size. 703 704 Open Connection And Log In 705 ${output} ${stderr} ${rc}= 706 ... Execute Command 707 ... journalctl --vacuum-size=${vacuum_size} 708 ... return_stderr=True return_rc=True 709 710 Should Be Equal ${rc} ${0} msg=${stderr} 711 712Set BMC Power Policy 713 [Documentation] Set the given BMC power policy. 714 [arguments] ${policy} 715 716 ${valueDict}= create dictionary data=${policy} 717 Write Attribute ${HOST_SETTING} power_policy data=${valueDict} 718 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy 719 Should Be Equal ${currentPolicy} ${policy} 720 721Get System Power Policy 722 [Documentation] Get the BMC power policy. 723 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy 724 [Return] ${currentPolicy} 725 726Get Auto Reboot 727 [Documentation] Returns auto reboot setting. 728 ${setting}= Read Attribute ${HOST_SETTING} auto_reboot 729 [Return] ${setting} 730 731 732Set Auto Reboot 733 [Documentation] Set the given auto reboot setting. 734 [Arguments] ${setting} 735 # setting auto reboot's setting, i.e. yes or no 736 737 ${valueDict}= Set Variable ${setting} 738 ${data}= Create Dictionary data=${valueDict} 739 Write Attribute ${HOST_SETTING} auto_reboot data=${data} 740 ${current_setting}= Get Auto Reboot 741 Should Be Equal ${current_setting} ${setting} 742 743 744Set BMC Reset Reference Time 745 [Documentation] Set current boot time as a reference and increment 746 ... boot count. 747 748 ${cur_btime}= Get BMC Boot Time 749 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0} 750 ... Set Global Variable ${BOOT_TIME} ${cur_btime} 751 ... ELSE IF ${cur_btime} > ${BOOT_TIME} 752 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime} 753 ... AND 754 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1} 755 756Get BMC Boot Time 757 [Documentation] Get boot time from /proc/stat. 758 759 Open Connection And Log In 760 ${output} ${stderr}= 761 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' ' 762 ... return_stderr=True 763 Should Be Empty ${stderr} 764 ${btime}= Convert To Integer ${output} 765 [Return] ${btime} 766 767Execute Command On BMC 768 [Documentation] Execute given command on BMC and return output. 769 [Arguments] ${command} 770 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True 771 Should Be Empty ${stderr} 772 [Return] ${stdout} 773 774 775Enable Core Dump On BMC 776 [Documentation] Enable core dump collection. 777 Open Connection And Log In 778 ${core_pattern}= Execute Command On BMC 779 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern 780 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p 781 782Get Number Of BMC Core Dump Files 783 [Documentation] Get number of core dump files on BMC. 784 Open Connection And Log In 785 ${num_of_core_dump}= Execute Command 786 ... ls /tmp/core* 2>/dev/null | wc -l 787 [Return] ${num_of_core_dump} 788 789Set Core Dump File Size Unlimited 790 [Documentation] Set core dump file size to unlimited. 791 Open Connection And Log In 792 Execute Command On BMC 793 ... ulimit -c unlimited 794 795Check For Core Dumps 796 [Documentation] Check for any core dumps exist. 797 ${output}= Get Number Of BMC Core Dump Files 798 Run Keyword If ${output} > 0 799 ... Log **Warning** BMC core dump files exist level=WARN 800 801Trigger Host Watchdog Error 802 [Documentation] Inject host watchdog timeout error via REST. 803 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s 804 # Description of argument(s): 805 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 = 806 # 1 second). 807 # sleep_time Time delay for host watchdog error to get injected. 808 # Default is 5 seconds. 809 810 ${data}= Create Dictionary data=${True} 811 Write Attribute /xyz/openbmc_project/watchdog/host0 Enabled data=${data} 812 813 ${data}= Create Dictionary data=${milliseconds} 814 Write Attribute /xyz/openbmc_project/watchdog/host0 TimeRemaining data=${data} 815 816 Sleep ${sleep_time} 817 818Login To OS Host 819 [Documentation] Login to OS Host. 820 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME} 821 ... ${os_password}=${OS_PASSWORD} 822 # Desription of arguments: 823 # ${os_host} IP address of the OS Host. 824 # ${os_username} OS Host Login user name. 825 # ${os_password} OS Host Login passwrd. 826 827 ${os_state}= Run Keyword And Return Status Ping Host ${os_host} 828 Run Keyword If '${os_state}' == 'False' 829 ... Run Keywords Initiate Host Reboot AND 830 ... Is Host Running AND 831 ... Wait for OS ${os_host} ${os_username} ${os_password} 832 833 Open Connection ${os_host} 834 ${resp}= Login ${os_username} ${os_password} 835 [Return] ${resp} 836 837Configure Initial Settings 838 [Documentation] Restore old IP and route. 839 ... This keyword requires initial settings viz IP address, 840 ... Network Mask, default gatway and serial console IP and port 841 ... information which should be provided in command line. 842 843 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK} 844 ... ${gw_ip}=${GW_IP} 845 846 # Open telnet connection and ignore the error, in case telnet session is 847 # already opened by the program calling this keyword. 848 849 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console 850 Telnet.write ifconfig eth0 ${host} netmask ${mask} 851 Telnet.write route add default gw ${gw_ip} 852 853Install Debug Tarball On BMC 854 [Documentation] Copy the debug tar file to BMC and install. 855 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz 856 ... ${targ_tarball_dir_path}=/home/root/tarball/ 857 858 # Description of arguments: 859 # tarball_file_path Path of the debug tarball file. 860 # The tar file is downloaded from the build page 861 # https://openpower.xyz/job/openbmc-build/ 862 # obmc-phosphor-debug-tarball-witherspoon.tar.xz 863 # 864 # targ_tarball_dir_path The directory path where the tarball is to be 865 # installed. 866 867 OperatingSystem.File Should Exist ${tarball_file_path} 868 ... msg=${tarball_file_path} doesn't exist. 869 870 # Upload the file to BMC. 871 Import Library SCPLibrary WITH NAME scp 872 Open Connection for SCP 873 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz 874 875 # Create tarball directory and install. 876 Open Connection And Log In 877 Execute Command On BMC mkdir -p ${targ_tarball_dir_path} 878 Execute Command On BMC 879 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path} 880 881 # Create symlink to callout-test binary. 882 Execute Command On BMC 883 ... ln -s ${targ_tarball_dir_path}/bin/callout-test /usr/bin/callout-test 884 885 # Create symlink to logging-test binary. 886 Execute Command On BMC 887 ... ln -s ${targ_tarball_dir_path}/bin/logging-test /usr/bin/logging-test 888 889 # Remove the tarball file from BMC 890 Execute Command On BMC rm /tmp/debug-tarball.tar.xz 891 892 893Get BMC Boot Count 894 [Documentation] Get BMC boot count based on boot time. 895 ${cur_btime}= Get BMC Boot Time 896 897 # Set global variable BOOT_TIME to current boot time if current boot time 898 # is changed. Also increase value of global variable BOOT_COUNT by 1. 899 Run Keyword If ${cur_btime} > ${BOOT_TIME} 900 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime} 901 ... AND 902 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1} 903 [Return] ${BOOT_COUNT} 904 905Set BMC Boot Count 906 [Documentation] Set BMC boot count to given value. 907 [Arguments] ${count} 908 909 # Description of arguments: 910 # count boot count value. 911 ${cur_btime}= Get BMC Boot Time 912 913 # Set global variable BOOT_COUNT to given value. 914 Set Global Variable ${BOOT_COUNT} ${count} 915 916 # Set BOOT_TIME variable to current boot time. 917 Set Global Variable ${BOOT_COUNT} ${count} 918 919Get System LED State 920 [Documentation] Return the state of given system LED. 921 [Arguments] ${led_name} 922 923 # Description of argument(s): 924 # led_name System LED name (e.g. heartbeat, identify, beep). 925 926 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State 927 [Return] ${state.rsplit('.', 1)[1]} 928 929############################################################################### 930Delete Error logs 931 [Documentation] Delete error logs. 932 933 # The REST method to delete error openbmc/openbmc#1327 934 # until then using logging restart. 935 Open Connection And Log In 936 Execute Command On BMC 937 ... systemctl restart xyz.openbmc_project.Logging.service 938 Sleep 10s reason=Wait for logging service to restart properly. 939 940############################################################################### 941Delete Error log Entry 942 [Documentation] Delete error log entry. 943 [Arguments] ${entry_path} 944 945 # Description of argument(s): 946 # entry_path Delete an error log entry. 947 # Ex. /xyz/openbmc_project/logging/entry/1 948 949 ${data}= Create Dictionary data=@{EMPTY} 950 ${resp}= Openbmc Delete Request ${entry_path} data=${data} 951 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK} 952 953 954Get LED State XYZ 955 [Documentation] Returns state of given LED. 956 [Arguments] ${led_name} 957 # Description of argument(s): 958 # led_name Name of LED 959 960 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted 961 [Return] ${state} 962