xref: /openbmc/openbmc-test-automation/lib/bmc_date_and_time_utils.robot (revision 069b266e40a93fda3992c888062745b1ac920473)
1*** Settings ***
2Documentation  This module provides general keywords for date time and ntp.
3
4Resource                     ../../lib/resource.robot
5Resource                     ../../lib/bmc_redfish_resource.robot
6Resource                     ../../lib/common_utils.robot
7Resource                     ../../lib/openbmc_ffdc.robot
8Resource                     ../../lib/utils.robot
9Resource                     ../../lib/rest_client.robot
10Library                      ../../lib/gen_robot_valid.py
11
12*** Variables ***
13
14${year_without_ntp}          1970
15
16*** Keywords ***
17
18
19Redfish Get DateTime
20    [Documentation]  Returns BMC Datetime value from Redfish.
21
22    ${date_time}=  Redfish.Get Attribute  ${REDFISH_BASE_URI}Managers/${MANAGER_ID}  DateTime
23    RETURN  ${date_time}
24
25
26Redfish Set DateTime
27    [Documentation]  Set DateTime using Redfish.
28    [Arguments]  ${date_time}=${EMPTY}  ${request_type}=valid
29    # Description of argument(s):
30    # date_time                     New time to set for BMC (eg.
31    #                               "2019-06-30 09:21:28"). If this value is
32    #                               empty, it will be set to the UTC current
33    #                               date time of the local system.
34    # request_type                  By default user request is valid.
35    #                               User can pass invalid to identify the user
36    #                               date time input will result in failure as
37    #                               expected.
38
39    # Assign default value of UTC current date time if date_time is empty.
40    ${current_date_time}=  Get Current Date  time_zone=UTC
41    ${date_time}=  Set Variable If  '${date_time}' == '${EMPTY}'
42    ...  ${current_date_time}  ${date_time}
43
44    # Patch date_time based on type of ${request_type}.
45    IF  '${request_type}' == 'valid'
46        ${date_time}=  Convert Date  ${date_time}  result_format=%Y-%m-%dT%H:%M:%S+00:00
47        Wait Until Keyword Succeeds  1min  5sec
48        ...  Redfish.Patch  ${REDFISH_BASE_URI}Managers/${MANAGER_ID}
49        ...  body={'DateTime': '${date_time}'}
50        ...  valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
51    ELSE
52        Wait Until Keyword Succeeds  1min  5sec
53        ...  Redfish.Patch  ${REDFISH_BASE_URI}Managers/${MANAGER_ID}
54        ...  body={'DateTime': '${date_time}'}
55        ...  valid_status_codes=[${HTTP_BAD_REQUEST}]
56    END
57
58
59Set Time To Manual Mode
60    [Documentation]  Set date time to manual mode via Redfish.
61
62    Redfish.Patch  ${REDFISH_NW_PROTOCOL_URI}  body={'NTP':{'ProtocolEnabled': ${False}}}
63    ...  valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
64
65
66Set BMC Date And Verify
67    [Documentation]  Set BMC Date Time at a given host state and verify.
68    [Arguments]  ${host_state}
69    # Description of argument(s):
70    # host_state  Host state at which date time will be updated for verification
71    #             (eg. on, off).
72
73    IF  '${host_state}' == 'on'
74        Redfish Power On  stack_mode=skip
75    ELSE
76        Redfish Power off  stack_mode=skip
77    END
78
79    ${current_date}=  Get Current Date  time_zone=UTC
80    ${new_value}=  Subtract Time From Date  ${current_date}  1 day
81    Redfish Set DateTime  ${new_value}
82    ${current_value}=  Redfish Get DateTime
83    ${time_diff}=  Subtract Date From Date  ${current_value}  ${new_value}
84    Should Be True  '${time_diff}'<='3'
85
86
87Set NTP state
88    [Documentation]  Set NTP service inactive.
89    [Arguments]  ${state}
90    # Description of argument(s):
91    # state      NTP protocol state (True/False).
92
93    Redfish.Patch  ${REDFISH_NW_PROTOCOL_URI}  body={'NTP':{'ProtocolEnabled': ${state}}}
94    ...  valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
95
96
97Get NTP Initial Status
98    [Documentation]  Get NTP service Status.
99
100    ${original_ntp}=  Redfish.Get Attribute  ${REDFISH_NW_PROTOCOL_URI}  NTP
101    Set Suite Variable  ${original_ntp}
102
103
104Restore NTP Status
105    [Documentation]  Restore NTP Status.
106
107    IF  '${original_ntp["ProtocolEnabled"]}' == 'True'
108        Set NTP state  ${TRUE}
109    ELSE
110        Set NTP state  ${FALSE}
111    END
112
113
114Verify NTP Servers Are Populated
115    [Documentation]  Redfish GET request /redfish/v1/Managers/${MANAGER_ID}/NetworkProtocol response
116    ...              and verify if NTP servers are populated.
117
118    ${network_protocol}=  Redfish.Get Properties  ${REDFISH_NW_PROTOCOL_URI}
119    Should Contain  ${network_protocol["NTP"]["NTPServers"]}  ${ntp_server_1}
120    ...  msg=NTP server value ${ntp_server_1} not stored.
121    Should Contain  ${network_protocol["NTP"]["NTPServers"]}  ${ntp_server_2}
122    ...  msg=NTP server value ${ntp_server_2} not stored.
123
124
125Verify System Time Sync Status
126    [Documentation]  Verify the status of service systemd-timesyncd matches the NTP protocol enabled state.
127    [Arguments]  ${expected_sync_status}=${True}
128
129    # Description of argument(s):
130    # expected_sync_status  expected status at which NTP protocol enabled will be updated for verification
131    #                       (eg. True, False).
132
133    ${resp}=  BMC Execute Command
134    ...  systemctl status systemd-timesyncd
135    ...  ignore_err=${1}
136    ${sync_status}=  Get Lines Matching Regexp  ${resp[0]}  .*Active.*
137    IF  ${expected_sync_status}==${True}
138        Should Contain  ${sync_status}  active (running)
139    END
140    IF  ${expected_sync_status}==${False}
141        Should Contain  ${sync_status}  inactive (dead)
142    END
143
144
145Enable NTP And Add NTP Address
146    [Documentation]  Enable NTP Protocol and Add NTP Address.
147
148    Set NTP state  ${TRUE}
149
150    Redfish.Patch  ${REDFISH_NW_PROTOCOL_URI}  body={'NTP':{'NTPServers': ${NTP_SERVER_ADDRESSES}}}
151    ...  valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
152
153    Wait Until Keyword Succeeds  1 min  10 sec  Check Date And Time Was Changed
154
155
156Check Date And Time Was Changed
157    [Documentation]  Verify date was current date and time.
158
159    ${new_date_time}=  CLI Get BMC DateTime
160    Should Not Contain  ${new_date_time}  ${year_without_ntp}
161
162
163Restore NTP Mode
164    [Documentation]  Restore the original NTP mode.
165
166    Return From Keyword If  &{original_ntp} == &{EMPTY}
167    Print Timen  Restore NTP Mode.
168    Redfish.Patch  ${REDFISH_NW_PROTOCOL_URI}
169    ...  body={'NTP':{'ProtocolEnabled': ${original_ntp["ProtocolEnabled"]}}}
170    ...  valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
171