blob: 0ade9fbff31ea4e31615d5739227001dd9c81b12 [file] [log] [blame]
Saqib Khanfb1f6ae2017-04-26 13:24:41 -05001#!/usr/bin/env python
2
3r"""
Charles Paul Hoferde7d4082017-08-08 14:41:01 -05004This module provides utilities for code updates.
Saqib Khanfb1f6ae2017-04-26 13:24:41 -05005"""
6
7import os
Saqib Khanfb1f6ae2017-04-26 13:24:41 -05008import re
Charles Paul Hoferde7d4082017-08-08 14:41:01 -05009import sys
Saqib Khanfb1f6ae2017-04-26 13:24:41 -050010import tarfile
11import time
12
13robot_pgm_dir_path = os.path.dirname(__file__) + os.sep
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050014repo_data_path = re.sub('/lib', '/data', robot_pgm_dir_path)
Saqib Khanfb1f6ae2017-04-26 13:24:41 -050015sys.path.append(repo_data_path)
16
Joy Onyerikwu9b668972018-05-22 19:10:43 -050017import bmc_ssh_utils as bsu
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050018import gen_robot_keyword as keyword
Saqib Khanfb1f6ae2017-04-26 13:24:41 -050019import gen_print as gp
20import variables as var
21from robot.libraries.BuiltIn import BuiltIn
22
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -050023
Gunnar Mills096cd562018-03-26 10:19:12 -050024def verify_no_duplicate_image_priorities(image_purpose):
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -050025 r"""
26 Check that there are no active images with the same purpose and priority.
27
28 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050029 image_purpose The purpose that images must have to be
30 checked for priority duplicates.
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -050031 """
32
33 taken_priorities = {}
34 _, image_names = keyword.run_key("Get Software Objects "
35 + "version_type=" + image_purpose)
36
37 for image_name in image_names:
38 _, image = keyword.run_key("Get Host Software Property " + image_name)
39 if image["Activation"] != var.ACTIVE:
40 continue
41 image_priority = image["Priority"]
42 if image_priority in taken_priorities:
43 BuiltIn().fail("Found active images with the same priority.\n"
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050044 + gp.sprint_vars(image,
45 taken_priorities[image_priority]))
Charles Paul Hofera5673162017-08-30 09:49:16 -050046 taken_priorities[image_priority] = image
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -050047
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -050048
Charles Paul Hoferda24d0a2017-08-09 15:03:40 -050049def get_non_running_bmc_software_object():
Charles Paul Hoferda24d0a2017-08-09 15:03:40 -050050 r"""
51 Get the URI to a BMC image from software that is not running on the BMC.
52 """
53
54 # Get the version of the image currently running on the BMC.
55 _, cur_img_version = keyword.run_key("Get BMC Version")
56 # Remove the surrounding double quotes from the version.
57 cur_img_version = cur_img_version.replace('"', '')
58
59 _, images = keyword.run_key("Read Properties "
60 + var.SOFTWARE_VERSION_URI + "enumerate")
61
62 for image_name in images:
63 _, image_properties = keyword.run_key(
Gunnar Mills096cd562018-03-26 10:19:12 -050064 "Get Host Software Property " + image_name)
Charles Paul Hofer1e487272017-09-14 12:55:11 -050065 if 'Purpose' in image_properties and 'Version' in image_properties \
66 and image_properties['Purpose'] != var.VERSION_PURPOSE_HOST \
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050067 and image_properties['Version'] != cur_img_version:
Charles Paul Hoferda24d0a2017-08-09 15:03:40 -050068 return image_name
69 BuiltIn().fail("Did not find any non-running BMC images.")
70
Charles Paul Hoferda24d0a2017-08-09 15:03:40 -050071
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050072def delete_all_pnor_images():
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050073 r"""
74 Delete all PNOR images from the BMC.
75 """
76
Adriana Kobylak7eedb1d2019-08-12 15:24:23 -050077 keyword.run_key("Initiate Host PowerOff")
78
George Keishing8e984782017-08-30 14:16:18 -050079 status, images = keyword.run_key("Get Software Objects "
80 + var.VERSION_PURPOSE_HOST)
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050081 for image_name in images:
Adriana Kobylak7eedb1d2019-08-12 15:24:23 -050082 keyword.run_key("Delete Image And Verify " + image_name + " "
83 + var.VERSION_PURPOSE_HOST)
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050084
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050085
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050086def wait_for_activation_state_change(version_id, initial_state):
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050087 r"""
88 Wait for the current activation state of ${version_id} to
89 change from the state provided by the calling function.
90
91 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -050092 version_id The version ID whose state change we are
93 waiting for.
94 initial_state The activation state we want to wait for.
Charles Paul Hoferde7d4082017-08-08 14:41:01 -050095 """
96
97 keyword.run_key_u("Open Connection And Log In")
98 retry = 0
Charles Paul Hofer290b8bd2017-09-26 10:02:22 -050099 num_read_errors = 0
100 read_fail_threshold = 1
George Keishing532f6c42018-11-27 09:01:57 -0600101 while (retry < 60):
Charles Paul Hofer290b8bd2017-09-26 10:02:22 -0500102 # TODO: Use retry option in run_key when available.
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500103 status, software_state = keyword.run_key("Read Properties "
104 + var.SOFTWARE_VERSION_URI
105 + str(version_id),
Gunnar Mills096cd562018-03-26 10:19:12 -0500106 ignore=1)
Charles Paul Hofer290b8bd2017-09-26 10:02:22 -0500107 if status == 'FAIL':
108 num_read_errors += 1
109 if num_read_errors > read_fail_threshold:
110 message = "Read errors exceeds threshold:\n " \
Gunnar Mills096cd562018-03-26 10:19:12 -0500111 + gp.sprint_vars(num_read_errors, read_fail_threshold)
Charles Paul Hofer290b8bd2017-09-26 10:02:22 -0500112 BuiltIn().fail(message)
Charles Paul Hofer4d26c002017-09-27 08:39:29 -0500113 time.sleep(10)
Charles Paul Hofer290b8bd2017-09-26 10:02:22 -0500114 continue
115
Charles Paul Hoferde7d4082017-08-08 14:41:01 -0500116 current_state = (software_state)["Activation"]
117 if (initial_state == current_state):
Charles Paul Hofer4d26c002017-09-27 08:39:29 -0500118 time.sleep(10)
Charles Paul Hoferde7d4082017-08-08 14:41:01 -0500119 retry += 1
Charles Paul Hofer290b8bd2017-09-26 10:02:22 -0500120 num_read_errors = 0
Charles Paul Hoferde7d4082017-08-08 14:41:01 -0500121 else:
122 return
123 return
124
Charles Paul Hoferde7d4082017-08-08 14:41:01 -0500125
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500126def get_latest_file(dir_path):
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500127 r"""
128 Get the path to the latest uploaded file.
129
130 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500131 dir_path Path to the dir from which the name of the
132 last updated file or folder will be
133 returned to the calling function.
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500134 """
135
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500136 stdout, stderr, rc = \
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500137 bsu.bmc_execute_command("cd " + dir_path
138 + "; stat -c '%Y %n' * |"
139 + " sort -k1,1nr | head -n 1")
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500140 return stdout.split(" ")[-1]
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500141
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500142
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500143def get_version_tar(tar_file_path):
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500144 r"""
145 Read the image version from the MANIFEST inside the tarball.
146
147 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500148 tar_file_path The path to a tar file that holds the image
149 version inside the MANIFEST.
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500150 """
151
152 tar = tarfile.open(tar_file_path)
153 for member in tar.getmembers():
Gunnar Mills096cd562018-03-26 10:19:12 -0500154 f = tar.extractfile(member)
155 content = f.read()
George Keishing36efbc02018-12-12 10:18:23 -0600156 if content.find(b"version=") == -1:
157 # This tar member does not contain the version.
158 continue
159 content = content.decode("utf-8").split("\n")
160 content = [x for x in content if "version=" in x]
161 version = content[0].split("=")[-1]
162 break
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500163 tar.close()
164 return version
165
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500166
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500167def get_image_version(file_path):
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500168 r"""
169 Read the file for a version object.
170
171 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500172 file_path The path to a file that holds the image
173 version.
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500174 """
175
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500176 stdout, stderr, rc = \
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500177 bsu.bmc_execute_command("cat " + file_path
178 + " | grep \"version=\"", ignore_err=1)
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500179 return (stdout.split("\n")[0]).split("=")[-1]
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500180
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500181
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500182def get_image_purpose(file_path):
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500183 r"""
184 Read the file for a purpose object.
185
186 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500187 file_path The path to a file that holds the image
188 purpose.
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500189 """
190
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500191 stdout, stderr, rc = \
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500192 bsu.bmc_execute_command("cat " + file_path
193 + " | grep \"purpose=\"", ignore_err=1)
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500194 return stdout.split("=")[-1]
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500195
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500196
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500197def get_image_path(image_version):
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500198 r"""
199 Query the upload image dir for the presence of image matching
200 the version that was read from the MANIFEST before uploading
201 the image. Based on the purpose verify the activation object
202 exists and is either READY or INVALID.
203
204 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500205 image_version The version of the image that should match
206 one of the images in the upload dir.
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500207 """
208
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500209 stdout, stderr, rc = \
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500210 bsu.bmc_execute_command("ls -d " + var.IMAGE_UPLOAD_DIR_PATH + "*/")
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500211
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500212 image_list = stdout.split("\n")
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500213 retry = 0
214 while (retry < 10):
215 for i in range(0, len(image_list)):
216 version = get_image_version(image_list[i] + "MANIFEST")
217 if (version == image_version):
218 return image_list[i]
219 time.sleep(10)
220 retry += 1
221
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500222
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500223def verify_image_upload(image_version,
224 timeout=3):
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500225 r"""
226 Verify the image was uploaded correctly and that it created
Charles Paul Hofer6b972682017-07-20 11:36:56 -0500227 a valid d-bus object. If the first check for the image
228 fails, try again until we reach the timeout.
229
230 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500231 image_version The version from the image's manifest file
232 (e.g. "v2.2-253-g00050f1").
233 timeout How long, in minutes, to keep trying to
234 find the image on the BMC. Default is 3 minutes.
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500235 """
236
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500237 image_path = get_image_path(image_version)
238 image_version_id = image_path.split("/")[-2]
239
Charles Paul Hoferde7d4082017-08-08 14:41:01 -0500240 keyword.run_key_u("Open Connection And Log In")
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500241 image_purpose = get_image_purpose(image_path + "MANIFEST")
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500242 if (image_purpose == var.VERSION_PURPOSE_BMC
243 or image_purpose == var.VERSION_PURPOSE_HOST):
George Keishingff1e3ec2017-07-20 01:58:21 -0500244 uri = var.SOFTWARE_VERSION_URI + image_version_id
Charles Paul Hofer6b972682017-07-20 11:36:56 -0500245 ret_values = ""
246 for itr in range(timeout * 2):
247 status, ret_values = \
Charles Paul Hoferde7d4082017-08-08 14:41:01 -0500248 keyword.run_key("Read Attribute " + uri + " Activation")
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500249
Charles Paul Hofer6b972682017-07-20 11:36:56 -0500250 if ((ret_values == var.READY) or (ret_values == var.INVALID)
251 or (ret_values == var.ACTIVE)):
Charles Paul Hofercef61992017-08-18 10:14:18 -0500252 return True, image_version_id
Charles Paul Hofer6b972682017-07-20 11:36:56 -0500253 else:
254 time.sleep(30)
255
256 # If we exit the for loop, the timeout has been reached
257 gp.print_var(ret_values)
Charles Paul Hofercef61992017-08-18 10:14:18 -0500258 return False, None
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500259 else:
Saqib Khanbb8b63f2017-05-24 10:58:01 -0500260 gp.print_var(image_purpose)
Charles Paul Hofercef61992017-08-18 10:14:18 -0500261 return False, None
Saqib Khanfb1f6ae2017-04-26 13:24:41 -0500262
Charles P. Hofer1d20acd2017-07-05 15:24:40 -0500263
Charles Paul Hofer6b972682017-07-20 11:36:56 -0500264def verify_image_not_in_bmc_uploads_dir(image_version, timeout=3):
Charles P. Hofer1d20acd2017-07-05 15:24:40 -0500265 r"""
266 Check that an image with the given version is not unpacked inside of the
267 BMCs image uploads directory. If no image is found, retry every 30 seconds
Charles Paul Hofer6b972682017-07-20 11:36:56 -0500268 until the given timeout is hit, in case the BMC takes time
269 unpacking the image.
Charles P. Hofer1d20acd2017-07-05 15:24:40 -0500270
271 Description of argument(s):
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500272 image_version The version of the image to look for on
273 the BMC.
274 timeout How long, in minutes, to try to find an
275 image on the BMC. Default is 3 minutes.
Charles P. Hofer1d20acd2017-07-05 15:24:40 -0500276 """
277
Charles Paul Hofer6b972682017-07-20 11:36:56 -0500278 for i in range(timeout * 2):
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500279 stdout, stderr, rc = \
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500280 bsu.bmc_execute_command('ls ' + var.IMAGE_UPLOAD_DIR_PATH
281 + '*/MANIFEST 2>/dev/null '
282 + '| xargs grep -rl "version='
283 + image_version + '"')
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500284 image_dir = os.path.dirname(stdout.split('\n')[0])
Charles P. Hofer1d20acd2017-07-05 15:24:40 -0500285 if '' != image_dir:
Joy Onyerikwu9b668972018-05-22 19:10:43 -0500286 bsu.bmc_execute_command('rm -rf ' + image_dir)
Charles P. Hofer1d20acd2017-07-05 15:24:40 -0500287 BuiltIn().fail('Found invalid BMC Image: ' + image_dir)
288 time.sleep(30)