1*** Settings ***
2Documentation     This module will take whatever action is necessary
3...               to bring the BMC to a stable, standby state.  For our
4...               purposes, a stable state is defined as:
5...                  - BMC is communicating
6...                   (pinging, sshing and REST commands working)
7...                  - Power state is 0 (off)
8...                  - BMC state is "Ready"
9...                  - HOST state is "Off"
10...                  - Boot policy is "ALWAYS_POWER_OFF"
11...               Power cycle system via PDU if specified
12...               Prune archived journal logs
13
14Resource          ../lib/utils.robot
15Resource          ../lib/pdu/pdu.robot
16Resource          ../lib/state_manager.robot
17Resource          ../lib/bmc_network_utils.robot
18Resource          ../lib/bmc_cleanup.robot
19Resource          ../lib/dump_utils.robot
20Resource          ../lib/bmc_redfish_resource.robot
21Resource          ../lib/bmc_redfish_utils.robot
22Library           ../lib/gen_misc.py
23
24*** Variables ***
25${HOST_SETTING}      /org/openbmc/settings/host0
26
27${ERROR_REGEX}  xyz.openbmc_project.Software.BMC.Updater.service: Failed with result 'core-dump'
28
29*** Test Cases ***
30
31Get To Stable State
32    [Documentation]  BMC cleanup drive to stable state
33    ...              1. PDU powercycle if specified
34    ...              1. Ping Test
35    ...              2. SSH Connection session Test
36    ...              3. REST Connection session Test
37    ...              4. Reboot BMC if REST Test failed
38    ...              5. Get BMC in Ready state if its not in this state
39    ...              6. Get Host in Off state if its not in this state
40    ...              7. Update restore policy
41    ...              8. Verify and Update MAC address.
42    [Tags]  Get_To_Stable_State
43
44    Run Keyword And Ignore Error  Powercycle System Via PDU
45
46    ${ping_status}=  Run Keyword And Return Status
47    ...  Wait For Host To Ping  ${OPENBMC_HOST}  2 mins
48
49    # Check if the ping works using 1400 MTU.
50    Run Keyword if  ${ping_status} == ${True}  MTU Ping Test
51
52    Run Keyword if  ${ping_status} == ${False}
53    ...  Fail  ${OPENBMC_HOST} ping test failed.
54
55    Open Connection And Log In  host=${OPENBMC_HOST}
56
57    Run Keyword If  ${REDFISH_SUPPORTED}  Redfish.Login
58
59    Wait Until Keyword Succeeds
60    ...  1 min  30 sec  Initialize OpenBMC
61
62    ${ready_status}=  Run Keyword And Return Status  Is BMC Ready
63    Run Keyword If  '${ready_status}' == '${False}'  Put BMC State  Ready
64
65    ${host_off_status}=  Run Keyword And Return Status  Is Host Off
66    Run Keyword If  '${host_off_status}' == '${False}'  Initiate Host PowerOff
67
68    Prune Journal Log
69
70    Run Keyword And Ignore Error  Set BMC Power Policy  ${ALWAYS_POWER_OFF}
71    Run Keyword And Ignore Error  Redfish Set Power Restore Policy  AlwaysOff
72
73    # TODO: Enable MAC AES check latter.
74    # Reference : openbmc/openbmc-test-automation#998
75    #Run Keyword If  '${MAC_ADDRESS}' != '${EMPTY}'
76    #...  Check And Reset MAC
77
78    # TODO: Add new UBI File system cleanup.
79    # Reference : openbmc/openbmc-test-automation#998
80    #${rc}=  Execute Command  find ${CLEANUP_DIR_PATH}
81    #...  return_stdout=False  return_rc=True
82    #Run Keyword If  '${CLEANUP_DIR_PATH}' != '${EMPTY}' and ${rc} == 0
83    #...  Cleanup Dir
84
85    Run Keyword And Ignore Error  Delete All Error Logs
86    Run Keyword And Ignore Error  Redfish Purge Event Log
87    Run Keyword And Ignore Error  Delete All Dumps
88    Run Keyword And Ignore Error  Delete All Redfish Sessions
89    Check For Current Boot Application Failures
90
91*** Keywords ***
92
93BMC Online Test
94    [Documentation]   BMC ping, SSH, REST connection Test
95
96    ${l_status}=   Run Keyword and Return Status
97    ...   Verify Ping and REST Authentication
98    Run Keyword If  '${l_status}' == '${False}'
99    ...   Fail  msg=System not in ideal state to continue [ERROR]
100
101
102Update Policy Setting
103    [Documentation]   Update the given restore policy
104    [Arguments]   ${policy}
105
106    ${valueDict}=     create dictionary  data=${policy}
107    Write Attribute    ${HOST_SETTING}    power_policy   data=${valueDict}
108    ${currentPolicy}=  Read Attribute     ${HOST_SETTING}   power_policy
109    Should Be Equal    ${currentPolicy}   ${policy}
110
111
112Trigger Warm Reset via Reboot
113    [Documentation]    Execute reboot command on the remote BMC and
114    ...                returns immediately. This keyword "Start Command"
115    ...                returns nothing and does not wait for the command
116    ...                execution to be finished.
117    Open Connection And Log In
118
119    Start Command   /sbin/reboot
120
121
122Powercycle System Via PDU
123    [Documentation]   AC cycle the system via PDU.
124
125    Validate Parameters
126    PDU Power Cycle
127    Check If BMC is Up   5 min    10 sec
128
129
130Check For Current Boot Application Failures
131    [Documentation]  Parse the journal log and check for failures.
132    [Arguments]  ${error_regex}=${ERROR_REGEX}
133
134    ${error_regex}=  Escape Bash Quotes  ${error_regex}
135    ${journal_log}  ${stderr}  ${rc}=  BMC Execute Command
136    ...  journalctl -b --no-pager | egrep '${error_regex}'  ignore_err=1
137
138    Should Be Empty  ${journal_log}
139
140
141Validate Parameters
142    [Documentation]  Validate PDU parameters.
143    Should Not Be Empty   ${PDU_IP}
144    Should Not Be Empty   ${PDU_TYPE}
145    Should Not Be Empty   ${PDU_SLOT_NO}
146    Should Not Be Empty   ${PDU_USERNAME}
147    Should Not Be Empty   ${PDU_PASSWORD}
148
149
150MTU Ping Test
151    [Documentation]  Ping test using MTU.
152    [Arguments]  ${mtu}=${1400}
153
154    # Description of argument(s):
155    # mtu   The maximum transmission unit (MTU) of a network interface.
156
157    ${rc}  ${output}=  Run And Return RC And Output
158    ...  ping -M do -s ${mtu} -c 10 ${OPENBMC_HOST}
159    Should Be Equal As Integers  ${rc}  0
160    Should Not Contain  ${output}  100% packet loss
161