1*** Settings ***
2Documentation       This suite tests IPMI Cold Reset in OpenBMC.
3...
4...                 The Cold reset command directs the Responder to perform
5...                 a 'Cold Reset' action, which causes default setting of
6...                 interrupt enables, event message generation,sensor scanning,
7...                 threshold values, and other 'power up' default state to be restored.
8...
9...                 The script consist of 3 testcases:
10...                 -  Cold_Reset_Via_IPMI
11...                 -  Cold_Reset_With_Invalid_Data_Request_Via_IPMI
12...                 -  Verify_Cold_Reset_Impact_On_Sensor_Threshold_Via_IPMI
13...
14...                 The script verifies command execution for cold reset,
15...                 invalid data request verification of cold reset and
16...                 impact on sensor threshold value change with cold reset.
17...
18...                 The script changes sensor threshold value for Fan sensor,
19...                 executes cold reset IPMI command,
20...                 compares sensor threshold values of initial and reading after cold reset.
21...
22...                 Request data for cold reset present under data/ipmi_raw_cmd_table.py
23
24Library             Collections
25Library             ../lib/ipmi_utils.py
26Resource            ../lib/ipmi_client.robot
27Resource            ../lib/openbmc_ffdc.robot
28Variables           ../data/ipmi_raw_cmd_table.py
29
30Test Teardown       FFDC On Test Case Fail
31
32
33*** Variables ***
34
35${NETWORK_RESTART_TIME}    30s
36@{thresholds_list}         lcr   lnc   unc   ucr
37
38
39*** Test Cases ***
40
41Cold Reset Via IPMI
42    [Documentation]  Verify Cold Reset via IPMI.
43    [Tags]  Cold_Reset_Via_IPMI
44
45    # Cold Reset Via IPMI raw command.
46    Run External IPMI Raw Command  ${IPMI_RAW_CMD['Cold Reset']['reset'][0]}
47
48    # Get the BMC Status.
49    Wait Until Keyword Succeeds  3 min  10 sec  Is BMC Unpingable
50    Wait Until Keyword Succeeds  3 min  10 sec  Is BMC Operational
51
52    # Verify if BMC restarted with Get Device ID command.
53
54    ${resp}=  Run External IPMI Raw Command  ${IPMI_RAW_CMD['Device ID']['Get'][0]}
55    Should Not Contain  ${resp}  ${IPMI_RAW_CMD['Device ID']['Get'][1]}
56
57
58Cold Reset With Invalid Data Request Via IPMI
59    [Documentation]  Verify Cold Reset with invalid data request via IPMI.
60    [Tags]  Cold_Reset_With_Invalid_Data_Request_Via_IPMI
61
62    # Verify cold reset with invalid length of the request data and expect error.
63    ${resp}=  Run Keyword and Expect Error  *Request data length invalid*
64    ...  Run External IPMI Raw Command  ${IPMI_RAW_CMD['Cold Reset']['reset'][0]} 0x00
65
66
67Verify Cold Reset Impact On Sensor Threshold Via IPMI
68    [Documentation]  Modify sensor threshold, perform cold reset,
69    ...  and verify if sensor threshold reverts back to initial value.
70    [Tags]  Verify_Cold_Reset_Impact_On_Sensor_Threshold_Via_IPMI
71
72    # Get sensor list.
73    ${Sensor_list}=  Get Sensor List
74
75    # Get initial sensor threshold readings.
76    ${initial_sensor_threshold}  ${sensor_name}=  Get The Sensor Name And Threshold  ${sensor_list}
77
78    # Identify sensor threshold values to modify.
79    ${threshold_dict}=  Identify Sensor Threshold Values   ${initial_sensor_threshold}
80
81    # Set sensor threshold for given sensor and compare with initial reading.
82    ${set_sensor_threshold}=  Set Sensor Threshold For given Sensor  ${threshold_dict}  ${sensor_name}
83    Should Not Be Equal  ${set_sensor_threshold}  ${initial_sensor_threshold}
84
85    # Execute cold reset command via IPMI and check status.
86    Run External IPMI Raw Command  ${IPMI_RAW_CMD['Cold Reset']['reset'][0]}
87    Wait Until Keyword Succeeds  3 min  10 sec  Is BMC Unpingable
88    Wait Until Keyword Succeeds  3 min  10 sec  Is BMC Operational
89
90    # Get sensor data for the sensor identified.
91    ${data_after_coldreset}=  Wait Until Keyword Succeeds  2 min  30 sec
92    ...  Run IPMI Standard Command   sensor | grep -i RPM | grep "${sensor_name}"
93
94    # Get sensor threshold readings after BMC restarts.
95    ${sensor_threshold_after_reset}  ${sensor_name_after_reset}=  Get The Sensor Name And Threshold  ${data_after_coldreset}
96
97    # Compare with initial sensor threshold values.
98    Should Be Equal  ${sensor_threshold_after_reset}  ${initial_sensor_threshold}
99
100
101*** Keywords ***
102
103Get Sensor List
104    [Documentation]  To get the list of sensors via IPMI sensor list.
105
106    # BMC may take time to populate all the sensors once BMC Cold reset completes.
107    ${data}=  Wait Until Keyword Succeeds  2 min  30 sec
108    ...  Run IPMI Standard Command   sensor | grep -i RPM
109
110    [Return]  ${data}
111
112Identify Sensor
113    [Documentation]  To fetch first sensor listed from sensor list IPMI command and return the sensor.
114    [Arguments]  ${data}
115
116    # Description of Argument(s):
117    # ${data}     All the sensors listed with ipmi sensor list command.
118
119    # Find Sensor detail of sensor list first entry.
120
121    ${data}=  Split To Lines  ${data}
122    ${data}=  Set Variable  ${data[0]}
123
124    [Return]  ${data}
125
126
127Get The Sensor Reading And Name
128    [Documentation]  To get the sensor reading of the given sensor using IPMI.
129    [Arguments]  ${Sensors_all}
130
131    # Description of Argument(s):
132    # ${Sensors_all}     All the sensors listed with ipmi sensor list command.
133
134    # Split Sensor details in a list.
135
136    ${sensor}=  Identify Sensor  ${Sensors_all}
137    ${data}=  Split String  ${sensor}  |
138
139    # Locate the sensor name.
140    ${sensor_name}=  Set Variable  ${data[0]}
141    # Function defined in lib/utils.py.
142    ${sensor_name}=  Remove Whitespace  ${sensor_name}
143
144    [Return]  ${data}  ${sensor_name}
145
146
147Get The Sensor Name And Threshold
148    [Documentation]  To get the sensor threshold for given sensor using IPMI.
149    [Arguments]  ${Sensor_list}
150
151    # Description of Argument(s):
152    #    ${Sensor_list}    All the sensors listed with ipmi sensor list command.
153
154    # Gets the sensor data and sensor name for the required sensor.
155    ${data}  ${sensor_name}=  Get The Sensor Reading And Name  ${Sensor_list}
156    # Gets the threshold values in a list.
157    ${threshold}=  Set Variable  ${data[5:9]}
158
159    [Return]  ${threshold}  ${sensor_name}
160
161
162Identify Sensor Threshold Values
163    [Documentation]  Identify New Sensor Threshold Values with adding 100 to old threshold values.
164    [Arguments]  ${old_threshold}
165
166    # Description of Argument(s):
167    #    ${old_threshold}   original threshold values list of the given sensor.
168
169    # Retrieves modified threshold values of the original threshold value.
170    ${threshold_dict}=  Modify And Fetch Threshold  ${old_threshold}  ${thresholds_list}
171
172    [Return]  ${threshold_dict}
173
174
175Set Sensor Threshold For given Sensor
176    [Documentation]  Set Sensor Threshold for given sensor with given Upper and Lower critical and non-critical values Via IPMI.
177    [Arguments]  ${threshold_list}  ${sensor}
178
179    # Description of Argument(s):
180    #    ${threshold_list}    New thresholds to be set, eg: [ na, 101, 102, 103 ]
181    #    ${sensor}            Sensor name, eg: SENSOR_1, FAN_1
182
183    # The return data will be newly set threshold value for the given sensor.
184
185    # Set critical and non-critical values for the given sensor.
186    FOR  ${criticals}  IN  @{threshold_list}
187        # Set Lower/Upper critical and non-critical values if a threshold is available.
188        Run keyword if  '${threshold_list['${criticals}']}' != 'na'
189        ...  Run IPMI Standard Command
190        ...  sensor thresh "${sensor}" ${criticals} ${threshold_list['${criticals}']}
191        # Allow Network restart sleep time for the readings to get reflected.
192        Sleep  ${NETWORK_RESTART_TIME}
193    END
194
195    # Get sensor list for the sensor name identified.
196    ${data}=  Wait Until Keyword Succeeds  2 min  30 sec
197    ...  Run IPMI Standard Command   sensor | grep -i RPM | grep "${sensor}"
198
199    # Get new threshold value set from sensor list.
200    ${threshold_new}  ${sensor_name}=  Get The Sensor Name And Threshold  ${data}
201
202    [Return]  ${threshold_new}
203