jenkins/ci-pipelines/ci_stage_3.groovy

   1 /* Copyright 2017 Sandvine
   2  *
   3  * All Rights Reserved.
   4  *
   5  *   Licensed under the Apache License, Version 2.0 (the "License"); you may
   6  *   not use this file except in compliance with the License. You may obtain
   7  *   a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *   Unless required by applicable law or agreed to in writing, software
  12  *   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13  *   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14  *   License for the specific language governing permissions and limitations
  15  *   under the License.
  16  */
  17
  18 /* Change log:
  19  * 1. Bug 745 : Jayant Madavi, Mrityunjay Yadav : JM00553988@techmahindra.com : 23-july-2019 : Improvement to the code, typically we have 2 *    or more branches whose build gets triggered, ex master & release branch, the previous code was removing any/all docker.
  20  *        Now removing previous docker of the same branch, so that the other branch failed docker should not be removed. It also
  21  *    acts as clean-up for previous docker remove failure.
  22  * 2. Feature 7829 : Mrityunjay Yadav, Jayant Madavi: MY00514913@techmahindra.com : 19-Aug-2019 : Added a parameters & function to invoke Robot test.
  23  */
  24
  25 properties([
  26     parameters([
  27         string(defaultValue: env.GERRIT_BRANCH, description: '', name: 'GERRIT_BRANCH'),
  28         string(defaultValue: 'system', description: '', name: 'NODE'),
  29         string(defaultValue: '', description: '', name: 'BUILD_FROM_SOURCE'),
  30         string(defaultValue: 'unstable', description: '', name: 'REPO_DISTRO'),
  31         string(defaultValue: '', description: '', name: 'COMMIT_ID'),
  32         string(defaultValue: '-stage_2', description: '', name: 'UPSTREAM_SUFFIX'),
  33         string(defaultValue: 'pubkey.asc', description: '', name: 'REPO_KEY_NAME'),
  34         string(defaultValue: 'release', description: '', name: 'RELEASE'),
  35         string(defaultValue: '', description: '', name: 'UPSTREAM_JOB_NAME'),
  36         string(defaultValue: '', description: '', name: 'UPSTREAM_JOB_NUMBER'),
  37         string(defaultValue: '', description: '', name: 'UPSTREAM_JOB_NUMBER'),
  38         string(defaultValue: 'OSMETSI', description: '', name: 'GPG_KEY_NAME'),
  39         string(defaultValue: 'artifactory-osm', description: '', name: 'ARTIFACTORY_SERVER'),
  40         string(defaultValue: 'osm-stage_4', description: '', name: 'DOWNSTREAM_STAGE_NAME'),
  41         string(defaultValue: 'testing-daily', description: '', name: 'DOCKER_TAG'),
  42         booleanParam(defaultValue: true, description: '', name: 'SAVE_CONTAINER_ON_FAIL'),
  43         booleanParam(defaultValue: false, description: '', name: 'SAVE_CONTAINER_ON_PASS'),
  44         booleanParam(defaultValue: true, description: '', name: 'SAVE_ARTIFACTS_ON_SMOKE_SUCCESS'),
  45         booleanParam(defaultValue: true, description: '', name: 'DO_STAGE_4'),
  46         booleanParam(defaultValue: true, description: '',  name: 'DO_BUILD'),
  47         booleanParam(defaultValue: true, description: '', name: 'DO_INSTALL'),
  48         booleanParam(defaultValue: true, description: '', name: 'DO_SMOKE'),
  49         booleanParam(defaultValue: true, description: '', name: 'DO_DOCKERPUSH'),
  50         booleanParam(defaultValue: false, description: '', name: 'SAVE_ARTIFACTS_OVERRIDE'),
  51         string(defaultValue: '/home/jenkins/hive/openstack-etsi.rc', description: '', name: 'HIVE_VIM_1'),
  52         booleanParam(defaultValue: false, description: '', name: 'DO_ROBOT'),
  53         string(defaultValue: 'sanity', description: 'sanity/regression are the options', name: 'TEST_NAME'),
  54         string(defaultValue: '/home/jenkins/hive/robot-systest.cfg', description: '', name: 'ROBOT_VIM'),
  55         string(defaultValue: '/home/jenkins/hive/kubeconfig.yaml', description: '', name: 'KUBECONFIG'),
  56         string(defaultValue: '/home/jenkins/hive/clouds.yaml', description: '', name: 'CLOUDS'),
  57     ])
  58 ])
  59
  60 def uninstall_osm(stackName) {
  61     sh """
  62          export OSM_USE_LOCAL_DEVOPS=true
  63          export PATH=$PATH:/snap/bin
  64          installers/full_install_osm.sh -y -w /tmp/osm -t ${stackName} -s ${stackName} --test --nolxd --nodocker --nojuju --nohostports --nohostclient --uninstall
  65        """
  66 }
  67
  68 def run_systest(stackName,tagName,testName,envfile=null) {
  69     tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
  70     if ( !envfile )
  71     {
  72         sh(script: "touch ${tempdir}/env")
  73         envfile="${tempdir}/env"
  74     }
  75     sh "docker run --network net${stackName} --env-file ${envfile} -v ${tempdir}:/usr/share/osm-devops/systest/reports opensourcemano/osmclient:${tagName} make -C /usr/share/osm-devops/systest ${testName}"
  76     sh "cp ${tempdir}/* ."
  77     junit  '*.xml'
  78 }
  79
  80 def run_robot_systest(stackName,tagName,testName,envfile=null,kubeconfig=null,clouds=null) {
  81     tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
  82     if ( !envfile )
  83     {
  84         sh(script: "touch ${tempdir}/env")
  85         envfile="${tempdir}/env"
  86     }
  87     sh "docker run --network net${stackName} --env OSM_HOSTNAME=${stackName}_nbi --env-file ${envfile} -v ${clouds}:/etc/openstack/clouds.yaml -v ${kubeconfig}:/root/.kube/config -v ${tempdir}:/robot-systest/reports opensourcemano/tests:${tagName} -c -t ${testName}"
  88     sh "cp ${tempdir}/* ."
  89     outputDirectory = sh(returnStdout: true, script: "pwd").trim()
  90     println ("Present Directory is : ${outputDirectory}")
  91     step([
  92         $class : 'RobotPublisher',
  93         outputPath : "${outputDirectory}",
  94         outputFileName : "*.xml",
  95         disableArchiveOutput : false,
  96         reportFileName : "report.html",
  97         logFileName : "log.html",
  98         passThreshold : 0,
  99         unstableThreshold: 0,
 100         otherFiles : "*.png",
 101     ])
 102 }
 103
 104 node("${params.NODE}") {
 105
 106     sh 'env'
 107
 108     tag_or_branch = params.GERRIT_BRANCH.replaceAll(/\./,"")
 109
 110     stage("Checkout") {
 111         checkout scm
 112     }
 113
 114     ci_helper = load "jenkins/ci-pipelines/ci_helper.groovy"
 115
 116     def upstream_main_job = params.UPSTREAM_SUFFIX
 117
 118     // upstream jobs always use merged artifacts
 119     upstream_main_job += '-merge'
 120     container_name_prefix = "osm-${tag_or_branch}"
 121     container_name = "${container_name_prefix}"
 122
 123     keep_artifacts = false
 124     if ( JOB_NAME.contains('merge') ) {
 125         container_name += "-merge"
 126
 127         // On a merge job, we keep artifacts on smoke success
 128         keep_artifacts = params.SAVE_ARTIFACTS_ON_SMOKE_SUCCESS
 129     }
 130     container_name += "-${BUILD_NUMBER}"
 131
 132     // Copy the artifacts from the upstream jobs
 133     stage("Copy Artifacts") {
 134         // cleanup any previous repo
 135         sh 'rm -rf repo'
 136         dir("repo") {
 137             // grab all stable upstream builds based on the
 138
 139             dir("${RELEASE}") {
 140                 def list = ["RO", "openvim", "osmclient", "IM", "devops", "MON", "N2VC", "NBI", "common", "LCM", "POL", "LW-UI", "NG-UI", "PLA", "tests"]
 141                 for (component in list) {
 142                     step ([$class: 'CopyArtifact',
 143                            projectName: "${component}${upstream_main_job}/${GERRIT_BRANCH}"])
 144
 145                     // grab the build name/number
 146                     //options = get_env_from_build('build.env')
 147                     build_num = ci_helper.get_env_value('build.env','BUILD_NUMBER')
 148
 149                     // grab the archives from the stage_2 builds (ie. this will be the artifacts stored based on a merge)
 150                     ci_helper.get_archive(params.ARTIFACTORY_SERVER,component,GERRIT_BRANCH, "${component}${upstream_main_job} :: ${GERRIT_BRANCH}", build_num)
 151
 152                     // cleanup any prevously defined dists
 153                     sh "rm -rf dists"
 154                 }
 155
 156                 // check if an upstream artifact based on specific build number has been requested
 157                 // This is the case of a merge build and the upstream merge build is not yet complete (it is not deemed
 158                 // a successful build yet). The upstream job is calling this downstream job (with the its build artifiact)
 159                 if ( params.UPSTREAM_JOB_NAME ) {
 160                     step ([$class: 'CopyArtifact',
 161                            projectName: "${params.UPSTREAM_JOB_NAME}",
 162                            selector: [$class: 'SpecificBuildSelector', buildNumber: "${params.UPSTREAM_JOB_NUMBER}"]
 163                           ])
 164
 165                     //options = get_env_from_build('build.env')
 166                     // grab the build name/number
 167                     //build_num = sh(returnStdout:true,  script: "cat build.env | awk -F= '/BUILD_NUMBER/{print \$2}'").trim()
 168                     build_num = ci_helper.get_env_value('build.env','BUILD_NUMBER')
 169                     component = ci_helper.get_mdg_from_project(ci_helper.get_env_value('build.env','GERRIT_PROJECT'))
 170
 171                     // the upstream job name contains suffix with the project. Need this stripped off
 172                     def project_without_branch = params.UPSTREAM_JOB_NAME.split('/')[0]
 173
 174                     // Remove the previous artifact for this component. Use the new upstream artifact
 175                     sh "rm -rf pool/${component}"
 176
 177                     ci_helper.get_archive(params.ARTIFACTORY_SERVER,component,GERRIT_BRANCH, "${project_without_branch} :: ${GERRIT_BRANCH}", build_num)
 178
 179                     sh "rm -rf dists"
 180                 }
 181
 182                 // sign all the components
 183                 for (component in list) {
 184                     sh "dpkg-sig --sign builder -k ${GPG_KEY_NAME} pool/${component}/*"
 185                 }
 186
 187                 // now create the distro
 188                 for (component in list) {
 189                     sh "mkdir -p dists/${params.REPO_DISTRO}/${component}/binary-amd64/"
 190                     sh "apt-ftparchive packages pool/${component} > dists/${params.REPO_DISTRO}/${component}/binary-amd64/Packages"
 191                     sh "gzip -9fk dists/${params.REPO_DISTRO}/${component}/binary-amd64/Packages"
 192                 }
 193
 194                 // create and sign the release file
 195                 sh "apt-ftparchive release dists/${params.REPO_DISTRO} > dists/${params.REPO_DISTRO}/Release"
 196                 sh "gpg --yes -abs -u ${GPG_KEY_NAME} -o dists/${params.REPO_DISTRO}/Release.gpg dists/${params.REPO_DISTRO}/Release"
 197
 198                 // copy the public key into the release folder
 199                 // this pulls the key from the home dir of the current user (jenkins)
 200                 sh "cp ~/${REPO_KEY_NAME} ."
 201
 202                 // merge the change logs
 203                 sh """
 204                    rm -f changelog/changelog-osm.html
 205                    [ ! -d changelog ] || for mdgchange in \$(ls changelog); do cat changelog/\$mdgchange >> changelog/changelog-osm.html; done
 206                    """
 207                 RELEASE_DIR = sh(returnStdout:true,  script: 'pwd').trim()
 208             }
 209             // start an apache server to serve up the images
 210             http_server_name = "${container_name}-apache"
 211
 212             pwd = sh(returnStdout:true,  script: 'pwd').trim()
 213             repo_base_url = ci_helper.start_http_server(pwd,http_server_name)
 214         }
 215
 216         // now pull the devops package and install in temporary location
 217         tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
 218         osm_devops_dpkg = sh(returnStdout: true, script: "find . -name osm-devops*.deb").trim()
 219         sh "dpkg -x ${osm_devops_dpkg} ${tempdir}"
 220         OSM_DEVOPS="${tempdir}/usr/share/osm-devops"
 221     }
 222
 223     dir(OSM_DEVOPS) {
 224         error = null
 225         if ( params.DO_BUILD ) {
 226             stage("Build") {
 227                 sh "make -C docker clean"
 228                 sh "make -C docker Q= CMD_DOCKER_ARGS= TAG=${container_name} RELEASE=${params.RELEASE} REPOSITORY_BASE=${repo_base_url} REPOSITORY_KEY=${params.REPO_KEY_NAME} REPOSITORY=${params.REPO_DISTRO}"
 229             }
 230         }
 231
 232         try {
 233             if ( params.DO_INSTALL ) {
 234                 stage("Install") {
 235
 236                     //will by default always delete containers on complete
 237                     //sh "jenkins/system/delete_old_containers.sh ${container_name_prefix}"
 238
 239                     commit_id = ''
 240                     repo_distro = ''
 241                     repo_key_name = ''
 242                     release = ''
 243
 244                     if ( params.COMMIT_ID )
 245                     {
 246                         commit_id = "-b ${params.COMMIT_ID}"
 247                     }
 248
 249                     if ( params.REPO_DISTRO )
 250                     {
 251                         repo_distro = "-r ${params.REPO_DISTRO}"
 252                     }
 253
 254                     if ( params.REPO_KEY_NAME )
 255                     {
 256                         repo_key_name = "-k ${params.REPO_KEY_NAME}"
 257                     }
 258
 259                     if ( params.RELEASE )
 260                     {
 261                         release = "-R ${params.RELEASE}"
 262                     }
 263
 264                     if ( params.REPOSITORY_BASE )
 265                     {
 266                         repo_base_url = "-u ${params.REPOSITORY_BASE}"
 267                     }
 268                                         if ( params.DO_STAGE_4 ) {
 269                                             try {
 270                         sh "docker stack list |grep \"${container_name_prefix}\"|  awk '{ print \$1 }'| xargs docker stack rm"
 271                                                 }
 272                                                 catch (caughtError) {
 273                                                   println("Caught error: docker stack rm failed!")
 274                                                 }
 275                                         }
 276                     sh """
 277                         export PATH=$PATH:/snap/bin
 278                         installers/full_install_osm.sh -y -s ${container_name} --test --nolxd --nodocker --nojuju --nohostports --nohostclient \
 279                                                         --nodockerbuild -t ${container_name} \
 280                                                         -w /tmp/osm \
 281                                                         ${commit_id} \
 282                                                         ${repo_distro} \
 283                                                         ${repo_base_url} \
 284                                                         ${repo_key_name} \
 285                                                         ${release} \
 286                                                         ${params.BUILD_FROM_SOURCE}
 287                        """
 288                 }
 289             }
 290
 291             stage_archive = false
 292             if ( params.DO_SMOKE ) {
 293                 stage("OSM Health") {
 294                     sh "installers/osm_health.sh -s ${container_name}"
 295                 }
 296                 stage("Smoke") {
 297                     run_systest(container_name,container_name,"smoke")
 298                     // archive smoke success until stage_4 is ready
 299
 300                     if ( ! currentBuild.result.equals('UNSTABLE') ) {
 301                         stage_archive = keep_artifacts
 302                     } else {
 303                                            error = new Exception("Smoke test failed")
 304                                            currentBuild.result = 'FAILURE'
 305                                         }
 306                 }
 307             }
 308
 309             if ( params.DO_STAGE_4 ) {
 310                 // override stage_archive to only archive on stable
 311                 stage_archive = false
 312                 stage("System Integration Test") {
 313                     if ( params.DO_ROBOT ) {
 314                         run_robot_systest(container_name,container_name,params.TEST_NAME,params.ROBOT_VIM,params.KUBECONFIG,params.CLOUDS)
 315                     } //else {
 316                     run_systest(container_name,container_name,"openstack_stage_4",params.HIVE_VIM_1)
 317                     //}
 318
 319                     if ( ! currentBuild.result.equals('UNSTABLE') && ! currentBuild.result.equals('FAILURE')) {
 320                         stage_archive = keep_artifacts
 321                     } else {
 322                        println ("Systest test failed, throwing error")
 323                                            error = new Exception("Systest test failed")
 324                                            currentBuild.result = 'FAILURE'
 325                                            throw error
 326                                         }
 327                 }
 328             }
 329
 330             // override to save the artifacts
 331             if ( params.SAVE_ARTIFACTS_OVERRIDE || stage_archive ) {
 332                 stage("Archive") {
 333                     sh "echo ${container_name} > build_version.txt"
 334                     archiveArtifacts artifacts: "build_version.txt", fingerprint: true
 335
 336                     // Archive the tested repo
 337                     dir("${RELEASE_DIR}") {
 338                         ci_helper.archive(params.ARTIFACTORY_SERVER,RELEASE,GERRIT_BRANCH,'tested')
 339                     }
 340                     if ( params.DO_DOCKERPUSH ) {
 341                         stage("Docker Push") {
 342                             sh "make -C docker push INPUT_TAG=${container_name} TAG=${params.DOCKER_TAG}"
 343                         }
 344                     }
 345                 }
 346             }
 347         }
 348         catch(Exception ex) {
 349             error = ex
 350             currentBuild.result = 'FAILURE'
 351             println("Caught error")
 352             println(ex.getMessage())
 353         }
 354         finally {
 355             if ( params.DO_INSTALL ) {
 356                 if (error) {
 357                     if ( !params.SAVE_CONTAINER_ON_FAIL ) {
 358                         uninstall_osm container_name
 359                         sh "docker stop ${http_server_name}"
 360                         sh "docker rm ${http_server_name}"
 361                     }
 362                 }
 363                 else {
 364                     if ( !params.SAVE_CONTAINER_ON_PASS ) {
 365                         uninstall_osm container_name
 366                         sh "docker stop ${http_server_name}"
 367                         sh "docker rm ${http_server_name}"
 368                     }
 369                 }
 370             }
 371         }
 372     }
 373 }