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: 'releaseseven-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: 'smoke/vim/sanity/comprehensive are the options', name: 'TEST_NAME'),
  54         string(defaultValue: '/home/jenkins/hive/robot-systest.cfg', description: '', name: 'ROBOT_VIM'),
  55     ])
  56 ])
  57
  58 def uninstall_osm(stackName) {
  59     sh """
  60          export OSM_USE_LOCAL_DEVOPS=true
  61          export PATH=$PATH:/snap/bin
  62          installers/full_install_osm.sh -y -w /tmp/osm -t ${stackName} -s ${stackName} --test --nolxd --nodocker --nojuju --nohostports --nohostclient --uninstall
  63        """
  64 }
  65
  66 def run_systest(stackName,tagName,testName,envfile=null) {
  67     tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
  68     if ( !envfile )
  69     {
  70         sh(script: "touch ${tempdir}/env")
  71         envfile="${tempdir}/env"
  72     }
  73     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}"
  74     sh "cp ${tempdir}/* ."
  75     junit  '*.xml'
  76 }
  77
  78 def run_robot_systest(stackName,tagName,testName,envfile=null) {
  79     tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
  80     if ( !envfile )
  81     {
  82         sh(script: "touch ${tempdir}/env")
  83         envfile="${tempdir}/env"
  84     }
  85     sh "docker run --network net${stackName} --env-file ${envfile} -v ${tempdir}:/usr/share/osm-devops/robot-systest/reports opensourcemano/osmclient:${tagName} bash -C /usr/share/osm-devops/robot-systest/run_test.sh --do_install -t ${testName}"
  86     sh "cp ${tempdir}/* ."
  87     outputDirectory = sh(returnStdout: true, script: "pwd").trim()
  88     println ("Present Directory is : ${outputDirectory}")
  89     step([
  90         $class : 'RobotPublisher',
  91         outputPath : "${outputDirectory}",
  92         outputFileName : "*.xml",
  93         disableArchiveOutput : false,
  94         reportFileName : "report.html",
  95         logFileName : "log.html",
  96         passThreshold : 0,
  97         unstableThreshold: 0,
  98         otherFiles : "*.png",
  99     ])
 100 }
 101
 102 node("${params.NODE}") {
 103
 104     sh 'env'
 105
 106     tag_or_branch = params.GERRIT_BRANCH.replaceAll(/\./,"")
 107
 108     stage("Checkout") {
 109         checkout scm
 110     }
 111
 112     ci_helper = load "jenkins/ci-pipelines/ci_helper.groovy"
 113
 114     def upstream_main_job = params.UPSTREAM_SUFFIX
 115
 116     // upstream jobs always use merged artifacts
 117     upstream_main_job += '-merge'
 118     container_name_prefix = "osm-${tag_or_branch}"
 119     container_name = "${container_name_prefix}"
 120
 121     keep_artifacts = false
 122     if ( JOB_NAME.contains('merge') ) {
 123         container_name += "-merge"
 124
 125         // On a merge job, we keep artifacts on smoke success
 126         keep_artifacts = params.SAVE_ARTIFACTS_ON_SMOKE_SUCCESS
 127     }
 128     container_name += "-${BUILD_NUMBER}"
 129
 130     // Copy the artifacts from the upstream jobs
 131     stage("Copy Artifacts") {
 132         // cleanup any previous repo
 133         sh 'rm -rf repo'
 134         dir("repo") {
 135             // grab all stable upstream builds based on the
 136
 137             dir("${RELEASE}") {
 138                 def list = ["RO", "openvim", "osmclient", "IM", "devops", "MON", "N2VC", "NBI", "common", "LCM", "POL", "LW-UI","NG-UI"]
 139                 for (component in list) {
 140                     step ([$class: 'CopyArtifact',
 141                            projectName: "${component}${upstream_main_job}/${GERRIT_BRANCH}"])
 142
 143                     // grab the build name/number
 144                     //options = get_env_from_build('build.env')
 145                     build_num = ci_helper.get_env_value('build.env','BUILD_NUMBER')
 146
 147                     // grab the archives from the stage_2 builds (ie. this will be the artifacts stored based on a merge)
 148                     ci_helper.get_archive(params.ARTIFACTORY_SERVER,component,GERRIT_BRANCH, "${component}${upstream_main_job} :: ${GERRIT_BRANCH}", build_num)
 149
 150                     // cleanup any prevously defined dists
 151                     sh "rm -rf dists"
 152                 }
 153
 154                 // check if an upstream artifact based on specific build number has been requested
 155                 // This is the case of a merge build and the upstream merge build is not yet complete (it is not deemed
 156                 // a successful build yet). The upstream job is calling this downstream job (with the its build artifiact)
 157                 if ( params.UPSTREAM_JOB_NAME ) {
 158                     step ([$class: 'CopyArtifact',
 159                            projectName: "${params.UPSTREAM_JOB_NAME}",
 160                            selector: [$class: 'SpecificBuildSelector', buildNumber: "${params.UPSTREAM_JOB_NUMBER}"]
 161                           ])
 162
 163                     //options = get_env_from_build('build.env')
 164                     // grab the build name/number
 165                     //build_num = sh(returnStdout:true,  script: "cat build.env | awk -F= '/BUILD_NUMBER/{print \$2}'").trim()
 166                     build_num = ci_helper.get_env_value('build.env','BUILD_NUMBER')
 167                     component = ci_helper.get_mdg_from_project(ci_helper.get_env_value('build.env','GERRIT_PROJECT'))
 168
 169                     // the upstream job name contains suffix with the project. Need this stripped off
 170                     def project_without_branch = params.UPSTREAM_JOB_NAME.split('/')[0]
 171
 172                     // Remove the previous artifact for this component. Use the new upstream artifact
 173                     sh "rm -rf pool/${component}"
 174
 175                     ci_helper.get_archive(params.ARTIFACTORY_SERVER,component,GERRIT_BRANCH, "${project_without_branch} :: ${GERRIT_BRANCH}", build_num)
 176
 177                     sh "rm -rf dists"
 178                 }
 179
 180                 // sign all the components
 181                 for (component in list) {
 182                     sh "dpkg-sig --sign builder -k ${GPG_KEY_NAME} pool/${component}/*"
 183                 }
 184
 185                 // now create the distro
 186                 for (component in list) {
 187                     sh "mkdir -p dists/${params.REPO_DISTRO}/${component}/binary-amd64/"
 188                     sh "apt-ftparchive packages pool/${component} > dists/${params.REPO_DISTRO}/${component}/binary-amd64/Packages"
 189                     sh "gzip -9fk dists/${params.REPO_DISTRO}/${component}/binary-amd64/Packages"
 190                 }
 191
 192                 // create and sign the release file
 193                 sh "apt-ftparchive release dists/${params.REPO_DISTRO} > dists/${params.REPO_DISTRO}/Release"
 194                 sh "gpg --yes -abs -u ${GPG_KEY_NAME} -o dists/${params.REPO_DISTRO}/Release.gpg dists/${params.REPO_DISTRO}/Release"
 195
 196                 // copy the public key into the release folder
 197                 // this pulls the key from the home dir of the current user (jenkins)
 198                 sh "cp ~/${REPO_KEY_NAME} ."
 199
 200                 // merge the change logs
 201                 sh """
 202                    rm -f changelog/changelog-osm.html
 203                    [ ! -d changelog ] || for mdgchange in \$(ls changelog); do cat changelog/\$mdgchange >> changelog/changelog-osm.html; done
 204                    """
 205                 RELEASE_DIR = sh(returnStdout:true,  script: 'pwd').trim()
 206             }
 207             // start an apache server to serve up the images
 208             http_server_name = "${container_name}-apache"
 209
 210             pwd = sh(returnStdout:true,  script: 'pwd').trim()
 211             repo_base_url = ci_helper.start_http_server(pwd,http_server_name)
 212         }
 213
 214         // now pull the devops package and install in temporary location
 215         tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
 216         osm_devops_dpkg = sh(returnStdout: true, script: "find . -name osm-devops*.deb").trim()
 217         sh "dpkg -x ${osm_devops_dpkg} ${tempdir}"
 218         OSM_DEVOPS="${tempdir}/usr/share/osm-devops"
 219     }
 220
 221     dir(OSM_DEVOPS) {
 222         error = null
 223         if ( params.DO_BUILD ) {
 224             stage("Build") {
 225                 sh "make -C docker clean"
 226                 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}"
 227             }
 228         }
 229
 230         try {
 231             if ( params.DO_INSTALL ) {
 232                 stage("Install") {
 233
 234                     //will by default always delete containers on complete
 235                     //sh "jenkins/system/delete_old_containers.sh ${container_name_prefix}"
 236
 237                     commit_id = ''
 238                     repo_distro = ''
 239                     repo_key_name = ''
 240                     release = ''
 241
 242                     if ( params.COMMIT_ID )
 243                     {
 244                         commit_id = "-b ${params.COMMIT_ID}"
 245                     }
 246
 247                     if ( params.REPO_DISTRO )
 248                     {
 249                         repo_distro = "-r ${params.REPO_DISTRO}"
 250                     }
 251
 252                     if ( params.REPO_KEY_NAME )
 253                     {
 254                         repo_key_name = "-k ${params.REPO_KEY_NAME}"
 255                     }
 256
 257                     if ( params.RELEASE )
 258                     {
 259                         release = "-R ${params.RELEASE}"
 260                     }
 261
 262                     if ( params.REPOSITORY_BASE )
 263                     {
 264                         repo_base_url = "-u ${params.REPOSITORY_BASE}"
 265                     }
 266                                         if ( params.DO_STAGE_4 ) {
 267                                             try {
 268                         sh "docker stack list |grep \"${container_name_prefix}\"|  awk '{ print \$1 }'| xargs docker stack rm"
 269                                                 }
 270                                                 catch (caughtError) {
 271                                                   println("Caught error: docker stack rm failed!")
 272                                                 }
 273                                         }
 274                     sh """
 275                         export PATH=$PATH:/snap/bin
 276                         installers/full_install_osm.sh -y -s ${container_name} --test --nolxd --nodocker --nojuju --nohostports --nohostclient \
 277                                                         --nodockerbuild -t ${container_name} \
 278                                                         -w /tmp/osm \
 279                                                         ${commit_id} \
 280                                                         ${repo_distro} \
 281                                                         ${repo_base_url} \
 282                                                         ${repo_key_name} \
 283                                                         ${release} \
 284                                                         ${params.BUILD_FROM_SOURCE}
 285                        """
 286                 }
 287             }
 288
 289             stage_archive = false
 290             if ( params.DO_SMOKE ) {
 291                 stage("OSM Health") {
 292                     sh "installers/osm_health.sh -s ${container_name}"
 293                 }
 294                 stage("Smoke") {
 295                     run_systest(container_name,container_name,"smoke")
 296                     // archive smoke success until stage_4 is ready
 297
 298                     if ( ! currentBuild.result.equals('UNSTABLE') ) {
 299                         stage_archive = keep_artifacts
 300                     } else {
 301                                            error = new Exception("Smoke test failed")
 302                                            currentBuild.result = 'FAILURE'
 303                                         }
 304                 }
 305             }
 306
 307             if ( params.DO_STAGE_4 ) {
 308                 // override stage_archive to only archive on stable
 309                 stage_archive = false
 310                 stage("System Integration Test") {
 311                     if ( params.DO_ROBOT ) {
 312                         run_robot_systest(container_name,container_name,params.TEST_NAME,params.ROBOT_VIM)
 313                     } //else {
 314                     run_systest(container_name,container_name,"openstack_stage_4",params.HIVE_VIM_1)
 315                     //}
 316
 317                     if ( ! currentBuild.result.equals('UNSTABLE') && ! currentBuild.result.equals('FAILURE')) {
 318                         stage_archive = keep_artifacts
 319                     } else {
 320                        println ("Systest test failed, throwing error")
 321                                            error = new Exception("Systest test failed")
 322                                            currentBuild.result = 'FAILURE'
 323                                            throw error
 324                                         }
 325                 }
 326             }
 327
 328             // override to save the artifacts
 329             if ( params.SAVE_ARTIFACTS_OVERRIDE || stage_archive ) {
 330                 stage("Archive") {
 331                     sh "echo ${container_name} > build_version.txt"
 332                     archiveArtifacts artifacts: "build_version.txt", fingerprint: true
 333
 334                     // Archive the tested repo
 335                     dir("${RELEASE_DIR}") {
 336                         ci_helper.archive(params.ARTIFACTORY_SERVER,RELEASE,GERRIT_BRANCH,'tested')
 337                     }
 338                     if ( params.DO_DOCKERPUSH ) {
 339                         stage("Docker Push") {
 340                             sh "make -C docker push INPUT_TAG=${container_name} TAG=${params.DOCKER_TAG}"
 341                         }
 342                     }
 343                 }
 344             }
 345         }
 346         catch(Exception ex) {
 347             error = ex
 348             currentBuild.result = 'FAILURE'
 349             println("Caught error")
 350             println(ex.getMessage())
 351         }
 352         finally {
 353             if ( params.DO_INSTALL ) {
 354                 if (error) {
 355                     if ( !params.SAVE_CONTAINER_ON_FAIL ) {
 356                         uninstall_osm container_name
 357                         sh "docker stop ${http_server_name}"
 358                         sh "docker rm ${http_server_name}"
 359                     }
 360                 }
 361                 else {
 362                     if ( !params.SAVE_CONTAINER_ON_PASS ) {
 363                         uninstall_osm container_name
 364                         sh "docker stop ${http_server_name}"
 365                         sh "docker rm ${http_server_name}"
 366                     }
 367                 }
 368             }
 369         }
 370     }
 371 }