1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
# Copyright 2017 Hewlett Packard Enterprise Company, L.P.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import fnmatch
import io
import os
import re
import shutil
import tarfile
import tempfile
import time
from oslo_concurrency import processutils
from oslo_serialization import base64
from proliantutils import exception
from proliantutils import utils
HPSUM_LOCATION = 'hp/swpackages/hpsum'
SUM_LOCATION = 'packages/smartupdate'
WAIT_TIME_DISK_LABEL_TO_BE_VISIBLE = 5
# List of log files created by SUM based firmware update.
OUTPUT_FILES = ['/var/hp/log/localhost/hpsum_log.txt',
'/var/hp/log/localhost/hpsum_detail_log.txt',
'/var/log/sum/localhost/sum_log.txt',
'/var/log/sum/localhost/sum_detail_log.txt']
EXIT_CODE_TO_STRING = {
0: "The smart component was installed successfully.",
1: ("The smart component was installed successfully, but the system "
"must be restarted."),
3: ("The smart component was not installed. Node is already "
"up-to-date."),
253: "The installation of the component failed."
}
def _execute_sum(sum_file_path, mount_point, components=None):
"""Executes the SUM based firmware update command.
This method executes the SUM based firmware update command to update the
components specified, if not, it performs update on all the firmware
components on th server.
:param sum_file_path: A string with the path to the SUM binary to be
executed
:param components: A list of components to be updated. If it is None, all
the firmware components are updated.
:param mount_point: Location in which SPP iso is mounted.
:returns: A string with the statistics of the updated/failed components.
:raises: SUMOperationError, when the SUM based firmware update operation
on the node fails.
"""
cmd = ' --c ' + ' --c '.join(components) if components else ''
try:
if SUM_LOCATION in sum_file_path:
location = os.path.join(mount_point, 'packages')
# NOTE: 'launch_sum.sh' binary is part of SPP ISO and it is
# available in the SPP mount point (eg:'/mount/launch_sum.sh').
# 'launch_sum.sh' binary calls the 'smartupdate' binary by passing
# the arguments.
processutils.execute('./launch_sum.sh', '--s', '--romonly',
'--use_location', location, cmd,
cwd=mount_point)
else:
processutils.execute(sum_file_path, '--s', '--romonly', cmd)
except processutils.ProcessExecutionError as e:
result = _parse_sum_ouput(e.exit_code)
if result:
return result
else:
raise exception.SUMOperationError(reason=str(e))
def _get_log_file_data_as_encoded_content():
"""Gzip and base64 encode files and BytesIO buffers.
This method gets the log files created by SUM based
firmware update and tar zip the files.
:returns: A gzipped and base64 encoded string as text.
"""
with io.BytesIO() as fp:
with tarfile.open(fileobj=fp, mode='w:gz') as tar:
for f in OUTPUT_FILES:
if os.path.isfile(f):
tar.add(f)
fp.seek(0)
return base64.encode_as_bytes(fp.getvalue())
def _parse_sum_ouput(exit_code):
"""Parse the SUM output log file.
This method parses through the SUM log file in the
default location to return the SUM update status. Sample return
string:
"Summary: The installation of the component failed. Status of updated
components: Total: 5 Success: 4 Failed: 1"
:param exit_code: A integer returned by the SUM after command execution.
:returns: A string with the statistics of the updated/failed
components and 'None' when the exit_code is not 0, 1, 3 or 253.
"""
if exit_code == 3:
return "Summary: %s" % EXIT_CODE_TO_STRING.get(exit_code)
if exit_code in (0, 1, 253):
if os.path.exists(OUTPUT_FILES[0]):
with open(OUTPUT_FILES[0], 'r') as f:
output_data = f.read()
ret_data = output_data[(output_data.find('Deployed Components:')
+ len('Deployed Components:')):
output_data.find('Exit status:')]
failed = 0
success = 0
for line in re.split('\n\n', ret_data):
if line:
if 'Success' not in line:
failed += 1
else:
success += 1
return {
'Summary': (
"%(return_string)s Status of updated components: Total: "
"%(total)s Success: %(success)s Failed: %(failed)s." %
{'return_string': EXIT_CODE_TO_STRING.get(exit_code),
'total': (success + failed), 'success': success,
'failed': failed}),
'Log Data': _get_log_file_data_as_encoded_content()
}
return "UPDATE STATUS: UNKNOWN"
def update_firmware(node, url, checksum, components=None):
"""Performs SUM based firmware update on the node.
This method performs SUM firmware update by mounting the
SPP ISO on the node. It performs firmware update on all or
some of the firmware components.
:param node: A dictionary of the node object.
:param url: URL of SPP (Service Pack for Proliant) ISO.
:param checksum: MD5 checksum of SPP ISO to verify the image.
:param components: List of filenames of the firmware components to be
flashed. If not provided, the firmware update is performed on all
the firmware components.
:returns: Operation Status string.
:raises: SUMOperationError, when the vmedia device is not found or
when the mount operation fails or when the image validation fails.
:raises: IloConnectionError, when the iLO connection fails.
:raises: IloError, when vmedia eject or insert operation fails.
"""
# Validates the http image reference for SUM update ISO.
try:
utils.validate_href(url)
except exception.ImageRefValidationFailed as e:
raise exception.SUMOperationError(reason=e)
# Waits for the OS to detect the disk and update the label file. SPP ISO
# is identified by matching its label.
time.sleep(WAIT_TIME_DISK_LABEL_TO_BE_VISIBLE)
vmedia_device_dir = "/dev/disk/by-label/"
for fname in os.listdir(vmedia_device_dir):
if fnmatch.fnmatch(fname, 'SPP*'):
vmedia_device_file = os.path.join(vmedia_device_dir, fname)
if not os.path.exists(vmedia_device_file):
msg = "Unable to find the virtual media device for SUM"
raise exception.SUMOperationError(reason=msg)
# Validates the SPP ISO image for any file corruption using the checksum
# of the ISO file.
try:
utils.verify_image_checksum(vmedia_device_file, checksum)
except exception.ImageRefValidationFailed as e:
raise exception.SUMOperationError(reason=e)
# Mounts SPP ISO on a temporary directory.
vmedia_mount_point = tempfile.mkdtemp()
try:
try:
processutils.execute("mount", vmedia_device_file,
vmedia_mount_point)
except processutils.ProcessExecutionError as e:
msg = ("Unable to mount virtual media device %(device)s: "
"%(error)s" % {'device': vmedia_device_file, 'error': e})
raise exception.SUMOperationError(reason=msg)
# Executes the SUM based firmware update by passing the 'smartupdate'
# executable path if exists else 'hpsum' executable path and the
# components specified (if any).
sum_file_path = os.path.join(vmedia_mount_point, SUM_LOCATION)
if not os.path.exists(sum_file_path):
sum_file_path = os.path.join(vmedia_mount_point, HPSUM_LOCATION)
result = _execute_sum(sum_file_path, vmedia_mount_point,
components=components)
processutils.trycmd("umount", vmedia_mount_point)
finally:
shutil.rmtree(vmedia_mount_point, ignore_errors=True)
return result
|
