blob: 92d6727af88e218e2fff268cd89e9cbc88798986 [file] [log] [blame]
Jakub Josef79ecec32017-02-17 14:36:28 +01001package com.mirantis.mk
2
Jakub Josefbceaa322017-06-13 18:28:27 +02003import com.cloudbees.groovy.cps.NonCPS
Jakub Josefb77c0812017-03-27 14:11:01 +02004import java.util.stream.Collectors
Jakub Josef79ecec32017-02-17 14:36:28 +01005/**
6 * Salt functions
7 *
8*/
9
10/**
11 * Salt connection and context parameters
12 *
13 * @param url Salt API server URL
14 * @param credentialsID ID of credentials store entry
15 */
16def connection(url, credentialsId = "salt") {
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +010017 def common = new com.mirantis.mk.Common()
Jakub Josef79ecec32017-02-17 14:36:28 +010018 params = [
19 "url": url,
20 "credentialsId": credentialsId,
21 "authToken": null,
22 "creds": common.getCredentials(credentialsId)
23 ]
24 params["authToken"] = saltLogin(params)
Jakub Josef79ecec32017-02-17 14:36:28 +010025 return params
26}
27
28/**
29 * Login to Salt API, return auth token
30 *
31 * @param master Salt connection object
32 */
33def saltLogin(master) {
Tomáš Kukrál7bec0532017-02-20 15:39:31 +010034 def http = new com.mirantis.mk.Http()
Jakub Josef79ecec32017-02-17 14:36:28 +010035 data = [
36 'username': master.creds.username,
37 'password': master.creds.password.toString(),
38 'eauth': 'pam'
39 ]
Tomáš Kukrál7bec0532017-02-20 15:39:31 +010040 authToken = http.restGet(master, '/login', data)['return'][0]['token']
Jakub Josef79ecec32017-02-17 14:36:28 +010041 return authToken
42}
43
44/**
chnydaa0dbb252017-10-05 10:46:09 +020045 * Run action using Salt API (using plain HTTP request from Jenkins master) or Pepper (from slave shell)
Jakub Josef79ecec32017-02-17 14:36:28 +010046 *
chnydaa0dbb252017-10-05 10:46:09 +020047 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) (determines if command will be sent with Pepper of Salt API )
Jakub Josef79ecec32017-02-17 14:36:28 +010048 * @param client Client type
49 * @param target Target specification, eg. for compound matches by Pillar
50 * data: ['expression': 'I@openssh:server', 'type': 'compound'])
51 * @param function Function to execute (eg. "state.sls")
Jakub Josef2f25cf22017-03-28 13:34:57 +020052 * @param batch Batch param to salt (integer or string with percents)
Jakub Josef79ecec32017-02-17 14:36:28 +010053 * @param args Additional arguments to function
54 * @param kwargs Additional key-value arguments to function
Jiri Broulik48544be2017-06-14 18:33:54 +020055 * @param timeout Additional argument salt api timeout
Vasyl Saienkoe36ab7c2017-07-17 14:35:48 +030056 * @param read_timeout http session read timeout
Jakub Josef79ecec32017-02-17 14:36:28 +010057 */
58@NonCPS
chnydaa0dbb252017-10-05 10:46:09 +020059def runSaltCommand(saltId, client, target, function, batch = null, args = null, kwargs = null, timeout = -1, read_timeout = -1) {
Jakub Josef79ecec32017-02-17 14:36:28 +010060
61 data = [
62 'tgt': target.expression,
63 'fun': function,
64 'client': client,
65 'expr_form': target.type,
66 ]
Jakub Josef5f838212017-04-06 12:43:58 +020067 if(batch != null && ( (batch instanceof Integer && batch > 0) || (batch instanceof String && batch.contains("%")))){
Jakub Josef2f25cf22017-03-28 13:34:57 +020068 data['client']= "local_batch"
69 data['batch'] = batch
Jakub Josef79ecec32017-02-17 14:36:28 +010070 }
71
72 if (args) {
73 data['arg'] = args
74 }
75
76 if (kwargs) {
77 data['kwarg'] = kwargs
78 }
79
Jiri Broulik48544be2017-06-14 18:33:54 +020080 if (timeout != -1) {
81 data['timeout'] = timeout
82 }
83
chnydaa0dbb252017-10-05 10:46:09 +020084 // Command will be sent using HttpRequest
85 if (saltId instanceof HashMap && saltId.containsKey("authToken") ) {
Jakub Josef79ecec32017-02-17 14:36:28 +010086
chnydaa0dbb252017-10-05 10:46:09 +020087 def headers = [
88 'X-Auth-Token': "${saltId.authToken}"
89 ]
90
91 def http = new com.mirantis.mk.Http()
92 return http.sendHttpPostRequest("${saltId.url}/", data, headers, read_timeout)
93 } else if (saltId instanceof HashMap) {
94 throw new Exception("Invalid saltId")
95 }
96
97 // Command will be sent using Pepper
98 return runPepperCommand(data, saltId)
Jakub Josef79ecec32017-02-17 14:36:28 +010099}
100
Jakub Josef5ade54c2017-03-10 16:14:01 +0100101/**
chnydaa0dbb252017-10-05 10:46:09 +0200102 * Return pillar for given saltId and target
103 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100104 * @param target Get pillar target
105 * @param pillar pillar name (optional)
106 * @return output of salt command
107 */
chnydaa0dbb252017-10-05 10:46:09 +0200108def getPillar(saltId, target, pillar = null) {
Tomáš Kukráld2589702017-03-10 16:30:46 +0100109 if (pillar != null) {
chnydaa0dbb252017-10-05 10:46:09 +0200110 return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'pillar.get', null, [pillar.replace('.', ':')])
Tomáš Kukráld2589702017-03-10 16:30:46 +0100111 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200112 return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'pillar.data')
Ales Komareka3c7e502017-03-13 11:20:44 +0100113 }
Jakub Josef79ecec32017-02-17 14:36:28 +0100114}
115
Jakub Josef5ade54c2017-03-10 16:14:01 +0100116/**
chnydaa0dbb252017-10-05 10:46:09 +0200117 * Return grain for given saltId and target
118 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100119 * @param target Get grain target
120 * @param grain grain name (optional)
121 * @return output of salt command
122 */
chnydaa0dbb252017-10-05 10:46:09 +0200123def getGrain(saltId, target, grain = null) {
Ales Komarekcec24d42017-03-08 10:25:45 +0100124 if(grain != null) {
chnydaa0dbb252017-10-05 10:46:09 +0200125 return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'grains.item', null, [grain])
Jakub Josef5ade54c2017-03-10 16:14:01 +0100126 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200127 return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'grains.items')
Ales Komarekcec24d42017-03-08 10:25:45 +0100128 }
Ales Komarekcec24d42017-03-08 10:25:45 +0100129}
130
Jakub Josef5ade54c2017-03-10 16:14:01 +0100131/**
chnydaa0dbb252017-10-05 10:46:09 +0200132 * Enforces state on given saltId and target
133 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100134 * @param target State enforcing target
135 * @param state Salt state
136 * @param output print output (optional, default true)
137 * @param failOnError throw exception on salt state result:false (optional, default true)
Jakub Josef2f25cf22017-03-28 13:34:57 +0200138 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
Petr Michalecde0ff322017-10-04 09:32:14 +0200139 * @param read_timeout http session read timeout (optional, default -1 - disabled)
140 * @param retries Retry count for salt state. (optional, default -1 - no retries)
141 * @param queue salt queue parameter for state.sls calls (optional, default true) - CANNOT BE USED WITH BATCH
Jakub Josef5ade54c2017-03-10 16:14:01 +0100142 * @return output of salt command
143 */
chnydaa0dbb252017-10-05 10:46:09 +0200144def enforceState(saltId, target, state, output = true, failOnError = true, batch = null, optional = false, read_timeout=-1, retries=-1, queue=true) {
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100145 def common = new com.mirantis.mk.Common()
Jakub Josef79ecec32017-02-17 14:36:28 +0100146 def run_states
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100147
Jakub Josef79ecec32017-02-17 14:36:28 +0100148 if (state instanceof String) {
149 run_states = state
150 } else {
151 run_states = state.join(',')
152 }
153
Marek Celoud63366112017-07-25 17:27:24 +0200154 common.infoMsg("Running state ${run_states} on ${target}")
Vasyl Saienkoe36ab7c2017-07-17 14:35:48 +0300155 def out
Petr Michalecde0ff322017-10-04 09:32:14 +0200156 def kwargs = [:]
157
158 if (queue && batch == null) {
159 kwargs["queue"] = true
160 }
Vasyl Saienkoe36ab7c2017-07-17 14:35:48 +0300161
chnydaa0dbb252017-10-05 10:46:09 +0200162 if (optional == false || testTarget(saltId, target)){
Richard Felkl03203d62017-11-01 17:57:32 +0100163 if (retries > 0){
164 failOnError = true
Vasyl Saienkoe36ab7c2017-07-17 14:35:48 +0300165 retry(retries){
chnydaa0dbb252017-10-05 10:46:09 +0200166 out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'state.sls', batch, [run_states], kwargs, -1, read_timeout)
Richard Felkl03203d62017-11-01 17:57:32 +0100167 checkResult(out, failOnError, output)
Vasyl Saienkoe36ab7c2017-07-17 14:35:48 +0300168 }
Petr Michalecde0ff322017-10-04 09:32:14 +0200169 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200170 out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'state.sls', batch, [run_states], kwargs, -1, read_timeout)
Richard Felkl03203d62017-11-01 17:57:32 +0100171 checkResult(out, failOnError, output)
Vasyl Saienkoe36ab7c2017-07-17 14:35:48 +0300172 }
Oleg Iurchenko7eb21502017-11-28 18:53:43 +0200173 waitForMinion(out)
Martin Polreich1c77afa2017-07-18 11:27:02 +0200174 return out
Martin Polreich1c77afa2017-07-18 11:27:02 +0200175 } else {
176 common.infoMsg("No Minions matched the target given, but 'optional' param was set to true - Pipeline continues. ")
177 }
Jakub Josef79ecec32017-02-17 14:36:28 +0100178}
179
Jakub Josef5ade54c2017-03-10 16:14:01 +0100180/**
181 * Run command on salt minion (salt cmd.run wrapper)
chnydaa0dbb252017-10-05 10:46:09 +0200182 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100183 * @param target Get pillar target
184 * @param cmd command
Jakub Josef053df392017-05-03 15:51:05 +0200185 * @param checkResponse test command success execution (default true)
Jakub Josef2f25cf22017-03-28 13:34:57 +0200186 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200187 * @param output do you want to print output
Jakub Josef5ade54c2017-03-10 16:14:01 +0100188 * @return output of salt command
189 */
chnydaa0dbb252017-10-05 10:46:09 +0200190def cmdRun(saltId, target, cmd, checkResponse = true, batch=null, output = true) {
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100191 def common = new com.mirantis.mk.Common()
Jakub Josef053df392017-05-03 15:51:05 +0200192 def originalCmd = cmd
Tomáš Kukráldfd4b492017-03-02 12:08:50 +0100193 common.infoMsg("Running command ${cmd} on ${target}")
Jakub Josef053df392017-05-03 15:51:05 +0200194 if (checkResponse) {
195 cmd = cmd + " && echo Salt command execution success"
196 }
chnydaa0dbb252017-10-05 10:46:09 +0200197 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.run', batch, [cmd])
Jakub Josef053df392017-05-03 15:51:05 +0200198 if (checkResponse) {
199 // iterate over all affected nodes and check success return code
Jiri Broulik16e9ce72017-05-17 13:28:31 +0200200 if (out["return"]){
201 for(int i=0;i<out["return"].size();i++){
202 def node = out["return"][i];
Jakub Josef053df392017-05-03 15:51:05 +0200203 for(int j=0;j<node.size();j++){
204 def nodeKey = node.keySet()[j]
205 if (!node[nodeKey].contains("Salt command execution success")) {
206 throw new Exception("Execution of cmd ${originalCmd} failed. Server returns: ${node[nodeKey]}")
207 }
208 }
209 }
210 }else{
211 throw new Exception("Salt Api response doesn't have return param!")
212 }
213 }
Jiri Broulik16e9ce72017-05-17 13:28:31 +0200214 if (output == true) {
215 printSaltCommandResult(out)
216 }
217 return out
Jakub Josef79ecec32017-02-17 14:36:28 +0100218}
219
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200220/**
Jiri Broulik71512bc2017-08-04 10:00:18 +0200221 * Checks if salt minion is in a list of salt master's accepted keys
chnydaa0dbb252017-10-05 10:46:09 +0200222 * @usage minionPresent(saltId, 'I@salt:master', 'ntw', true, null, true, 200, 3)
223 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200224 * @param target Get pillar target
225 * @param minion_name unique identification of a minion in salt-key command output
226 * @param waitUntilPresent return after the minion becomes present (default true)
227 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
228 * @param output print salt command (default true)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200229 * @param maxRetries finite number of iterations to check status of a command (default 200)
230 * @param answers how many minions should return (optional, default 1)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200231 * @return output of salt command
232 */
chnydaa0dbb252017-10-05 10:46:09 +0200233def minionPresent(saltId, target, minion_name, waitUntilPresent = true, batch=null, output = true, maxRetries = 200, answers = 1) {
Jiri Broulik71512bc2017-08-04 10:00:18 +0200234 minion_name = minion_name.replace("*", "")
235 def common = new com.mirantis.mk.Common()
236 def cmd = 'salt-key | grep ' + minion_name
237 if (waitUntilPresent){
238 def count = 0
239 while(count < maxRetries) {
chnydaa0dbb252017-10-05 10:46:09 +0200240 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200241 if (output) {
242 printSaltCommandResult(out)
243 }
244 def valueMap = out["return"][0]
245 def result = valueMap.get(valueMap.keySet()[0])
246 def resultsArray = result.tokenize("\n")
247 def size = resultsArray.size()
248 if (size >= answers) {
chnydaa0dbb252017-10-05 10:46:09 +0200249 return out
Jiri Broulik71512bc2017-08-04 10:00:18 +0200250 }
251 count++
252 sleep(time: 500, unit: 'MILLISECONDS')
253 common.infoMsg("Waiting for ${cmd} on ${target} to be in correct state")
254 }
255 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200256 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200257 if (output) {
258 printSaltCommandResult(out)
259 }
260 return out
261 }
262 // otherwise throw exception
263 common.errorMsg("Status of command ${cmd} on ${target} failed, please check it.")
264 throw new Exception("${cmd} signals failure of status check!")
265}
266
267/**
268 * You can call this function when salt-master already contains salt keys of the target_nodes
chnydaa0dbb252017-10-05 10:46:09 +0200269 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200270 * @param target Should always be salt-master
271 * @param target_nodes unique identification of a minion or group of salt minions
272 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
273 * @param wait timeout for the salt command if minions do not return (default 10)
274 * @param maxRetries finite number of iterations to check status of a command (default 200)
275 * @return output of salt command
276 */
chnydaa0dbb252017-10-05 10:46:09 +0200277def minionsReachable(saltId, target, target_nodes, batch=null, wait = 10, maxRetries = 200) {
Jiri Broulik71512bc2017-08-04 10:00:18 +0200278 def common = new com.mirantis.mk.Common()
279 def cmd = "salt -t${wait} -C '${target_nodes}' test.ping"
280 common.infoMsg("Checking if all ${target_nodes} minions are reachable")
281 def count = 0
282 while(count < maxRetries) {
283 Calendar timeout = Calendar.getInstance();
284 timeout.add(Calendar.SECOND, wait);
chnydaa0dbb252017-10-05 10:46:09 +0200285 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, wait)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200286 Calendar current = Calendar.getInstance();
287 if (current.getTime().before(timeout.getTime())) {
288 printSaltCommandResult(out)
289 return out
290 }
291 common.infoMsg("Not all of the targeted '${target_nodes}' minions returned yet. Waiting ...")
292 count++
293 sleep(time: 500, unit: 'MILLISECONDS')
294 }
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200295}
296
297/**
298 * Run command on salt minion (salt cmd.run wrapper)
chnydaa0dbb252017-10-05 10:46:09 +0200299 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200300 * @param target Get pillar target
301 * @param cmd name of a service
302 * @param correct_state string that command must contain if status is in correct state (optional, default 'running')
Jiri Broulikcf1f2332017-07-25 11:30:03 +0200303 * @param find bool value if it is suppose to find some string in the output or the cmd should return empty string (optional, default true)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200304 * @param waitUntilOk return after the minion becomes present (optional, default true)
305 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
306 * @param output print salt command (default true)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200307 * @param maxRetries finite number of iterations to check status of a command (default 200)
308 * @param answers how many minions should return (optional, default 0)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200309 * @return output of salt command
310 */
chnydaa0dbb252017-10-05 10:46:09 +0200311def commandStatus(saltId, target, cmd, correct_state='running', find = true, waitUntilOk = true, batch=null, output = true, maxRetries = 200, answers = 0) {
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200312 def common = new com.mirantis.mk.Common()
313 common.infoMsg("Checking if status of verification command ${cmd} on ${target} is in correct state")
314 if (waitUntilOk){
315 def count = 0
316 while(count < maxRetries) {
chnydaa0dbb252017-10-05 10:46:09 +0200317 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200318 if (output) {
319 printSaltCommandResult(out)
320 }
Jakub Josef115a78f2017-07-18 15:04:00 +0200321 def resultMap = out["return"][0]
Jiri Broulik71512bc2017-08-04 10:00:18 +0200322 def success = 0
323 if (answers == 0){
324 answers = resultMap.size()
325 }
326 for (int i=0;i<answers;i++) {
327 result = resultMap.get(resultMap.keySet()[i])
328 // if the goal is to find some string in output of the command
329 if (find) {
330 if(result == null || result instanceof Boolean || result.isEmpty()) { result='' }
331 if (result.toLowerCase().contains(correct_state.toLowerCase())) {
332 success++
333 if (success == answers) {
334 return out
335 }
Jiri Broulikd0c27572017-07-24 20:01:10 +0200336 }
Jiri Broulik71512bc2017-08-04 10:00:18 +0200337 // else the goal is to not find any string in output of the command
338 } else {
339 if(result instanceof String && result.isEmpty()) {
340 success++
341 if (success == answers) {
342 return out
chnydaa0dbb252017-10-05 10:46:09 +0200343 }
Jiri Broulik71512bc2017-08-04 10:00:18 +0200344 }
345 }
346 }
347 count++
348 sleep(time: 500, unit: 'MILLISECONDS')
349 common.infoMsg("Waiting for ${cmd} on ${target} to be in correct state")
350 }
351 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200352 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200353 def resultMap = out["return"][0]
354 if (output) {
355 printSaltCommandResult(out)
356 }
357 for (int i=0;i<resultMap.size();i++) {
358 result = resultMap.get(resultMap.keySet()[i])
359 // if the goal is to find some string in output of the command
360 if (find) {
361 if(result == null || result instanceof Boolean || result.isEmpty()) { result='' }
362 if (result.toLowerCase().contains(correct_state.toLowerCase())) {
Jiri Broulikd0c27572017-07-24 20:01:10 +0200363 return out
364 }
365
366 // else the goal is to not find any string in output of the command
367 } else {
368 if(result instanceof String && result.isEmpty()) {
369 return out
370 }
371 }
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200372 }
373 }
374 // otherwise throw exception
Jiri Broulikd0c27572017-07-24 20:01:10 +0200375 common.errorMsg("Status of command ${cmd} on ${target} failed, please check it.")
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200376 throw new Exception("${cmd} signals failure of status check!")
377}
378
Jakub Josef5ade54c2017-03-10 16:14:01 +0100379/**
380 * Perform complete salt sync between master and target
chnydaa0dbb252017-10-05 10:46:09 +0200381 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100382 * @param target Get pillar target
383 * @return output of salt command
384 */
chnydaa0dbb252017-10-05 10:46:09 +0200385def syncAll(saltId, target) {
386 return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'saltutil.sync_all')
Jakub Josef79ecec32017-02-17 14:36:28 +0100387}
388
Jakub Josef5ade54c2017-03-10 16:14:01 +0100389/**
390 * Enforce highstate on given targets
chnydaa0dbb252017-10-05 10:46:09 +0200391 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100392 * @param target Highstate enforcing target
393 * @param output print output (optional, default true)
394 * @param failOnError throw exception on salt state result:false (optional, default true)
Jakub Josef2f25cf22017-03-28 13:34:57 +0200395 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100396 * @return output of salt command
397 */
chnydaa0dbb252017-10-05 10:46:09 +0200398def enforceHighstate(saltId, target, output = false, failOnError = true, batch = null) {
399 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'state.highstate', batch)
Alexander Noskov657ccfc2017-07-14 11:35:52 +0000400 def common = new com.mirantis.mk.Common()
401
Marek Celoud63366112017-07-25 17:27:24 +0200402 common.infoMsg("Running state highstate on ${target}")
Alexander Noskov657ccfc2017-07-14 11:35:52 +0000403
Jakub Josef374beb72017-04-27 15:45:09 +0200404 checkResult(out, failOnError, output)
Jakub Josef79ecec32017-02-17 14:36:28 +0100405 return out
406}
407
Jakub Josef5ade54c2017-03-10 16:14:01 +0100408/**
Ales Komarek5276ebe2017-03-16 08:46:34 +0100409 * Get running minions IDs according to the target
chnydaa0dbb252017-10-05 10:46:09 +0200410 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Ales Komarek5276ebe2017-03-16 08:46:34 +0100411 * @param target Get minions target
412 * @return list of active minions fitin
413 */
chnydaa0dbb252017-10-05 10:46:09 +0200414def getMinions(saltId, target) {
415 def minionsRaw = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'test.ping')
Ales Komarek5276ebe2017-03-16 08:46:34 +0100416 return new ArrayList<String>(minionsRaw['return'][0].keySet())
417}
418
419
420/**
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200421 * Test if there are any minions to target
chnydaa0dbb252017-10-05 10:46:09 +0200422 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200423 * @param target Target to test
vrovachev1c4770b2017-07-05 13:25:21 +0400424 * @return bool indicating if target was succesful
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200425 */
426
chnydaa0dbb252017-10-05 10:46:09 +0200427def testTarget(saltId, target) {
428 return getMinions(saltId, target).size() > 0
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200429}
430
431/**
Jakub Josef5ade54c2017-03-10 16:14:01 +0100432 * Generates node key using key.gen_accept call
chnydaa0dbb252017-10-05 10:46:09 +0200433 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100434 * @param target Key generating target
435 * @param host Key generating host
436 * @param keysize generated key size (optional, default 4096)
437 * @return output of salt command
438 */
chnydaa0dbb252017-10-05 10:46:09 +0200439def generateNodeKey(saltId, target, host, keysize = 4096) {
440 return runSaltCommand(saltId, 'wheel', target, 'key.gen_accept', [host], ['keysize': keysize])
Jakub Josef79ecec32017-02-17 14:36:28 +0100441}
442
Jakub Josef5ade54c2017-03-10 16:14:01 +0100443/**
Jakub Josef2f25cf22017-03-28 13:34:57 +0200444 * Generates node reclass metadata
chnydaa0dbb252017-10-05 10:46:09 +0200445 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100446 * @param target Metadata generating target
447 * @param host Metadata generating host
448 * @param classes Reclass classes
449 * @param parameters Reclass parameters
450 * @return output of salt command
451 */
chnydaa0dbb252017-10-05 10:46:09 +0200452def generateNodeMetadata(saltId, target, host, classes, parameters) {
453 return runSaltCommand(saltId, 'local', target, 'reclass.node_create', [host, '_generated'], ['classes': classes, 'parameters': parameters])
Jakub Josef79ecec32017-02-17 14:36:28 +0100454}
455
Jakub Josef5ade54c2017-03-10 16:14:01 +0100456/**
457 * Run salt orchestrate on given targets
chnydaa0dbb252017-10-05 10:46:09 +0200458 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100459 * @param target Orchestration target
460 * @param orchestrate Salt orchestrate params
461 * @return output of salt command
462 */
chnydaa0dbb252017-10-05 10:46:09 +0200463def orchestrateSystem(saltId, target, orchestrate) {
464 return runSaltCommand(saltId, 'runner', target, 'state.orchestrate', [orchestrate])
Jakub Josef79ecec32017-02-17 14:36:28 +0100465}
466
Jakub Josef5ade54c2017-03-10 16:14:01 +0100467/**
468 * Run salt process step
chnydaa0dbb252017-10-05 10:46:09 +0200469 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100470 * @param tgt Salt process step target
471 * @param fun Salt process step function
472 * @param arg process step arguments (optional, default [])
Jakub Josef2f25cf22017-03-28 13:34:57 +0200473 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100474 * @param output print output (optional, default false)
Jiri Broulik48544be2017-06-14 18:33:54 +0200475 * @param timeout Additional argument salt api timeout
Jakub Josef5ade54c2017-03-10 16:14:01 +0100476 * @return output of salt command
477 */
chnydaa0dbb252017-10-05 10:46:09 +0200478def runSaltProcessStep(saltId, tgt, fun, arg = [], batch = null, output = false, timeout = -1, kwargs = null) {
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100479 def common = new com.mirantis.mk.Common()
Jiri Broulik48544be2017-06-14 18:33:54 +0200480 def salt = new com.mirantis.mk.Salt()
Tomáš Kukráladb4ecd2017-03-02 10:06:36 +0100481 def out
482
Marek Celoud63366112017-07-25 17:27:24 +0200483 common.infoMsg("Running step ${fun} ${arg} on ${tgt}")
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100484
Filip Pytlounf0435c02017-03-02 17:48:54 +0100485 if (batch == true) {
chnydaa0dbb252017-10-05 10:46:09 +0200486 out = runSaltCommand(saltId, 'local_batch', ['expression': tgt, 'type': 'compound'], fun, String.valueOf(batch), arg, kwargs, timeout)
Tomáš Kukráladb4ecd2017-03-02 10:06:36 +0100487 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200488 out = runSaltCommand(saltId, 'local', ['expression': tgt, 'type': 'compound'], fun, batch, arg, kwargs, timeout)
Jakub Josef79ecec32017-02-17 14:36:28 +0100489 }
Tomáš Kukráladb4ecd2017-03-02 10:06:36 +0100490
Tomáš Kukrálf5dda642017-03-02 14:22:59 +0100491 if (output == true) {
Jiri Broulik48544be2017-06-14 18:33:54 +0200492 salt.printSaltCommandResult(out)
Jakub Josef79ecec32017-02-17 14:36:28 +0100493 }
Jiri Broulikae19c262017-05-16 19:06:52 +0200494 return out
Jakub Josef79ecec32017-02-17 14:36:28 +0100495}
496
497/**
498 * Check result for errors and throw exception if any found
499 *
500 * @param result Parsed response of Salt API
Jakub Josef8021c002017-03-27 15:41:28 +0200501 * @param failOnError Do you want to throw exception if salt-call fails (optional, default true)
Jakub Josefa87941c2017-04-20 17:14:58 +0200502 * @param printResults Do you want to print salt results (optional, default true)
Jakub Josefa87941c2017-04-20 17:14:58 +0200503 * @param printOnlyChanges If true (default), print only changed resources
Jakub Josef79ecec32017-02-17 14:36:28 +0100504 */
Jakub Josef374beb72017-04-27 15:45:09 +0200505def checkResult(result, failOnError = true, printResults = true, printOnlyChanges = true) {
Jakub Josef5ade54c2017-03-10 16:14:01 +0100506 def common = new com.mirantis.mk.Common()
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100507 if(result != null){
508 if(result['return']){
509 for (int i=0;i<result['return'].size();i++) {
510 def entry = result['return'][i]
511 if (!entry) {
512 if (failOnError) {
513 throw new Exception("Salt API returned empty response: ${result}")
514 } else {
515 common.errorMsg("Salt API returned empty response: ${result}")
Jakub Josefece32af2017-03-14 19:20:08 +0100516 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100517 }
518 for (int j=0;j<entry.size();j++) {
519 def nodeKey = entry.keySet()[j]
520 def node=entry[nodeKey]
Jakub Josefa87941c2017-04-20 17:14:58 +0200521 def outputResources = []
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100522 common.infoMsg("Node ${nodeKey} changes:")
523 if(node instanceof Map || node instanceof List){
524 for (int k=0;k<node.size();k++) {
525 def resource;
526 def resKey;
527 if(node instanceof Map){
528 resKey = node.keySet()[k]
529 }else if(node instanceof List){
530 resKey = k
531 }
532 resource = node[resKey]
Jakub Josefc4c40202017-04-28 12:04:24 +0200533 // print
Jakub Josefa87941c2017-04-20 17:14:58 +0200534 if(printResults){
535 if(resource instanceof Map && resource.keySet().contains("result")){
536 //clean unnesaccary fields
537 if(resource.keySet().contains("__run_num__")){
538 resource.remove("__run_num__")
539 }
540 if(resource.keySet().contains("__id__")){
541 resource.remove("__id__")
542 }
543 if(resource.keySet().contains("pchanges")){
544 resource.remove("pchanges")
545 }
546 if(!resource["result"] || (resource["result"] instanceof String && resource["result"] != "true")){
547 if(resource["result"] != null){
Jakub Josefbceaa322017-06-13 18:28:27 +0200548 outputResources.add(String.format("Resource: %s\n\u001B[31m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200549 }else{
Jakub Josefbceaa322017-06-13 18:28:27 +0200550 outputResources.add(String.format("Resource: %s\n\u001B[33m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200551 }
552 }else{
553 if(!printOnlyChanges || resource.changes.size() > 0){
Jakub Josefbceaa322017-06-13 18:28:27 +0200554 outputResources.add(String.format("Resource: %s\n\u001B[32m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200555 }
556 }
557 }else{
Jakub Josefbceaa322017-06-13 18:28:27 +0200558 outputResources.add(String.format("Resource: %s\n\u001B[36m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200559 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100560 }
Jakub Josefc4c40202017-04-28 12:04:24 +0200561 common.debugMsg("checkResult: checking resource: ${resource}")
562 if(resource instanceof String || (resource["result"] != null && !resource["result"]) || (resource["result"] instanceof String && resource["result"] == "false")){
Jakub Josefbceaa322017-06-13 18:28:27 +0200563 def prettyResource = common.prettify(resource)
Jakub Josefc4c40202017-04-28 12:04:24 +0200564 if(env["ASK_ON_ERROR"] && env["ASK_ON_ERROR"] == "true"){
565 timeout(time:1, unit:'HOURS') {
566 input message: "False result on ${nodeKey} found, resource ${prettyResource}. \nDo you want to continue?"
567 }
568 }else{
Jakub Josefd97d7db2017-05-11 19:11:53 +0200569 common.errorMsg(String.format("Resource: %s\n%s", resKey, prettyResource))
Jakub Josefd9001df2017-05-11 16:45:28 +0200570 def errorMsg = "Salt state on node ${nodeKey} failed: ${prettyResource}."
Jakub Josefc4c40202017-04-28 12:04:24 +0200571 if (failOnError) {
572 throw new Exception(errorMsg)
573 } else {
574 common.errorMsg(errorMsg)
575 }
576 }
577 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100578 }
Jakub Josefa87941c2017-04-20 17:14:58 +0200579 }else if(node!=null && node!=""){
Jakub Josef62f6c842017-08-04 16:36:35 +0200580 outputResources.add(String.format("Resource: %s\n\u001B[36m%s\u001B[0m", nodeKey, common.prettify(node)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200581 }
582 if(printResults && !outputResources.isEmpty()){
Jakub Josefe6c562e2017-08-09 14:41:03 +0200583 print outputResources.stream().collect(Collectors.joining("\n"))
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100584 }
585 }
Jakub Josef52f69f72017-03-14 15:18:08 +0100586 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100587 }else{
588 common.errorMsg("Salt result hasn't return attribute! Result: ${result}")
Jakub Josef79ecec32017-02-17 14:36:28 +0100589 }
Jakub Josef52f69f72017-03-14 15:18:08 +0100590 }else{
Jakub Josefa87941c2017-04-20 17:14:58 +0200591 common.errorMsg("Cannot check salt result, given result is null")
Jakub Josef79ecec32017-02-17 14:36:28 +0100592 }
593}
594
595/**
Oleg Iurchenko7eb21502017-11-28 18:53:43 +0200596* Parse salt API output to check minion restart and wait some time to be sure minion is up.
597* See https://mirantis.jira.com/browse/PROD-16258 for more details
598* TODO: change sleep to more tricky procedure.
599*
600* @param result Parsed response of Salt API
601*/
602def waitForMinion(result) {
603 def common = new com.mirantis.mk.Common()
604 def matcher = result =~ /(?s).*salt_minion_service_restart.*?(changes:\[.*?\])/
605 def isMinionRestarted = false
606 while (matcher.find()) {
607 if (matcher.group(1) != null && matcher.group(1).contains("pid")) {
608 isMinionRestarted = true
609 }
610 }
611 // There is an exception when use sleep after defined Matcher. Therefore destroy the matcher.
612 matcher = null
613 if (isMinionRestarted){
614 common.infoMsg("Salt minion service restart detected. Sleep 10 seconds to wait minion restart")
615 sleep(10)
616 }
617}
618
619/**
Jakub Josef7852fe12017-03-15 16:02:41 +0100620 * Print salt command run results in human-friendly form
Jakub Josef79ecec32017-02-17 14:36:28 +0100621 *
622 * @param result Parsed response of Salt API
Jakub Josef79ecec32017-02-17 14:36:28 +0100623 */
Filip Pytlound2f1bbe2017-02-27 19:03:51 +0100624def printSaltCommandResult(result) {
Jakub Josef871bf152017-03-14 20:13:41 +0100625 def common = new com.mirantis.mk.Common()
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100626 if(result != null){
627 if(result['return']){
628 for (int i=0; i<result['return'].size(); i++) {
629 def entry = result['return'][i]
630 for (int j=0; j<entry.size(); j++) {
631 common.debugMsg("printSaltCommandResult: printing salt command entry: ${entry}")
632 def nodeKey = entry.keySet()[j]
633 def node=entry[nodeKey]
Jakub Josefbceaa322017-06-13 18:28:27 +0200634 common.infoMsg(String.format("Node %s changes:\n%s",nodeKey, common.prettify(node)))
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100635 }
Jakub Josef8a715bf2017-03-14 21:39:01 +0100636 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100637 }else{
638 common.errorMsg("Salt result hasn't return attribute! Result: ${result}")
Jakub Josef79ecec32017-02-17 14:36:28 +0100639 }
Jakub Josef8a715bf2017-03-14 21:39:01 +0100640 }else{
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100641 common.errorMsg("Cannot print salt command result, given result is null")
Jakub Josef52f69f72017-03-14 15:18:08 +0100642 }
Jakub Josef79ecec32017-02-17 14:36:28 +0100643}
Tomáš Kukrálb12eedd2017-04-21 10:45:13 +0200644
645
646/**
647 * Return content of file target
648 *
chnydaa0dbb252017-10-05 10:46:09 +0200649 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Tomáš Kukrálb12eedd2017-04-21 10:45:13 +0200650 * @param target Compound target (should target only one host)
651 * @param file File path to read (/etc/hosts for example)
652 */
653
chnydaa0dbb252017-10-05 10:46:09 +0200654def getFileContent(saltId, target, file) {
655 result = cmdRun(saltId, target, "cat ${file}")
Tomáš Kukrálf1a692a2017-08-11 13:29:28 +0200656 return result['return'][0].values()[0].replaceAll('Salt command execution success','')
Tomáš Kukrálb12eedd2017-04-21 10:45:13 +0200657}
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300658
659/**
660 * Set override parameters in Salt cluster metadata
661 *
chnydaa0dbb252017-10-05 10:46:09 +0200662 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300663 * @param salt_overrides YAML formatted string containing key: value, one per line
Matthew Mosesohne5646842017-07-19 16:54:57 +0300664 * @param reclass_dir Directory where Reclass git repo is located
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300665 */
666
chnydaa0dbb252017-10-05 10:46:09 +0200667def setSaltOverrides(saltId, salt_overrides, reclass_dir="/srv/salt/reclass") {
Tomáš Kukrálf178f052017-07-11 11:31:00 +0200668 def common = new com.mirantis.mk.Common()
Mykyta Karpin1c165e22017-08-22 18:27:01 +0300669 def salt_overrides_map = readYaml text: salt_overrides
Tomáš Kukrál243cf842017-07-11 13:11:56 +0200670 for (entry in common.entries(salt_overrides_map)) {
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300671 def key = entry[0]
672 def value = entry[1]
673
674 common.debugMsg("Set salt override ${key}=${value}")
Mykyta Karpind4a42d02017-11-16 16:24:37 +0200675 runSaltProcessStep(saltId, 'I@salt:master', 'reclass.cluster_meta_set', [key, value], false)
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300676 }
chnydaa0dbb252017-10-05 10:46:09 +0200677 runSaltProcessStep(saltId, 'I@salt:master', 'cmd.run', ["git -C ${reclass_dir} update-index --skip-worktree classes/cluster/overrides.yml"])
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300678}
Oleg Grigorovbec45582017-09-12 20:29:24 +0300679
680/**
681* Execute salt commands via salt-api with
682* CLI client salt-pepper
683*
684* @param data Salt command map
685* @param venv Path to virtualenv with
686*/
687
688def runPepperCommand(data, venv) {
689 def python = new com.mirantis.mk.Python()
690 def dataStr = new groovy.json.JsonBuilder(data).toString()
chnyda4901a042017-11-16 12:14:56 +0100691
Jakub Josefcaa070b2017-11-29 18:13:26 +0100692 def offlineDeployment = env.getEnvironment().containsKey("OFFLINE_DEPLOYMENT") && env["OFFLINE_DEPLOYMENT"].toBoolean()
Jakub Josef804dd052017-11-29 18:59:05 +0100693 if(!offlineDeployment){
694 try {
Jakub Josef5f97d532017-11-29 18:51:41 +0100695 //TODO: remove wget after global env prop enforcments
Alexander Noskova5f11962017-12-05 11:25:16 +0400696 offlineDeployment = sh(script: "wget -q -T 10 --spider http://google.com", returnStatus: true) != 0
Jakub Josef804dd052017-11-29 18:59:05 +0100697 } catch(Exception e) {
Jakub Josef6d067c12017-12-01 16:41:57 +0100698 def common = new com.mirantis.mk.Common()
chnydabcfff182017-11-29 10:24:36 +0100699 common.warningMsg("You might be offline, will use pepper with option --json instead of option --json-file")
Jakub Josef804dd052017-11-29 18:59:05 +0100700 }
chnydabcfff182017-11-29 10:24:36 +0100701 }
chnydabcfff182017-11-29 10:24:36 +0100702 def pepperCmd
703
704 if (!offlineDeployment) {
705 def pepperCmdFile = "${venv}/pepper-cmd.json"
706 writeFile file: pepperCmdFile, text: dataStr
707 pepperCmd = "pepper -c ${venv}/pepperrc --make-token -x ${venv}/.peppercache --json-file ${pepperCmdFile}"
708 } else {
Jakub Josef38ad6cc2017-11-29 23:13:42 +0100709 pepperCmd = "pepper -c ${venv}/pepperrc --make-token -x ${venv}/.peppercache --json \"" + dataStr.replaceAll('"', '\\\\\\\"') + "\"" // yeah, really 7 backslashes, don't ask why
chnydabcfff182017-11-29 10:24:36 +0100710 }
Oleg Grigorovbec45582017-09-12 20:29:24 +0300711
712 if (venv) {
713 output = python.runVirtualenvCommand(venv, pepperCmd)
714 } else {
715 echo("[Command]: ${pepperCmd}")
716 output = sh (
717 script: pepperCmd,
718 returnStdout: true
719 ).trim()
720 }
721
722 return new groovy.json.JsonSlurperClassic().parseText(output)
723}