blob: a9796f9fd03185a623cfa2749a1b606d06206875 [file] [log] [blame]
Sivas SRR0e3bc6d2019-04-23 08:36:35 -05001*** Settings ***
2Documentation Test BMC manager time functionality.
3Resource ../../lib/resource.robot
4Resource ../../lib/bmc_redfish_resource.robot
5Resource ../../lib/common_utils.robot
6Resource ../../lib/openbmc_ffdc.robot
7Resource ../../lib/utils.robot
Sushil Singh79b04aa2019-06-18 05:25:34 -05008Resource ../../lib/rest_client.robot
Sivas SRR20fe0322019-06-17 04:24:18 -05009Library ../../lib/gen_robot_valid.py
Sivas SRR0e3bc6d2019-04-23 08:36:35 -050010
Michael Walsh09083a82019-08-01 12:46:16 -050011Test Setup Printn
Sivas SRR0e3bc6d2019-04-23 08:36:35 -050012Test Teardown Test Teardown Execution
Sivas SRR20fe0322019-06-17 04:24:18 -050013Suite Setup Suite Setup Execution
George Keishingade5f6e2019-07-12 11:42:42 -050014Suite Teardown Suite Teardown Execution
Sivas SRR0e3bc6d2019-04-23 08:36:35 -050015
16*** Variables ***
17${max_time_diff_in_seconds} 6
Sivas SRR9e00ff32019-07-18 10:38:44 -050018# The "offset" consists of the value "26" specified for hours. Redfish will
19# convert that to the next day + 2 hours.
20${date_time_with_offset} 2019-04-25T26:24:46+00:00
21${expected_date_time} 2019-04-26T02:24:46+00:00
Sivas SRR3f152ae2019-06-07 10:02:51 -050022${invalid_datetime} "2019-04-251T12:24:46+00:00"
George Keishing5c7318d2022-07-07 12:46:00 -050023${ntp_server_1} 9.9.9.9
24${ntp_server_2} 2.2.3.3
Sivas SRR20fe0322019-06-17 04:24:18 -050025&{original_ntp} &{EMPTY}
ganesanb3937eaa2023-04-15 10:24:38 +000026${year_without_ntp} 1970
Sivas SRR0e3bc6d2019-04-23 08:36:35 -050027
28*** Test Cases ***
29
30Verify Redfish BMC Time
31 [Documentation] Verify that date/time obtained via redfish matches
32 ... date/time obtained via BMC command line.
33 [Tags] Verify_Redfish_BMC_Time
34
35 ${redfish_date_time}= Redfish Get DateTime
36 ${cli_date_time}= CLI Get BMC DateTime
37 ${time_diff}= Subtract Date From Date ${cli_date_time}
38 ... ${redfish_date_time}
39 ${time_diff}= Evaluate abs(${time_diff})
40 Rprint Vars redfish_date_time cli_date_time time_diff
41 Should Be True ${time_diff} < ${max_time_diff_in_seconds}
42 ... The difference between Redfish time and CLI time exceeds the allowed time difference.
43
44
Sivas SRR8a53dad2019-05-16 08:56:14 -050045Verify Set Time Using Redfish
46 [Documentation] Verify set time using redfish API.
47 [Tags] Verify_Set_Time_Using_Redfish
48
Anusha Dathatri87e4e552020-05-28 07:02:42 -050049 Set Time To Manual Mode
Sushil Singh79b04aa2019-06-18 05:25:34 -050050
Sivas SRR8a53dad2019-05-16 08:56:14 -050051 ${old_bmc_time}= CLI Get BMC DateTime
52 # Add 3 days to current date.
53 ${new_bmc_time}= Add Time to Date ${old_bmc_time} 3 Days
54 Redfish Set DateTime ${new_bmc_time}
55 ${cli_bmc_time}= CLI Get BMC DateTime
56 ${time_diff}= Subtract Date From Date ${cli_bmc_time}
57 ... ${new_bmc_time}
58 ${time_diff}= Evaluate abs(${time_diff})
59 Rprint Vars old_bmc_time new_bmc_time cli_bmc_time time_diff max_time_diff_in_seconds
60 Should Be True ${time_diff} < ${max_time_diff_in_seconds}
61 ... The difference between Redfish time and CLI time exceeds the allowed time difference.
62 # Setting back to old bmc time.
63 Redfish Set DateTime ${old_bmc_time}
64
65
Sivas SRR9e00ff32019-07-18 10:38:44 -050066Verify Set DateTime With Offset Using Redfish
67 [Documentation] Verify set DateTime with offset using redfish API.
68 [Tags] Verify_Set_DateTime_With_Offset_Using_Redfish
69 [Teardown] Run Keywords Redfish Set DateTime AND FFDC On Test Case Fail
70
71 Redfish Set DateTime ${date_time_with_offset}
72 ${cli_bmc_time}= CLI Get BMC DateTime
73
74 ${date_time_diff}= Subtract Date From Date ${cli_bmc_time}
75 ... ${expected_date_time} exclude_millis=yes
76 ${date_time_diff}= Convert to Integer ${date_time_diff}
Michael Walsh09083a82019-08-01 12:46:16 -050077 Rprint Vars date_time_with_offset expected_date_time cli_bmc_time
Sivas SRR9e00ff32019-07-18 10:38:44 -050078 ... date_time_diff max_time_diff_in_seconds
Michael Walsh09083a82019-08-01 12:46:16 -050079 Valid Range date_time_diff 0 ${max_time_diff_in_seconds}
Sivas SRR9e00ff32019-07-18 10:38:44 -050080
81
Sivas SRR3f152ae2019-06-07 10:02:51 -050082Verify Set DateTime With Invalid Data Using Redfish
83 [Documentation] Verify error while setting invalid DateTime using Redfish.
84 [Tags] Verify_Set_DateTime_With_Invalid_Data_Using_Redfish
85
86 Redfish Set DateTime ${invalid_datetime} valid_status_codes=[${HTTP_BAD_REQUEST}]
87
88
Sivas SRR4d645992019-06-20 05:34:50 -050089Verify DateTime Persists After Reboot
90 [Documentation] Verify date persists after BMC reboot.
91 [Tags] Verify_DateTime_Persists_After_Reboot
92
93 # Synchronize BMC date/time to local system date/time.
94 ${local_system_time}= Get Current Date
95 Redfish Set DateTime ${local_system_time}
96 Redfish OBMC Reboot (off)
97 Redfish.Login
98 ${bmc_time}= CLI Get BMC DateTime
99 ${local_system_time}= Get Current Date
100 ${time_diff}= Subtract Date From Date ${bmc_time}
101 ... ${local_system_time}
102 ${time_diff}= Evaluate abs(${time_diff})
103 Rprint Vars local_system_time bmc_time time_diff max_time_diff_in_seconds
104 Should Be True ${time_diff} < ${max_time_diff_in_seconds}
105 ... The difference between Redfish time and CLI time exceeds the allowed time difference.
106
107
Sivas SRR62d22d02019-06-08 12:13:31 -0500108Verify NTP Server Set
George Keishing5c7318d2022-07-07 12:46:00 -0500109 [Documentation] Patch NTP servers and verify NTP servers is set.
Sivas SRR62d22d02019-06-08 12:13:31 -0500110 [Tags] Verify_NTP_Server_Set
George Keishing5c7318d2022-07-07 12:46:00 -0500111 [Setup] Set NTP state ${True}
Sivas SRR62d22d02019-06-08 12:13:31 -0500112
George Keishing093c1bd2020-02-10 09:47:34 -0600113 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI}
114 ... body={'NTP':{'NTPServers': ['${ntp_server_1}', '${ntp_server_2}']}}
George Keishingfa2840d2020-01-28 01:41:30 -0600115 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Sivas SRR62d22d02019-06-08 12:13:31 -0500116
George Keishing5c7318d2022-07-07 12:46:00 -0500117 # NTP network take few seconds to reload.
118 Wait Until Keyword Succeeds 30 sec 10 sec Verify NTP Servers Are Populated
Sivas SRR62d22d02019-06-08 12:13:31 -0500119
120Verify NTP Server Value Not Duplicated
121 [Documentation] Verify NTP servers value not same for both primary and secondary server.
122 [Tags] Verify_NTP_Server_Value_Not_Duplicated
123
George Keishing093c1bd2020-02-10 09:47:34 -0600124 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI}
125 ... body={'NTP':{'NTPServers': ['${ntp_server_1}', '${ntp_server_1}']}}
George Keishingfa2840d2020-01-28 01:41:30 -0600126 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Sivas SRR62d22d02019-06-08 12:13:31 -0500127 ${network_protocol}= Redfish.Get Properties ${REDFISH_NW_PROTOCOL_URI}
128 Should Contain X Times ${network_protocol["NTP"]["NTPServers"]} ${ntp_server_1} 1
George Keishing1af70ef2019-06-11 09:31:10 -0500129 ... msg=NTP primary and secondary server values should not be same.
Sivas SRR62d22d02019-06-08 12:13:31 -0500130
131
Sivas SRRaac72b02019-06-11 08:56:10 -0500132Verify NTP Server Setting Persist After BMC Reboot
133 [Documentation] Verify NTP server setting persist after BMC reboot.
134 [Tags] Verify_NTP_Server_Setting_Persist_After_BMC_Reboot
George Keishing5c7318d2022-07-07 12:46:00 -0500135 [Setup] Set NTP state ${True}
Sivas SRRaac72b02019-06-11 08:56:10 -0500136
George Keishing093c1bd2020-02-10 09:47:34 -0600137 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI}
138 ... body={'NTP':{'NTPServers': ['${ntp_server_1}', '${ntp_server_2}']}}
George Keishingfa2840d2020-01-28 01:41:30 -0600139 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Sivas SRRaac72b02019-06-11 08:56:10 -0500140 Redfish OBMC Reboot (off)
141 Redfish.Login
George Keishing5c7318d2022-07-07 12:46:00 -0500142
143 # NTP network take few seconds to reload.
144 Wait Until Keyword Succeeds 30 sec 10 sec Verify NTP Servers Are Populated
Sivas SRRaac72b02019-06-11 08:56:10 -0500145
146
Sivas SRR20fe0322019-06-17 04:24:18 -0500147Verify Enable NTP
148 [Documentation] Verify NTP protocol mode can be enabled.
149 [Teardown] Restore NTP Mode
150 [Tags] Verify_Enable_NTP
151
152 ${original_ntp}= Redfish.Get Attribute ${REDFISH_NW_PROTOCOL_URI} NTP
153 Set Suite Variable ${original_ntp}
Michael Walsh39c00512019-07-17 10:54:06 -0500154 Rprint Vars original_ntp
Sivas SRR20fe0322019-06-17 04:24:18 -0500155 # The following patch command should set the ["NTP"]["ProtocolEnabled"] property to "True".
George Keishingfa2840d2020-01-28 01:41:30 -0600156 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI} body={'NTP':{'ProtocolEnabled': ${True}}}
157 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
aravinth051083f31182022-09-30 12:32:57 +0000158 Wait Until Keyword Succeeds 1 min 5 sec
aravinth0510f031ca12022-06-16 12:47:33 +0000159 ... Verify System Time Sync Status ${True}
Sivas SRR20fe0322019-06-17 04:24:18 -0500160 ${ntp}= Redfish.Get Attribute ${REDFISH_NW_PROTOCOL_URI} NTP
Michael Walsh39c00512019-07-17 10:54:06 -0500161 Rprint Vars ntp
Michael Walshe7edb222019-08-19 17:39:38 -0500162 Valid Value ntp["ProtocolEnabled"] valid_values=[True]
Sivas SRR20fe0322019-06-17 04:24:18 -0500163
164
Anusha Dathatri4ad9f432020-06-29 05:18:29 -0500165Verify Immediate Consumption Of BMC Date
166 [Documentation] Verify immediate change in BMC date time.
167 [Tags] Verify_Immediate_Consumption_Of_BMC_Date
168 [Setup] Run Keywords Set Time To Manual Mode AND
Anusha Dathatriad6a3df2020-07-22 05:20:18 -0500169 ... Redfish Set DateTime valid_status_codes=[${HTTP_OK}]
Anusha Dathatri4ad9f432020-06-29 05:18:29 -0500170 [Teardown] Run Keywords FFDC On Test Case Fail AND
171 ... Redfish Set DateTime valid_status_codes=[${HTTP_OK}]
172 [Template] Set BMC Date And Verify
173
174 # host_state
175 on
176 off
177
178
aravinth0510f031ca12022-06-16 12:47:33 +0000179Verify Set DateTime With NTP Enabled
180 [Documentation] Verify whether set managers dateTime is restricted with NTP enabled.
181 [Tags] Verify_Set_DateTime_With_NTP_Enabled
182
183 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI} body={'NTP':{'ProtocolEnabled': ${True}}}
184 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
185 ${ntp}= Redfish.Get Attribute ${REDFISH_NW_PROTOCOL_URI} NTP
186 Valid Value ntp["ProtocolEnabled"] valid_values=[True]
187 ${local_system_time}= Get Current Date
188 Redfish Set DateTime ${local_system_time}
189 ... valid_status_codes=[${HTTP_BAD_REQUEST}, ${HTTP_INTERNAL_SERVER_ERROR}]
190
191
Sivas SRR0e3bc6d2019-04-23 08:36:35 -0500192*** Keywords ***
193
Sivas SRR4d645992019-06-20 05:34:50 -0500194
Sivas SRR0e3bc6d2019-04-23 08:36:35 -0500195Test Teardown Execution
196 [Documentation] Do the post test teardown.
197
198 FFDC On Test Case Fail
Sivas SRR0e3bc6d2019-04-23 08:36:35 -0500199
200
201Redfish Get DateTime
202 [Documentation] Returns BMC Datetime value from Redfish.
203
ganesanb4d430282023-04-27 14:33:23 +0000204 ${date_time}= Redfish.Get Attribute ${REDFISH_BASE_URI}Managers/${MANAGER_ID} DateTime
Sivas SRR0e3bc6d2019-04-23 08:36:35 -0500205 [Return] ${date_time}
Sivas SRR8a53dad2019-05-16 08:56:14 -0500206
207
208Redfish Set DateTime
209 [Documentation] Set DateTime using Redfish.
Sivas SRR9e00ff32019-07-18 10:38:44 -0500210 [Arguments] ${date_time}=${EMPTY} &{kwargs}
Sivas SRR8a53dad2019-05-16 08:56:14 -0500211 # Description of argument(s):
Sivas SRR3f152ae2019-06-07 10:02:51 -0500212 # date_time New time to set for BMC (eg.
Sivas SRR9e00ff32019-07-18 10:38:44 -0500213 # "2019-06-30 09:21:28"). If this value is
214 # empty, it will be set to the UTC current
215 # date time of the local system.
George Keishing7bc01e92021-06-15 11:07:14 -0500216 # kwargs Additional parameters to be passed directly to
Sivas SRR3f152ae2019-06-07 10:02:51 -0500217 # th Redfish.Patch function. A good use for
218 # this is when testing a bad date-time, the
219 # caller can specify
220 # valid_status_codes=[${HTTP_BAD_REQUEST}].
Sivas SRR8a53dad2019-05-16 08:56:14 -0500221
Sivas SRR9e00ff32019-07-18 10:38:44 -0500222 # Assign default value of UTC current date time if date_time is empty.
223 ${date_time}= Run Keyword If
224 ... '${date_time}' == '${EMPTY}' Get Current Date time_zone=UTC
225 ... ELSE
226 ... Set Variable ${date_time}
Anusha Dathatriad6a3df2020-07-22 05:20:18 -0500227 Wait Until Keyword Succeeds 1min 5sec
ganesanb4d430282023-04-27 14:33:23 +0000228 ... Redfish.Patch ${REDFISH_BASE_URI}Managers/${MANAGER_ID} body={'DateTime': '${date_time}'} &{kwargs}
Sushil Singh79b04aa2019-06-18 05:25:34 -0500229
230
Anusha Dathatri87e4e552020-05-28 07:02:42 -0500231Set Time To Manual Mode
Anusha Dathatrid1a7bf02021-09-15 03:04:45 -0500232 [Documentation] Set date time to manual mode via Redfish.
Sushil Singh79b04aa2019-06-18 05:25:34 -0500233
Anusha Dathatrid1a7bf02021-09-15 03:04:45 -0500234 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI} body={'NTP':{'ProtocolEnabled': ${False}}}
235 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Sushil Singh79b04aa2019-06-18 05:25:34 -0500236
Sivas SRR9e00ff32019-07-18 10:38:44 -0500237
Sivas SRR20fe0322019-06-17 04:24:18 -0500238Restore NTP Mode
239 [Documentation] Restore the original NTP mode.
240
241
242 Return From Keyword If &{original_ntp} == &{EMPTY}
243 Print Timen Restore NTP Mode.
244 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI}
George Keishingfa2840d2020-01-28 01:41:30 -0600245 ... body={'NTP':{'ProtocolEnabled': ${original_ntp["ProtocolEnabled"]}}}
246 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Sivas SRR20fe0322019-06-17 04:24:18 -0500247
248
249Suite Setup Execution
250 [Documentation] Do the suite level setup.
251
252 Printn
253 Redfish.Login
Tony Lee10822662020-05-12 14:53:35 +0800254 Get NTP Initial Status
ganesanb3937eaa2023-04-15 10:24:38 +0000255 ${old_date_time}= CLI Get BMC DateTime
256 ${year_status}= Run Keyword And Return Status Should Not Contain ${old_date_time} ${year_without_ntp}
257 Run Keyword If ${year_status} == False
258 ... Enable NTP And Add NTP Address
Anusha Dathatri87e4e552020-05-28 07:02:42 -0500259 Set Time To Manual Mode
Tony Lee10822662020-05-12 14:53:35 +0800260
George Keishingade5f6e2019-07-12 11:42:42 -0500261
262Suite Teardown Execution
263 [Documentation] Do the suite level teardown.
Sivas SRR9e00ff32019-07-18 10:38:44 -0500264
Sivas SRR64613ff2019-07-13 03:06:33 -0500265 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI}
George Keishingf05a1032020-01-27 11:08:51 -0600266 ... body={'NTP':{'NTPServers': ['${EMPTY}', '${EMPTY}']}}
267 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
Anusha Dathatri87e4e552020-05-28 07:02:42 -0500268 Set Time To Manual Mode
Tony Lee10822662020-05-12 14:53:35 +0800269 Restore NTP Status
George Keishingade5f6e2019-07-12 11:42:42 -0500270 Redfish.Logout
Tony Lee10822662020-05-12 14:53:35 +0800271
272
273Set NTP state
274 [Documentation] Set NTP service inactive.
275 [Arguments] ${state}
276
277 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI} body={'NTP':{'ProtocolEnabled': ${state}}}
278 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
279
280
281Get NTP Initial Status
282 [Documentation] Get NTP service Status.
283
284 ${original_ntp}= Redfish.Get Attribute ${REDFISH_NW_PROTOCOL_URI} NTP
285 Set Suite Variable ${original_ntp}
286
287
288Restore NTP Status
289 [Documentation] Restore NTP Status.
290
291 Run Keyword If '${original_ntp["ProtocolEnabled"]}' == 'True'
292 ... Set NTP state ${TRUE}
Anusha Dathatri4ad9f432020-06-29 05:18:29 -0500293 ... ELSE Set NTP state ${FALSE}
294
295
296Set BMC Date And Verify
297 [Documentation] Set BMC Date Time at a given host state and verify.
298 [Arguments] ${host_state}
299 # Description of argument(s):
300 # host_state Host state at which date time will be updated for verification
301 # (eg. on, off).
302
303 Run Keyword If '${host_state}' == 'on'
304 ... Redfish Power On stack_mode=skip
305 ... ELSE
306 ... Redfish Power off stack_mode=skip
307 ${current_date}= Get Current Date time_zone=UTC
308 ${new_value}= Subtract Time From Date ${current_date} 1 day
309 Redfish Set DateTime ${new_value} valid_status_codes=[${HTTP_OK}]
310 ${current_value}= Redfish Get DateTime
311 ${time_diff}= Subtract Date From Date ${current_value} ${new_value}
312 Should Be True '${time_diff}'<='3'
George Keishing5c7318d2022-07-07 12:46:00 -0500313
314Verify NTP Servers Are Populated
ganesanb4d430282023-04-27 14:33:23 +0000315 [Documentation] Redfish GET request /redfish/v1/Managers/${MANAGER_ID}/NetworkProtocol response
George Keishing5c7318d2022-07-07 12:46:00 -0500316 ... and verify if NTP servers are populated.
317
318 ${network_protocol}= Redfish.Get Properties ${REDFISH_NW_PROTOCOL_URI}
319 Should Contain ${network_protocol["NTP"]["NTPServers"]} ${ntp_server_1}
320 ... msg=NTP server value ${ntp_server_1} not stored.
321 Should Contain ${network_protocol["NTP"]["NTPServers"]} ${ntp_server_2}
322 ... msg=NTP server value ${ntp_server_2} not stored.
323
aravinth0510f031ca12022-06-16 12:47:33 +0000324
325Verify System Time Sync Status
326 [Documentation] Verify the status of service systemd-timesyncd matches the NTP protocol enabled state.
327 [Arguments] ${expected_sync_status}=${True}
328
329 # Description of argument(s):
330 # expected_sync_status expected status at which NTP protocol enabled will be updated for verification
331 # (eg. True, False).
332
333 ${resp}= BMC Execute Command
334 ... systemctl status systemd-timesyncd
335 ... ignore_err=${1}
336 ${sync_status}= Get Lines Matching Regexp ${resp[0]} .*Active.*
337 Run Keyword If ${expected_sync_status}==${True}
338 ... Should Contain ${sync_status} active (running)
339 Run Keyword If ${expected_sync_status}==${False}
340 ... Should Contain ${sync_status} inactive (dead)
ganesanb3937eaa2023-04-15 10:24:38 +0000341
342Enable NTP And Add NTP Address
343 [Documentation] Enable NTP Protocol and Add NTP Address.
344
345 Set NTP state ${TRUE}
346
347 Redfish.Patch ${REDFISH_NW_PROTOCOL_URI} body={'NTP':{'NTPServers': ${NTP_SERVER_ADDRESSES}}}
348 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
349
350 Wait Until Keyword Succeeds 1 min 10 sec Check Date And Time Was Changed
351
352Check Date And Time Was Changed
353 [Documentation] Verify date was current date and time.
354
355 ${new_date_time}= CLI Get BMC DateTime
356 Should Not Contain ${new_date_time} ${year_without_ntp}