blob: c3995d5aa758271e2ad7517c44b0d13fed51b95a [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
chnyda205a92b2018-01-11 17:07:32 +0100188 * @param saltArgs additional salt args eq. ["runas=aptly"]
Jakub Josef5ade54c2017-03-10 16:14:01 +0100189 * @return output of salt command
190 */
chnyda205a92b2018-01-11 17:07:32 +0100191def cmdRun(saltId, target, cmd, checkResponse = true, batch=null, output = true, saltArgs = []) {
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100192 def common = new com.mirantis.mk.Common()
Jakub Josef053df392017-05-03 15:51:05 +0200193 def originalCmd = cmd
Tomáš Kukráldfd4b492017-03-02 12:08:50 +0100194 common.infoMsg("Running command ${cmd} on ${target}")
Jakub Josef053df392017-05-03 15:51:05 +0200195 if (checkResponse) {
196 cmd = cmd + " && echo Salt command execution success"
197 }
chnyda205a92b2018-01-11 17:07:32 +0100198
199 saltArgs << cmd
200
201 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.run', batch, saltArgs.reverse())
Jakub Josef053df392017-05-03 15:51:05 +0200202 if (checkResponse) {
203 // iterate over all affected nodes and check success return code
Jiri Broulik16e9ce72017-05-17 13:28:31 +0200204 if (out["return"]){
205 for(int i=0;i<out["return"].size();i++){
206 def node = out["return"][i];
Jakub Josef053df392017-05-03 15:51:05 +0200207 for(int j=0;j<node.size();j++){
208 def nodeKey = node.keySet()[j]
209 if (!node[nodeKey].contains("Salt command execution success")) {
210 throw new Exception("Execution of cmd ${originalCmd} failed. Server returns: ${node[nodeKey]}")
211 }
212 }
213 }
214 }else{
215 throw new Exception("Salt Api response doesn't have return param!")
216 }
217 }
Jiri Broulik16e9ce72017-05-17 13:28:31 +0200218 if (output == true) {
219 printSaltCommandResult(out)
220 }
221 return out
Jakub Josef79ecec32017-02-17 14:36:28 +0100222}
223
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200224/**
Jiri Broulik71512bc2017-08-04 10:00:18 +0200225 * Checks if salt minion is in a list of salt master's accepted keys
chnydaa0dbb252017-10-05 10:46:09 +0200226 * @usage minionPresent(saltId, 'I@salt:master', 'ntw', true, null, true, 200, 3)
227 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200228 * @param target Get pillar target
229 * @param minion_name unique identification of a minion in salt-key command output
230 * @param waitUntilPresent return after the minion becomes present (default true)
231 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
232 * @param output print salt command (default true)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200233 * @param maxRetries finite number of iterations to check status of a command (default 200)
234 * @param answers how many minions should return (optional, default 1)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200235 * @return output of salt command
236 */
chnydaa0dbb252017-10-05 10:46:09 +0200237def minionPresent(saltId, target, minion_name, waitUntilPresent = true, batch=null, output = true, maxRetries = 200, answers = 1) {
Jiri Broulik71512bc2017-08-04 10:00:18 +0200238 minion_name = minion_name.replace("*", "")
239 def common = new com.mirantis.mk.Common()
240 def cmd = 'salt-key | grep ' + minion_name
241 if (waitUntilPresent){
242 def count = 0
243 while(count < maxRetries) {
chnydaa0dbb252017-10-05 10:46:09 +0200244 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200245 if (output) {
246 printSaltCommandResult(out)
247 }
248 def valueMap = out["return"][0]
249 def result = valueMap.get(valueMap.keySet()[0])
250 def resultsArray = result.tokenize("\n")
251 def size = resultsArray.size()
252 if (size >= answers) {
chnydaa0dbb252017-10-05 10:46:09 +0200253 return out
Jiri Broulik71512bc2017-08-04 10:00:18 +0200254 }
255 count++
256 sleep(time: 500, unit: 'MILLISECONDS')
257 common.infoMsg("Waiting for ${cmd} on ${target} to be in correct state")
258 }
259 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200260 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200261 if (output) {
262 printSaltCommandResult(out)
263 }
264 return out
265 }
266 // otherwise throw exception
267 common.errorMsg("Status of command ${cmd} on ${target} failed, please check it.")
268 throw new Exception("${cmd} signals failure of status check!")
269}
270
271/**
272 * You can call this function when salt-master already contains salt keys of the target_nodes
chnydaa0dbb252017-10-05 10:46:09 +0200273 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200274 * @param target Should always be salt-master
275 * @param target_nodes unique identification of a minion or group of salt minions
276 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
277 * @param wait timeout for the salt command if minions do not return (default 10)
278 * @param maxRetries finite number of iterations to check status of a command (default 200)
279 * @return output of salt command
280 */
chnydaa0dbb252017-10-05 10:46:09 +0200281def minionsReachable(saltId, target, target_nodes, batch=null, wait = 10, maxRetries = 200) {
Jiri Broulik71512bc2017-08-04 10:00:18 +0200282 def common = new com.mirantis.mk.Common()
283 def cmd = "salt -t${wait} -C '${target_nodes}' test.ping"
284 common.infoMsg("Checking if all ${target_nodes} minions are reachable")
285 def count = 0
286 while(count < maxRetries) {
287 Calendar timeout = Calendar.getInstance();
288 timeout.add(Calendar.SECOND, wait);
chnydaa0dbb252017-10-05 10:46:09 +0200289 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, wait)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200290 Calendar current = Calendar.getInstance();
291 if (current.getTime().before(timeout.getTime())) {
292 printSaltCommandResult(out)
293 return out
294 }
295 common.infoMsg("Not all of the targeted '${target_nodes}' minions returned yet. Waiting ...")
296 count++
297 sleep(time: 500, unit: 'MILLISECONDS')
298 }
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200299}
300
301/**
302 * Run command on salt minion (salt cmd.run wrapper)
chnydaa0dbb252017-10-05 10:46:09 +0200303 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200304 * @param target Get pillar target
305 * @param cmd name of a service
306 * @param correct_state string that command must contain if status is in correct state (optional, default 'running')
Jiri Broulikcf1f2332017-07-25 11:30:03 +0200307 * @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 +0200308 * @param waitUntilOk return after the minion becomes present (optional, default true)
309 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
310 * @param output print salt command (default true)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200311 * @param maxRetries finite number of iterations to check status of a command (default 200)
312 * @param answers how many minions should return (optional, default 0)
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200313 * @return output of salt command
314 */
chnydaa0dbb252017-10-05 10:46:09 +0200315def 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 +0200316 def common = new com.mirantis.mk.Common()
317 common.infoMsg("Checking if status of verification command ${cmd} on ${target} is in correct state")
318 if (waitUntilOk){
319 def count = 0
320 while(count < maxRetries) {
chnydaa0dbb252017-10-05 10:46:09 +0200321 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200322 if (output) {
323 printSaltCommandResult(out)
324 }
Jakub Josef115a78f2017-07-18 15:04:00 +0200325 def resultMap = out["return"][0]
Jiri Broulik71512bc2017-08-04 10:00:18 +0200326 def success = 0
327 if (answers == 0){
328 answers = resultMap.size()
329 }
330 for (int i=0;i<answers;i++) {
331 result = resultMap.get(resultMap.keySet()[i])
332 // if the goal is to find some string in output of the command
333 if (find) {
334 if(result == null || result instanceof Boolean || result.isEmpty()) { result='' }
335 if (result.toLowerCase().contains(correct_state.toLowerCase())) {
336 success++
337 if (success == answers) {
338 return out
339 }
Jiri Broulikd0c27572017-07-24 20:01:10 +0200340 }
Jiri Broulik71512bc2017-08-04 10:00:18 +0200341 // else the goal is to not find any string in output of the command
342 } else {
343 if(result instanceof String && result.isEmpty()) {
344 success++
345 if (success == answers) {
346 return out
chnydaa0dbb252017-10-05 10:46:09 +0200347 }
Jiri Broulik71512bc2017-08-04 10:00:18 +0200348 }
349 }
350 }
351 count++
352 sleep(time: 500, unit: 'MILLISECONDS')
353 common.infoMsg("Waiting for ${cmd} on ${target} to be in correct state")
354 }
355 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200356 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5)
Jiri Broulik71512bc2017-08-04 10:00:18 +0200357 def resultMap = out["return"][0]
358 if (output) {
359 printSaltCommandResult(out)
360 }
361 for (int i=0;i<resultMap.size();i++) {
362 result = resultMap.get(resultMap.keySet()[i])
363 // if the goal is to find some string in output of the command
364 if (find) {
365 if(result == null || result instanceof Boolean || result.isEmpty()) { result='' }
366 if (result.toLowerCase().contains(correct_state.toLowerCase())) {
Jiri Broulikd0c27572017-07-24 20:01:10 +0200367 return out
368 }
369
370 // else the goal is to not find any string in output of the command
371 } else {
372 if(result instanceof String && result.isEmpty()) {
373 return out
374 }
375 }
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200376 }
377 }
378 // otherwise throw exception
Jiri Broulikd0c27572017-07-24 20:01:10 +0200379 common.errorMsg("Status of command ${cmd} on ${target} failed, please check it.")
Jiri Broulik2c69f3d2017-07-18 14:23:58 +0200380 throw new Exception("${cmd} signals failure of status check!")
381}
382
Jakub Josef5ade54c2017-03-10 16:14:01 +0100383/**
384 * Perform complete salt sync between master and target
chnydaa0dbb252017-10-05 10:46:09 +0200385 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100386 * @param target Get pillar target
387 * @return output of salt command
388 */
chnydaa0dbb252017-10-05 10:46:09 +0200389def syncAll(saltId, target) {
390 return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'saltutil.sync_all')
Jakub Josef79ecec32017-02-17 14:36:28 +0100391}
392
Jakub Josef5ade54c2017-03-10 16:14:01 +0100393/**
394 * Enforce highstate on given targets
chnydaa0dbb252017-10-05 10:46:09 +0200395 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100396 * @param target Highstate enforcing target
397 * @param output print output (optional, default true)
398 * @param failOnError throw exception on salt state result:false (optional, default true)
Jakub Josef2f25cf22017-03-28 13:34:57 +0200399 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100400 * @return output of salt command
401 */
chnydaa0dbb252017-10-05 10:46:09 +0200402def enforceHighstate(saltId, target, output = false, failOnError = true, batch = null) {
403 def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'state.highstate', batch)
Alexander Noskov657ccfc2017-07-14 11:35:52 +0000404 def common = new com.mirantis.mk.Common()
405
Marek Celoud63366112017-07-25 17:27:24 +0200406 common.infoMsg("Running state highstate on ${target}")
Alexander Noskov657ccfc2017-07-14 11:35:52 +0000407
Jakub Josef374beb72017-04-27 15:45:09 +0200408 checkResult(out, failOnError, output)
Jakub Josef79ecec32017-02-17 14:36:28 +0100409 return out
410}
411
Jakub Josef5ade54c2017-03-10 16:14:01 +0100412/**
Ales Komarek5276ebe2017-03-16 08:46:34 +0100413 * Get running minions IDs according to the target
chnydaa0dbb252017-10-05 10:46:09 +0200414 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Ales Komarek5276ebe2017-03-16 08:46:34 +0100415 * @param target Get minions target
416 * @return list of active minions fitin
417 */
chnydaa0dbb252017-10-05 10:46:09 +0200418def getMinions(saltId, target) {
419 def minionsRaw = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'test.ping')
Ales Komarek5276ebe2017-03-16 08:46:34 +0100420 return new ArrayList<String>(minionsRaw['return'][0].keySet())
421}
422
423
424/**
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200425 * Test if there are any minions to target
chnydaa0dbb252017-10-05 10:46:09 +0200426 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200427 * @param target Target to test
vrovachev1c4770b2017-07-05 13:25:21 +0400428 * @return bool indicating if target was succesful
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200429 */
430
chnydaa0dbb252017-10-05 10:46:09 +0200431def testTarget(saltId, target) {
432 return getMinions(saltId, target).size() > 0
Tomáš Kukrálb12ff9f2017-07-12 12:32:34 +0200433}
434
435/**
Jakub Josef5ade54c2017-03-10 16:14:01 +0100436 * Generates node key using key.gen_accept call
chnydaa0dbb252017-10-05 10:46:09 +0200437 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100438 * @param target Key generating target
439 * @param host Key generating host
440 * @param keysize generated key size (optional, default 4096)
441 * @return output of salt command
442 */
chnydaa0dbb252017-10-05 10:46:09 +0200443def generateNodeKey(saltId, target, host, keysize = 4096) {
444 return runSaltCommand(saltId, 'wheel', target, 'key.gen_accept', [host], ['keysize': keysize])
Jakub Josef79ecec32017-02-17 14:36:28 +0100445}
446
Jakub Josef5ade54c2017-03-10 16:14:01 +0100447/**
Jakub Josef2f25cf22017-03-28 13:34:57 +0200448 * Generates node reclass metadata
chnydaa0dbb252017-10-05 10:46:09 +0200449 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100450 * @param target Metadata generating target
451 * @param host Metadata generating host
452 * @param classes Reclass classes
453 * @param parameters Reclass parameters
454 * @return output of salt command
455 */
chnydaa0dbb252017-10-05 10:46:09 +0200456def generateNodeMetadata(saltId, target, host, classes, parameters) {
457 return runSaltCommand(saltId, 'local', target, 'reclass.node_create', [host, '_generated'], ['classes': classes, 'parameters': parameters])
Jakub Josef79ecec32017-02-17 14:36:28 +0100458}
459
Jakub Josef5ade54c2017-03-10 16:14:01 +0100460/**
461 * Run salt orchestrate on given targets
chnydaa0dbb252017-10-05 10:46:09 +0200462 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100463 * @param target Orchestration target
464 * @param orchestrate Salt orchestrate params
465 * @return output of salt command
466 */
chnydaa0dbb252017-10-05 10:46:09 +0200467def orchestrateSystem(saltId, target, orchestrate) {
468 return runSaltCommand(saltId, 'runner', target, 'state.orchestrate', [orchestrate])
Jakub Josef79ecec32017-02-17 14:36:28 +0100469}
470
Jakub Josef5ade54c2017-03-10 16:14:01 +0100471/**
472 * Run salt process step
chnydaa0dbb252017-10-05 10:46:09 +0200473 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100474 * @param tgt Salt process step target
475 * @param fun Salt process step function
476 * @param arg process step arguments (optional, default [])
Jakub Josef2f25cf22017-03-28 13:34:57 +0200477 * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch)
Jakub Josef5ade54c2017-03-10 16:14:01 +0100478 * @param output print output (optional, default false)
Jiri Broulik48544be2017-06-14 18:33:54 +0200479 * @param timeout Additional argument salt api timeout
Jakub Josef5ade54c2017-03-10 16:14:01 +0100480 * @return output of salt command
481 */
chnydaa0dbb252017-10-05 10:46:09 +0200482def runSaltProcessStep(saltId, tgt, fun, arg = [], batch = null, output = false, timeout = -1, kwargs = null) {
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100483 def common = new com.mirantis.mk.Common()
Jiri Broulik48544be2017-06-14 18:33:54 +0200484 def salt = new com.mirantis.mk.Salt()
Tomáš Kukráladb4ecd2017-03-02 10:06:36 +0100485 def out
486
Marek Celoud63366112017-07-25 17:27:24 +0200487 common.infoMsg("Running step ${fun} ${arg} on ${tgt}")
Tomáš Kukrál6c04bd02017-03-01 22:18:52 +0100488
Filip Pytlounf0435c02017-03-02 17:48:54 +0100489 if (batch == true) {
chnydaa0dbb252017-10-05 10:46:09 +0200490 out = runSaltCommand(saltId, 'local_batch', ['expression': tgt, 'type': 'compound'], fun, String.valueOf(batch), arg, kwargs, timeout)
Tomáš Kukráladb4ecd2017-03-02 10:06:36 +0100491 } else {
chnydaa0dbb252017-10-05 10:46:09 +0200492 out = runSaltCommand(saltId, 'local', ['expression': tgt, 'type': 'compound'], fun, batch, arg, kwargs, timeout)
Jakub Josef79ecec32017-02-17 14:36:28 +0100493 }
Tomáš Kukráladb4ecd2017-03-02 10:06:36 +0100494
Tomáš Kukrálf5dda642017-03-02 14:22:59 +0100495 if (output == true) {
Jiri Broulik48544be2017-06-14 18:33:54 +0200496 salt.printSaltCommandResult(out)
Jakub Josef79ecec32017-02-17 14:36:28 +0100497 }
Jiri Broulikae19c262017-05-16 19:06:52 +0200498 return out
Jakub Josef79ecec32017-02-17 14:36:28 +0100499}
500
501/**
502 * Check result for errors and throw exception if any found
503 *
504 * @param result Parsed response of Salt API
Jakub Josef8021c002017-03-27 15:41:28 +0200505 * @param failOnError Do you want to throw exception if salt-call fails (optional, default true)
Jakub Josefa87941c2017-04-20 17:14:58 +0200506 * @param printResults Do you want to print salt results (optional, default true)
Jakub Josefa87941c2017-04-20 17:14:58 +0200507 * @param printOnlyChanges If true (default), print only changed resources
Jakub Josef79ecec32017-02-17 14:36:28 +0100508 */
Jakub Josef374beb72017-04-27 15:45:09 +0200509def checkResult(result, failOnError = true, printResults = true, printOnlyChanges = true) {
Jakub Josef5ade54c2017-03-10 16:14:01 +0100510 def common = new com.mirantis.mk.Common()
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100511 if(result != null){
512 if(result['return']){
513 for (int i=0;i<result['return'].size();i++) {
514 def entry = result['return'][i]
515 if (!entry) {
516 if (failOnError) {
517 throw new Exception("Salt API returned empty response: ${result}")
518 } else {
519 common.errorMsg("Salt API returned empty response: ${result}")
Jakub Josefece32af2017-03-14 19:20:08 +0100520 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100521 }
522 for (int j=0;j<entry.size();j++) {
523 def nodeKey = entry.keySet()[j]
524 def node=entry[nodeKey]
Jakub Josefa87941c2017-04-20 17:14:58 +0200525 def outputResources = []
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100526 common.infoMsg("Node ${nodeKey} changes:")
527 if(node instanceof Map || node instanceof List){
528 for (int k=0;k<node.size();k++) {
529 def resource;
530 def resKey;
531 if(node instanceof Map){
532 resKey = node.keySet()[k]
533 }else if(node instanceof List){
534 resKey = k
535 }
536 resource = node[resKey]
Jakub Josefc4c40202017-04-28 12:04:24 +0200537 // print
Jakub Josefa87941c2017-04-20 17:14:58 +0200538 if(printResults){
539 if(resource instanceof Map && resource.keySet().contains("result")){
540 //clean unnesaccary fields
541 if(resource.keySet().contains("__run_num__")){
542 resource.remove("__run_num__")
543 }
544 if(resource.keySet().contains("__id__")){
545 resource.remove("__id__")
546 }
547 if(resource.keySet().contains("pchanges")){
548 resource.remove("pchanges")
549 }
550 if(!resource["result"] || (resource["result"] instanceof String && resource["result"] != "true")){
551 if(resource["result"] != null){
Jakub Josefbceaa322017-06-13 18:28:27 +0200552 outputResources.add(String.format("Resource: %s\n\u001B[31m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200553 }else{
Jakub Josefbceaa322017-06-13 18:28:27 +0200554 outputResources.add(String.format("Resource: %s\n\u001B[33m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200555 }
556 }else{
557 if(!printOnlyChanges || resource.changes.size() > 0){
Jakub Josefbceaa322017-06-13 18:28:27 +0200558 outputResources.add(String.format("Resource: %s\n\u001B[32m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200559 }
560 }
561 }else{
Jakub Josefbceaa322017-06-13 18:28:27 +0200562 outputResources.add(String.format("Resource: %s\n\u001B[36m%s\u001B[0m", resKey, common.prettify(resource)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200563 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100564 }
Jakub Josefc4c40202017-04-28 12:04:24 +0200565 common.debugMsg("checkResult: checking resource: ${resource}")
566 if(resource instanceof String || (resource["result"] != null && !resource["result"]) || (resource["result"] instanceof String && resource["result"] == "false")){
Jakub Josefbceaa322017-06-13 18:28:27 +0200567 def prettyResource = common.prettify(resource)
Jakub Josefc4c40202017-04-28 12:04:24 +0200568 if(env["ASK_ON_ERROR"] && env["ASK_ON_ERROR"] == "true"){
569 timeout(time:1, unit:'HOURS') {
570 input message: "False result on ${nodeKey} found, resource ${prettyResource}. \nDo you want to continue?"
571 }
572 }else{
Jakub Josefd97d7db2017-05-11 19:11:53 +0200573 common.errorMsg(String.format("Resource: %s\n%s", resKey, prettyResource))
Jakub Josefd9001df2017-05-11 16:45:28 +0200574 def errorMsg = "Salt state on node ${nodeKey} failed: ${prettyResource}."
Jakub Josefc4c40202017-04-28 12:04:24 +0200575 if (failOnError) {
576 throw new Exception(errorMsg)
577 } else {
578 common.errorMsg(errorMsg)
579 }
580 }
581 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100582 }
Jakub Josefa87941c2017-04-20 17:14:58 +0200583 }else if(node!=null && node!=""){
Jakub Josef62f6c842017-08-04 16:36:35 +0200584 outputResources.add(String.format("Resource: %s\n\u001B[36m%s\u001B[0m", nodeKey, common.prettify(node)))
Jakub Josefa87941c2017-04-20 17:14:58 +0200585 }
586 if(printResults && !outputResources.isEmpty()){
Jakub Josefe6c562e2017-08-09 14:41:03 +0200587 print outputResources.stream().collect(Collectors.joining("\n"))
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100588 }
589 }
Jakub Josef52f69f72017-03-14 15:18:08 +0100590 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100591 }else{
592 common.errorMsg("Salt result hasn't return attribute! Result: ${result}")
Jakub Josef79ecec32017-02-17 14:36:28 +0100593 }
Jakub Josef52f69f72017-03-14 15:18:08 +0100594 }else{
Jakub Josefa87941c2017-04-20 17:14:58 +0200595 common.errorMsg("Cannot check salt result, given result is null")
Jakub Josef79ecec32017-02-17 14:36:28 +0100596 }
597}
598
599/**
Oleg Iurchenko7eb21502017-11-28 18:53:43 +0200600* Parse salt API output to check minion restart and wait some time to be sure minion is up.
601* See https://mirantis.jira.com/browse/PROD-16258 for more details
602* TODO: change sleep to more tricky procedure.
603*
604* @param result Parsed response of Salt API
605*/
606def waitForMinion(result) {
607 def common = new com.mirantis.mk.Common()
Oleg Iurchenko3eedc782017-12-12 11:49:29 +0200608 //In order to prevent multiple sleeps use bool variable to catch restart for any minion.
Oleg Iurchenko7eb21502017-11-28 18:53:43 +0200609 def isMinionRestarted = false
Oleg Iurchenko3eedc782017-12-12 11:49:29 +0200610 if(result != null){
611 if(result['return']){
612 for (int i=0;i<result['return'].size();i++) {
613 def entry = result['return'][i]
614 // exit in case of empty response.
615 if (!entry) {
616 return
617 }
618 // Loop for nodes
619 for (int j=0;j<entry.size();j++) {
620 def nodeKey = entry.keySet()[j]
621 def node=entry[nodeKey]
622 if(node instanceof Map || node instanceof List){
623 // Loop for node resources
624 for (int k=0;k<node.size();k++) {
625 def resource;
626 def resKey;
627 if(node instanceof Map){
628 resKey = node.keySet()[k]
629 }else if(node instanceof List){
630 resKey = k
631 }
632 resource = node[resKey]
633 if(resKey.contains("salt_minion_service_restart") && resource instanceof Map && resource.keySet().contains("result")){
634 if((resource["result"] instanceof Boolean && resource["result"]) || (resource["result"] instanceof String && resource["result"] == "true")){
635 if(resource.changes.size() > 0){
636 isMinionRestarted=true
637 }
638 }
639 }
640 }
641 }
642 }
643 }
Oleg Iurchenko7eb21502017-11-28 18:53:43 +0200644 }
645 }
Oleg Iurchenko7eb21502017-11-28 18:53:43 +0200646 if (isMinionRestarted){
647 common.infoMsg("Salt minion service restart detected. Sleep 10 seconds to wait minion restart")
648 sleep(10)
649 }
650}
651
652/**
Jakub Josef7852fe12017-03-15 16:02:41 +0100653 * Print salt command run results in human-friendly form
Jakub Josef79ecec32017-02-17 14:36:28 +0100654 *
655 * @param result Parsed response of Salt API
Jakub Josef79ecec32017-02-17 14:36:28 +0100656 */
Filip Pytlound2f1bbe2017-02-27 19:03:51 +0100657def printSaltCommandResult(result) {
Jakub Josef871bf152017-03-14 20:13:41 +0100658 def common = new com.mirantis.mk.Common()
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100659 if(result != null){
660 if(result['return']){
661 for (int i=0; i<result['return'].size(); i++) {
662 def entry = result['return'][i]
663 for (int j=0; j<entry.size(); j++) {
664 common.debugMsg("printSaltCommandResult: printing salt command entry: ${entry}")
665 def nodeKey = entry.keySet()[j]
666 def node=entry[nodeKey]
Jakub Josefbceaa322017-06-13 18:28:27 +0200667 common.infoMsg(String.format("Node %s changes:\n%s",nodeKey, common.prettify(node)))
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100668 }
Jakub Josef8a715bf2017-03-14 21:39:01 +0100669 }
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100670 }else{
671 common.errorMsg("Salt result hasn't return attribute! Result: ${result}")
Jakub Josef79ecec32017-02-17 14:36:28 +0100672 }
Jakub Josef8a715bf2017-03-14 21:39:01 +0100673 }else{
Jakub Josefd9afd0e2017-03-15 19:19:23 +0100674 common.errorMsg("Cannot print salt command result, given result is null")
Jakub Josef52f69f72017-03-14 15:18:08 +0100675 }
Jakub Josef79ecec32017-02-17 14:36:28 +0100676}
Tomáš Kukrálb12eedd2017-04-21 10:45:13 +0200677
678
679/**
680 * Return content of file target
681 *
chnydaa0dbb252017-10-05 10:46:09 +0200682 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Tomáš Kukrálb12eedd2017-04-21 10:45:13 +0200683 * @param target Compound target (should target only one host)
684 * @param file File path to read (/etc/hosts for example)
685 */
686
chnydaa0dbb252017-10-05 10:46:09 +0200687def getFileContent(saltId, target, file) {
688 result = cmdRun(saltId, target, "cat ${file}")
Tomáš Kukrálf1a692a2017-08-11 13:29:28 +0200689 return result['return'][0].values()[0].replaceAll('Salt command execution success','')
Tomáš Kukrálb12eedd2017-04-21 10:45:13 +0200690}
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300691
692/**
693 * Set override parameters in Salt cluster metadata
694 *
chnydaa0dbb252017-10-05 10:46:09 +0200695 * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method)
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300696 * @param salt_overrides YAML formatted string containing key: value, one per line
Matthew Mosesohne5646842017-07-19 16:54:57 +0300697 * @param reclass_dir Directory where Reclass git repo is located
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300698 */
699
chnydaa0dbb252017-10-05 10:46:09 +0200700def setSaltOverrides(saltId, salt_overrides, reclass_dir="/srv/salt/reclass") {
Tomáš Kukrálf178f052017-07-11 11:31:00 +0200701 def common = new com.mirantis.mk.Common()
Mykyta Karpin1c165e22017-08-22 18:27:01 +0300702 def salt_overrides_map = readYaml text: salt_overrides
Tomáš Kukrál243cf842017-07-11 13:11:56 +0200703 for (entry in common.entries(salt_overrides_map)) {
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300704 def key = entry[0]
705 def value = entry[1]
706
707 common.debugMsg("Set salt override ${key}=${value}")
Mykyta Karpind4a42d02017-11-16 16:24:37 +0200708 runSaltProcessStep(saltId, 'I@salt:master', 'reclass.cluster_meta_set', [key, value], false)
Matthew Mosesohn9e880852017-07-04 21:17:53 +0300709 }
chnydaa0dbb252017-10-05 10:46:09 +0200710 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 +0300711}
Oleg Grigorovbec45582017-09-12 20:29:24 +0300712
713/**
714* Execute salt commands via salt-api with
715* CLI client salt-pepper
716*
717* @param data Salt command map
718* @param venv Path to virtualenv with
719*/
720
721def runPepperCommand(data, venv) {
Jakub Josef03d4d5a2017-12-20 16:35:09 +0100722 def common = new com.mirantis.mk.Common()
Oleg Grigorovbec45582017-09-12 20:29:24 +0300723 def python = new com.mirantis.mk.Python()
724 def dataStr = new groovy.json.JsonBuilder(data).toString()
chnyda4901a042017-11-16 12:14:56 +0100725
Jakub Josef5e50e172017-12-20 17:18:23 +0100726 //def offlineDeployment = env.getEnvironment().containsKey("OFFLINE_DEPLOYMENT") && env["OFFLINE_DEPLOYMENT"].toBoolean()
727 def offlineDeployment = env.getEnvironment().containsKey("OFFLINE_DEPLOYMENT")
Jakub Josef804dd052017-11-29 18:59:05 +0100728 if(!offlineDeployment){
Jakub Josef03d4d5a2017-12-20 16:35:09 +0100729 //TODO: remove wget after global env prop enforcments
730 def netcheckResult = sh(script: "wget -q -T 10 --spider http://google.com", returnStatus: true)
731 offlineDeployment = netcheckResult != 0 && netcheckResult <= 5
Jakub Josef5e50e172017-12-20 17:18:23 +0100732 }else{
733 offlineDeployment = env["OFFLINE_DEPLOYMENT"].toBoolean()
chnydabcfff182017-11-29 10:24:36 +0100734 }
chnydabcfff182017-11-29 10:24:36 +0100735 def pepperCmd
736
737 if (!offlineDeployment) {
738 def pepperCmdFile = "${venv}/pepper-cmd.json"
739 writeFile file: pepperCmdFile, text: dataStr
740 pepperCmd = "pepper -c ${venv}/pepperrc --make-token -x ${venv}/.peppercache --json-file ${pepperCmdFile}"
741 } else {
Jakub Josef03d4d5a2017-12-20 16:35:09 +0100742 common.warningMsg("You might be offline, will use pepper with option --json instead of option --json-file, some complex commands like complicated cmd.runs may not work!")
Jakub Josef38ad6cc2017-11-29 23:13:42 +0100743 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 +0100744 }
Oleg Grigorovbec45582017-09-12 20:29:24 +0300745
746 if (venv) {
747 output = python.runVirtualenvCommand(venv, pepperCmd)
748 } else {
749 echo("[Command]: ${pepperCmd}")
750 output = sh (
751 script: pepperCmd,
752 returnStdout: true
753 ).trim()
754 }
755
756 return new groovy.json.JsonSlurperClassic().parseText(output)
757}