1 /* Copyright ETSI Contributors and Others
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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
20 string(defaultValue: env.GERRIT_BRANCH, description: '', name: 'GERRIT_BRANCH'),
21 string(defaultValue: 'system', description: '', name: 'NODE'),
22 string(defaultValue: '', description: '', name: 'BUILD_FROM_SOURCE'),
23 string(defaultValue: 'unstable', description: '', name: 'REPO_DISTRO'),
24 string(defaultValue: '', description: '', name: 'COMMIT_ID'),
25 string(defaultValue: '-stage_2', description: '', name: 'UPSTREAM_SUFFIX'),
26 string(defaultValue: 'pubkey.asc', description: '', name: 'REPO_KEY_NAME'),
27 string(defaultValue: 'release', description: '', name: 'RELEASE'),
28 string(defaultValue: '', description: '', name: 'UPSTREAM_JOB_NAME'),
29 string(defaultValue: '', description: '', name: 'UPSTREAM_JOB_NUMBER'),
30 string(defaultValue: '', description: '', name: 'UPSTREAM_JOB_NUMBER'),
31 string(defaultValue: 'OSMETSI', description: '', name: 'GPG_KEY_NAME'),
32 string(defaultValue: 'artifactory-osm', description: '', name: 'ARTIFACTORY_SERVER'),
33 string(defaultValue: 'osm-stage_4', description: '', name: 'DOWNSTREAM_STAGE_NAME'),
34 string(defaultValue: 'testing-daily', description: '', name: 'DOCKER_TAG'),
35 booleanParam(defaultValue: false, description: '', name: 'SAVE_CONTAINER_ON_FAIL'),
36 booleanParam(defaultValue: false, description: '', name: 'SAVE_CONTAINER_ON_PASS'),
37 booleanParam(defaultValue: true, description: '', name: 'SAVE_ARTIFACTS_ON_SMOKE_SUCCESS'),
38 booleanParam(defaultValue: true, description: '', name: 'DO_STAGE_4'),
39 booleanParam(defaultValue: true, description: '', name: 'DO_BUILD'),
40 booleanParam(defaultValue: true, description: '', name: 'DO_INSTALL'),
41 booleanParam(defaultValue: true, description: '', name: 'DO_SMOKE'),
42 booleanParam(defaultValue: true, description: '', name: 'DO_DOCKERPUSH'),
43 booleanParam(defaultValue: false, description: '', name: 'SAVE_ARTIFACTS_OVERRIDE'),
44 string(defaultValue: '/home/jenkins/hive/openstack-etsi.rc', description: '', name: 'HIVE_VIM_1'),
45 booleanParam(defaultValue: false, description: '', name: 'DO_ROBOT'),
46 string(defaultValue: 'daily', description: 'sanity/regression/daily are the common options', name: 'TEST_NAME'),
47 string(defaultValue: '/home/jenkins/hive/robot-systest.cfg', description: '', name: 'ROBOT_VIM'),
48 string(defaultValue: '/home/jenkins/hive/kubeconfig.yaml', description: '', name: 'KUBECONFIG'),
49 string(defaultValue: '/home/jenkins/hive/clouds.yaml', description: '', name: 'CLOUDS'),
50 string(defaultValue: 'Default', description: '', name: 'INSTALLER'),
55 ////////////////////////////////////////////////////////////////////////////////////////
57 ////////////////////////////////////////////////////////////////////////////////////////
58 def run_robot_systest(tagName,testName,osmHostname,prometheusHostname,prometheus_port=null,envfile=null,kubeconfig=null,clouds=null,hostfile=null,jujuPassword=null) {
59 tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
62 sh(script: "touch ${tempdir}/env")
63 envfile="${tempdir}/env"
65 PROMETHEUS_PORT_VAR = ""
66 if ( prometheusPort != null) {
67 PROMETHEUS_PORT_VAR = "--env PROMETHEUS_PORT="+prometheusPort
71 hostfilemount="-v "+hostfile+":/etc/hosts"
74 JUJU_PASSWORD_VAR = ""
75 if ( jujuPassword != null) {
76 JUJU_PASSWORD_VAR = "--env JUJU_PASSWORD="+jujuPassword
80 sh "docker run --env OSM_HOSTNAME=${osmHostname} --env PROMETHEUS_HOSTNAME=${prometheusHostname} ${PROMETHEUS_PORT_VAR} ${JUJU_PASSWORD_VAR} --env-file ${envfile} -v ${clouds}:/etc/openstack/clouds.yaml -v ${kubeconfig}:/root/.kube/config -v ${tempdir}:/robot-systest/reports ${hostfilemount} opensourcemano/tests:${tagName} -c -t ${testName}"
82 sh "cp ${tempdir}/* ."
83 outputDirectory = sh(returnStdout: true, script: "pwd").trim()
84 println ("Present Directory is : ${outputDirectory}")
86 $class : 'RobotPublisher',
87 outputPath : "${outputDirectory}",
88 outputFileName : "*.xml",
89 disableArchiveOutput : false,
90 reportFileName : "report.html",
91 logFileName : "log.html",
99 def archive_logs(remote) {
101 sshCommand remote: remote, command: '''mkdir -p logs'''
102 if (useCharmedInstaller) {
103 sshCommand remote: remote, command: '''
104 for container in `kubectl get pods -n osm | grep -v operator | grep -v NAME| awk '{print $1}'`; do
105 logfile=`echo $container | cut -d- -f1`
106 echo "Extracting log for $logfile"
107 kubectl logs -n osm $container --timestamps=true 2>&1 > logs/$logfile.log
111 sshCommand remote: remote, command: '''
112 for deployment in `kubectl -n osm get deployments | grep -v operator | grep -v NAME| awk '{print $1}'`; do
113 echo "Extracting log for $deployment"
114 kubectl -n osm logs deployments/$deployment --timestamps=true --all-containers 2>&1 > logs/$deployment.log
117 sshCommand remote: remote, command: '''
118 for statefulset in `kubectl -n osm get statefulsets | grep -v operator | grep -v NAME| awk '{print $1}'`; do
119 echo "Extracting log for $statefulset"
120 kubectl -n osm logs statefulsets/$statefulset --timestamps=true --all-containers 2>&1 > logs/$statefulset.log
126 sshCommand remote: remote, command: '''ls -al logs'''
127 sshGet remote: remote, from: 'logs', into: '.', override: true
129 archiveArtifacts artifacts: '*.log'
132 def get_value(key, output) {
133 for (String line : output.split( '\n' )) {
134 data = line.split( '\\|' )
135 if (data.length > 1) {
136 if ( data[1].trim() == key ) {
137 return data[2].trim()
143 ////////////////////////////////////////////////////////////////////////////////////////
145 ////////////////////////////////////////////////////////////////////////////////////////
146 node("${params.NODE}") {
148 INTERNAL_DOCKER_REGISTRY = 'osm.etsi.org:5050/devops/cicd/'
149 INTERNAL_DOCKER_PROXY = 'http://172.21.1.1:5000'
150 SSH_KEY = '~/hive/cicd_rsa'
153 tag_or_branch = params.GERRIT_BRANCH.replaceAll(/\./,"")
159 ci_helper = load "jenkins/ci-pipelines/ci_helper.groovy"
161 def upstream_main_job = params.UPSTREAM_SUFFIX
163 // upstream jobs always use merged artifacts
164 upstream_main_job += '-merge'
165 container_name_prefix = "osm-${tag_or_branch}"
166 container_name = "${container_name_prefix}"
168 keep_artifacts = false
169 if ( JOB_NAME.contains('merge') ) {
170 container_name += "-merge"
172 // On a merge job, we keep artifacts on smoke success
173 keep_artifacts = params.SAVE_ARTIFACTS_ON_SMOKE_SUCCESS
175 container_name += "-${BUILD_NUMBER}"
178 http_server_name = null
180 useCharmedInstaller = params.INSTALLER.equalsIgnoreCase("charmed")
184 ///////////////////////////////////////////////////////////////////////////////////////
185 // Fetch stage 2 .deb artifacts
186 ///////////////////////////////////////////////////////////////////////////////////////
187 stage("Copy Artifacts") {
188 // cleanup any previous repo
193 RELEASE_DIR = sh(returnStdout:true, script: 'pwd').trim()
195 // check if an upstream artifact based on specific build number has been requested
196 // This is the case of a merge build and the upstream merge build is not yet complete (it is not deemed
197 // a successful build yet). The upstream job is calling this downstream job (with the its build artifiact)
198 def upstreamComponent=""
199 if ( params.UPSTREAM_JOB_NAME ) {
200 println("Fetching upstream job artifact from ${params.UPSTREAM_JOB_NAME}")
202 step ([$class: 'CopyArtifact',
203 projectName: "${params.UPSTREAM_JOB_NAME}",
204 selector: [$class: 'SpecificBuildSelector',
205 buildNumber: "${params.UPSTREAM_JOB_NUMBER}"]
208 upstreamComponent = ci_helper.get_mdg_from_project(
209 ci_helper.get_env_value('build.env','GERRIT_PROJECT'))
210 def buildNumber = ci_helper.get_env_value('build.env','BUILD_NUMBER')
211 dir("$upstreamComponent") {
212 // the upstream job name contains suffix with the project. Need this stripped off
213 def project_without_branch = params.UPSTREAM_JOB_NAME.split('/')[0]
214 def packages = ci_helper.get_archive(params.ARTIFACTORY_SERVER,
217 "${project_without_branch} :: ${GERRIT_BRANCH}",
220 packageList.addAll(packages)
221 println("Fetched pre-merge ${params.UPSTREAM_JOB_NAME}: ${packages}")
226 def list = ["RO", "openvim", "osmclient", "IM", "devops", "MON", "N2VC", "NBI", "common", "LCM", "POL", "LW-UI", "NG-UI", "PLA", "tests"]
227 if (upstreamComponent.length()>0) {
228 println("Skipping upstream fetch of "+upstreamComponent)
229 list.remove(upstreamComponent)
231 for (buildStep in list) {
232 def component = buildStep
233 parallelSteps[component] = {
235 println("Fetching artifact for ${component}")
236 step ([$class: 'CopyArtifact',
237 projectName: "${component}${upstream_main_job}/${GERRIT_BRANCH}"])
239 // grab the archives from the stage_2 builds (ie. this will be the artifacts stored based on a merge)
240 def packages = ci_helper.get_archive(params.ARTIFACTORY_SERVER,
243 "${component}${upstream_main_job} :: ${GERRIT_BRANCH}",
244 ci_helper.get_env_value('build.env','BUILD_NUMBER'))
245 packageList.addAll(packages)
246 println("Fetched ${component}: ${packages}")
251 parallel parallelSteps
253 ///////////////////////////////////////////////////////////////////////////////////////
254 // Create Devops APT repository
255 ///////////////////////////////////////////////////////////////////////////////////////
256 sh "mv devops/pool/ pool"
257 sh "dpkg-sig --sign builder -k ${GPG_KEY_NAME} pool/devops/*"
258 sh "mkdir -p dists/${params.REPO_DISTRO}/devops/binary-amd64/"
259 sh "apt-ftparchive packages pool/devops > dists/${params.REPO_DISTRO}/devops/binary-amd64/Packages"
260 sh "gzip -9fk dists/${params.REPO_DISTRO}/devops/binary-amd64/Packages"
262 // create and sign the release file
263 sh "apt-ftparchive release dists/${params.REPO_DISTRO} > dists/${params.REPO_DISTRO}/Release"
264 sh "gpg --yes -abs -u ${GPG_KEY_NAME} -o dists/${params.REPO_DISTRO}/Release.gpg dists/${params.REPO_DISTRO}/Release"
266 // copy the public key into the release folder
267 // this pulls the key from the home dir of the current user (jenkins)
268 sh "cp ~/${REPO_KEY_NAME} 'OSM ETSI Release Key.gpg'"
269 sh "cp ~/${REPO_KEY_NAME} ."
272 // start an apache server to serve up the packages
273 http_server_name = "${container_name}-apache"
275 pwd = sh(returnStdout:true, script: 'pwd').trim()
276 repo_port = sh(script: 'echo $(python -c \'import socket; s=socket.socket(); s.bind(("", 0)); print(s.getsockname()[1]); s.close()\');', returnStdout: true).trim()
277 repo_base_url = ci_helper.start_http_server(pwd,http_server_name,repo_port)
278 NODE_IP_ADDRESS=sh(returnStdout: true, script:
279 "echo ${SSH_CONNECTION} | awk '{print \$3}'").trim()
282 // Unpack devops package into temporary location so that we use it from upstream if it was part of a patch
283 osm_devops_dpkg = sh(returnStdout: true, script: "find ./repo/release/pool/ -name osm-devops*.deb").trim()
284 devopstempdir = sh(returnStdout: true, script: "mktemp -d").trim()
285 println("Extracting local devops package ${osm_devops_dpkg} into ${devopstempdir} for docker build step")
286 sh "dpkg -x ${osm_devops_dpkg} ${devopstempdir}"
287 OSM_DEVOPS="${devopstempdir}/usr/share/osm-devops"
288 // Convert URLs from stage 2 packages to arguments that can be passed to docker build
289 for (remotePath in packageList) {
290 packageName=remotePath.substring(remotePath.lastIndexOf('/')+1)
291 packageName=packageName.substring(0,packageName.indexOf('_'))
292 builtModules[packageName]=remotePath
296 ///////////////////////////////////////////////////////////////////////////////////////
297 // Build docker containers
298 ///////////////////////////////////////////////////////////////////////////////////////
302 if ( params.DO_BUILD ) {
303 withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'gitlab-registry',
304 usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD']]) {
305 sh "docker login ${INTERNAL_DOCKER_REGISTRY} -u ${USERNAME} -p ${PASSWORD}"
308 for (packageName in builtModules.keySet()) {
309 envName=packageName.replaceAll("-","_").toUpperCase()+"_URL"
310 moduleBuildArgs += " --build-arg ${envName}=" + builtModules[packageName]
314 containerList = sh(returnStdout: true, script:
315 "find . -name Dockerfile -printf '%h\\n' | sed 's|\\./||'")
316 containerList=Arrays.asList(containerList.split("\n"))
319 for (buildStep in containerList) {
320 def module = buildStep
321 def moduleName = buildStep.toLowerCase()
322 def moduleTag = container_name
323 parallelSteps[module] = {
325 sh "docker build -t opensourcemano/${moduleName}:${moduleTag} ${moduleBuildArgs} ."
326 println("Tagging ${moduleName}:${moduleTag}")
327 sh "docker tag opensourcemano/${moduleName}:${moduleTag} ${INTERNAL_DOCKER_REGISTRY}opensourcemano/${moduleName}:${moduleTag}"
328 sh "docker push ${INTERNAL_DOCKER_REGISTRY}opensourcemano/${moduleName}:${moduleTag}"
332 parallel parallelSteps
335 } // if ( params.DO_BUILD )
337 if ( params.DO_INSTALL ) {
338 ///////////////////////////////////////////////////////////////////////////////////////
340 ///////////////////////////////////////////////////////////////////////////////////////
341 stage("Spawn Remote VM") {
342 println("Launching new VM")
343 output=sh(returnStdout: true, script: """#!/bin/sh -e
344 for line in `grep OS ~/hive/robot-systest.cfg | grep -v OS_CLOUD` ; do export \$line ; done
345 openstack server create --flavor osm.sanity \
346 --image ubuntu18.04 \
348 --property build_url="${BUILD_URL}" \
349 --nic net-id=osm-ext \
353 server_id = get_value('id', output)
355 if (server_id == null) {
356 println("VM launch output: ")
358 throw new Exception("VM Launch failed")
360 println("Target VM is ${server_id}, waiting for IP address to be assigned")
364 while (IP_ADDRESS == "") {
365 output=sh(returnStdout: true, script: """#!/bin/sh -e
366 for line in `grep OS ~/hive/robot-systest.cfg | grep -v OS_CLOUD` ; do export \$line ; done
367 openstack server show ${server_id}
369 IP_ADDRESS = get_value('addresses', output)
371 IP_ADDRESS = IP_ADDRESS.split('=')[1]
372 println("Waiting for VM at ${IP_ADDRESS} to be reachable")
376 output=sh(returnStdout: true, script: "sleep 1 ; nc -zv ${IP_ADDRESS} 22 2>&1 || true").trim()
377 println("output is [$output]")
378 alive = output.contains("succeeded")
380 println("VM is ready and accepting ssh connections")
381 } // stage("Spawn Remote VM")
383 ///////////////////////////////////////////////////////////////////////////////////////
385 ///////////////////////////////////////////////////////////////////////////////////////
392 if ( params.COMMIT_ID )
394 commit_id = "-b ${params.COMMIT_ID}"
397 if ( params.REPO_DISTRO )
399 repo_distro = "-r ${params.REPO_DISTRO}"
402 if ( params.REPO_KEY_NAME )
404 repo_key_name = "-k ${params.REPO_KEY_NAME}"
407 if ( params.RELEASE )
409 release = "-R ${params.RELEASE}"
412 if ( params.REPOSITORY_BASE )
414 repo_base_url = "-u ${params.REPOSITORY_BASE}"
418 repo_base_url = "-u http://${NODE_IP_ADDRESS}:${repo_port}"
421 remote.name = container_name
422 remote.host = IP_ADDRESS
423 remote.user = 'ubuntu'
424 remote.identityFile = SSH_KEY
425 remote.allowAnyHosts = true
426 remote.logLevel = 'INFO'
429 sshCommand remote: remote, command: """
430 wget https://osm-download.etsi.org/ftp/osm-9.0-nine/install_osm.sh
431 chmod +x ./install_osm.sh
432 sed -i '1 i\\export PATH=/snap/bin:\${PATH}' ~/.bashrc
435 if ( useCharmedInstaller ) {
436 // Use local proxy for docker hub
437 sshCommand remote: remote, command: '''
438 sudo snap install microk8s --classic --channel=1.19/stable
439 sudo sed -i "s|https://registry-1.docker.io|http://172.21.1.1:5000|" /var/snap/microk8s/current/args/containerd-template.toml
440 sudo systemctl restart snap.microk8s.daemon-containerd.service
441 sudo snap alias microk8s.kubectl kubectl
444 withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'gitlab-registry',
445 usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD']]) {
446 sshCommand remote: remote, command: """
447 ./install_osm.sh -y \
450 ${release} -r unstable \
452 --registry ${USERNAME}:${PASSWORD}@${INTERNAL_DOCKER_REGISTRY} \
453 --tag ${container_name}
456 prometheusHostname = "prometheus."+IP_ADDRESS+".xip.io"
458 osmHostname = "nbi."+IP_ADDRESS+".xip.io:443"
460 // Run -k8s installer here specifying internal docker registry and docker proxy
461 withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'gitlab-registry',
462 usernameVariable: 'USERNAME', passwordVariable: 'PASSWORD']]) {
463 sshCommand remote: remote, command: """
464 ./install_osm.sh -y \
467 ${release} -r unstable \
468 -d ${USERNAME}:${PASSWORD}@${INTERNAL_DOCKER_REGISTRY} \
469 -p ${INTERNAL_DOCKER_PROXY} \
473 prometheusHostname = IP_ADDRESS
474 prometheusPort = 9091
475 osmHostname = IP_ADDRESS
477 } // stage("Install")
478 } // if ( params.DO_INSTALL )
480 ///////////////////////////////////////////////////////////////////////////////////////
481 // Health check of installed OSM in remote vm
482 ///////////////////////////////////////////////////////////////////////////////////////
483 if ( params.DO_SMOKE ) {
484 stage("OSM Health") {
486 sshCommand remote: remote, command: """
487 /usr/share/osm-devops/installers/osm_health.sh -k -s ${stackName}
492 ///////////////////////////////////////////////////////////////////////////////////////
493 // Execute Robot tests
494 ///////////////////////////////////////////////////////////////////////////////////////
495 stage_archive = false
496 if ( params.DO_STAGE_4 ) {
498 stage("System Integration Test") {
499 if ( params.DO_ROBOT ) {
500 if( useCharmedInstaller ) {
501 tempdir = sh(returnStdout: true, script: "mktemp -d").trim()
502 sh(script: "touch ${tempdir}/hosts")
503 hostfile="${tempdir}/hosts"
504 sh """cat << EOF > ${hostfile}
506 ${remote.host} prometheus.${remote.host}.xip.io nbi.${remote.host}.xip.io
512 jujuPassword=sshCommand remote: remote, command: """
513 echo `juju gui 2>&1 | grep password | cut -d: -f2`
528 } // stage("System Integration Test")
530 stage("Archive Container Logs") {
531 // Archive logs to containers_logs.txt
533 if ( ! currentBuild.result.equals('UNSTABLE') && ! currentBuild.result.equals('FAILURE')) {
534 stage_archive = keep_artifacts
536 println ("Systest test failed, throwing error")
537 error = new Exception("Systest test failed")
538 currentBuild.result = 'FAILURE'
543 } // if ( params.DO_STAGE_4 )
545 if ( params.SAVE_ARTIFACTS_OVERRIDE || stage_archive ) {
547 sh "echo ${container_name} > build_version.txt"
548 archiveArtifacts artifacts: "build_version.txt", fingerprint: true
550 // Archive the tested repo
551 dir("${RELEASE_DIR}") {
552 ci_helper.archive(params.ARTIFACTORY_SERVER,RELEASE,GERRIT_BRANCH,'tested')
554 if ( params.DO_DOCKERPUSH ) {
555 stage("Publish to Dockerhub") {
557 for (buildStep in containerList) {
558 def module = buildStep
559 def moduleName = buildStep.toLowerCase()
560 def dockerTag = params.DOCKER_TAG
561 def moduleTag = container_name
563 parallelSteps[module] = {
565 sh "docker tag opensourcemano/${moduleName}:${moduleTag} opensourcemano/${moduleName}:${dockerTag}"
566 sh "docker push opensourcemano/${moduleName}:${dockerTag}"
570 parallel parallelSteps
573 stage("Snap promotion") {
574 def snaps = ["osmclient"]
575 sh "snapcraft login --with ~/.snapcraft/config"
576 for (snap in snaps) {
578 if (BRANCH_NAME.startsWith("v")) {
579 channel=BRANCH_NAME.substring(1)+"/"
580 } else if (BRANCH_NAME!="master") {
581 channel+="/"+BRANCH_NAME.replaceAll('/','-')
583 track=channel+"edge\\*"
584 edge_rev=sh(returnStdout: true,
585 script: "snapcraft revisions $snap | " +
586 "grep \"$track\" | tail -1 | awk '{print \$1}'").trim()
587 print "edge rev is $edge_rev"
588 track=channel+"beta\\*"
589 beta_rev=sh(returnStdout: true,
590 script: "snapcraft revisions $snap | " +
591 "grep \"$track\" | tail -1 | awk '{print \$1}'").trim()
592 print "beta rev is $beta_rev"
594 if ( edge_rev != beta_rev ) {
595 print "Promoting $edge_rev to beta in place of $beta_rev"
596 beta_track=channel+"beta"
597 sh "snapcraft release $snap $edge_rev $beta_track"
600 } // stage("Snap promotion")
601 } // if ( params.DO_DOCKERPUSH )
602 } // stage("Archive")
603 } // if ( params.SAVE_ARTIFACTS_OVERRIDE || stage_archive )
606 if ( params.DO_INSTALL && server_id != null) {
608 if (error && params.SAVE_CONTAINER_ON_FAIL ) {
611 if (!error && params.SAVE_CONTAINER_ON_PASS ) {
616 if (server_id != null) {
617 println("Deleting VM: $server_id")
619 for line in `grep OS ~/hive/robot-systest.cfg | grep -v OS_CLOUD` ; do export \$line ; done
620 openstack server delete ${server_id}
623 println("Saved VM $server_id in ETSI VIM")
627 if ( http_server_name != null ) {
628 sh "docker stop ${http_server_name} || true"
629 sh "docker rm ${http_server_name} || true"
632 if ( devopstempdir != null ) {
633 sh "rm -rf ${devopstempdir}"