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