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    Wait Until Keyword Succeeds
58    ...  1 min  30 sec  Initialize OpenBMC
59
60    ${ready_status}=  Run Keyword And Return Status  Is BMC Ready
61    Run Keyword If  '${ready_status}' == '${False}'  Put BMC State  Ready
62
63    ${host_off_status}=  Run Keyword And Return Status  Is Host Off
64    Run Keyword If  '${host_off_status}' == '${False}'  Initiate Host PowerOff
65
66    Prune Journal Log
67
68    Run Keyword And Ignore Error  Set BMC Power Policy  ${ALWAYS_POWER_OFF}
69
70    # TODO: Enable MAC AES check latter.
71    # Reference : openbmc/openbmc-test-automation#998
72    #Run Keyword If  '${MAC_ADDRESS}' != '${EMPTY}'
73    #...  Check And Reset MAC
74
75    # TODO: Add new UBI File system cleanup.
76    # Reference : openbmc/openbmc-test-automation#998
77    #${rc}=  Execute Command  find ${CLEANUP_DIR_PATH}
78    #...  return_stdout=False  return_rc=True
79    #Run Keyword If  '${CLEANUP_DIR_PATH}' != '${EMPTY}' and ${rc} == 0
80    #...  Cleanup Dir
81
82    Run Keyword And Ignore Error  Delete All Error Logs
83    Run Keyword And Ignore Error  Redfish Purge Event Log
84    Run Keyword And Ignore Error  Delete All Dumps
85    Run Keyword And Ignore Error  Delete All Redfish Sessions
86    Check For Current Boot Application Failures
87
88*** Keywords ***
89
90BMC Online Test
91    [Documentation]   BMC ping, SSH, REST connection Test
92
93    ${l_status}=   Run Keyword and Return Status
94    ...   Verify Ping and REST Authentication
95    Run Keyword If  '${l_status}' == '${False}'
96    ...   Fail  msg=System not in ideal state to continue [ERROR]
97
98
99Update Policy Setting
100    [Documentation]   Update the given restore policy
101    [Arguments]   ${policy}
102
103    ${valueDict}=     create dictionary  data=${policy}
104    Write Attribute    ${HOST_SETTING}    power_policy   data=${valueDict}
105    ${currentPolicy}=  Read Attribute     ${HOST_SETTING}   power_policy
106    Should Be Equal    ${currentPolicy}   ${policy}
107
108
109Trigger Warm Reset via Reboot
110    [Documentation]    Execute reboot command on the remote BMC and
111    ...                returns immediately. This keyword "Start Command"
112    ...                returns nothing and does not wait for the command
113    ...                execution to be finished.
114    Open Connection And Log In
115
116    Start Command   /sbin/reboot
117
118
119Powercycle System Via PDU
120    [Documentation]   AC cycle the system via PDU.
121
122    Validate Parameters
123    PDU Power Cycle
124    Check If BMC is Up   5 min    10 sec
125
126
127Check For Current Boot Application Failures
128    [Documentation]  Parse the journal log and check for failures.
129    [Arguments]  ${error_regex}=${ERROR_REGEX}
130
131    ${error_regex}=  Escape Bash Quotes  ${error_regex}
132    ${journal_log}  ${stderr}  ${rc}=  BMC Execute Command
133    ...  journalctl -b --no-pager | egrep '${error_regex}'  ignore_err=1
134
135    Should Be Empty  ${journal_log}
136
137
138Validate Parameters
139    [Documentation]  Validate PDU parameters.
140    Should Not Be Empty   ${PDU_IP}
141    Should Not Be Empty   ${PDU_TYPE}
142    Should Not Be Empty   ${PDU_SLOT_NO}
143    Should Not Be Empty   ${PDU_USERNAME}
144    Should Not Be Empty   ${PDU_PASSWORD}
145
146
147MTU Ping Test
148    [Documentation]  Ping test using MTU.
149    [Arguments]  ${mtu}=${1400}
150
151    # Description of argument(s):
152    # mtu   The maximum transmission unit (MTU) of a network interface.
153
154    ${rc}  ${output}=  Run And Return RC And Output
155    ...  ping -M do -s ${mtu} -c 10 ${OPENBMC_HOST}
156    Should Be Equal As Integers  ${rc}  0
157    Should Not Contain  ${output}  100% packet loss
158