Jenkinsfile

#!/usr/bin/env groovy

// Global scope required for multi-stage persistence
def artServer = Artifactory.server 'art-p-01'
def buildInfo = Artifactory.newBuildInfo()
def distDir = 'build/dist/'
def agentSbtVersion = 'sbt_1-2-4'

pipeline {
    libraries {
        lib('jenkins-pipeline-shared')
    }
    environment {
        SVC_NAME = "br-paye-api"
        ORG = "SBR"
    }
    options {
        skipDefaultCheckout()
        buildDiscarder(logRotator(numToKeepStr: '30', artifactNumToKeepStr: '30'))
        timeout(time: 1, unit: 'HOURS')
        ansiColor('xterm')
    }
    agent { label 'download.jenkins.slave' }
    stages {
        stage('Checkout') {
            agent { label 'download.jenkins.slave' }
            steps {
                checkout scm
                script {
                    buildInfo.name = "${SVC_NAME}"
                    buildInfo.number = "${BUILD_NUMBER}"
                    buildInfo.env.collect()
                }
                colourText("info", "BuildInfo: ${buildInfo.name}-${buildInfo.number}")
                stash name: 'Checkout'
            }
        }

        stage('Build'){
            agent { label "build.${agentSbtVersion}" }
            steps {
                unstash name: 'Checkout'
                sh "sbt compile"
            }
            post {
                success {
                    colourText("info","Stage: ${env.STAGE_NAME} successful!")
                }
                failure {
                    colourText("warn","Stage: ${env.STAGE_NAME} failed!")
                }
            }
        }

        stage('Validate') {
            agent { label "build.${agentSbtVersion}" }
            steps {
                unstash name: 'Checkout'
                sh 'sbt coverage test coverageReport'
            }
            post {
                always {
                    junit '**/target/test-reports/*.xml'
                    cobertura autoUpdateHealth: false,
                            autoUpdateStability: false,
                            coberturaReportFile: 'target/**/coverage-report/cobertura.xml',
                            conditionalCoverageTargets: '70, 0, 0',
                            failUnhealthy: false,
                            failUnstable: false,
                            lineCoverageTargets: '80, 0, 0',
                            maxNumberOfBuilds: 0,
                            methodCoverageTargets: '80, 0, 0',
                            onlyStable: false,
                            zoomCoverageChart: false
                }
                success {
                    colourText("info","Stage: ${env.STAGE_NAME} successful!")
                }
                failure {
                    colourText("warn","Stage: ${env.STAGE_NAME} failed!")
                }
            }
        }

        stage('Test: Acceptance') {
            agent { label "build.${agentSbtVersion}" }
            steps {
                unstash name: 'Checkout'
                sh "sbt it:test"
                milestone label: 'post test:acceptance', ordinal: 1
            }
            post {
                always {
                    junit '**/target/test-reports/*.xml'
                }
                success {
                    colourText("info","Stage: ${env.STAGE_NAME} successful!")
                }
                failure {
                    colourText("warn","Stage: ${env.STAGE_NAME} failed!")
                }
            }
        }

        stage ('Publish') {
            agent { label "build.${agentSbtVersion}" }
            when {
                branch "master"
                // evaluate the when condition before entering this stage's agent, if any
                beforeAgent true
            }
            steps {
                colourText("info", "Building ${env.BUILD_ID} on ${env.JENKINS_URL} from branch ${env.BRANCH_NAME}")
                unstash name: 'Checkout'
                sh 'sbt universal:packageBin'
                script {
                    def uploadSpec = """{
                        "files": [
                            {
                                "pattern": "target/universal/*.zip",
                                "target": "registers-sbt-snapshots/uk/gov/ons/${buildInfo.name}/${buildInfo.number}/"
                            }
                        ]
                    }"""
                    artServer.upload spec: uploadSpec, buildInfo: buildInfo
                }
            }
            post {
                success {
                    colourText("info","Stage: ${env.STAGE_NAME} successful!")
                }
                failure {
                    colourText("warn","Stage: ${env.STAGE_NAME} failed!")
                }
            }
        }

        stage('Deploy: Dev'){
            agent { label 'deploy.cf' }
            when {
                branch "master"
                // evaluate the when condition before entering this stage's agent, if any
                beforeAgent true
            }
            environment{
                CREDS = 's_jenkins_br_dev'
                SPACE = 'Dev'
            }
            steps {
                script {
                    def downloadSpec = """{
                        "files": [
                            {
                                "pattern": "registers-sbt-snapshots/uk/gov/ons/${buildInfo.name}/${buildInfo.number}/*.zip",
                                "target": "${distDir}",
                                "flat": "true"
                            }
                        ]
                    }"""
                    artServer.download spec: downloadSpec, buildInfo: buildInfo
                    sh "mv ${distDir}*.zip ${distDir}${env.SVC_NAME}.zip"
                }
                dir('config') {
                    git url: "${GITLAB_URL}/BusinessRegister/${env.SVC_NAME}.git", credentialsId: 'JenkinsBR__gitlab'
                }
                lock("${this.env.SPACE.toLowerCase()}-${this.env.SVC_NAME}"){
                    script {
                        cfDeploy {
                            credentialsId = "${this.env.CREDS}"
                            org = "${this.env.ORG}"
                            space = "${this.env.SPACE}"
                            appName = "${this.env.SPACE.toLowerCase()}-${this.env.SVC_NAME}"
                            appPath = "./${distDir}/${this.env.SVC_NAME}.zip"
                            manifestPath  = "config/${this.env.SPACE.toLowerCase()}/manifest.yml"
                        }
                    }
                }
                milestone label: 'post deploy:dev', ordinal: 2
            }
            post {
                success {
                    colourText("info","Stage: ${env.STAGE_NAME} successful!")
                }
                failure {
                    colourText("warn","Stage: ${env.STAGE_NAME} failed!")
                }
            }
        }

        stage('Deploy: Test'){
            agent { label 'deploy.cf' }
            when {
                branch "master"
                // evaluate the when condition before entering this stage's agent, if any
                beforeAgent true
            }
            environment{
                CREDS = 's_jenkins_br_test'
                SPACE = 'Test'
            }
            steps {
                script {
                    def downloadSpec = """{
                        "files": [
                            {
                                "pattern": "registers-sbt-snapshots/uk/gov/ons/${buildInfo.name}/${buildInfo.number}/*.zip",
                                "target": "${distDir}",
                                "flat": "true"
                            }
                        ]
                    }"""
                    artServer.download spec: downloadSpec, buildInfo: buildInfo
                    sh "mv ${distDir}*.zip ${distDir}${env.SVC_NAME}.zip"
                }
                dir('config') {
                    git url: "${GITLAB_URL}/BusinessRegister/${env.SVC_NAME}.git", credentialsId: 'JenkinsBR__gitlab'
                }
                lock("${this.env.SPACE.toLowerCase()}-${this.env.SVC_NAME}"){
                    script {
                        cfDeploy {
                            credentialsId = "${this.env.CREDS}"
                            org = "${this.env.ORG}"
                            space = "${this.env.SPACE}"
                            appName = "${this.env.SPACE.toLowerCase()}-${this.env.SVC_NAME}"
                            appPath = "./${distDir}/${this.env.SVC_NAME}.zip"
                            manifestPath  = "config/${this.env.SPACE.toLowerCase()}/manifest.yml"
                        }
                    }
                }
                milestone label: 'post deploy:test', ordinal: 3
            }
            post {
                success {
                    colourText("info","Stage: ${env.STAGE_NAME} successful!")
                }
                failure {
                    colourText("warn","Stage: ${env.STAGE_NAME} failed!")
                }
            }
        }
    }

    post {
        success {
            colourText("success", "All stages complete. Build was successful.")
            slackSend(
                    color: "good",
                    message: "${env.JOB_NAME} success: ${env.RUN_DISPLAY_URL}"
            )
        }
        unstable {
            colourText("warn", "Something went wrong, build finished with result ${currentResult}. This may be caused by failed tests, code violation or in some cases unexpected interrupt.")
            slackSend(
                    color: "warning",
                    message: "${env.JOB_NAME} unstable: ${env.RUN_DISPLAY_URL}"
            )
        }
        failure {
            colourText("warn","Process failed at: ${env.NODE_STAGE}")
            slackSend(
                    color: "danger",
                    message: "${env.JOB_NAME} failed at ${env.STAGE_NAME}: ${env.RUN_DISPLAY_URL}"
            )
        }
    }
}