Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | |
| 3 | r""" |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 4 | This module provides utilities for code updates. |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 5 | """ |
| 6 | |
| 7 | import os |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 8 | import re |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 9 | import sys |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 10 | import tarfile |
| 11 | import time |
| 12 | |
| 13 | robot_pgm_dir_path = os.path.dirname(__file__) + os.sep |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 14 | repo_data_path = re.sub('/lib', '/data', robot_pgm_dir_path) |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 15 | sys.path.append(repo_data_path) |
| 16 | |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 17 | import bmc_ssh_utils as bsu |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 18 | import gen_robot_keyword as keyword |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 19 | import gen_print as gp |
| 20 | import variables as var |
| 21 | from robot.libraries.BuiltIn import BuiltIn |
| 22 | |
Charles Paul Hofer | c1fa2bc | 2017-08-18 16:44:03 -0500 | [diff] [blame] | 23 | |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 24 | def verify_no_duplicate_image_priorities(image_purpose): |
Charles Paul Hofer | c1fa2bc | 2017-08-18 16:44:03 -0500 | [diff] [blame] | 25 | r""" |
| 26 | Check that there are no active images with the same purpose and priority. |
| 27 | |
| 28 | Description of argument(s): |
| 29 | image_purpose The purpose that images must have to be checked for |
| 30 | priority duplicates. |
| 31 | """ |
| 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" |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 44 | + gp.sprint_vars(image, taken_priorities[image_priority])) |
Charles Paul Hofer | a567316 | 2017-08-30 09:49:16 -0500 | [diff] [blame] | 45 | taken_priorities[image_priority] = image |
Charles Paul Hofer | c1fa2bc | 2017-08-18 16:44:03 -0500 | [diff] [blame] | 46 | |
Charles Paul Hofer | c1fa2bc | 2017-08-18 16:44:03 -0500 | [diff] [blame] | 47 | |
Charles Paul Hofer | da24d0a | 2017-08-09 15:03:40 -0500 | [diff] [blame] | 48 | def get_non_running_bmc_software_object(): |
Charles Paul Hofer | da24d0a | 2017-08-09 15:03:40 -0500 | [diff] [blame] | 49 | r""" |
| 50 | Get the URI to a BMC image from software that is not running on the BMC. |
| 51 | """ |
| 52 | |
| 53 | # Get the version of the image currently running on the BMC. |
| 54 | _, cur_img_version = keyword.run_key("Get BMC Version") |
| 55 | # Remove the surrounding double quotes from the version. |
| 56 | cur_img_version = cur_img_version.replace('"', '') |
| 57 | |
| 58 | _, images = keyword.run_key("Read Properties " |
| 59 | + var.SOFTWARE_VERSION_URI + "enumerate") |
| 60 | |
| 61 | for image_name in images: |
| 62 | _, image_properties = keyword.run_key( |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 63 | "Get Host Software Property " + image_name) |
Charles Paul Hofer | 1e48727 | 2017-09-14 12:55:11 -0500 | [diff] [blame] | 64 | if 'Purpose' in image_properties and 'Version' in image_properties \ |
| 65 | and image_properties['Purpose'] != var.VERSION_PURPOSE_HOST \ |
Charles Paul Hofer | 9f74d3a | 2017-08-18 09:54:28 -0500 | [diff] [blame] | 66 | and image_properties['Version'] != cur_img_version: |
Charles Paul Hofer | da24d0a | 2017-08-09 15:03:40 -0500 | [diff] [blame] | 67 | return image_name |
| 68 | BuiltIn().fail("Did not find any non-running BMC images.") |
| 69 | |
Charles Paul Hofer | da24d0a | 2017-08-09 15:03:40 -0500 | [diff] [blame] | 70 | |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 71 | def delete_all_pnor_images(): |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 72 | r""" |
| 73 | Delete all PNOR images from the BMC. |
| 74 | """ |
| 75 | |
George Keishing | 8e98478 | 2017-08-30 14:16:18 -0500 | [diff] [blame] | 76 | status, images = keyword.run_key("Get Software Objects " |
| 77 | + var.VERSION_PURPOSE_HOST) |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 78 | for image_name in images: |
George Keishing | 8e98478 | 2017-08-30 14:16:18 -0500 | [diff] [blame] | 79 | BuiltIn().log_to_console(image_name) |
| 80 | # Delete twice, in case the image is in the /tmp/images directory |
| 81 | keyword.run_key("Call Method " + image_name |
| 82 | + " delete data={\"data\":[]}") |
| 83 | keyword.run_key("Call Method " + image_name |
| 84 | + " delete data={\"data\":[]}") |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 85 | |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 86 | |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 87 | def wait_for_activation_state_change(version_id, initial_state): |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 88 | r""" |
| 89 | Wait for the current activation state of ${version_id} to |
| 90 | change from the state provided by the calling function. |
| 91 | |
| 92 | Description of argument(s): |
| 93 | version_id The version ID whose state change we are waiting for. |
| 94 | initial_state The activation state we want to wait for. |
| 95 | """ |
| 96 | |
| 97 | keyword.run_key_u("Open Connection And Log In") |
| 98 | retry = 0 |
Charles Paul Hofer | 290b8bd | 2017-09-26 10:02:22 -0500 | [diff] [blame] | 99 | num_read_errors = 0 |
| 100 | read_fail_threshold = 1 |
Charles Paul Hofer | 4d26c00 | 2017-09-27 08:39:29 -0500 | [diff] [blame] | 101 | while (retry < 30): |
Charles Paul Hofer | 290b8bd | 2017-09-26 10:02:22 -0500 | [diff] [blame] | 102 | # TODO: Use retry option in run_key when available. |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 103 | status, software_state = keyword.run_key("Read Properties " + |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 104 | var.SOFTWARE_VERSION_URI + |
| 105 | str(version_id), |
| 106 | ignore=1) |
Charles Paul Hofer | 290b8bd | 2017-09-26 10:02:22 -0500 | [diff] [blame] | 107 | if status == 'FAIL': |
| 108 | num_read_errors += 1 |
| 109 | if num_read_errors > read_fail_threshold: |
| 110 | message = "Read errors exceeds threshold:\n " \ |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 111 | + gp.sprint_vars(num_read_errors, read_fail_threshold) |
Charles Paul Hofer | 290b8bd | 2017-09-26 10:02:22 -0500 | [diff] [blame] | 112 | BuiltIn().fail(message) |
Charles Paul Hofer | 4d26c00 | 2017-09-27 08:39:29 -0500 | [diff] [blame] | 113 | time.sleep(10) |
Charles Paul Hofer | 290b8bd | 2017-09-26 10:02:22 -0500 | [diff] [blame] | 114 | continue |
| 115 | |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 116 | current_state = (software_state)["Activation"] |
| 117 | if (initial_state == current_state): |
Charles Paul Hofer | 4d26c00 | 2017-09-27 08:39:29 -0500 | [diff] [blame] | 118 | time.sleep(10) |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 119 | retry += 1 |
Charles Paul Hofer | 290b8bd | 2017-09-26 10:02:22 -0500 | [diff] [blame] | 120 | num_read_errors = 0 |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 121 | else: |
| 122 | return |
| 123 | return |
| 124 | |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 125 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 126 | def get_latest_file(dir_path): |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 127 | r""" |
| 128 | Get the path to the latest uploaded file. |
| 129 | |
| 130 | Description of argument(s): |
| 131 | dir_path Path to the dir from which the name of the last |
| 132 | updated file or folder will be returned to the |
| 133 | calling function. |
| 134 | """ |
| 135 | |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 136 | stdout, stderr, rc = \ |
| 137 | bsu.bmc_execute_command("cd " + dir_path + |
| 138 | "; stat -c '%Y %n' * |" + |
| 139 | " sort -k1,1nr | head -n 1") |
| 140 | return stdout.split(" ")[-1] |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 141 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 142 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 143 | def get_version_tar(tar_file_path): |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 144 | r""" |
| 145 | Read the image version from the MANIFEST inside the tarball. |
| 146 | |
| 147 | Description of argument(s): |
| 148 | tar_file_path The path to a tar file that holds the image |
| 149 | version inside the MANIFEST. |
| 150 | """ |
| 151 | |
| 152 | tar = tarfile.open(tar_file_path) |
| 153 | for member in tar.getmembers(): |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 154 | f = tar.extractfile(member) |
| 155 | content = f.read() |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 156 | if "version=" in content: |
| 157 | content = content.split("\n") |
| 158 | content = [x for x in content if "version=" in x] |
| 159 | version = content[0].split("=")[-1] |
| 160 | break |
| 161 | tar.close() |
| 162 | return version |
| 163 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 164 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 165 | def get_image_version(file_path): |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 166 | r""" |
| 167 | Read the file for a version object. |
| 168 | |
| 169 | Description of argument(s): |
| 170 | file_path The path to a file that holds the image version. |
| 171 | """ |
| 172 | |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 173 | stdout, stderr, rc = \ |
| 174 | bsu.bmc_execute_command("cat " + file_path + |
| 175 | " | grep \"version=\"", ignore_err=1) |
| 176 | return (stdout.split("\n")[0]).split("=")[-1] |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 177 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 178 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 179 | def get_image_purpose(file_path): |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 180 | r""" |
| 181 | Read the file for a purpose object. |
| 182 | |
| 183 | Description of argument(s): |
| 184 | file_path The path to a file that holds the image purpose. |
| 185 | """ |
| 186 | |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 187 | stdout, stderr, rc = \ |
| 188 | bsu.bmc_execute_command("cat " + file_path + |
| 189 | " | grep \"purpose=\"", ignore_err=1) |
| 190 | return stdout.split("=")[-1] |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 191 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 192 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 193 | def get_image_path(image_version): |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 194 | r""" |
| 195 | Query the upload image dir for the presence of image matching |
| 196 | the version that was read from the MANIFEST before uploading |
| 197 | the image. Based on the purpose verify the activation object |
| 198 | exists and is either READY or INVALID. |
| 199 | |
| 200 | Description of argument(s): |
| 201 | image_version The version of the image that should match one |
| 202 | of the images in the upload dir. |
| 203 | """ |
| 204 | |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 205 | stdout, stderr, rc = \ |
| 206 | bsu.bmc_execute_command("ls -d " + var.IMAGE_UPLOAD_DIR_PATH + |
| 207 | "*/") |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 208 | |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 209 | image_list = stdout.split("\n") |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 210 | retry = 0 |
| 211 | while (retry < 10): |
| 212 | for i in range(0, len(image_list)): |
| 213 | version = get_image_version(image_list[i] + "MANIFEST") |
| 214 | if (version == image_version): |
| 215 | return image_list[i] |
| 216 | time.sleep(10) |
| 217 | retry += 1 |
| 218 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 219 | |
Charles Paul Hofer | 9f74d3a | 2017-08-18 09:54:28 -0500 | [diff] [blame] | 220 | def verify_image_upload(image_version, |
| 221 | timeout=3): |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 222 | r""" |
| 223 | Verify the image was uploaded correctly and that it created |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 224 | a valid d-bus object. If the first check for the image |
| 225 | fails, try again until we reach the timeout. |
| 226 | |
| 227 | Description of argument(s): |
Charles Paul Hofer | 9f74d3a | 2017-08-18 09:54:28 -0500 | [diff] [blame] | 228 | image_version The version from the image's manifest file |
George Keishing | e0a8128 | 2018-06-08 10:02:30 -0500 | [diff] [blame^] | 229 | (e.g. "v2.2-253-g00050f1"). |
Charles Paul Hofer | 9f74d3a | 2017-08-18 09:54:28 -0500 | [diff] [blame] | 230 | timeout How long, in minutes, to keep trying to find the |
| 231 | image on the BMC. Default is 3 minutes. |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 232 | """ |
| 233 | |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 234 | image_path = get_image_path(image_version) |
| 235 | image_version_id = image_path.split("/")[-2] |
| 236 | |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 237 | keyword.run_key_u("Open Connection And Log In") |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 238 | image_purpose = get_image_purpose(image_path + "MANIFEST") |
Saqib Khan | bb8b63f | 2017-05-24 10:58:01 -0500 | [diff] [blame] | 239 | if (image_purpose == var.VERSION_PURPOSE_BMC or |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 240 | image_purpose == var.VERSION_PURPOSE_HOST): |
George Keishing | ff1e3ec | 2017-07-20 01:58:21 -0500 | [diff] [blame] | 241 | uri = var.SOFTWARE_VERSION_URI + image_version_id |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 242 | ret_values = "" |
| 243 | for itr in range(timeout * 2): |
| 244 | status, ret_values = \ |
Charles Paul Hofer | de7d408 | 2017-08-08 14:41:01 -0500 | [diff] [blame] | 245 | keyword.run_key("Read Attribute " + uri + " Activation") |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 246 | |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 247 | if ((ret_values == var.READY) or (ret_values == var.INVALID) |
| 248 | or (ret_values == var.ACTIVE)): |
Charles Paul Hofer | cef6199 | 2017-08-18 10:14:18 -0500 | [diff] [blame] | 249 | return True, image_version_id |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 250 | else: |
| 251 | time.sleep(30) |
| 252 | |
| 253 | # If we exit the for loop, the timeout has been reached |
| 254 | gp.print_var(ret_values) |
Charles Paul Hofer | cef6199 | 2017-08-18 10:14:18 -0500 | [diff] [blame] | 255 | return False, None |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 256 | else: |
Saqib Khan | bb8b63f | 2017-05-24 10:58:01 -0500 | [diff] [blame] | 257 | gp.print_var(image_purpose) |
Charles Paul Hofer | cef6199 | 2017-08-18 10:14:18 -0500 | [diff] [blame] | 258 | return False, None |
Saqib Khan | fb1f6ae | 2017-04-26 13:24:41 -0500 | [diff] [blame] | 259 | |
Charles P. Hofer | 1d20acd | 2017-07-05 15:24:40 -0500 | [diff] [blame] | 260 | |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 261 | def verify_image_not_in_bmc_uploads_dir(image_version, timeout=3): |
Charles P. Hofer | 1d20acd | 2017-07-05 15:24:40 -0500 | [diff] [blame] | 262 | r""" |
| 263 | Check that an image with the given version is not unpacked inside of the |
| 264 | BMCs image uploads directory. If no image is found, retry every 30 seconds |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 265 | until the given timeout is hit, in case the BMC takes time |
| 266 | unpacking the image. |
Charles P. Hofer | 1d20acd | 2017-07-05 15:24:40 -0500 | [diff] [blame] | 267 | |
| 268 | Description of argument(s): |
| 269 | image_version The version of the image to look for on the BMC. |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 270 | timeout How long, in minutes, to try to find an image on the BMC. |
| 271 | Default is 3 minutes. |
Charles P. Hofer | 1d20acd | 2017-07-05 15:24:40 -0500 | [diff] [blame] | 272 | """ |
| 273 | |
Charles Paul Hofer | 6b97268 | 2017-07-20 11:36:56 -0500 | [diff] [blame] | 274 | for i in range(timeout * 2): |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 275 | stdout, stderr, rc = \ |
| 276 | bsu.bmc_execute_command('ls ' + var.IMAGE_UPLOAD_DIR_PATH + |
| 277 | '*/MANIFEST 2>/dev/null ' + |
| 278 | '| xargs grep -rl "version=' + |
| 279 | image_version + '"') |
| 280 | image_dir = os.path.dirname(stdout.split('\n')[0]) |
Charles P. Hofer | 1d20acd | 2017-07-05 15:24:40 -0500 | [diff] [blame] | 281 | if '' != image_dir: |
Joy Onyerikwu | 9b66897 | 2018-05-22 19:10:43 -0500 | [diff] [blame] | 282 | bsu.bmc_execute_command('rm -rf ' + image_dir) |
Charles P. Hofer | 1d20acd | 2017-07-05 15:24:40 -0500 | [diff] [blame] | 283 | BuiltIn().fail('Found invalid BMC Image: ' + image_dir) |
| 284 | time.sleep(30) |