Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 1 | package com.mirantis.mk |
Jakub Josef | 6d8082b | 2017-08-09 12:40:50 +0200 | [diff] [blame] | 2 | |
Jakub Josef | b41c8d5 | 2017-03-24 13:52:24 +0100 | [diff] [blame] | 3 | import static groovy.json.JsonOutput.prettyPrint |
| 4 | import static groovy.json.JsonOutput.toJson |
Jakub Josef | 6d8082b | 2017-08-09 12:40:50 +0200 | [diff] [blame] | 5 | |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 6 | import com.cloudbees.groovy.cps.NonCPS |
Jakub Josef | b7ab847 | 2017-04-05 14:56:53 +0200 | [diff] [blame] | 7 | import groovy.json.JsonSlurperClassic |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 8 | |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 9 | /** |
| 10 | * |
| 11 | * Common functions |
| 12 | * |
| 13 | */ |
| 14 | |
| 15 | /** |
| 16 | * Generate current timestamp |
| 17 | * |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 18 | * @param format Defaults to yyyyMMddHHmmss |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 19 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 20 | def getDatetime(format = "yyyyMMddHHmmss") { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 21 | def now = new Date(); |
| 22 | return now.format(format, TimeZone.getTimeZone('UTC')); |
| 23 | } |
| 24 | |
| 25 | /** |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 26 | * Return workspace. |
| 27 | * Currently implemented by calling pwd so it won't return relevant result in |
| 28 | * dir context |
| 29 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 30 | def getWorkspace(includeBuildNum = false) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 31 | def workspace = sh script: 'pwd', returnStdout: true |
| 32 | workspace = workspace.trim() |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 33 | if (includeBuildNum) { |
| 34 | if (!workspace.endsWith("/")) { |
| 35 | workspace += "/" |
| 36 | } |
| 37 | workspace += env.BUILD_NUMBER |
Jakub Josef | a661b8c | 2018-01-17 14:51:25 +0100 | [diff] [blame] | 38 | } |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 39 | return workspace |
| 40 | } |
| 41 | |
| 42 | /** |
Filip Pytloun | 81c864d | 2017-03-21 15:19:30 +0100 | [diff] [blame] | 43 | * Get UID of jenkins user. |
| 44 | * Must be run from context of node |
| 45 | */ |
| 46 | def getJenkinsUid() { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 47 | return sh( |
Filip Pytloun | 81c864d | 2017-03-21 15:19:30 +0100 | [diff] [blame] | 48 | script: 'id -u', |
| 49 | returnStdout: true |
| 50 | ).trim() |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Get GID of jenkins user. |
| 55 | * Must be run from context of node |
| 56 | */ |
| 57 | def getJenkinsGid() { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 58 | return sh( |
Filip Pytloun | 81c864d | 2017-03-21 15:19:30 +0100 | [diff] [blame] | 59 | script: 'id -g', |
| 60 | returnStdout: true |
| 61 | ).trim() |
| 62 | } |
| 63 | |
| 64 | /** |
Jakub Josef | c8074db | 2018-01-30 13:33:20 +0100 | [diff] [blame] | 65 | * Returns Jenkins user uid and gid in one list (in that order) |
| 66 | * Must be run from context of node |
| 67 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 68 | def getJenkinsUserIds() { |
Jakub Josef | c8074db | 2018-01-30 13:33:20 +0100 | [diff] [blame] | 69 | return sh(script: "id -u && id -g", returnStdout: true).tokenize("\n") |
| 70 | } |
| 71 | |
| 72 | /** |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 73 | * |
| 74 | * Find credentials by ID |
| 75 | * |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 76 | * @param credsId Credentials ID |
| 77 | * @param credsType Credentials type (optional) |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 78 | * |
| 79 | */ |
| 80 | def getCredentialsById(String credsId, String credsType = 'any') { |
| 81 | def credClasses = [ // ordered by class name |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 82 | sshKey : com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey.class, |
| 83 | cert : com.cloudbees.plugins.credentials.common.CertificateCredentials.class, |
| 84 | password : com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials.class, |
| 85 | any : com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.class, |
| 86 | dockerCert: org.jenkinsci.plugins.docker.commons.credentials.DockerServerCredentials.class, |
| 87 | file : org.jenkinsci.plugins.plaincredentials.FileCredentials.class, |
| 88 | string : org.jenkinsci.plugins.plaincredentials.StringCredentials.class, |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 89 | ] |
| 90 | return com.cloudbees.plugins.credentials.CredentialsProvider.lookupCredentials( |
| 91 | credClasses[credsType], |
| 92 | jenkins.model.Jenkins.instance |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 93 | ).findAll { cred -> cred.id == credsId }[0] |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | /** |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 97 | * Get credentials from store |
| 98 | * |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 99 | * @param id Credentials name |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 100 | */ |
Jakub Josef | 3d9d9ab | 2017-03-14 15:09:03 +0100 | [diff] [blame] | 101 | def getCredentials(id, cred_type = "username_password") { |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 102 | warningMsg('You are using obsolete function. Please switch to use `getCredentialsById()`') |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 103 | |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 104 | type_map = [ |
| 105 | username_password: 'password', |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 106 | key : 'sshKey', |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 107 | ] |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 108 | |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 109 | return getCredentialsById(id, type_map[cred_type]) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | /** |
| 113 | * Abort build, wait for some time and ensure we will terminate |
| 114 | */ |
| 115 | def abortBuild() { |
| 116 | currentBuild.build().doStop() |
| 117 | sleep(180) |
| 118 | // just to be sure we will terminate |
| 119 | throw new InterruptedException() |
| 120 | } |
| 121 | |
| 122 | /** |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 123 | * Print pretty-printed string representation of given item |
| 124 | * @param item item to be pretty-printed (list, map, whatever) |
| 125 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 126 | def prettyPrint(item) { |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 127 | println prettify(item) |
| 128 | } |
| 129 | |
| 130 | /** |
Jakub Josef | b41c8d5 | 2017-03-24 13:52:24 +0100 | [diff] [blame] | 131 | * Return pretty-printed string representation of given item |
| 132 | * @param item item to be pretty-printed (list, map, whatever) |
| 133 | * @return pretty-printed string |
| 134 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 135 | def prettify(item) { |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 136 | return groovy.json.JsonOutput.prettyPrint(toJson(item)).replace('\\n', System.getProperty('line.separator')) |
Jakub Josef | b41c8d5 | 2017-03-24 13:52:24 +0100 | [diff] [blame] | 137 | } |
| 138 | |
| 139 | /** |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 140 | * Print informational message |
| 141 | * |
| 142 | * @param msg |
| 143 | * @param color Colorful output or not |
| 144 | */ |
| 145 | def infoMsg(msg, color = true) { |
| 146 | printMsg(msg, "cyan") |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * Print error message |
| 151 | * |
| 152 | * @param msg |
| 153 | * @param color Colorful output or not |
| 154 | */ |
| 155 | def errorMsg(msg, color = true) { |
| 156 | printMsg(msg, "red") |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Print success message |
| 161 | * |
| 162 | * @param msg |
| 163 | * @param color Colorful output or not |
| 164 | */ |
| 165 | def successMsg(msg, color = true) { |
| 166 | printMsg(msg, "green") |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * Print warning message |
| 171 | * |
| 172 | * @param msg |
| 173 | * @param color Colorful output or not |
| 174 | */ |
| 175 | def warningMsg(msg, color = true) { |
Jakub Josef | 0e7bd63 | 2017-03-16 16:25:05 +0100 | [diff] [blame] | 176 | printMsg(msg, "yellow") |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | /** |
Jakub Josef | 952ae0b | 2017-03-14 19:04:21 +0100 | [diff] [blame] | 180 | * Print debug message, this message will show only if DEBUG global variable is present |
| 181 | * @param msg |
| 182 | * @param color Colorful output or not |
| 183 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 184 | def debugMsg(msg, color = true) { |
Jakub Josef | 9a836ac | 2017-04-24 12:26:02 +0200 | [diff] [blame] | 185 | // if debug property exists on env, debug is enabled |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 186 | if (env.getEnvironment().containsKey('DEBUG') && env['DEBUG'] == "true") { |
Jakub Josef | 74b3469 | 2017-03-15 12:10:57 +0100 | [diff] [blame] | 187 | printMsg("[DEBUG] ${msg}", "red") |
Jakub Josef | 952ae0b | 2017-03-14 19:04:21 +0100 | [diff] [blame] | 188 | } |
| 189 | } |
| 190 | |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 191 | def getColorizedString(msg, color) { |
| 192 | def colorMap = [ |
| 193 | 'red' : '\u001B[31m', |
| 194 | 'black' : '\u001B[30m', |
| 195 | 'green' : '\u001B[32m', |
| 196 | 'yellow': '\u001B[33m', |
| 197 | 'blue' : '\u001B[34m', |
| 198 | 'purple': '\u001B[35m', |
| 199 | 'cyan' : '\u001B[36m', |
| 200 | 'white' : '\u001B[37m', |
| 201 | 'reset' : '\u001B[0m' |
| 202 | ] |
Vasyl Saienko | 00ef98b | 2018-09-05 10:34:32 +0300 | [diff] [blame] | 203 | |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 204 | return "${colorMap[color]}${msg}${colorMap.reset}" |
Vasyl Saienko | 00ef98b | 2018-09-05 10:34:32 +0300 | [diff] [blame] | 205 | } |
| 206 | |
Jakub Josef | 952ae0b | 2017-03-14 19:04:21 +0100 | [diff] [blame] | 207 | /** |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 208 | * Print message |
| 209 | * |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 210 | * @param msg Message to be printed |
Vasyl Saienko | 00ef98b | 2018-09-05 10:34:32 +0300 | [diff] [blame] | 211 | * @param color Color to use for output |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 212 | */ |
Vasyl Saienko | 00ef98b | 2018-09-05 10:34:32 +0300 | [diff] [blame] | 213 | def printMsg(msg, color) { |
| 214 | print getColorizedString(msg, color) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 215 | } |
| 216 | |
| 217 | /** |
| 218 | * Traverse directory structure and return list of files |
| 219 | * |
| 220 | * @param path Path to search |
| 221 | * @param type Type of files to search (groovy.io.FileType.FILES) |
| 222 | */ |
| 223 | @NonCPS |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 224 | def getFiles(path, type = groovy.io.FileType.FILES) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 225 | files = [] |
| 226 | new File(path).eachFile(type) { |
| 227 | files[] = it |
| 228 | } |
| 229 | return files |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Helper method to convert map into form of list of [key,value] to avoid |
| 234 | * unserializable exceptions |
| 235 | * |
| 236 | * @param m Map |
| 237 | */ |
| 238 | @NonCPS |
| 239 | def entries(m) { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 240 | m.collect { k, v -> [k, v] } |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 241 | } |
| 242 | |
| 243 | /** |
| 244 | * Opposite of build-in parallel, run map of steps in serial |
| 245 | * |
Jakub Josef | 7fb8bbd | 2017-05-15 16:02:44 +0200 | [diff] [blame] | 246 | * @param steps Map of String<name>: CPSClosure2<step> (or list of closures) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 247 | */ |
| 248 | def serial(steps) { |
| 249 | stepsArray = entries(steps) |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 250 | for (i = 0; i < stepsArray.size; i++) { |
Jakub Josef | d31de30 | 2017-05-15 13:59:18 +0200 | [diff] [blame] | 251 | def step = stepsArray[i] |
Jakub Josef | 7fb8bbd | 2017-05-15 16:02:44 +0200 | [diff] [blame] | 252 | def dummySteps = [:] |
| 253 | def stepKey |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 254 | if (step[1] instanceof List || step[1] instanceof Map) { |
| 255 | for (j = 0; j < step[1].size(); j++) { |
| 256 | if (step[1] instanceof List) { |
Jakub Josef | 7fb8bbd | 2017-05-15 16:02:44 +0200 | [diff] [blame] | 257 | stepKey = j |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 258 | } else if (step[1] instanceof Map) { |
Jakub Josef | 7fb8bbd | 2017-05-15 16:02:44 +0200 | [diff] [blame] | 259 | stepKey = step[1].keySet()[j] |
| 260 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 261 | dummySteps.put("step-${step[0]}-${stepKey}", step[1][stepKey]) |
Jakub Josef | d31de30 | 2017-05-15 13:59:18 +0200 | [diff] [blame] | 262 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 263 | } else { |
Jakub Josef | d31de30 | 2017-05-15 13:59:18 +0200 | [diff] [blame] | 264 | dummySteps.put(step[0], step[1]) |
| 265 | } |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 266 | parallel dummySteps |
| 267 | } |
| 268 | } |
| 269 | |
| 270 | /** |
Jakub Josef | 7fb8bbd | 2017-05-15 16:02:44 +0200 | [diff] [blame] | 271 | * Partition given list to list of small lists |
| 272 | * @param inputList input list |
| 273 | * @param partitionSize (partition size, optional, default 5) |
| 274 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 275 | def partitionList(inputList, partitionSize = 5) { |
| 276 | List<List<String>> partitions = new ArrayList<>(); |
| 277 | for (int i = 0; i < inputList.size(); i += partitionSize) { |
| 278 | partitions.add(new ArrayList<String>(inputList.subList(i, Math.min(i + partitionSize, inputList.size())))); |
| 279 | } |
| 280 | return partitions |
Jakub Josef | 7fb8bbd | 2017-05-15 16:02:44 +0200 | [diff] [blame] | 281 | } |
| 282 | |
| 283 | /** |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 284 | * Get password credentials from store |
| 285 | * |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 286 | * @param id Credentials name |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 287 | */ |
| 288 | def getPasswordCredentials(id) { |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 289 | return getCredentialsById(id, 'password') |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 290 | } |
| 291 | |
| 292 | /** |
| 293 | * Get SSH credentials from store |
| 294 | * |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 295 | * @param id Credentials name |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 296 | */ |
| 297 | def getSshCredentials(id) { |
Alexander Evseev | bc1fea4 | 2017-12-13 10:03:03 +0100 | [diff] [blame] | 298 | return getCredentialsById(id, 'sshKey') |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 299 | } |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 300 | |
| 301 | /** |
| 302 | * Tests Jenkins instance for existence of plugin with given name |
| 303 | * @param pluginName plugin short name to test |
| 304 | * @return boolean result |
| 305 | */ |
| 306 | @NonCPS |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 307 | def jenkinsHasPlugin(pluginName) { |
| 308 | return Jenkins.instance.pluginManager.plugins.collect { p -> p.shortName }.contains(pluginName) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 309 | } |
| 310 | |
| 311 | @NonCPS |
| 312 | def _needNotification(notificatedTypes, buildStatus, jobName) { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 313 | if (notificatedTypes && notificatedTypes.contains("onchange")) { |
| 314 | if (jobName) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 315 | def job = Jenkins.instance.getItem(jobName) |
| 316 | def numbuilds = job.builds.size() |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 317 | if (numbuilds > 0) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 318 | //actual build is first for some reasons, so last finished build is second |
| 319 | def lastBuild = job.builds[1] |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 320 | if (lastBuild) { |
| 321 | if (lastBuild.result.toString().toLowerCase().equals(buildStatus)) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 322 | println("Build status didn't changed since last build, not sending notifications") |
| 323 | return false; |
| 324 | } |
| 325 | } |
| 326 | } |
| 327 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 328 | } else if (!notificatedTypes.contains(buildStatus)) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 329 | return false; |
| 330 | } |
| 331 | return true; |
| 332 | } |
| 333 | |
| 334 | /** |
| 335 | * Send notification to all enabled notifications services |
| 336 | * @param buildStatus message type (success, warning, error), null means SUCCESSFUL |
| 337 | * @param msgText message text |
| 338 | * @param enabledNotifications list of enabled notification types, types: slack, hipchat, email, default empty |
| 339 | * @param notificatedTypes types of notifications will be sent, default onchange - notificate if current build result not equal last result; |
| 340 | * otherwise use - ["success","unstable","failed"] |
| 341 | * @param jobName optional job name param, if empty env.JOB_NAME will be used |
Jakub Josef | d057115 | 2017-07-17 14:11:39 +0200 | [diff] [blame] | 342 | * @param buildNumber build number param, if empty env.BUILD_NUM will be used |
| 343 | * @param buildUrl build url param, if empty env.BUILD_URL will be used |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 344 | * @param mailFrom mail FROM param, if empty "jenkins" will be used, it's mandatory for sending email notifications |
Jakub Josef | d057115 | 2017-07-17 14:11:39 +0200 | [diff] [blame] | 345 | * @param mailTo mail TO param, it's mandatory for sending email notifications, this option enable mail notification |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 346 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 347 | def sendNotification(buildStatus, msgText = "", enabledNotifications = [], notificatedTypes = ["onchange"], jobName = null, buildNumber = null, buildUrl = null, mailFrom = "jenkins", mailTo = null) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 348 | // Default values |
| 349 | def colorName = 'blue' |
| 350 | def colorCode = '#0000FF' |
| 351 | def buildStatusParam = buildStatus != null && buildStatus != "" ? buildStatus : "SUCCESS" |
| 352 | def jobNameParam = jobName != null && jobName != "" ? jobName : env.JOB_NAME |
| 353 | def buildNumberParam = buildNumber != null && buildNumber != "" ? buildNumber : env.BUILD_NUMBER |
| 354 | def buildUrlParam = buildUrl != null && buildUrl != "" ? buildUrl : env.BUILD_URL |
| 355 | def subject = "${buildStatusParam}: Job '${jobNameParam} [${buildNumberParam}]'" |
| 356 | def summary = "${subject} (${buildUrlParam})" |
| 357 | |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 358 | if (msgText != null && msgText != "") { |
| 359 | summary += "\n${msgText}" |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 360 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 361 | if (buildStatusParam.toLowerCase().equals("success")) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 362 | colorCode = "#00FF00" |
| 363 | colorName = "green" |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 364 | } else if (buildStatusParam.toLowerCase().equals("unstable")) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 365 | colorCode = "#FFFF00" |
| 366 | colorName = "yellow" |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 367 | } else if (buildStatusParam.toLowerCase().equals("failure")) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 368 | colorCode = "#FF0000" |
| 369 | colorName = "red" |
| 370 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 371 | if (_needNotification(notificatedTypes, buildStatusParam.toLowerCase(), jobNameParam)) { |
| 372 | if (enabledNotifications.contains("slack") && jenkinsHasPlugin("slack")) { |
| 373 | try { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 374 | slackSend color: colorCode, message: summary |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 375 | } catch (Exception e) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 376 | println("Calling slack plugin failed") |
| 377 | e.printStackTrace() |
| 378 | } |
| 379 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 380 | if (enabledNotifications.contains("hipchat") && jenkinsHasPlugin("hipchat")) { |
| 381 | try { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 382 | hipchatSend color: colorName.toUpperCase(), message: summary |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 383 | } catch (Exception e) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 384 | println("Calling hipchat plugin failed") |
| 385 | e.printStackTrace() |
| 386 | } |
| 387 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 388 | if (enabledNotifications.contains("email") && mailTo != null && mailTo != "" && mailFrom != null && mailFrom != "") { |
| 389 | try { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 390 | mail body: summary, from: mailFrom, subject: subject, to: mailTo |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 391 | } catch (Exception e) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 392 | println("Sending mail plugin failed") |
| 393 | e.printStackTrace() |
| 394 | } |
| 395 | } |
| 396 | } |
Filip Pytloun | 49d6630 | 2017-03-06 10:26:22 +0100 | [diff] [blame] | 397 | } |
chnyda | 4e5ac79 | 2017-03-14 15:24:18 +0100 | [diff] [blame] | 398 | |
| 399 | /** |
| 400 | * Execute linux command and catch nth element |
| 401 | * @param cmd command to execute |
| 402 | * @param index index to retrieve |
| 403 | * @return index-th element |
| 404 | */ |
| 405 | |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 406 | def cutOrDie(cmd, index) { |
chnyda | 4e5ac79 | 2017-03-14 15:24:18 +0100 | [diff] [blame] | 407 | def common = new com.mirantis.mk.Common() |
| 408 | def output |
| 409 | try { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 410 | output = sh(script: cmd, returnStdout: true) |
| 411 | def result = output.tokenize(" ")[index] |
| 412 | return result; |
chnyda | 4e5ac79 | 2017-03-14 15:24:18 +0100 | [diff] [blame] | 413 | } catch (Exception e) { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 414 | common.errorMsg("Failed to execute cmd: ${cmd}\n output: ${output}") |
chnyda | 4e5ac79 | 2017-03-14 15:24:18 +0100 | [diff] [blame] | 415 | } |
Filip Pytloun | 81c864d | 2017-03-21 15:19:30 +0100 | [diff] [blame] | 416 | } |
Tomáš Kukrál | 767dd73 | 2017-03-23 10:38:59 +0100 | [diff] [blame] | 417 | |
| 418 | /** |
| 419 | * Check variable contains keyword |
| 420 | * @param variable keywork is searched (contains) here |
| 421 | * @param keyword string to look for |
| 422 | * @return True if variable contains keyword (case insensitive), False if do not contains or any of input isn't a string |
| 423 | */ |
| 424 | |
| 425 | def checkContains(variable, keyword) { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 426 | if (env.getEnvironment().containsKey(variable)) { |
Jakub Josef | 7a8dea2 | 2017-03-23 19:51:32 +0100 | [diff] [blame] | 427 | return env[variable] && env[variable].toLowerCase().contains(keyword.toLowerCase()) |
Tomáš Kukrál | 767dd73 | 2017-03-23 10:38:59 +0100 | [diff] [blame] | 428 | } else { |
Tomáš Kukrál | c76c1e0 | 2017-03-23 19:06:59 +0100 | [diff] [blame] | 429 | return false |
Tomáš Kukrál | 767dd73 | 2017-03-23 10:38:59 +0100 | [diff] [blame] | 430 | } |
| 431 | } |
Jakub Josef | a877db5 | 2017-04-05 14:22:30 +0200 | [diff] [blame] | 432 | |
| 433 | /** |
| 434 | * Parse JSON string to hashmap |
| 435 | * @param jsonString input JSON string |
| 436 | * @return created hashmap |
| 437 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 438 | def parseJSON(jsonString) { |
| 439 | def m = [:] |
| 440 | def lazyMap = new JsonSlurperClassic().parseText(jsonString) |
| 441 | m.putAll(lazyMap) |
| 442 | return m |
Jakub Josef | a877db5 | 2017-04-05 14:22:30 +0200 | [diff] [blame] | 443 | } |
Jakub Josef | ed239cd | 2017-05-09 15:27:33 +0200 | [diff] [blame] | 444 | |
| 445 | /** |
| 446 | * Test pipeline input parameter existence and validity (not null and not empty string) |
| 447 | * @param paramName input parameter name (usually uppercase) |
| 448 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 449 | def validInputParam(paramName) { |
Jakub Josef | ed239cd | 2017-05-09 15:27:33 +0200 | [diff] [blame] | 450 | return env.getEnvironment().containsKey(paramName) && env[paramName] != null && env[paramName] != "" |
Tomáš Kukrál | d34fe87 | 2017-06-13 10:50:50 +0200 | [diff] [blame] | 451 | } |
| 452 | |
| 453 | /** |
| 454 | * Take list of hashmaps and count number of hashmaps with parameter equals eq |
| 455 | * @param lm list of hashmaps |
| 456 | * @param param define parameter of hashmap to read and compare |
| 457 | * @param eq desired value of hashmap parameter |
| 458 | * @return count of hashmaps meeting defined condition |
| 459 | */ |
| 460 | |
| 461 | @NonCPS |
| 462 | def countHashMapEquals(lm, param, eq) { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 463 | return lm.stream().filter { i -> i[param].equals(eq) }.collect(java.util.stream.Collectors.counting()) |
Tomáš Kukrál | d34fe87 | 2017-06-13 10:50:50 +0200 | [diff] [blame] | 464 | } |
Vasyl Saienko | fb055b1 | 2017-11-23 18:15:23 +0200 | [diff] [blame] | 465 | |
| 466 | /** |
| 467 | * Execute shell command and return stdout, stderr and status |
| 468 | * |
| 469 | * @param cmd Command to execute |
| 470 | * @return map with stdout, stderr, status keys |
| 471 | */ |
| 472 | |
| 473 | def shCmdStatus(cmd) { |
| 474 | def res = [:] |
| 475 | def stderr = sh(script: 'mktemp', returnStdout: true).trim() |
| 476 | def stdout = sh(script: 'mktemp', returnStdout: true).trim() |
| 477 | |
| 478 | try { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 479 | def status = sh(script: "${cmd} 1>${stdout} 2>${stderr}", returnStatus: true) |
Vasyl Saienko | fb055b1 | 2017-11-23 18:15:23 +0200 | [diff] [blame] | 480 | res['stderr'] = sh(script: "cat ${stderr}", returnStdout: true) |
| 481 | res['stdout'] = sh(script: "cat ${stdout}", returnStdout: true) |
| 482 | res['status'] = status |
| 483 | } finally { |
| 484 | sh(script: "rm ${stderr}", returnStdout: true) |
| 485 | sh(script: "rm ${stdout}", returnStdout: true) |
| 486 | } |
| 487 | |
| 488 | return res |
| 489 | } |
Richard Felkl | 66a242d | 2018-01-25 15:27:15 +0100 | [diff] [blame] | 490 | |
Richard Felkl | 66a242d | 2018-01-25 15:27:15 +0100 | [diff] [blame] | 491 | /** |
| 492 | * Retry commands passed to body |
| 493 | * |
| 494 | * @param times Number of retries |
Jakub Josef | 61463c7 | 2018-02-13 16:10:56 +0100 | [diff] [blame] | 495 | * @param delay Delay between retries (in seconds) |
Richard Felkl | 66a242d | 2018-01-25 15:27:15 +0100 | [diff] [blame] | 496 | * @param body Commands to be in retry block |
| 497 | * @return calling commands in body |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 498 | * @example retry ( 3 , 5 ) { function body }* retry{ function body } |
Richard Felkl | 66a242d | 2018-01-25 15:27:15 +0100 | [diff] [blame] | 499 | */ |
| 500 | |
| 501 | def retry(int times = 5, int delay = 0, Closure body) { |
| 502 | int retries = 0 |
| 503 | def exceptions = [] |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 504 | while (retries++ < times) { |
Richard Felkl | 66a242d | 2018-01-25 15:27:15 +0100 | [diff] [blame] | 505 | try { |
| 506 | return body.call() |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 507 | } catch (e) { |
Richard Felkl | 66a242d | 2018-01-25 15:27:15 +0100 | [diff] [blame] | 508 | sleep(delay) |
| 509 | } |
| 510 | } |
| 511 | currentBuild.result = "FAILURE" |
| 512 | throw new Exception("Failed after $times retries") |
| 513 | } |
Dmitry Pyzhov | 0d0d852 | 2018-05-15 22:37:37 +0300 | [diff] [blame] | 514 | |
Dmitry Pyzhov | 0d0d852 | 2018-05-15 22:37:37 +0300 | [diff] [blame] | 515 | /** |
| 516 | * Wait for user input with timeout |
| 517 | * |
| 518 | * @param timeoutInSeconds Timeout |
| 519 | * @param options Options for input widget |
| 520 | */ |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 521 | def waitForInputThenPass(timeoutInSeconds, options = [message: 'Ready to go?']) { |
| 522 | def userInput = true |
| 523 | try { |
| 524 | timeout(time: timeoutInSeconds, unit: 'SECONDS') { |
| 525 | userInput = input options |
| 526 | } |
| 527 | } catch (err) { // timeout reached or input false |
| 528 | def user = err.getCauses()[0].getUser() |
| 529 | if ('SYSTEM' == user.toString()) { // SYSTEM means timeout. |
| 530 | println("Timeout, proceeding") |
| 531 | } else { |
| 532 | userInput = false |
| 533 | println("Aborted by: [${user}]") |
| 534 | throw err |
| 535 | } |
Dmitry Pyzhov | 0d0d852 | 2018-05-15 22:37:37 +0300 | [diff] [blame] | 536 | } |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 537 | return userInput |
Dmitry Pyzhov | 0d0d852 | 2018-05-15 22:37:37 +0300 | [diff] [blame] | 538 | } |
Oleksii Grudev | 9e1d97a | 2018-06-29 16:04:30 +0300 | [diff] [blame] | 539 | |
| 540 | /** |
| 541 | * Function receives Map variable as input and sorts it |
| 542 | * by values ascending. Returns sorted Map |
| 543 | * @param _map Map variable |
| 544 | */ |
| 545 | @NonCPS |
| 546 | def SortMapByValueAsc(_map) { |
azvyagintsev | 6bda942 | 2018-08-20 11:57:05 +0300 | [diff] [blame] | 547 | def sortedMap = _map.sort { it.value } |
Oleksii Grudev | 9e1d97a | 2018-06-29 16:04:30 +0300 | [diff] [blame] | 548 | return sortedMap |
| 549 | } |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 550 | |
| 551 | /** |
| 552 | * Compare 'old' and 'new' dir's recursively |
| 553 | * @param diffData =' Only in new/XXX/infra: secrets.yml |
| 554 | Files old/XXX/init.yml and new/XXX/init.yml differ |
| 555 | Only in old/XXX/infra: secrets11.yml ' |
| 556 | * |
| 557 | * @return |
| 558 | * - new: |
| 559 | - XXX/secrets.yml |
| 560 | - diff: |
| 561 | - XXX/init.yml |
| 562 | - removed: |
| 563 | - XXX/secrets11.yml |
| 564 | |
| 565 | */ |
| 566 | def diffCheckMultidir(diffData) { |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 567 | common = new com.mirantis.mk.Common() |
| 568 | // Some global constants. Don't change\move them! |
| 569 | keyNew = 'new' |
| 570 | keyRemoved = 'removed' |
| 571 | keyDiff = 'diff' |
| 572 | def output = [ |
| 573 | new : [], |
| 574 | removed: [], |
| 575 | diff : [], |
| 576 | ] |
| 577 | String pathSep = '/' |
| 578 | diffData.each { line -> |
| 579 | def job_file = '' |
| 580 | def job_type = '' |
| 581 | if (line.startsWith('Files old/')) { |
| 582 | job_file = new File(line.replace('Files old/', '').tokenize()[0]) |
| 583 | job_type = keyDiff |
| 584 | } else if (line.startsWith('Only in new/')) { |
| 585 | // get clean normalized filepath, under new/ |
| 586 | job_file = new File(line.replace('Only in new/', '').replace(': ', pathSep)).toString() |
| 587 | job_type = keyNew |
| 588 | } else if (line.startsWith('Only in old/')) { |
| 589 | // get clean normalized filepath, under old/ |
| 590 | job_file = new File(line.replace('Only in old/', '').replace(': ', pathSep)).toString() |
| 591 | job_type = keyRemoved |
| 592 | } else { |
| 593 | common.warningMsg("Not parsed diff line: ${line}!") |
| 594 | } |
| 595 | if (job_file != '') { |
| 596 | output[job_type].push(job_file) |
| 597 | } |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 598 | } |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 599 | return output |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 600 | } |
| 601 | |
| 602 | /** |
| 603 | * Compare 2 folder, file by file |
| 604 | * Structure should be: |
| 605 | * ${compRoot}/ |
| 606 | └── diff - diff results will be save here |
| 607 | ├── new - input folder with data |
| 608 | ├── old - input folder with data |
| 609 | ├── pillar.diff - globall diff will be saved here |
| 610 | * b_url - usual env.BUILD_URL, to be add into description |
azvyagintsev | 3bbcafe | 2018-08-20 19:36:16 +0300 | [diff] [blame] | 611 | * grepOpts - General grep cmdline; Could be used to pass some magic |
| 612 | * regexp into after-diff listing file(pillar.diff) |
| 613 | * Example: '-Ev infra/secrets.yml' |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 614 | * return - html-based string |
| 615 | * TODO: allow to specify subdir for results? |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 616 | **/ |
azvyagintsev | 3bbcafe | 2018-08-20 19:36:16 +0300 | [diff] [blame] | 617 | def comparePillars(compRoot, b_url, grepOpts) { |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 618 | common = new com.mirantis.mk.Common() |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 619 | // Some global constants. Don't change\move them! |
| 620 | keyNew = 'new' |
| 621 | keyRemoved = 'removed' |
| 622 | keyDiff = 'diff' |
| 623 | def diff_status = 0 |
| 624 | // FIXME |
| 625 | httpWS = b_url + '/artifact/' |
| 626 | dir(compRoot) { |
azvyagintsev | 3bbcafe | 2018-08-20 19:36:16 +0300 | [diff] [blame] | 627 | // If diff empty - exit 0 |
| 628 | diff_status = sh(script: 'diff -q -r old/ new/ > pillar.diff', |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 629 | returnStatus: true, |
| 630 | ) |
azvyagintsev | 24d4965 | 2018-08-21 19:33:51 +0300 | [diff] [blame] | 631 | } |
azvyagintsev | c0fe144 | 2018-08-21 20:01:34 +0300 | [diff] [blame] | 632 | // Unfortunately, diff not able to work with dir-based regexp |
| 633 | if (diff_status == 1 && grepOpts) { |
| 634 | dir(compRoot) { |
| 635 | grep_status = sh(script: """ |
azvyagintsev | 3bbcafe | 2018-08-20 19:36:16 +0300 | [diff] [blame] | 636 | cp -v pillar.diff pillar_orig.diff |
| 637 | grep ${grepOpts} pillar_orig.diff > pillar.diff |
| 638 | """, |
azvyagintsev | c0fe144 | 2018-08-21 20:01:34 +0300 | [diff] [blame] | 639 | returnStatus: true |
| 640 | ) |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 641 | if (grep_status == 1) { |
azvyagintsev | c0fe144 | 2018-08-21 20:01:34 +0300 | [diff] [blame] | 642 | common.warningMsg("Grep regexp ${grepOpts} removed all diff!") |
| 643 | diff_status = 0 |
azvyagintsev | b99f87c | 2018-08-21 19:43:59 +0300 | [diff] [blame] | 644 | } |
azvyagintsev | 3bbcafe | 2018-08-20 19:36:16 +0300 | [diff] [blame] | 645 | } |
azvyagintsev | c0fe144 | 2018-08-21 20:01:34 +0300 | [diff] [blame] | 646 | } |
| 647 | // Set job description |
| 648 | String description = '' |
| 649 | if (diff_status == 1) { |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 650 | // Analyse output file and prepare array with results |
| 651 | String data_ = readFile file: "${compRoot}/pillar.diff" |
| 652 | def diff_list = diffCheckMultidir(data_.split("\\r?\\n")) |
| 653 | common.infoMsg(diff_list) |
| 654 | dir(compRoot) { |
| 655 | if (diff_list[keyDiff].size() > 0) { |
| 656 | if (!fileExists('diff')) { |
| 657 | sh('mkdir -p diff') |
| 658 | } |
| 659 | description += '<b>CHANGED</b><ul>' |
| 660 | common.infoMsg('Changed items:') |
| 661 | for (item in diff_list[keyDiff]) { |
| 662 | // We don't want to handle sub-dirs structure. So, simply make diff 'flat' |
| 663 | item_f = item.toString().replace('/', '_') |
| 664 | description += "<li><a href=\"${httpWS}/diff/${item_f}/*view*/\">${item}</a></li>" |
| 665 | // Generate diff file |
| 666 | def diff_exit_code = sh([ |
| 667 | script : "diff -U 50 old/${item} new/${item} > diff/${item_f}", |
| 668 | returnStdout: false, |
| 669 | returnStatus: true, |
| 670 | ]) |
| 671 | // catch normal errors, diff should always return 1 |
| 672 | if (diff_exit_code != 1) { |
| 673 | error 'Error with diff file generation' |
| 674 | } |
| 675 | } |
| 676 | } |
| 677 | if (diff_list[keyNew].size() > 0) { |
| 678 | description += '<b>ADDED</b><ul>' |
| 679 | for (item in diff_list[keyNew]) { |
| 680 | description += "<li><a href=\"${httpWS}/new/${item}/*view*/\">${item}</a></li>" |
| 681 | } |
| 682 | } |
| 683 | if (diff_list[keyRemoved].size() > 0) { |
| 684 | description += '<b>DELETED</b><ul>' |
| 685 | for (item in diff_list[keyRemoved]) { |
| 686 | description += "<li><a href=\"${httpWS}/old/${item}/*view*/\">${item}</a></li>" |
| 687 | } |
| 688 | } |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 689 | |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 690 | } |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 691 | } |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 692 | |
| 693 | if (description != '') { |
| 694 | dir(compRoot) { |
| 695 | archiveArtifacts([ |
| 696 | artifacts : '**', |
| 697 | allowEmptyArchive: true, |
| 698 | ]) |
| 699 | } |
| 700 | return description.toString() |
| 701 | } else { |
| 702 | return 'No job changes' |
| 703 | } |
azvyagintsev | 99d3584 | 2018-08-17 20:26:34 +0300 | [diff] [blame] | 704 | } |
azvyagintsev | ab5637b | 2018-08-20 18:18:15 +0300 | [diff] [blame] | 705 | |
| 706 | /** |
| 707 | * Simple function, to get basename from string. |
| 708 | * line - path-string |
| 709 | * remove_ext - string, optionl. Drop file extenstion. |
| 710 | **/ |
| 711 | def GetBaseName(line, remove_ext) { |
| 712 | filename = line.toString().split('/').last() |
| 713 | if (remove_ext && filename.endsWith(remove_ext.toString())) { |
| 714 | filename = filename.take(filename.lastIndexOf(remove_ext.toString())) |
| 715 | } |
| 716 | return filename |
Vasyl Saienko | 00ef98b | 2018-09-05 10:34:32 +0300 | [diff] [blame] | 717 | } |
Vasyl Saienko | 723cbbc | 2018-09-05 11:08:52 +0300 | [diff] [blame] | 718 | |
| 719 | /** |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 720 | * Return colored string of specific stage in stageMap |
| 721 | * |
| 722 | * @param stageMap LinkedHashMap object. |
| 723 | * @param stageName The name of current stage we are going to execute. |
| 724 | * @param color Text color |
| 725 | * */ |
| 726 | def getColoredStageView(stageMap, stageName, color) { |
| 727 | def stage = stageMap[stageName] |
| 728 | def banner = [] |
| 729 | def currentStageIndex = new ArrayList<String>(stageMap.keySet()).indexOf(stageName) |
| 730 | def numberOfStages = stageMap.keySet().size() - 1 |
Vasyl Saienko | 723cbbc | 2018-09-05 11:08:52 +0300 | [diff] [blame] | 731 | |
Vasyl Saienko | 723cbbc | 2018-09-05 11:08:52 +0300 | [diff] [blame] | 732 | banner.add(getColorizedString( |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 733 | "=========== Stage ${currentStageIndex}/${numberOfStages}: ${stageName} ===========", color)) |
| 734 | for (stage_item in stage.keySet()) { |
| 735 | banner.add(getColorizedString( |
| 736 | "${stage_item}: ${stage[stage_item]}", color)) |
Vasyl Saienko | 723cbbc | 2018-09-05 11:08:52 +0300 | [diff] [blame] | 737 | } |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 738 | banner.add('\n') |
| 739 | |
| 740 | return banner |
| 741 | } |
| 742 | |
| 743 | /** |
| 744 | * Pring stageMap to console with specified color |
| 745 | * |
| 746 | * @param stageMap LinkedHashMap object with stages information. |
| 747 | * @param currentStage The name of current stage we are going to execute. |
| 748 | * |
| 749 | * */ |
| 750 | def printCurrentStage(stageMap, currentStage) { |
| 751 | print getColoredStageView(stageMap, currentStage, "cyan").join('\n') |
| 752 | } |
| 753 | |
| 754 | /** |
| 755 | * Pring stageMap to console with specified color |
| 756 | * |
| 757 | * @param stageMap LinkedHashMap object. |
| 758 | * @param baseColor Text color (default white) |
| 759 | * */ |
| 760 | def printStageMap(stageMap, baseColor = "white") { |
| 761 | def banner = [] |
| 762 | def index = 0 |
| 763 | for (stage_name in stageMap.keySet()) { |
| 764 | banner.addAll(getColoredStageView(stageMap, stage_name, baseColor)) |
| 765 | } |
| 766 | print banner.join('\n') |
| 767 | } |
| 768 | |
| 769 | /** |
| 770 | * Wrap provided code in stage, and do interactive retires if needed. |
| 771 | * |
| 772 | * @param stageMap LinkedHashMap object with stages information. |
| 773 | * @param currentStage The name of current stage we are going to execute. |
| 774 | * @param target Target host to execute stage on. |
| 775 | * @param interactive Boolean flag to specify if interaction with user is enabled. |
| 776 | * @param body Command to be in stage block. |
| 777 | * */ |
| 778 | def stageWrapper(stageMap, currentStage, target, interactive = true, Closure body) { |
| 779 | def common = new com.mirantis.mk.Common() |
| 780 | def banner = [] |
| 781 | |
| 782 | printCurrentStage(stageMap, currentStage) |
| 783 | |
| 784 | stage(currentStage) { |
Vasyl Saienko | bc6debb | 2018-09-10 14:08:09 +0300 | [diff] [blame^] | 785 | if (interactive){ |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 786 | input message: getColorizedString("We are going to execute stage \'${currentStage}\' on the following target ${target}.\nPlease review stage information above.", "yellow") |
Vasyl Saienko | bc6debb | 2018-09-10 14:08:09 +0300 | [diff] [blame^] | 787 | } |
| 788 | try { |
| 789 | return body.call() |
| 790 | stageMap[currentStage]['Status'] = "SUCCESS" |
| 791 | } catch (Exception err) { |
| 792 | def msg = "Stage ${currentStage} failed with the following exception:\n${err}" |
| 793 | print getColorizedString(msg, "yellow") |
| 794 | common.errorMsg(err) |
| 795 | if (interactive) { |
| 796 | input message: getColorizedString("Please make sure problem is fixed to proceed with retry. Ready to proceed?", "yellow") |
| 797 | stageMap[currentStage]['Status'] = "RETRYING" |
| 798 | stageWrapper(stageMap, currentStage, target, interactive, body) |
| 799 | } else { |
| 800 | error(msg) |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 801 | } |
Vasyl Saienko | bc6debb | 2018-09-10 14:08:09 +0300 | [diff] [blame^] | 802 | } |
azvyagintsev | f6e7791 | 2018-09-07 15:41:09 +0300 | [diff] [blame] | 803 | } |
| 804 | } |
| 805 | |
| 806 | /** |
| 807 | * Ugly transition solution for internal tests. |
| 808 | * 1) Check input => transform to static result, based on runtime and input |
| 809 | * 2) Check remote-binary repo for exact resource |
| 810 | */ |
| 811 | |
| 812 | def checkRemoteBinary(LinkedHashMap config, List extraScmExtensions = []) { |
| 813 | def common = new com.mirantis.mk.Common() |
| 814 | res = [:] |
| 815 | res['MirrorRoot'] = config.get('globalMirrorRoot', env["BIN_MIRROR_ROOT"] ? env["BIN_MIRROR_ROOT"] : "http://mirror.mirantis.com/") |
| 816 | // Reclass-like format's. To make life eazy! |
| 817 | res['apt_mk_version'] = config.get('apt_mk_version', env["BIN_APT_MK_VERSION"] ? env["BIN_APT_MK_VERSION"] : 'nightly') |
| 818 | res['linux_system_repo_url'] = config.get('linux_system_repo_url', env["BIN_linux_system_repo_url"] ? env["BIN_linux_system_repo_url"] : "${res['MirrorRoot']}/${res['apt_mk_version']}/") |
| 819 | |
| 820 | if (config.get('verify', true)) { |
| 821 | MirrorRootStatus = sh(script: "wget --auth-no-challenge --spider ${res['linux_system_repo_url']} 2>/dev/null", returnStatus: true) |
| 822 | if (MirrorRootStatus != '0') { |
| 823 | common.warningMsg("Resource: ${res['linux_system_repo_url']} not exist") |
| 824 | res['linux_system_repo_url'] = false |
| 825 | } |
| 826 | } |
| 827 | return res |
Vasyl Saienko | 723cbbc | 2018-09-05 11:08:52 +0300 | [diff] [blame] | 828 | } |