1*** Settings ***
2Documentation            Update the BMC code on a target BMC via Redifsh.
3
4# Test Parameters:
5# IMAGE_FILE_PATH        The path to the BMC image file.
6#
7# Firmware update states:
8#     Enabled            Image is installed and either functional or active.
9#     Disabled           Image installation failed or ready for activation.
10#     Updating           Image installation currently in progress.
11
12Resource                 ../../lib/resource.robot
13Resource                 ../../lib/bmc_redfish_resource.robot
14Resource                 ../../lib/openbmc_ffdc.robot
15Resource                 ../../lib/common_utils.robot
16Resource                 ../../lib/code_update_utils.robot
17Resource                 ../../lib/redfish_code_update_utils.robot
18Resource                 ../../lib/utils.robot
19Library                  ../../lib/gen_robot_valid.py
20Library                  ../../lib/var_funcs.py
21Library                  ../../lib/gen_robot_keyword.py
22
23Suite Setup              Suite Setup Execution
24Suite Teardown           Redfish.Logout
25Test Setup               Printn
26Test Teardown            FFDC On Test Case Fail
27
28Force Tags               BMC_Code_Update
29
30*** Test Cases ***
31
32Redfish BMC Code Update
33    [Documentation]  Update the firmware image.
34    [Tags]  Redfish_BMC_Code_Update
35
36    ${image_version}=  Get Version Tar  ${IMAGE_FILE_PATH}
37    Rprint Vars  image_version
38
39    Run Keyword If  not ${FORCE_UPDATE}
40    ...  Activate Existing Firmware  ${image_version}
41    Redfish Update Firmware
42
43*** Keywords ***
44
45Suite Setup Execution
46    [Documentation]  Do the suite setup.
47
48    Redfish.Login
49    # Delete BMC dump and Error logs.
50    Delete All BMC Dump
51    Redfish Purge Event Log
52    # Checking for file existence.
53    Valid File Path  IMAGE_FILE_PATH
54
55Activate Existing Firmware
56    [Documentation]  Set fimware image to lower priority.
57    [Arguments]  ${image_version}
58
59    # Description of argument(s):
60    # image_version     Version of image.
61
62    ${software_inventory_record}=  Get Software Inventory State By Version
63    ...  ${image_version}
64    ${num_keys}=  Get Length  ${software_inventory_record}
65
66    Rprint Vars  software_inventory_record
67
68    # If no software inventory record was found, there is no existing
69    # firmware for the given version and therefore no action to be taken.
70    Return From Keyword If  not ${num_keys}
71
72    # Check if the existing firmware is functional.
73    Pass Execution If  ${software_inventory_record['functional']}
74    ...  The existing ${image_version} firmware is already functional.
75
76    # If existing firmware is not functional, then set the priority to least.
77    Print Timen  The existing ${image_version} firmware is not yet functional.
78    Set BMC Image Priority To Least  ${image_version}  ${software_inventory_record}
79
80    Pass Execution  The existing ${image_version} firmware is now functional.
81
82
83Get Image Priority
84    [Documentation]  Get Current Image Priority.
85    [Arguments]  ${image_version}
86
87    # Description of argument(s):
88    # image_version       The Fimware image version (e.g. 2.8.0-dev-1107-g512028d95).
89
90    ${software_info}=  Read Properties
91    ...  ${SOFTWARE_VERSION_URI}/enumerate  quiet=1
92    # Get only the record associated with our image_version.
93
94    ${software_info}=  Filter Struct
95    ...  ${software_info}  [('Version', '${image_version}')]
96    # Convert from dict to list.
97    ${software_info}=  Get Dictionary Values  ${software_info}
98
99    [Return]  ${software_info[0]['Priority']}
100
101
102Set BMC Image Priority To Least
103    [Documentation]  Set BMC image priority to least value.
104    [Arguments]  ${image_version}  ${software_inventory}
105
106    # Description of argument(s):
107    # image_version       The Fimware image version (e.g. 2.8.0-dev-1107-g512028d95).
108    # software_inventory  Software inventory details.
109
110    ${least_priority}=  Get Least Value Priority Image  ${VERSION_PURPOSE_BMC}
111    ${cur_priority}=  Get Image Priority  ${image_version}
112    Rprint Vars  least_priority  cur_priority
113
114    Return From Keyword If  '${least_priority}' == ${cur_priority}
115    Set Host Software Property
116    ...  ${SOFTWARE_VERSION_URI}${software_inventory['image_id']}
117    ...  Priority  ${least_priority}
118
119    # Reboot BMC And Login
120    Redfish OBMC Reboot (off)
121    Redfish.Login
122
123
124Redfish Update Firmware
125    [Documentation]  Update the BMC firmware via redfish interface.
126
127    ${post_code_update_actions}=  Get Post Boot Action
128    ${state}=  Get Pre Reboot State
129    Rprint Vars  state
130    Run Keyword And Ignore Error  Set ApplyTime  policy=OnReset
131    Redfish Upload Image And Check Progress State
132    ${tar_version}=  Get Version Tar  ${IMAGE_FILE_PATH}
133    ${image_info}=  Get Software Inventory State By Version  ${tar_version}
134    Run Key  ${post_code_update_actions['${image_info["image_type"]}']['OnReset']}
135    Redfish.Login
136    Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
137
138