Jenkinsfile-develop

#!/usr/bin/env groovy

import bcgov.GitHubHelper
import groovy.json.JsonOutput
import groovy.json.JsonSlurper
import java.util.regex.Pattern

/*
 * Sends a rocket chat notification
 */
def notifyRocketChat(text, target) {
  def message = text.replaceAll(~/\'/, "")
  def payload = JsonOutput.toJson([
    "username":"Jenkins",
    "icon_url":"https://wiki.jenkins.io/download/attachments/2916393/headshot.png",
    "text": message
  ])
  try {
    def rocketChatURL;
  if (target == 'deploy') {
    rocketChatURL = ROCKET_DEPLOY_WEBHOOK
  } else if (target == 'qa') {
    rocketChatURL = ROCKET_QA_WEBHOOK
  }
    sh("curl -X POST -H 'Content-Type: application/json' --data \'${payload}\' ${rocketChatURL}")
  } catch (error) {
    echo "Error posting Rocket Chat message: ${error}"
  }
}

// Create deployment status and pass to Jenkins-GitHub library
void createDeploymentStatus (String suffix, String status) {
  try {
    def ghDeploymentId = new GitHubHelper().createDeployment(
      this,
      "pull/${env.CHANGE_ID}/head",
      [
          'environment':"${suffix}",
          'task':"deploy:pull:${env.CHANGE_ID}"
      ]
    )

    new GitHubHelper().createDeploymentStatus(
      this,
      ghDeploymentId,
      "${status}",
      ['targetUrl':"https://eagle-${PR_NAME}-dev.${OCPHOST}/"]
    )

    if ('SUCCESS'.equalsIgnoreCase("${status}")) {
      echo "${suffix} deployment successful!"
    } else if ('PENDING'.equalsIgnoreCase("${status}")){
      echo "${suffix} deployment pending."
    }
  } catch (error) {
    echo "Unable to update Github deployment status: ${error}"
  }
}

// Print stack trace of error
@NonCPS
private static String stackTraceAsString(Throwable t) {
    StringWriter sw = new StringWriter();
    t.printStackTrace(new PrintWriter(sw));
    return sw.toString()
}

def _openshift(String name, String project, Closure body) {
  script {
    openshift.withCluster() {
      openshift.withProject(project) {
        echo "Running Stage '${name}'"
        waitUntil {
          boolean isDone=false
          try {
            body()
            isDone=true
            echo "Completed Stage '${name}'"
          } catch (error) {
            echo "${stackTraceAsString(error)}"
            def inputAction = input(
              message: "This step (${name}) has failed. See related messages:",
              ok: 'Confirm',
              parameters: [
                choice(
                  name: 'action',
                  choices: 'Re-run\nIgnore',
                  description: 'What would you like to do?'
                )
              ]
            )

            if ('Ignore'.equalsIgnoreCase(inputAction)) {
              notifyRocketChat(
                "@all The build ${env.BUILD_DISPLAY_NAME} of eagle-api-pr, seems to be broken.\n ${env.RUN_DISPLAY_URL}\n Error: \n ${error.message}",
                'deploy'
              )
              isDone=true
            }
          }
          return isDone
        }
      }
    }
  }
}

/*
 * Updates the global pastBuilds array: it will iterate recursively
 * and add all the builds prior to the current one that had a result
 * different than 'SUCCESS'.
 */
def buildsSinceLastSuccess(previousBuild, build) {
  if ((build != null) && (build.result != 'SUCCESS')) {
    pastBuilds.add(build)
    buildsSinceLastSuccess(pastBuilds, build.getPreviousBuild())
  }
}

/*
 * Generates a string containing all the commit messages from
 * the builds in pastBuilds.
 */
@NonCPS
def getChangeLog(pastBuilds) {
  def log = ""
  for (int x = 0; x < pastBuilds.size(); x++) {
    for (int i = 0; i < pastBuilds[x].changeSets.size(); i++) {
      def entries = pastBuilds[x].changeSets[i].items
      for (int j = 0; j < entries.length; j++) {
        def entry = entries[j]
        log += "* ${entry.msg} by ${entry.author} \n"
      }
    }
  }
  return log;
}

def checkForPRDeployment() {
  def dcCount = 999;
  _openshift(env.STAGE_NAME, TOOLSPROJECT) {
    try {
      dcCount = openshift.selector('bc', "${PR_NAME}-eagle-api").count()
    } catch (error) {
      echo "${stackTraceAsString(error)}"
      dcCount = 0
    }
    echo "count: ${dcCount}"
  }
  if (dcCount == 0) {
    echo "no deployments, return false"
    return false
  } else {
    return true
  }
}

def createFullPRDeployment() {
  openshift.withCluster() {
    echo "Configuring deployment scripts"
    try {
      sh '''
        if [ -d "eagle-helper-pods" ]
        then
          echo "stale helper pods checkout, removing it"
          rm -rf eagle-helper-pods
        fi
        git clone https://github.com/bcgov/eagle-helper-pods
        cd eagle-helper-pods/openshift/setup-teardown/

          # set project to PR deployment template folder
        find . -name "projectset.config" -exec sed -i -e "s/^\\( *TARGET_PROJECT_SET=*\\)[^ ]*\\(.*\\)*$/\\1${PROJECTSET}\\2/" {} \\;

          # set unique name (ie. pr-branchName) for pr builds & deployments
        cd params/CUSTOM_SETTINGS/${PROJECTSET}
        find . -name "*.config" -exec sed -i -e "s/pr-placeholder/${PR_NAME}/g" {} \\;
         # set api vars to pr fork
        cd api
        find . -name "*.config" -exec sed -i -e "s/branch-placeholder/${CHANGE_BRANCH}/g" {} \\;
        find . -name "*.config" -exec sed -i -e "s/fork-placeholder/${PR_FORK}/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/fork-placeholder/${PR_FORK}/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/pr-placeholder/${PR_NAME}/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/branch-placeholder/${CHANGE_BRANCH}/g" {} \\;

          # set api, admin to bcgov/develop
        cd ../public
        find . -name "*.config" -exec sed -i -e "s/branch-placeholder/develop/g" {} \\;
        find . -name "*.config" -exec sed -i -e "s/fork-placeholder/bcgov/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/fork-placeholder/bcgov/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/pr-placeholder/${PR_NAME}/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/branch-placeholder/develop/g" {} \\;

        cd ../admin
        find . -name "*.config" -exec sed -i -e "s/branch-placeholder/develop/g" {} \\;
        find . -name "*.config" -exec sed -i -e "s/fork-placeholder/bcgov/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/fork-placeholder/bcgov/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/pr-placeholder/${PR_NAME}/g" {} \\;
        find . -name "*.params" -exec sed -i -e "s/branch-placeholder/develop/g" {} \\;

        # create builds and deploys
        cd ../../../..
        ./setup-all.sh
        # switch back to tools project,
        oc project ${TOOLSPROJECT}
      '''
      echo "deployment scripts configured and PR env created"
    } catch (error) {
      notifyRocketChat(
        "@all The build ${env.BUILD_DISPLAY_NAME} of eagle-api dev-pr, seems to be broken.\n ${env.RUN_DISPLAY_URL}\n Error: \n ${error.message}",
        'deploy'
      )
      currentBuild.result = 'FAILURE'
      throw new Exception("Full PR env deployment failed")
    }
  }
}

def cleanUpPR() {
  openshift.withCluster() {
    echo "Configuring deployment scripts for teardown"
    try {
      sh '''
        if [ -d "eagle-helper-pods" ]
        then
          echo "stale helper pods checkout, removing it"
          rm -rf eagle-helper-pods
        fi
        git clone https://github.com/bcgov/eagle-helper-pods
        cd eagle-helper-pods/openshift/setup-teardown/

            # set project to PR deployment template folder
        find . -name "projectset.config" -exec sed -i -e "s/^\\( *TARGET_PROJECT_SET=*\\)[^ ]*\\(.*\\)*$/\\1${PROJECTSET}\\2/" {} \\;

            # set to unique name (ie. branchName-appName) for pr builds & deployments
        cd params/CUSTOM_SETTINGS/${PROJECTSET}
        find . -name "*.params" -exec sed -i -e "s/pr-placeholder/${PR_NAME}/g" {} \\;
        find . -name "*.config" -exec sed -i -e "s/pr-placeholder/${PR_NAME}/g" {} \\;

        cd ../../../
        ./teardown-all.sh

            # switch back to tools project,
        oc project ${TOOLSPROJECT}
      '''
      echo "Template scripts configured and PR env removed"
    } catch (error) {
      notifyRocketChat(
       "@all The cleanup ${env.BUILD_DISPLAY_NAME} of eagle ${PR_NAME} deployment may have failed.\n ${env.RUN_DISPLAY_URL}\n Error: \n ${error.message}",
       'deploy'
      )
      throw new Exception("Full PR env teardown failed: ${error}")
    }
  }
}

def cleanUpLock(lockName) {
  def manager = org.jenkins.plugins.lockableresources.LockableResourcesManager.get()
  def resources = manager.getResources().findAll{
    !it.locked && it.name.equalsIgnoreCase(lockName)
  }
  resources.each{
    manager.getResources().remove(it)
    echo "Removing lock: ${lockName}"
  }
  manager.save()
}

def CHANGELOG = "No new changes"
def IMAGE_HASH = "latest"
def BUILD_DONE_STATUSES = ['Complete', 'Failed', 'Cancelled']
def lockName = "eagle-api-${env.JOB_NAME}-${env.BUILD_NUMBER}"
pipeline {
  environment {
    TOOLSPROJECT = "${TOOLS_NAMESPACE ?: '6cdc9e-tools'}"
    DEVPROJECT = "${DEV_NAMESPACE ?: '6cdc9e-dev'}"
    PROJECTSET = "${PR_SET ?: 'OCP4_PR'}"
    OCPHOST = "${OCP_HOST ?: 'apps.silver.devops.gov.bc.ca'}"
    PR_NAME = "${env.CHANGE_BRANCH}".toLowerCase()
    PR_FORK = "${env.CHANGE_FORK}"
  }
  agent any
  stages {
    stage('Build Init') {
      when {
        expression {
          env.PR_NAME != 'develop' || env.PR_NAME != 'test'
        }
      }
      steps {
        script {
          openshift.setLockName(lockName)
           // setup vars for keycloak client access
          try{
            sh("oc extract secret/pr-kc-secret --to=${env.WORKSPACE} --confirm")
            KC_CLIENT_ID = sh(returnStdout: true, script: 'cat CLIENT_SSO_CLIENTID')
            KC_CLIENT_SECRET = sh(returnStdout: true, script: 'cat CLIENT_SSO_SECRET')
            CLIENT_PUBLIC = sh(returnStdout: true, script: 'cat CLIENT_PUBLIC')
            KC_REALM_ID = sh(returnStdout: true, script: 'cat KC_REALM')
            SSO_HOST = sh(returnStdout: true, script: 'cat KC_HOST')
            APP_HOST="eagle-${PR_NAME}-dev.${OCPHOST}"
          } catch (error) {
            echo "Error retrieving keycloak parameters, message: ${error}"
          }
          sh "npm i axios@^0.19.2 lodash@^4.17.19"
        }
      }
    }

    stage("Add URI to KC"){
      when {
        expression {
          env.PR_NAME != 'develop' || env.PR_NAME != 'test'
        }
      }
      steps {
        script {
          try {
            sh '''
              curl -L -O https://raw.githubusercontent.com/bcgov/eagle-helper-pods/master/openshift/jenkins/scripts/keycloak.js
              curl -L -O https://raw.githubusercontent.com/bcgov/eagle-helper-pods/master/openshift/jenkins/scripts/addURI.js
              curl -L -O https://raw.githubusercontent.com/bcgov/eagle-helper-pods/master/openshift/jenkins/scripts/removeURI.js
              chmod +x addURI.js removeURI.js
            '''
          } catch (error) {
            echo "Error retrieving keycloak util: ${error}"
          }

          //set env vars for stage
          env.KC_CLIENT_ID="${KC_CLIENT_ID}"
          env.KC_CLIENT_SECRET="${KC_CLIENT_SECRET}"
          env.APP_CLIENT_ID="${CLIENT_PUBLIC}"
          env.KC_REALM_ID="${KC_REALM_ID}"
          env.SSO_HOST="${SSO_HOST}"
          env.APP_HOST="${APP_HOST}"

          sh "node addURI.js"
        }
      }
    }

    stage('Setup PR env') {
      when {
        expression {
          env.PR_NAME != 'develop' || env.PR_NAME != 'test'
        }
      }
      steps {
        script {
          try {
            sh("oc extract secret/rocket-chat-secrets --to=${env.WORKSPACE} --confirm")
          } catch (error) {
            echo "Error retrieving Rocket Chat token"
          }
          
          createDeploymentStatus('dev', "PENDING")
          
          echo "Branch to build: ${PR_NAME}"
          echo "Source fork: ${PR_FORK}"
          if (!checkForPRDeployment()) {
            // env hasn't been created, call setup scripts
            echo "Deploying PR Environment"
            createFullPRDeployment()
          } else {
            echo "Deployment for this PR already exists, skipping deploy all"
            // modify bc to point at proper fork-branch, then continue to build step
            _openshift(env.STAGE_NAME, TOOLSPROJECT) {
              openshift.patch(
                "bc/${PR_NAME}-eagle-api",
                '\'{"spec":{"source":{"git":{"ref": "${CHANGE_BRANCH}", "uri": "https://github.com/${PR_FORK}/eagle-api"}}}}\''
              )
            }
          }
        }
      }
    }

    stage('Build') {
      when {
        expression {
          env.PR_NAME != 'develop' || env.PR_NAME != 'test'
        }
      }
      agent any
      steps {
        milestone 1
        script {
          pastBuilds = []
          buildsSinceLastSuccess(pastBuilds, currentBuild);
          CHANGELOG = getChangeLog(pastBuilds);

          echo ">>>>>>Changelog: \n ${CHANGELOG}"
          _openshift(env.STAGE_NAME, TOOLSPROJECT) {
            timeout(10) {
              try {
                sh("oc extract secret/rocket-chat-secrets --to=${env.WORKSPACE} --confirm")
                ROCKET_DEPLOY_WEBHOOK = sh(returnStdout: true, script: 'cat rocket-deploy-webhook')
                ROCKET_QA_WEBHOOK = sh(returnStdout: true, script: 'cat rocket-qa-webhook')
              } catch (error) {
                echo "Error retrieving Rocket Chat token"
              }

              echo "Building eagle-api ${PR_NAME} branch"
              // trigger and wait for s2i build to complete
              def bcObj1 = openshift.selector('bc', "${PR_NAME}-eagle-api")
              bcObj1.startBuild()
              def buildName = "${PR_NAME}-eagle-api-${bcObj1.object().status.lastVersion}"
              echo "API build name: ${buildName}"
              def buildSelector1 = openshift.selector('build', buildName)
              buildSelector1.untilEach(1) {
                def phase = it.object().status.phase
                if (phase == 'Failed') {
                  currentBuild.result = "FAILURE"
                }
                return ( BUILD_DONE_STATUSES.contains(phase) )
              }

              echo "Build done"

              echo ">>> Get Image Hash"
              // Don't tag with BUILD_ID so the pruner can do it's job; it won't delete tagged images.
              // Tag the images for deployment based on the image's hash
              IMAGE_HASH = sh (
                script: """oc get istag ${PR_NAME}-eagle-api:latest -o template --template=\"{{.image.dockerImageReference}}\"|awk -F \":\" \'{print \$3}\'""",
                returnStdout: true).trim()
              echo ">> IMAGE_HASH: ${IMAGE_HASH}"
            }
          }
        }
      }
    }

    stage('Deploy'){
      when {
        expression {
          env.PR_NAME != 'develop' || env.PR_NAME != 'test'
        }
      }
      agent any
      steps {
        script {
          try {
            openshift.withCluster() {
              openshift.withProject(TOOLSPROJECT) {
                echo "Deploying to dev env..."
                openshift.tag("${TOOLSPROJECT}/${PR_NAME}-eagle-api:latest", "${TOOLSPROJECT}/${PR_NAME}-eagle-api:${PR_NAME}")
                echo "Tagged ${TOOLSPROJECT}/${PR_NAME}-eagle-api:latest as ${TOOLSPROJECT}/${PR_NAME}-eagle-api:${PR_NAME}"
              }

              openshift.withProject(DEVPROJECT) {
                def dcObj = openshift.selector('dc', "${PR_NAME}-eagle-api")
                dcObj.rollout().status()
                echo ">>>> Deployment Complete"
                
                createDeploymentStatus('dev', "SUCCESS")

                notifyRocketChat(
                  "A new version of eagle-api ${PR_NAME} is now in Dev, build: ${env.BUILD_DISPLAY_NAME} \n  https://eagle-${PR_NAME}-dev.${OCPHOST}/ \nChanges: \n ${CHANGELOG}",
                  'deploy'
                )
                notifyRocketChat(
                  "@all A new version of eagle-api is now in Dev and ready for QA. \n  https://eagle-${PR_NAME}-dev.${OCPHOST}/ \nChanges to Dev: \n ${CHANGELOG}",
                  'qa'
                )
              }

              // must be done before cleanup or PR imagestream won't exist
              openshift.withProject(TOOLSPROJECT) {
                echo "Deploying to dev env..."
                openshift.tag("${TOOLSPROJECT}/${PR_NAME}-eagle-api:latest", "${TOOLSPROJECT}/eagle-api:latest")
                echo "Tagged ${TOOLSPROJECT}/${PR_NAME}-eagle-api:latest as ${TOOLSPROJECT}/eagle-api:latest"
              }
            }
          } catch (error) {
            notifyRocketChat(
              "@all The build ${env.BUILD_DISPLAY_NAME} of eagle-api, seems to be broken.\n ${env.RUN_DISPLAY_URL}\n Error: \n ${error.message}",
              'deploy'
            )
            currentBuild.result = "FAILURE"
            throw new Exception("Deploy failed")
          }
        }
      }
    }

    stage("Populate Data"){
      when {
        expression {
          env.PR_NAME != 'develop' || env.PR_NAME != 'test'
        }
      }
      steps {
        script {
          try {
            openshift.withCluster() {
              openshift.withProject(DEVPROJECT) {
                echo "Running data generators"
                /* Get the Deployment Config (DC) Object */
                def dcObj = openshift.selector("dc", "${PR_NAME}-eagle-api-generator").object()

                /* Use the DC to find the pods */
                def podSelector = openshift.selector("pod", [deployment: "${PR_NAME}-eagle-api-generator-${dcObj.status.latestVersion}"])

                podSelector.withEach {
                    // obtain the pod name and remove "pods/" from the front.
                    def podName = it.name()
                    podName = podName.replaceFirst("pod/", "")
                    // todo add pod ready check
                    // Run a command in the container
                    openshift.exec("-n", "${DEVPROJECT}", podName, "scl", "enable", "rh-nodejs10", '"/opt/app-root/src/generate.sh 20 Static Saved Single"')
                }
              }
            }
          } catch (error) {
            notifyRocketChat(
              "@all Data generation failed for the build ${env.BUILD_DISPLAY_NAME} of eagle-api.\n ${env.RUN_DISPLAY_URL}\n Error: \n ${error.message}",
              'deploy'
            )
            currentBuild.result = "FAILURE"
            throw new Exception("Data generation failed")
          }
        }
      }
    }

    stage('Cleanup') {
      when {
        expression {
          env.PR_NAME != 'develop' || env.PR_NAME != 'test'
        }
      }
      steps {
        milestone 2
        script {
          // set kc client env vars for stage
          env.KC_CLIENT_ID="${KC_CLIENT_ID}"
          env.KC_CLIENT_SECRET="${KC_CLIENT_SECRET}"
          env.APP_CLIENT_ID="${CLIENT_PUBLIC}"
          env.KC_REALM_ID="${KC_REALM_ID}"
          env.SSO_HOST="${SSO_HOST}"
          env.APP_HOST="${APP_HOST}"

          echo "Removing pipeline lock and cleaning up deployment"
          def inputAction = input(
            message: "Are you ready to cleanup ${PR_NAME} deployment?",
            ok: 'Confirm',
            parameters: [
              choice(
                name: 'action',
                choices: 'Clean-up\nIgnore',
                description: 'What would you like to do?'
              )
            ]
          )
          if ('Clean-up'.equalsIgnoreCase(inputAction)) {
            sh "node removeURI.js"
            cleanUpLock(lockName)
            cleanUpPR()
            echo "Cleanup of ${PR_NAME} deployment is complete"
          }
        }
      }
    }
  }

  post {
    success {
      echo 'Build and deploy complete'
    }
    failure {
      echo 'Something went wrong, check deploy and builds'
    }
  }
}