| *** Settings *** |
| Resource ../lib/utils.robot |
| Resource ../lib/connection_client.robot |
| Resource ../lib/boot_utils.robot |
| Library ../lib/gen_misc.py |
| Library ../lib/utils.py |
| |
| *** Variables *** |
| # MAC input from user. |
| ${MAC_ADDRESS} ${EMPTY} |
| |
| |
| *** Keywords *** |
| |
| Check And Reset MAC |
| [Documentation] Update BMC with user input MAC address. |
| [Arguments] ${mac_address}=${MAC_ADDRESS} |
| |
| # Description of argument(s): |
| # mac_address The mac address (e.g. 00:01:6c:80:02:28). |
| |
| Should Not Be Empty ${mac_address} |
| Open Connection And Log In |
| ${bmc_mac_addr} ${stderr} ${rc}= BMC Execute Command |
| ... cat /sys/class/net/eth0/address |
| Run Keyword If '${mac_address.lower()}' != '${bmc_mac_addr.lower()}' |
| ... Set MAC Address |
| |
| |
| Set MAC Address |
| [Documentation] Update eth0 with input MAC address. |
| [Arguments] ${mac_address}=${MAC_ADDRESS} |
| |
| # Description of argument(s): |
| # mac_address The mac address (e.g. 00:01:6c:80:02:28). |
| |
| Write fw_setenv ethaddr ${mac_address} |
| OBMC Reboot (off) |
| |
| # Take SSH session post BMC reboot. |
| Open Connection And Log In |
| ${bmc_mac_addr} ${stderr} ${rc}= BMC Execute Command |
| ... cat /sys/class/net/eth0/address |
| Should Be Equal ${bmc_mac_addr} ${mac_address} ignore_case=True |
| |
| |
| Get BMC IP Info |
| [Documentation] Get system IP address and prefix length. |
| |
| |
| # Get system IP address and prefix length details using "ip addr" |
| # Sample Output of "ip addr": |
| # 1: eth0: <BROADCAST,MULTIAST> mtu 1500 qdisc mq state UP qlen 1000 |
| # link/ether xx:xx:xx:xx:xx:xx brd ff:ff:ff:ff:ff:ff |
| # inet xx.xx.xx.xx/24 brd xx.xx.xx.xx scope global eth0 |
| |
| ${cmd_output} ${stderr} ${rc}= BMC Execute Command |
| ... /sbin/ip addr | grep eth0 |
| |
| # Get line having IP address details. |
| ${lines}= Get Lines Containing String ${cmd_output} inet |
| |
| # List IP address details. |
| @{ip_components}= Split To Lines ${lines} |
| |
| @{ip_data}= Create List |
| |
| # Get all IP addresses and prefix lengths on system. |
| :FOR ${ip_component} IN @{ip_components} |
| \ @{if_info}= Split String ${ip_component} |
| \ ${ip_n_prefix}= Get From List ${if_info} 1 |
| \ Append To List ${ip_data} ${ip_n_prefix} |
| |
| [Return] ${ip_data} |
| |
| Get BMC Route Info |
| [Documentation] Get system route info. |
| |
| |
| # Sample output of "ip route": |
| # default via xx.xx.xx.x dev eth0 |
| # xx.xx.xx.0/23 dev eth0 src xx.xx.xx.xx |
| # xx.xx.xx.0/24 dev eth0 src xx.xx.xx.xx |
| |
| ${cmd_output} ${stderr} ${rc}= BMC Execute Command |
| ... /sbin/ip route |
| |
| [Return] ${cmd_output} |
| |
| # TODO: openbmc/openbmc-test-automation#1331 |
| Get BMC MAC Address |
| [Documentation] Get system MAC address. |
| |
| |
| # Sample output of "ip addr | grep ether": |
| # link/ether xx.xx.xx.xx.xx.xx brd ff:ff:ff:ff:ff:ff |
| |
| ${cmd_output} ${stderr} ${rc}= BMC Execute Command |
| ... /sbin/ip addr | grep ether |
| |
| # Split the line and return MAC address. |
| # Split list data: |
| # link/ether | xx:xx:xx:xx:xx:xx | brd | ff:ff:ff:ff:ff:ff |
| |
| @{words}= Split String ${cmd_output} |
| |
| [Return] ${words[1]} |
| |
| |
| Get BMC MAC Address List |
| [Documentation] Get system MAC address |
| |
| # Sample output of "ip addr | grep ether": |
| # link/ether xx.xx.xx.xx.xx.xx brd ff:ff:ff:ff:ff:ff |
| |
| ${cmd_output} ${stderr} ${rc}= BMC Execute Command |
| ... /sbin/ip addr | grep ether |
| |
| # Split the line and return MAC address. |
| # Split list data: |
| # link/ether | xx:xx:xx:xx:xx:xx | brd | ff:ff:ff:ff:ff:ff |
| # link/ether | xx:xx:xx:xx:xx:xx | brd | ff:ff:ff:ff:ff:ff |
| |
| ${mac_list}= Create List |
| @{lines}= Split To Lines ${cmd_output} |
| :FOR ${line} IN @{lines} |
| \ @{words}= Split String ${line} |
| \ Append To List ${mac_list} ${words[1]} |
| |
| [Return] ${mac_list} |
| |
| Get BMC Hostname |
| [Documentation] Get BMC hostname. |
| |
| # Sample output of "hostname": |
| # test_hostname |
| |
| ${output} ${stderr} ${rc}= BMC Execute Command hostname |
| |
| [Return] ${output} |
| |
| Get List Of IP Address Via REST |
| [Documentation] Get list of IP address via REST. |
| [Arguments] @{ip_uri_list} |
| |
| # Description of argument(s): |
| # ip_uri_list List of IP objects. |
| # Example: |
| # "data": [ |
| # "/xyz/openbmc_project/network/eth0/ipv4/e9767624", |
| # "/xyz/openbmc_project/network/eth0/ipv4/31f4ce8b" |
| # ], |
| |
| ${ip_list}= Create List |
| |
| : FOR ${ip_uri} IN @{ip_uri_list} |
| \ ${ip_addr}= Read Attribute ${ip_uri} Address |
| \ Append To List ${ip_list} ${ip_addr} |
| |
| [Return] @{ip_list} |
| |
| Delete IP And Object |
| [Documentation] Delete IP and object. |
| [Arguments] ${ip_addr} @{ip_uri_list} |
| |
| # Description of argument(s): |
| # ip_addr IP address to be deleted. |
| # ip_uri_list List of IP object URIs. |
| |
| # Find IP object having this IP address. |
| |
| : FOR ${ip_uri} IN @{ip_uri_list} |
| \ ${ip_addr1}= Read Attribute ${ip_uri} Address |
| \ Run Keyword If '${ip_addr}' == '${ip_addr1}' Exit For Loop |
| |
| # If the given IP address is not configured, return. |
| # Otherwise, delete the IP and object. |
| |
| Run Keyword And Return If '${ip_addr}' != '${ip_addr1}' |
| ... Pass Execution IP address to be deleted is not configured. |
| |
| Run Keyword And Ignore Error OpenBMC Delete Request ${ip_uri} |
| |
| # After any modification on network interface, BMC restarts network |
| # module, wait until it is reachable. Then wait 15 seconds for new |
| # configuration to be updated on BMC. |
| |
| Wait For Host To Ping ${OPENBMC_HOST} ${NETWORK_TIMEOUT} |
| ... ${NETWORK_RETRY_TIME} |
| Sleep 15s |
| |
| # Verify whether deleted IP address is removed from BMC system. |
| |
| ${ip_data}= Get BMC IP Info |
| Should Not Contain Match ${ip_data} ${ip_addr}* |
| ... msg=IP address not deleted. |
| |
| Get First Non Pingable IP From Subnet |
| [Documentation] Find first non-pingable IP from the subnet and return it. |
| [Arguments] ${host}=${OPENBMC_HOST} |
| |
| # Description of argument(s): |
| # host Any valid host name or IP address |
| # (e.g. "machine1" or "9.xx.xx.31"). |
| |
| # Non-pingable IP is unused IP address in the subnet. |
| ${host_name} ${ip_addr}= Get Host Name IP |
| |
| # Split IP address into network part and host part. |
| # IP address will have 4 octets xx.xx.xx.xx. |
| # Sample output after split: |
| # split_ip [xx.xx.xx, xx] |
| |
| ${split_ip}= Split String From Right ${ip_addr} . 1 |
| # First element in list is Network part. |
| ${network_part}= Get From List ${split_ip} 0 |
| |
| : FOR ${octet4} IN RANGE 1 255 |
| \ ${new_ip}= Catenate ${network_part}.${octet4} |
| \ ${status}= Run Keyword And Return Status Ping Host ${new_ip} |
| # If IP is non-pingable, return it. |
| \ Return From Keyword If '${status}' == 'False' ${new_ip} |
| |
| Fail msg=No non-pingable IP could be found in subnet ${network_part}. |
| |
| |
| Validate MAC On BMC |
| [Documentation] Validate MAC on BMC. |
| [Arguments] ${mac_addr} |
| |
| # Description of argument(s): |
| # mac_addr MAC address of the BMC. |
| |
| ${system_mac}= Get BMC MAC Address |
| |
| ${status}= Compare MAC Address ${system_mac} ${mac_addr} |
| Should Be True ${status} |
| ... msg=MAC address ${system_mac} does not match ${mac_addr}. |
| |
| |
| Run Build Net |
| [Documentation] Run build_net to preconfigure the ethernet interfaces. |
| |
| OS Execute Command build_net help y y |
| # Run pingum to check if the "build_net" was run correctly done. |
| ${output} ${stderr} ${rc}= OS Execute Command pingum |
| Should Contain ${output} All networks ping Ok |
| |
| |
| Configure Hostname |
| [Documentation] Configure hostname on BMC via Redfish. |
| [Arguments] ${hostname} |
| |
| # Description of argument(s): |
| # hostname A hostname value which is to be configured on BMC. |
| |
| ${data}= Create Dictionary HostName=${hostname} |
| Redfish.patch ${REDFISH_NW_PROTOCOL_URI} body=&{data} |
| ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}] |
| |
| |
| Verify IP On BMC |
| [Documentation] Verify IP on BMC. |
| [Arguments] ${ip} |
| |
| # Description of argument(s): |
| # ip IP address to be verified (e.g. "10.7.7.7"). |
| |
| # Get IP address details on BMC using IP command. |
| @{ip_data}= Get BMC IP Info |
| Should Contain Match ${ip_data} ${ip}/* |
| ... msg=IP address does not exist. |
| |
| |
| Verify Gateway On BMC |
| [Documentation] Verify gateway on BMC. |
| [Arguments] ${gateway_ip}=0.0.0.0 |
| |
| # Description of argument(s): |
| # gateway_ip Gateway IP address. |
| |
| ${route_info}= Get BMC Route Info |
| |
| # If gateway IP is empty or 0.0.0.0 it will not have route entry. |
| |
| Run Keyword If '${gateway_ip}' == '0.0.0.0' |
| ... Pass Execution Gateway IP is "0.0.0.0". |
| ... ELSE |
| ... Should Contain ${route_info} ${gateway_ip} |
| ... msg=Gateway IP address not matching. |
| |
| |
| Get BMC DNS Info |
| [Documentation] Get system DNS info. |
| |
| |
| # Sample output of "resolv.conf": |
| # ### Generated manually via dbus settings ### |
| # nameserver 8.8.8.8 |
| |
| ${cmd_output} ${stderr} ${rc}= BMC Execute Command |
| ... cat /etc/resolv.conf |
| |
| [Return] ${cmd_output} |
| |
| |
| CLI Get Nameservers |
| [Documentation] Get the nameserver IPs from /etc/resolv.conf and return as a list. |
| |
| # Example of /etc/resolv.conf data: |
| # nameserver x.x.x.x |
| # nameserver y.y.y.y |
| |
| ${stdout} ${stderr} ${rc}= BMC Execute Command egrep nameserver /etc/resolv.conf | cut -f2- -d ' ' |
| ${nameservers}= Split String ${stdout} |
| |
| [Return] ${nameservers} |