MCP pipeline library merged with ccp-pipeline-libs repo.
Change-Id: I74080e18c5a482b7bf44b5516228b7bfe1fe3586
diff --git a/src/com/mirantis/mk/Common.groovy b/src/com/mirantis/mk/Common.groovy
new file mode 100644
index 0000000..02fcada
--- /dev/null
+++ b/src/com/mirantis/mk/Common.groovy
@@ -0,0 +1,483 @@
+package com.mirantis.mk
+
+/**
+ *
+ * Common functions
+ *
+ */
+
+/**
+ * Generate current timestamp
+ *
+ * @param format Defaults to yyyyMMddHHmmss
+ */
+def getDatetime(format="yyyyMMddHHmmss") {
+ def now = new Date();
+ return now.format(format, TimeZone.getTimeZone('UTC'));
+}
+
+/**
+ * Parse HEAD of current directory and return commit hash
+ */
+def getGitCommit() {
+ git_commit = sh (
+ script: 'git rev-parse HEAD',
+ returnStdout: true
+ ).trim()
+ return git_commit
+}
+
+/**
+ * Return workspace.
+ * Currently implemented by calling pwd so it won't return relevant result in
+ * dir context
+ */
+def getWorkspace() {
+ def workspace = sh script: 'pwd', returnStdout: true
+ workspace = workspace.trim()
+ return workspace
+}
+
+/**
+ * Get credentials from store
+ *
+ * @param id Credentials name
+ */
+def getCredentials(id) {
+ def creds = com.cloudbees.plugins.credentials.CredentialsProvider.lookupCredentials(
+ com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials.class,
+ jenkins.model.Jenkins.instance
+ )
+
+ for (Iterator<String> credsIter = creds.iterator(); credsIter.hasNext();) {
+ c = credsIter.next();
+ if ( c.id == id ) {
+ return c;
+ }
+ }
+
+ throw new Exception("Could not find credentials for ID ${id}")
+}
+
+/**
+ * Abort build, wait for some time and ensure we will terminate
+ */
+def abortBuild() {
+ currentBuild.build().doStop()
+ sleep(180)
+ // just to be sure we will terminate
+ throw new InterruptedException()
+}
+
+/**
+ * Print informational message
+ *
+ * @param msg
+ * @param color Colorful output or not
+ */
+def infoMsg(msg, color = true) {
+ printMsg(msg, "cyan")
+}
+
+/**
+ * Print error message
+ *
+ * @param msg
+ * @param color Colorful output or not
+ */
+def errorMsg(msg, color = true) {
+ printMsg(msg, "red")
+}
+
+/**
+ * Print success message
+ *
+ * @param msg
+ * @param color Colorful output or not
+ */
+def successMsg(msg, color = true) {
+ printMsg(msg, "green")
+}
+
+/**
+ * Print warning message
+ *
+ * @param msg
+ * @param color Colorful output or not
+ */
+def warningMsg(msg, color = true) {
+ printMsg(msg, "blue")
+}
+
+/**
+ * Print message
+ *
+ * @param msg Message to be printed
+ * @param level Level of message (default INFO)
+ * @param color Color to use for output or false (default)
+ */
+def printMsg(msg, color = false) {
+ colors = [
+ 'red' : '\u001B[31m',
+ 'black' : '\u001B[30m',
+ 'green' : '\u001B[32m',
+ 'yellow': '\u001B[33m',
+ 'blue' : '\u001B[34m',
+ 'purple': '\u001B[35m',
+ 'cyan' : '\u001B[36m',
+ 'white' : '\u001B[37m',
+ 'reset' : '\u001B[0m'
+ ]
+ if (color != false) {
+ wrap([$class: 'AnsiColorBuildWrapper']) {
+ print "${colors[color]}${msg}${colors.reset}"
+ }
+ } else {
+ print "[${level}] ${msg}"
+ }
+}
+
+/**
+ * Traverse directory structure and return list of files
+ *
+ * @param path Path to search
+ * @param type Type of files to search (groovy.io.FileType.FILES)
+ */
+@NonCPS
+def getFiles(path, type=groovy.io.FileType.FILES) {
+ files = []
+ new File(path).eachFile(type) {
+ files[] = it
+ }
+ return files
+}
+
+/**
+ * Helper method to convert map into form of list of [key,value] to avoid
+ * unserializable exceptions
+ *
+ * @param m Map
+ */
+@NonCPS
+def entries(m) {
+ m.collect {k, v -> [k, v]}
+}
+
+/**
+ * Opposite of build-in parallel, run map of steps in serial
+ *
+ * @param steps Map of String<name>: CPSClosure2<step>
+ */
+def serial(steps) {
+ stepsArray = entries(steps)
+ for (i=0; i < stepsArray.size; i++) {
+ s = stepsArray[i]
+ dummySteps = ["${s[0]}": s[1]]
+ parallel dummySteps
+ }
+}
+
+/**
+ * Get password credentials from store
+ *
+ * @param id Credentials name
+ */
+def getPasswordCredentials(id) {
+ def creds = com.cloudbees.plugins.credentials.CredentialsProvider.lookupCredentials(
+ com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials.class,
+ jenkins.model.Jenkins.instance
+ )
+
+ for (Iterator<String> credsIter = creds.iterator(); credsIter.hasNext();) {
+ c = credsIter.next();
+ if ( c.id == id ) {
+ return c;
+ }
+ }
+
+ throw new Exception("Could not find credentials for ID ${id}")
+}
+
+/**
+ * Get SSH credentials from store
+ *
+ * @param id Credentials name
+ */
+def getSshCredentials(id) {
+ def creds = com.cloudbees.plugins.credentials.CredentialsProvider.lookupCredentials(
+ com.cloudbees.plugins.credentials.common.StandardUsernameCredentials.class,
+ jenkins.model.Jenkins.instance
+ )
+
+ for (Iterator<String> credsIter = creds.iterator(); credsIter.hasNext();) {
+ c = credsIter.next();
+ if ( c.id == id ) {
+ return c;
+ }
+ }
+
+ throw new Exception("Could not find credentials for ID ${id}")
+}
+/**
+ * Setup ssh agent and add private key
+ *
+ * @param credentialsId Jenkins credentials name to lookup private key
+ */
+def prepareSshAgentKey(credentialsId) {
+ c = getSshCredentials(credentialsId)
+ sh("test -d ~/.ssh || mkdir -m 700 ~/.ssh")
+ sh('pgrep -l -u $USER -f | grep -e ssh-agent\$ >/dev/null || ssh-agent|grep -v "Agent pid" > ~/.ssh/ssh-agent.sh')
+ sh("set +x; echo '${c.getPrivateKey()}' > ~/.ssh/id_rsa_${credentialsId} && chmod 600 ~/.ssh/id_rsa_${credentialsId}; set -x")
+ agentSh("ssh-add ~/.ssh/id_rsa_${credentialsId}")
+}
+
+/**
+ * Execute command with ssh-agent
+ *
+ * @param cmd Command to execute
+ */
+def agentSh(cmd) {
+ sh(". ~/.ssh/ssh-agent.sh && ${cmd}")
+}
+
+/**
+ * Ensure entry in SSH known hosts
+ *
+ * @param url url of remote host
+ */
+def ensureKnownHosts(url) {
+ def hostArray = getKnownHost(url)
+ sh "test -f ~/.ssh/known_hosts && grep ${hostArray[0]} ~/.ssh/known_hosts || ssh-keyscan -p ${hostArray[1]} ${hostArray[0]} >> ~/.ssh/known_hosts"
+}
+
+@NonCPS
+def getKnownHost(url){
+ // test for git@github.com:organization/repository like URLs
+ def p = ~/.+@(.+\..+)\:{1}.*/
+ def result = p.matcher(url)
+ def host = ""
+ if (result.matches()) {
+ host = result.group(1)
+ port = 22
+ } else {
+ parsed = new URI(url)
+ host = parsed.host
+ port = parsed.port && parsed.port > 0 ? parsed.port: 22
+ }
+ return [host,port]
+}
+
+/**
+ * Mirror git repository, merge target changes (downstream) on top of source
+ * (upstream) and push target or both if pushSource is true
+ *
+ * @param sourceUrl Source git repository
+ * @param targetUrl Target git repository
+ * @param credentialsId Credentials id to use for accessing source/target
+ * repositories
+ * @param branches List or comma-separated string of branches to sync
+ * @param followTags Mirror tags
+ * @param pushSource Push back into source branch, resulting in 2-way sync
+ * @param pushSourceTags Push target tags into source or skip pushing tags
+ * @param gitEmail Email for creation of merge commits
+ * @param gitName Name for creation of merge commits
+ */
+def mirrorGit(sourceUrl, targetUrl, credentialsId, branches, followTags = false, pushSource = false, pushSourceTags = false, gitEmail = 'jenkins@localhost', gitName = 'Jenkins') {
+ if (branches instanceof String) {
+ branches = branches.tokenize(',')
+ }
+
+ prepareSshAgentKey(credentialsId)
+ ensureKnownHosts(targetUrl)
+ sh "git config user.email '${gitEmail}'"
+ sh "git config user.name '${gitName}'"
+
+ sh "git remote | grep target || git remote add target ${TARGET_URL}"
+ agentSh "git remote update --prune"
+
+ for (i=0; i < branches.size; i++) {
+ branch = branches[i]
+ sh "git branch | grep ${branch} || git checkout -b ${branch} origin/${branch}"
+ sh "git branch | grep ${branch} && git checkout ${branch} && git reset --hard origin/${branch}"
+
+ sh "git ls-tree target/${branch} && git merge --no-edit --ff target/${branch} || echo 'Target repository is empty, skipping merge'"
+ followTagsArg = followTags ? "--follow-tags" : ""
+ agentSh "git push ${followTagsArg} target HEAD:${branch}"
+
+ if (pushSource == true) {
+ followTagsArg = followTags && pushSourceTags ? "--follow-tags" : ""
+ agentSh "git push ${followTagsArg} origin HEAD:${branch}"
+ }
+ }
+
+ if (followTags == true) {
+ agentSh "git push target --tags"
+
+ if (pushSourceTags == true) {
+ agentSh "git push origin --tags"
+ }
+ }
+}
+
+/**
+ * Tests Jenkins instance for existence of plugin with given name
+ * @param pluginName plugin short name to test
+ * @return boolean result
+ */
+@NonCPS
+def jenkinsHasPlugin(pluginName){
+ return Jenkins.instance.pluginManager.plugins.collect{p -> p.shortName}.contains(pluginName)
+}
+
+@NonCPS
+def _needNotification(notificatedTypes, buildStatus, jobName) {
+ if(notificatedTypes && notificatedTypes.contains("onchange")){
+ if(jobName){
+ def job = Jenkins.instance.getItem(jobName)
+ def numbuilds = job.builds.size()
+ if (numbuilds > 0){
+ //actual build is first for some reasons, so last finished build is second
+ def lastBuild = job.builds[1]
+ if(lastBuild){
+ if(lastBuild.result.toString().toLowerCase().equals(buildStatus)){
+ println("Build status didn't changed since last build, not sending notifications")
+ return false;
+ }
+ }
+ }
+ }
+ }else if(!notificatedTypes.contains(buildStatus)){
+ return false;
+ }
+ return true;
+}
+
+/**
+ * Send notification to all enabled notifications services
+ * @param buildStatus message type (success, warning, error), null means SUCCESSFUL
+ * @param msgText message text
+ * @param enabledNotifications list of enabled notification types, types: slack, hipchat, email, default empty
+ * @param notificatedTypes types of notifications will be sent, default onchange - notificate if current build result not equal last result;
+ * otherwise use - ["success","unstable","failed"]
+ * @param jobName optional job name param, if empty env.JOB_NAME will be used
+ * @param buildNumber build number param, if empty env.JOB_NAME will be used
+ * @param buildUrl build url param, if empty env.JOB_NAME will be used
+ * @param mailFrom mail FROM param, if empty "jenkins" will be used, it's mandatory for sending email notifications
+ * @param mailTo mail TO param, it's mandatory for sending email notifications
+ */
+def sendNotification(buildStatus, msgText="", enabledNotifications = [], notificatedTypes=["onchange"], jobName=null, buildNumber=null, buildUrl=null, mailFrom="jenkins", mailTo=null){
+ // Default values
+ def colorName = 'blue'
+ def colorCode = '#0000FF'
+ def buildStatusParam = buildStatus != null && buildStatus != "" ? buildStatus : "SUCCESS"
+ def jobNameParam = jobName != null && jobName != "" ? jobName : env.JOB_NAME
+ def buildNumberParam = buildNumber != null && buildNumber != "" ? buildNumber : env.BUILD_NUMBER
+ def buildUrlParam = buildUrl != null && buildUrl != "" ? buildUrl : env.BUILD_URL
+ def subject = "${buildStatusParam}: Job '${jobNameParam} [${buildNumberParam}]'"
+ def summary = "${subject} (${buildUrlParam})"
+
+ if(msgText != null && msgText != ""){
+ summary+="\n${msgText}"
+ }
+ if(buildStatusParam.toLowerCase().equals("success")){
+ colorCode = "#00FF00"
+ colorName = "green"
+ }else if(buildStatusParam.toLowerCase().equals("unstable")){
+ colorCode = "#FFFF00"
+ colorName = "yellow"
+ }else if(buildStatusParam.toLowerCase().equals("failure")){
+ colorCode = "#FF0000"
+ colorName = "red"
+ }
+ if(_needNotification(notificatedTypes, buildStatusParam.toLowerCase(), jobNameParam)){
+ if(enabledNotifications.contains("slack") && jenkinsHasPlugin("slack")){
+ try{
+ slackSend color: colorCode, message: summary
+ }catch(Exception e){
+ println("Calling slack plugin failed")
+ e.printStackTrace()
+ }
+ }
+ if(enabledNotifications.contains("hipchat") && jenkinsHasPlugin("hipchat")){
+ try{
+ hipchatSend color: colorName.toUpperCase(), message: summary
+ }catch(Exception e){
+ println("Calling hipchat plugin failed")
+ e.printStackTrace()
+ }
+ }
+ if(enabledNotifications.contains("email") && mailTo != null && mailTo != "" && mailFrom != null && mailFrom != ""){
+ try{
+ mail body: summary, from: mailFrom, subject: subject, to: mailTo
+ }catch(Exception e){
+ println("Sending mail plugin failed")
+ e.printStackTrace()
+ }
+ }
+ }
+}
+
+/**
+ * Execute git clone and checkout stage from gerrit review
+ *
+ * @param config LinkedHashMap
+ * config includes next parameters:
+ * - credentialsId, id of user which should make checkout
+ * - withMerge, prevent detached mode in repo
+ * - withWipeOut, wipe repository and force clone
+ *
+ * Usage example:
+ * //anonymous gerrit checkout
+ * def gitFunc = new com.mirantis.mcp.Git()
+ * gitFunc.gerritPatchsetCheckout([
+ * withMerge : true
+ * ])
+ *
+ * def gitFunc = new com.mirantis.mcp.Git()
+ * gitFunc.gerritPatchsetCheckout([
+ * credentialsId : 'mcp-ci-gerrit',
+ * withMerge : true
+ * ])
+ */
+def gerritPatchsetCheckout(LinkedHashMap config) {
+ def merge = config.get('withMerge', false)
+ def wipe = config.get('withWipeOut', false)
+ def credentials = config.get('credentialsId','')
+
+ // default parameters
+ def scmExtensions = [
+ [$class: 'CleanCheckout'],
+ [$class: 'BuildChooserSetting', buildChooser: [$class: 'GerritTriggerBuildChooser']]
+ ]
+ def scmUserRemoteConfigs = [
+ name: 'gerrit',
+ refspec: "${GERRIT_REFSPEC}"
+ ]
+
+ if (credentials == '') {
+ // then try to checkout in anonymous mode
+ scmUserRemoteConfigs.put('url',"https://${GERRIT_HOST}/${GERRIT_PROJECT}")
+ } else {
+ // else use ssh checkout
+ scmUserRemoteConfigs.put('url',"ssh://${GERRIT_NAME}@${GERRIT_HOST}:${GERRIT_PORT}/${GERRIT_PROJECT}.git")
+ scmUserRemoteConfigs.put('credentialsId',credentials)
+ }
+
+ // if we need to "merge" code from patchset to GERRIT_BRANCH branch
+ if (merge) {
+ scmExtensions.add([$class: 'LocalBranch', localBranch: "${GERRIT_BRANCH}"])
+ }
+ // we need wipe workspace before checkout
+ if (wipe) {
+ scmExtensions.add([$class: 'WipeWorkspace'])
+ }
+
+ checkout(
+ scm: [
+ $class: 'GitSCM',
+ branches: [[name: "${GERRIT_BRANCH}"]],
+ extensions: scmExtensions,
+ userRemoteConfigs: [scmUserRemoteConfigs]
+ ]
+ )
+}