jjb/integration/integration-macros.yaml

   1 ---
   2 # TODO: Make all bash constants more readable.
   3 # e.g.: DISTRIBUTION_BRANCH instead of DISTROBRANCH.
   4 - parameter:
   5     name: integration-distribution-branch
   6     parameters:
   7       - string:
   8           name: DISTROBRANCH
   9           default: '{branch}'
  10           description: 'Distribution GIT branch'
  11
  12 - parameter:
  13     name: integration-bundleurl
  14     parameters:
  15       - string:
  16           name: BUNDLEURL
  17           default: '{bundleurl}'
  18           description: 'URL to karaf distribution zip'
  19
  20 - parameter:
  21     name: integration-jdk-version
  22     parameters:
  23       - string:
  24           name: JDKVERSION
  25           default: '{jdkversion}'
  26           description: 'Parameter to indicate JAVA Version'
  27
  28 - parameter:
  29     name: integration-controller-scope
  30     parameters:
  31       - string:
  32           name: CONTROLLERSCOPE
  33           default: '{controller-scope}'
  34           description: 'Feature Only or Feature All test'
  35
  36 - parameter:
  37     name: integration-controller-features
  38     parameters:
  39       - string:
  40           name: CONTROLLERFEATURES
  41           default: '{controller-features}'
  42           description: 'Features to install in the controller separated by comma'
  43
  44 - parameter:
  45     name: integration-distribution-stream
  46     parameters:
  47       - string:
  48           name: DISTROSTREAM
  49           default: '{stream}'
  50           description: 'Distribution stream string, for suites to know which behavior to expect'
  51
  52 - parameter:
  53     name: integration-stream-test-plan
  54     parameters:
  55       - string:
  56           name: STREAMTESTPLAN
  57           default: '{stream-test-plan}'
  58           description: 'Stream-specific test plan we will run'
  59
  60 - parameter:
  61     name: integration-test-plan
  62     parameters:
  63       - string:
  64           name: TESTPLAN
  65           default: '{test-plan}'
  66           description: 'General test plan we will run unless stream-specific one is found'
  67
  68 - parameter:
  69     name: integration-test-options
  70     parameters:
  71       - string:
  72           name: TESTOPTIONS
  73           default: '{test-options}'
  74           description: 'Robot command options'
  75
  76 - parameter:
  77     name: integration-distribution-git-url
  78     parameters:
  79       - string:
  80           name: DISTROGITURL
  81           default: '{git-url}/integration/distribution'
  82           description: 'Distribution GIT URL (do not modify)'
  83
  84 - parameter:
  85     name: integration-patch-refspec
  86     parameters:
  87       - string:
  88           name: PATCHREFSPEC
  89           default: '{branch}'
  90           description: 'Integration Patch Refspec'
  91
  92 # Macro: integration-gerrit-scm
  93 # Operation: this macro downloads a project gerrit
  94 # Used by: all csit jobs
  95
  96 - scm:
  97     name: integration-gerrit-scm
  98     scm:
  99       - git:
 100           credentials-id: 'opendaylight-jenkins-ssh'
 101           url: '$GIT_BASE'
 102           basedir: '{basedir}'
 103           refspec: '{refspec}'
 104           branches:
 105             - 'origin/{branch}'
 106           skip-tag: true
 107           choosing-strategy: 'gerrit'
 108
 109 # Macro: integration-distribution-scm
 110 # Operation: this macro downloads the integration/distribution repo using distribution as basedir
 111 # Used by: integration-patch-test-{stream} job template
 112
 113 - scm:
 114     name: integration-distribution-scm
 115     scm:
 116       - git:
 117           credentials-id: 'opendaylight-jenkins-ssh'
 118           basedir: 'distribution'
 119           url: '$DISTROGITURL'
 120           refspec: ''
 121           branches:
 122             - 'origin/{branch}'
 123           skip-tag: true
 124
 125 # Macro: integration-trigger-patch-submitted
 126 # This is a single macro to use for all csit jobs who vote on every (relevant) patch set.
 127 # Only 'recheck' trigger word is supported, it always triggers the full set of relevant jobs,
 128 # in order to prevent Jenkins from starting only a subset and still voting Verified+1.
 129 # Contrary to gerrit-trigger-patch-submitted, this votes +1 also on unstable runs.
 130 # Arguments:
 131 #     server: name of gerrit server to listen to
 132 #     project: pattern to match triggering projects
 133 #     branch: triggering branch name
 134 #     files: pattern to match triggering filepaths
 135 - trigger:
 136     name: integration-trigger-patch-submitted
 137     triggers:
 138       - gerrit:
 139           server-name: '{server}'
 140           trigger-on:
 141             - patchset-created-event:
 142                 exclude-drafts: 'true'
 143                 exclude-trivial-rebase: 'false'
 144                 exclude-no-code-change: 'true'
 145             - draft-published-event
 146             - comment-added-contains-event:
 147                 comment-contains-value: 'recheck'
 148           override-votes: true
 149           gerrit-build-unstable-verified-value: +1
 150           gerrit-build-unstable-codereview-value: 0
 151           projects:
 152             - project-compare-type: 'ANT'
 153               project-pattern: '{project}'
 154               branches:
 155                 - branch-compare-type: 'ANT'
 156                   branch-pattern: '**/{branch}'
 157               file-paths:
 158                 - compare-type: 'ANT'
 159                   pattern: '{files}'
 160
 161 # Macro: integration-openstack-controller-mininet
 162 # Operation: this macro will spin the controller and mininet vms
 163 # Used by: {project}-csit-* job templates
 164
 165 - wrapper:
 166     name: integration-openstack-controller-mininet
 167     wrappers:
 168       - openstack:
 169           instances:
 170             - cloud-name: 'ODLRPC'
 171               template-name: '{controller-image}'
 172               count: '{controller-vms}'
 173             - cloud-name: 'ODLRPC'
 174               template-name: '{mininet-image}'
 175               count: '{mininet-vms}'
 176
 177 # Macro: integration-openstack-controller-devstack
 178 # Operation: this macro will spin the controller and devstack vms
 179 # Used by: {project}-csit-openstack job templates
 180 - wrapper:
 181     name: integration-openstack-controller-devstack
 182     wrappers:
 183       - openstack:
 184           instances:
 185             - cloud-name: 'ODLRPC'
 186               template-name: '{controller-image}'
 187               count: '{controller-vms}'
 188             - cloud-name: 'ODLRPC'
 189               template-name: '{openstack-image}'
 190               count: '{openstack-vms}'
 191
 192 #################
 193 # Shell Scripts #
 194 #################
 195
 196 # Macro: integration-infra-stack
 197 # Operation: Sets environment and then calls opendaylight-infra-stack to spin
 198 #            up csit lab using openstack-heat.
 199 # Used by: {project}-csit-* job templates
 200
 201 - builder:
 202     name: integration-infra-stack
 203     builders:
 204       - integration-cleanup-workspace
 205       - shell: |
 206           #!/bin/bash
 207           # Setup openstack envirnoment file for use by
 208           # the opendaylight-infra-stack macro
 209           cat > $WORKSPACE/opendaylight-infra-environment.yaml << EOF
 210           parameters:
 211               vm_0_count: {vm_0_count}
 212               vm_0_flavor: {vm_0_flavor}
 213               vm_0_image: {vm_0_image}
 214               vm_1_count: {vm_1_count}
 215               vm_1_flavor: {vm_1_flavor}
 216               vm_1_image: {vm_1_image}
 217           EOF
 218           echo "Contents of opendaylight-infra-environment.yaml ..."
 219           cat $WORKSPACE/opendaylight-infra-environment.yaml
 220       - opendaylight-infra-stack:
 221           stack-template: '{stack-template}'
 222
 223 # Macro: integration-infra-stack-3-type
 224 # Operation: Sets environment and then calls opendaylight-infra-stack to spin
 225 #            up csit lab using openstack-heat.
 226 # Used by: {project}-csit-* job templates
 227
 228 - builder:
 229     name: integration-infra-stack-3-type
 230     builders:
 231       - integration-cleanup-workspace
 232       - shell: |
 233           #!/bin/bash
 234           # Setup openstack envirnoment file for use by
 235           # the opendaylight-infra-stack macro
 236           cat > $WORKSPACE/opendaylight-infra-environment.yaml << EOF
 237           parameters:
 238               vm_0_count: {vm_0_count}
 239               vm_0_flavor: {vm_0_flavor}
 240               vm_0_image: {vm_0_image}
 241               vm_1_count: {vm_1_count}
 242               vm_1_flavor: {vm_1_flavor}
 243               vm_1_image: {vm_1_image}
 244               vm_2_count: {vm_2_count}
 245               vm_2_flavor: {vm_2_flavor}
 246               vm_2_image: {vm_2_image}
 247           EOF
 248           echo "Contents of opendaylight-infra-environment.yaml ..."
 249           cat $WORKSPACE/opendaylight-infra-environment.yaml
 250       - opendaylight-infra-stack:
 251           stack-template: 'csit-3-instance-type.yaml'
 252
 253 # Macro: integration-get-slave-addresses
 254 # Operation: this macro gets the IP addresses of the dynamic vms
 255 # Used by: {project}-csit-* job templates
 256
 257 - builder:
 258     name: integration-get-slave-addresses
 259     builders:
 260       - shell: !include-raw: include-raw-integration-get-slave-addresses.sh
 261
 262 # Macro: integration-get-bundle-vars
 263 # Operation: this macro gets all bundle related variables
 264 # Used by: {project}-csit-3node-* job templates
 265
 266 - builder:
 267     name: integration-get-bundle-vars
 268     builders:
 269       - shell: !include-raw: include-raw-integration-get-bundle-vars.sh
 270
 271 # Macro: integration-distribution-check
 272 # Operation: this macro deploys the controller with all fetures
 273 # Used by: {project}-distribution-check-{stream} job template
 274
 275 - builder:
 276     name: integration-distribution-check
 277     builders:
 278       - shell: !include-raw: include-raw-integration-distribution-check.sh
 279
 280 # Macro: integration-deploy-controller-verify
 281 # Operation: this macro deploys the controller with all fetures
 282 # Used by: distribution-deploy-{stream} job template
 283
 284 - builder:
 285     name: integration-deploy-controller-verify
 286     builders:
 287       - shell: !include-raw: include-raw-integration-deploy-controller-verify.sh
 288
 289 # Macro: integration-deploy-controller-offline
 290 # Operation: this macro deploys the controller with no external repo configuration
 291 # Used by: integration-distrbution-offline-{stream} job template
 292
 293 - builder:
 294     name: integration-deploy-controller-offline
 295     builders:
 296       - shell: !include-raw: include-raw-integration-deploy-controller-offline.sh
 297
 298 # Macro: integration-deply-controller-run-test
 299 # Operation: this macro deploys single contoller and runs test
 300 # Used by: {project}-csit-1node-* job templates
 301
 302 - builder:
 303     name: integration-deploy-controller-run-test
 304     builders:
 305       - shell: !include-raw: include-raw-integration-deploy-controller-run-test.sh
 306
 307 # Macro: integration-configure-clustering
 308 # Operation: this macro configures the clustering
 309 # Used by: {project}-csit-3node-* job templates
 310
 311 - builder:
 312     name: integration-configure-clustering
 313     builders:
 314       - shell: !include-raw: include-raw-integration-configure-clustering.sh
 315
 316 # Macro: integration-start-cluster-run-test
 317 # Operation: this macro starts the 3-node cluster and runs test
 318 # Used by: {project}-csit-3node-* job templates
 319
 320 - builder:
 321     name: integration-start-cluster-run-test
 322     builders:
 323       - shell: !include-raw: include-raw-integration-start-cluster-run-test.sh
 324
 325 # Macro: integration-get-bundle-url
 326 # Operation: this macro gets the job generated distribution URL from distribution pom.xml
 327 # Used by: integration-patch-test-{stream} job template
 328
 329 - builder:
 330     name: integration-get-bundle-url
 331     builders:
 332       - shell: !include-raw: include-raw-integration-get-bundle-url.sh
 333
 334 # Macro: integration-get-bundle-url-root
 335 # Operation: this macro gets the job generated distribution URL from root pom.xml
 336 # Used by: distribution-verify-{stream} job template
 337
 338 - builder:
 339     name: integration-get-bundle-url-root
 340     builders:
 341       - shell: !include-raw: include-raw-integration-get-bundle-url-root.sh
 342
 343 # Macro: integration-install-robotframework
 344 # Operation: Installs robotframework using pip to a virtualenv
 345 # Used by: {project}-csit-* job templates
 346
 347 - builder:
 348     name: integration-install-robotframework
 349     builders:
 350       - shell: !include-raw: include-raw-integration-install-robotframework.sh
 351
 352 # Macro: integration-cleanup-tmp
 353 # Operation: Cleans up temporary files created by build
 354 # Used by: {project}-csit-* job templates
 355
 356 - builder:
 357     name: integration-cleanup-tmp
 358     builders:
 359       - shell: !include-raw: include-raw-integration-cleanup-tmp.sh
 360
 361 # Macro: integration-multipatch-builder
 362 # Operation: checks out multiple patches and builds custom distribution
 363 # Used by: integration-multipatch-test-* job templates
 364
 365 - builder:
 366     name: integration-multipatch-builder
 367     builders:
 368       - shell: !include-raw: include-raw-integration-multipatch-distribution-test.sh
 369
 370 # Macro: integration-cleanup-workspace
 371 # Operation: Cleans up files possibly left there by the previous build
 372 # Used by: {project}-csit-* job templates
 373
 374 - builder:
 375     name: integration-cleanup-workspace
 376     builders:
 377       - shell: !include-raw: include-raw-integration-cleanup-workspace.sh
 378
 379 # Macro: integration-rebase-patch
 380 # Operation: For cloned project, rebase checked-out Gerrit patch onto $DISTROBRANCH.
 381 # Used by: integration-patch-distribution-* job template
 382
 383 - builder:
 384     name: integration-rebase-gerrit-patch
 385     builders:
 386       - shell: !include-raw: include-raw-integration-rebase-gerrit-patch.sh
 387
 388 - builder:
 389     name: integration-deploy-openstack-run-test
 390     builders:
 391       - shell: !include-raw: include-raw-integration-deploy-openstack-run-test.sh
 392
 393 # Macro: integration-list-jobs
 394 # Operation: queries Jenkins jobs from jenkins.opendaylight.org and
 395 #   writes a list of the jobs corresponding to the search terms to a file.
 396 # Used by: builder-merge job template
 397 #
 398 # This script requires the following JJB variables to be passed in:
 399 #   {search_string}     Job type to act as a primary filter (e.g. csit)
 400 #   {blacklist}         List of sub-projects to filter out (e.g. longevity)
 401 #   {stream}            Development release name (e.g. boron)
 402 #   {jobs-filename}     Filename to write list into (e.g. carbon-jobs.lst)
 403 # NOTE: Requires xmlstarlet installed on node.
 404
 405 - builder:
 406     name: integration-list-jobs
 407     builders:
 408       - shell: !include-raw: include-raw-integration-list-jobs.sh
 409
 410 # Macro: integration-replace-block-text
 411 # Operation: using starting and ending regex to
 412 # replace a block of text in a file with the text in
 413 # another file. Regex should be basic and work with sed
 414 # Used by: builder-merge job template
 415 #
 416 # This script requires the following JJB variables to be passed in:
 417 #   {starting-regex}
 418 #   {ending-regex}
 419 #   {file-with-changes-to-insert}
 420 #   {file-to-change}
 421
 422 - builder:
 423     name: integration-replace-block-text
 424     builders:
 425       - shell: !include-raw: include-raw-integration-replace-block-text.sh
 426
 427 # Macro: integration-compare-distributions
 428 # Operation: will compare an already created distribtion (probably last
 429 # published to nexus) to the current distribution being created.
 430 # The comparison is done to find the list of patches that are new to the
 431 # current distribtion.
 432 # Used by: builder-merge job template
 433 #
 434 # This script requires the bundle vars that are created by the
 435 # get-bundle-vars macro script
 436
 437
 438 - builder:
 439     name: integration-compare-distributions
 440     builders:
 441       - shell: !include-raw: include-raw-integration-compare-distributions.sh
 442
 443 ##############
 444 # Publishers #
 445 ##############
 446
 447 # Macro: integration-robot
 448 # Operation: this macro publishes robot results
 449 # Used by: {project}-csit-* job templates
 450
 451 - publisher:
 452     name: integration-robot
 453     publishers:
 454       - robot:
 455           output-path: ''
 456           other-files: ''
 457           unstable-threshold: '{unstable-if}'
 458           pass-threshold: '{pass-if}'
 459           only-critical: false
 460
 461 - publisher:
 462     name: integration-robot-tempest
 463     publishers:
 464       - robot:
 465           output-path: ''
 466           other-files:
 467             - tempest_results.html
 468           unstable-threshold: '{unstable-if}'
 469           pass-threshold: '{pass-if}'
 470           only-critical: false
 471
 472 - publisher:
 473     name: integration-csit-archive-build
 474     publishers:
 475       - postbuildscript:
 476           builders:
 477             - shell: |
 478                 #!/bin/bash
 479                 mkdir -p $WORKSPACE/archives
 480                 curl --output robot-plugin.zip "$BUILD_URL/robot/report/*zip*/robot-plugin.zip"
 481                 unzip -d $WORKSPACE/archives robot-plugin.zip
 482                 mv *log* *.log *.log.gz *.csv *.png $WORKSPACE/archives || true  # Don't fail if file missing
 483           script-only-if-succeeded: 'False'
 484           script-only-if-failed: 'False'
 485           mark-unstable-if-failed: 'True'