jjb/lf-macros.yaml

   1 ---
   2 ############
   3 # BUILDERS #
   4 ############
   5
   6 # To take advantage of this macro, have your build write
   7 # out the file 'gerrit_comment.txt' with information to post
   8 # back to gerrit and include this macro in the list of builders.
   9 - builder:
  10     name: comment-to-gerrit
  11     builders:
  12       - shell: !include-raw: ../shell/comment-to-gerrit.sh
  13
  14 - builder:
  15     name: lf-fetch-dependent-patches
  16     builders:
  17       - shell: !include-raw: ../shell/gerrit-fetch-dependencies.sh
  18       - inject:
  19           properties-file: $WORKSPACE/.dependency.properties
  20
  21 - builder:
  22     name: lf-license-check
  23     builders:
  24       - inject:
  25           properties-content: |
  26             FILE_PATTERNS={file-patterns}
  27             SPDX_DISABLE={spdx-disable}
  28             LHC_VERSION={lhc-version}
  29             LICENSE_EXCLUDE_PATHS={license-exclude-paths}
  30             LICENSES_ALLOWED={licenses-allowed}
  31       - shell: !include-raw-escape:
  32           - ../shell/license-check.sh
  33
  34 - builder:
  35     name: lf-infra-create-netrc
  36     builders:
  37       - inject:
  38           properties-content: "SERVER_ID={server-id}"
  39       - shell: !include-raw-escape: ../shell/create-netrc.sh
  40
  41 - builder:
  42     name: lf-infra-docker-login
  43     builders:
  44       - lf-provide-maven-settings:
  45           global-settings-file: "{global-settings-file}"
  46           settings-file: "{settings-file}"
  47       - shell: !include-raw-escape: ../shell/docker-login.sh
  48       - lf-provide-maven-settings-cleanup
  49
  50 - builder:
  51     name: lf-infra-gpg-verify-git-signature
  52     # TODO: Verify signature after downloading users public key from a locally
  53     # created repository instead of the public keymesh. This requires a process
  54     # in place to get ODL developers public keys into a local repository without
  55     # increasing the job thoughput.
  56     builders:
  57       - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
  58
  59 - builder:
  60     name: lf-infra-pre-build
  61     builders:
  62       - shell: !include-raw-escape: ../shell/python-tools-install.sh
  63
  64 - builder:
  65     name: lf-infra-ship-logs
  66     builders:
  67       # Ensure no pre-existing .netrc files are overriding logs config
  68       - lf-provide-maven-settings-cleanup
  69       - config-file-provider:
  70           files:
  71             - file-id: "jenkins-log-archives-settings"
  72               variable: "SETTINGS_FILE"
  73       - lf-infra-create-netrc:
  74           server-id: logs
  75       - shell: !include-raw:
  76           # Ensure python-tools are installed in case job template does not
  77           # call the lf-infra-pre-build macro.
  78           - ../shell/python-tools-install.sh
  79       - shell: !include-raw:
  80           - ../shell/logs-deploy.sh
  81       - shell: !include-raw:
  82           - ../shell/logs-clear-credentials.sh
  83       - description-setter:
  84           regexp: "^Build logs: .*"
  85
  86 - builder:
  87     name: lf-infra-package-listing
  88     builders:
  89       - shell: !include-raw:
  90           - ../shell/package-listing.sh
  91
  92 - builder:
  93     name: lf-infra-packer-build
  94     builders:
  95       - conditional-step:
  96           condition-kind: boolean-expression
  97           condition-expression: "{openstack}"
  98           steps:
  99             - config-file-provider:
 100                 files:
 101                   - file-id: clouds-yaml
 102                     target: "$HOME/.config/openstack/clouds.yaml"
 103             - inject:
 104                 properties-content: OS_CLOUD={openstack-cloud}
 105       - config-file-provider:
 106           files:
 107             - file-id: "{packer-cloud-settings}"
 108               variable: CLOUDENV
 109       - inject:
 110           properties-content: |
 111             PACKER_PLATFORM={platform}
 112             PACKER_TEMPLATE={template}
 113             PACKER_VERSION={packer-version}
 114       - shell: !include-raw-escape:
 115           - ../shell/packer-install.sh
 116           - ../shell/packer-build.sh
 117       - shell: !include-raw:
 118           - ../shell/packer-clear-credentials.sh
 119
 120 - builder:
 121     name: lf-infra-packer-validate
 122     builders:
 123       - conditional-step:
 124           condition-kind: boolean-expression
 125           condition-expression: "{openstack}"
 126           steps:
 127             - config-file-provider:
 128                 files:
 129                   - file-id: clouds-yaml
 130                     target: "$HOME/.config/openstack/clouds.yaml"
 131             - inject:
 132                 properties-content: OS_CLOUD={openstack-cloud}
 133       - config-file-provider:
 134           files:
 135             - file-id: "{packer-cloud-settings}"
 136               variable: CLOUDENV
 137       - inject:
 138           properties-content: |
 139             PACKER_VERSION={packer-version}
 140       - shell: !include-raw-escape:
 141           - ../shell/packer-install.sh
 142           - ../shell/packer-validate.sh
 143       - shell: !include-raw:
 144           - ../shell/packer-clear-credentials.sh
 145
 146 - builder:
 147     name: lf-infra-push-gerrit-patch
 148     builders:
 149       - inject:
 150           properties-content: |
 151             PROJECT={project}
 152             GERRIT_COMMIT_MESSAGE={gerrit-commit-message}
 153             GERRIT_HOST={gerrit-host}
 154             GERRIT_TOPIC={gerrit-topic}
 155             GERRIT_USER={gerrit-user}
 156             REVIEWERS_EMAIL={reviewers-email}
 157       - shell: !include-raw-escape: ../shell/gerrit-push-patch.sh
 158
 159 - builder:
 160     name: lf-infra-sysstat
 161     builders:
 162       - shell: !include-raw:
 163           - ../shell/sysstat.sh
 164
 165 - builder:
 166     name: lf-jacoco-nojava-workaround
 167     builders:
 168       - shell: "mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes"
 169
 170 - builder:
 171     name: lf-infra-deploy-maven-file
 172     builders:
 173       - lf-maven-install:
 174           mvn-version: "{mvn-version}"
 175       - lf-provide-maven-settings:
 176           global-settings-file: "{global-settings-file}"
 177           settings-file: "{settings-file}"
 178       - inject:
 179           properties-content: |
 180             MAVEN_REPO_URL={maven-repo-url}
 181             REPO_ID={repo-id}
 182             GROUP_ID={group-id}
 183             UPLOAD_FILES_PATH={upload-files-dir}
 184       - shell: !include-raw-escape:
 185           - ../shell/common-variables.sh
 186           - ../shell/deploy-maven-file.sh
 187       - lf-provide-maven-settings-cleanup
 188
 189 - builder:
 190     name: lf-maven-central
 191     builders:
 192       - conditional-step:
 193           condition-kind: boolean-expression
 194           condition-expression: "{mvn-central}"
 195           steps:
 196             - lf-provide-maven-settings:
 197                 global-settings-file: "{mvn-global-settings}"
 198                 settings-file: "{mvn-settings}"
 199             - lf-infra-create-netrc:
 200                 server-id: "ossrh"
 201             - inject:
 202                 properties-content: "OSSRH_PROFILE_ID={ossrh-profile-id}"
 203             - shell: !include-raw-escape: ../shell/maven-central.sh
 204             - lf-provide-maven-settings-cleanup
 205
 206 - builder:
 207     name: lf-maven-install
 208     builders:
 209       # Create a $HOME/.wgetrc to make the Maven download quiet.
 210       - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
 211       - maven-target:
 212           maven-version: "{mvn-version}"
 213           goals: "--version"
 214       - shell: 'rm "$HOME/.wgetrc"'
 215
 216 - builder:
 217     name: lf-provide-maven-settings
 218     builders:
 219       - config-file-provider:
 220           files:
 221             - file-id: "{global-settings-file}"
 222               variable: "GLOBAL_SETTINGS_FILE"
 223             - file-id: "{settings-file}"
 224               variable: "SETTINGS_FILE"
 225
 226 - builder:
 227     name: lf-pip-install
 228     builders:
 229       - inject:
 230           properties-content: PIP_PACKAGES={pip-packages}
 231       - shell: !include-raw-escape: ../shell/pip-install.sh
 232
 233 - builder:
 234     name: lf-provide-maven-settings-cleanup
 235     builders:
 236       - shell: |
 237           #!/bin/bash
 238           set +e  # DO NOT cause build failure if any of the rm calls fail.
 239
 240           rm -f "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
 241
 242           # In some cases we use the lf-provide-maven-settings macro to produce
 243           # a "$HOME/.netrc" file containing credentials. Remove that file here
 244           # too if it exists.
 245           rm -f "$HOME/.netrc"
 246
 247           # DO NOT fail build if any of the above lines fail.
 248           exit 0
 249
 250 - builder:
 251     name: lf-rtd-trigger-build
 252     builders:
 253       - inject:
 254           properties-content: |
 255             RTD_BUILD_URL={rtd-build-url}
 256             RTD_TOKEN={rtd-token}
 257       - shell: !include-raw-escape: ../shell/rtd-trigger-build.sh
 258
 259 - builder:
 260     name: lf-rtd-verify
 261     builders:
 262       - inject:
 263           properties-content: DOC_DIR={doc-dir}
 264       - shell: !include-raw-escape: ../shell/tox-install.sh
 265       - shell: !include-raw-escape: ../shell/rtd-verify.sh
 266
 267 - builder:
 268     name: check-info-votes
 269     builders:
 270       - inject:
 271           properties-content: JENKINS_SSH_CREDENTIAL={jenkins-ssh-credential}
 272       - shell: !include-raw-escape: ../shell/check-info-votes.sh
 273
 274 - builder:
 275     name: lf-release
 276     builders:
 277       - config-file-provider:
 278           files:
 279             - file-id: lftoolsini
 280               target: "$HOME/.config/lftools/lftools.ini"
 281       - shell: !include-raw: ../shell/release-job.sh
 282
 283 - builder:
 284     name: lf-sigul-sign-dir
 285     # Requires that Jenkins be configured with SIGUL_BRIDGE_IP as a global
 286     # Environment variable
 287     builders:
 288       - conditional-step:
 289           condition-kind: boolean-expression
 290           condition-expression: "{sign-artifacts}"
 291           steps:
 292             - config-file-provider:
 293                 files:
 294                   - file-id: sigul-config
 295                     variable: SIGUL_CONFIG
 296                   - file-id: sigul-password
 297                     variable: SIGUL_PASSWORD
 298                   - file-id: sigul-pki
 299                     variable: SIGUL_PKI
 300             - shell: !include-raw-escape: ../shell/sigul-configuration.sh
 301             - shell: !include-raw-escape: ../shell/sigul-install.sh
 302             - inject:
 303                 properties-content: |
 304                   SIGN_DIR={sign-dir}
 305                   SIGN_MODE={sign-mode}
 306             - shell: !include-raw-escape:
 307                 - ../shell/sigul-sign-dir.sh
 308             - shell: !include-raw-escape: ../shell/sigul-configuration-cleanup.sh
 309
 310 - builder:
 311     name: lf-infra-provide-docker-cleanup
 312     builders:
 313       - shell: |
 314           #!/bin/bash
 315           set +e  # DO NOT cause build failure if docker rmi fails
 316           docker rmi -f $(docker images -a -q)
 317           exit 0
 318
 319 - builder:
 320     name: lf-infra-sonar
 321     # Run a Sonar Jenkins Plugin
 322     builders:
 323       - sonar:
 324           sonar-name: Sonar
 325           scanner-name: SonarQubeScanner
 326           task: "{sonar-task}"
 327           project: "sonar-project.properties"
 328           properties: "{sonar-properties}"
 329           java-opts: "{sonar-java-opts}"
 330           additional-arguments: "{sonar-additional-args}"
 331
 332 - builder:
 333     name: lf-infra-sonar-with-prescan
 334     # Run a Sonar Jenkins Plugin
 335     builders:
 336       - lf-sonar-prescan # Must be defined by caller
 337       - sonar:
 338           sonar-name: Sonar
 339           scanner-name: SonarQubeScanner
 340           task: "{sonar-task}"
 341           project: "sonar-project.properties"
 342           properties: "{sonar-properties}"
 343           java-opts: "{sonar-java-opts}"
 344           additional-arguments: "{sonar-additional-args}"
 345
 346 ##############
 347 # PARAMETERS #
 348 ##############
 349
 350 - parameter:
 351     name: lf-clm-parameters
 352     parameters:
 353       - string:
 354           name: NEXUS_IQ_STAGE
 355           default: "{nexus-iq-stage}"
 356           description: |
 357             Stage the policy evaluation will be run against on the Nexus IQ Server.
 358
 359 - parameter:
 360     name: lf-cmake-parameters
 361     # Parameters useful in CMake builds.
 362     parameters:
 363       - string:
 364           name: BUILD_DIR
 365           default: "{build-dir}"
 366           description: "Directory to build the project in."
 367       - string:
 368           name: CMAKE_OPTS
 369           default: "{cmake-opts}"
 370           description: |
 371             Options to pass to CMAKE.
 372             Example: -DCMAKE_INSTALL_PREFIX=$WORKSPACE/target/output
 373       - string:
 374           name: INSTALL_PREFIX
 375           default: "{install-prefix}"
 376           description: "Install prefix for C/C++ builds. Example: /usr/local"
 377       - string:
 378           name: MAKE_OPTS
 379           default: "{make-opts}"
 380           description: "Options to pass to make. Example: -j8"
 381
 382 - parameter:
 383     name: lf-infra-maven-parameters
 384     parameters:
 385       - string:
 386           name: M2_HOME
 387           # Sets an env var for shell scripts to be able to call the dynamically
 388           # installed maven without having to calculate the M2_HOME themselves.
 389           default: "/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}"
 390           description: "Maven selector to be used by shell scripts"
 391       - string:
 392           name: MAVEN_OPTS
 393           default: "{mvn-opts}"
 394           description: |
 395             Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
 396       - string:
 397           name: MAVEN_PARAMS
 398           default: "{mvn-params}"
 399           description: |
 400             Maven parameters to pass to the mvn command.
 401       - string:
 402           name: MVN
 403           # Sets an env var for shell scripts to be able to call the dynamically
 404           # installed maven without having to calculate the path themselves.
 405           # yamllint disable-line rule:line-length
 406           default: "/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn"
 407           description: "Maven selector to be used by shell scripts"
 408
 409 - parameter:
 410     name: lf-infra-openstack-parameters
 411     parameters:
 412       - string:
 413           name: OS_CLOUD
 414           default: "{os-cloud}"
 415           description: |
 416             The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
 417             variable name that is significant to openstack client as a
 418             environment variable. Please refer to the documentation for
 419             further details.
 420             https://docs.openstack.org/developer/python-openstackclient/
 421
 422 - parameter:
 423     name: lf-infra-parameters
 424     # Standard parameters used in the LF CI environments. Gerrit variables are
 425     # not used by GitHub projects, but defining them isn't harmful.
 426     parameters:
 427       - string:
 428           name: PROJECT
 429           default: "{project}"
 430           description: |
 431             Parameter to identify a SCM project to build. This is typically
 432             the project repo path. For example: ofextensions/circuitsw
 433       - string:
 434           name: STREAM
 435           default: "{stream}"
 436           description: |
 437             Stream is often set to the same name as 'branch' but can
 438             sometimes be used as a name representing a project's release code
 439             name.
 440       - string:
 441           name: GERRIT_PROJECT
 442           default: "{project}"
 443           description: |
 444             Gerrit Trigger provided parameter to identify Gerrit project that
 445             triggered the build. This is typically the project repo path as
 446             exists in Gerrit. For example: ofextensions/circuitsw
 447
 448             If using Gerrit, in a manual build this should match the PROJECT
 449             parameter above.
 450       - string:
 451           name: GERRIT_BRANCH
 452           default: "{branch}"
 453           description: |
 454             Gerrit Trigger provided parameter to identify a Gerrit branch.
 455
 456             If using Gerrit, in a manual build override with the branch to
 457             build against.
 458       - string:
 459           name: GERRIT_REFSPEC
 460           default: "refs/heads/{branch}"
 461           description: |
 462             Gerrit Trigger provided parameter to identify a refspec to fetch
 463             from Gerrit.
 464
 465             If using Gerrit, in a manual build override with a refspec.
 466             https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
 467             For example: 'refs/heads/master'
 468       - string:
 469           name: sha1
 470           default: "origin/{branch}"
 471           description: |
 472             GitHub PR Trigger provided parameter for specifying the commit
 473             to checkout.
 474
 475             If using GitHub, in a manual build override with a branch path or
 476             sha1 hash to a specific commit. For example: 'origin/master'
 477
 478 - parameter:
 479     name: lf-infra-node-parameters
 480     parameters:
 481       - string:
 482           name: NODE_DIR
 483           default: "{node-dir}"
 484           description: Path to a Node project directory.
 485       - string:
 486           name: NODE_VERSION
 487           default: "{node-version}"
 488           description: Version of NodeJS to install.
 489
 490 - parameter:
 491     name: lf-infra-tox-parameters
 492     parameters:
 493       - string:
 494           name: TOX_DIR
 495           default: "{tox-dir}"
 496           description: |
 497             Path to directory containing tox.ini file.
 498       - string:
 499           name: TOX_ENVS
 500           default: "{tox-envs}"
 501           description: |
 502             Tox environments to run build against.
 503             Example: docs,py2,py3
 504
 505 - parameter:
 506     name: lf-build-with-parameters-maven-release
 507     parameters:
 508       - string:
 509           name: VERSION
 510           default: ""
 511           description: "This is the tag, Example: 1.0.0"
 512       - string:
 513           name: LOG_DIR
 514           default: ""
 515           description: "Log dir, example: project-maven-stage-master/17/"
 516       - string:
 517           name: DISTRIBUTION_TYPE
 518           default: ""
 519           description: "Set to maven for build with parametes"
 520       - bool:
 521           name: USE_RELEASE_FILE
 522           default: "{use-release-file}"
 523           description: "Set to False for job built with parameters"
 524
 525 ##############
 526 # PROPERTIES #
 527 ##############
 528
 529 - property:
 530     name: lf-infra-properties
 531     properties:
 532       - build-discarder:
 533           # Allow build data to be stored at a length configured by the
 534           # downstream project.
 535           days-to-keep: "{build-days-to-keep}"
 536           # Do not allow artifacts to be stored in Jenkins.
 537           artifact-num-to-keep: 0
 538
 539 ##############
 540 # PUBLISHERS #
 541 ##############
 542
 543 - publisher:
 544     name: lf-jacoco-report
 545     publishers:
 546       - jacoco:
 547           exec-pattern: "**/**.exec"
 548           class-pattern: "**/classes"
 549           source-pattern: "**/src/main/java"
 550           # yamllint disable-line rule:line-length
 551           exclusion-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
 552           status-update: true
 553           targets:
 554             - branch:
 555                 healthy: 10
 556                 unhealthy: 20
 557             - method:
 558                 healthy: 50
 559                 unhealthy: 40
 560
 561 - publisher:
 562     name: lf-infra-publish
 563     # lf-infra macro to finish up a build.
 564     #
 565     # Handles the following:
 566     #   - Shipping logs to Nexus logs site repository
 567     #   - Cleanup workspace
 568     publishers:
 569       - postbuildscript:
 570           builders:
 571             - role: BOTH
 572               build-on:
 573                 - ABORTED
 574                 - FAILURE
 575                 - NOT_BUILT
 576                 - SUCCESS
 577                 - UNSTABLE
 578               build-steps:
 579                 - lf-infra-sysstat
 580                 - lf-infra-package-listing
 581                 - lf-infra-ship-logs
 582           mark-unstable-if-failed: true
 583       - workspace-cleanup:
 584           exclude:
 585             # Do not clean up *.jenkins-trigger files for jobs that use a
 586             # properties file as input for triggering another build.
 587             - "**/*.jenkins-trigger"
 588           fail-build: false
 589
 590 - publisher:
 591     name: lf-infra-publish-windows
 592     # lf-infra macro to finish up a build.
 593     #
 594     # Handles the following:
 595     #   - Shipping logs to Nexus logs site repository
 596     #   - Cleanup workspace
 597     publishers:
 598       # TODO: RELENG-1228 Develop log shipping script for Windows systems
 599       # - postbuildscript:
 600       #     builders:
 601       #       - role: BOTH
 602       #         build-on:
 603       #           - ABORTED
 604       #           - FAILURE
 605       #           - NOT_BUILT
 606       #           - SUCCESS
 607       #           - UNSTABLE
 608       #         build-steps:
 609       #           - lf-infra-ship-logs-windows
 610       #     mark-unstable-if-failed: true
 611       - workspace-cleanup:
 612           exclude:
 613             # Do not clean up *.jenkins-trigger files for jobs that use a
 614             # properties file as input for triggering another build.
 615             - "**/*.jenkins-trigger"
 616           fail-build: false
 617
 618 #######
 619 # SCM #
 620 #######
 621
 622 - scm:
 623     name: lf-infra-gerrit-scm
 624     scm:
 625       - git:
 626           credentials-id: "{jenkins-ssh-credential}"
 627           url: "{git-url}"
 628           refspec: "{refspec}"
 629           branches:
 630             - "refs/heads/{branch}"
 631           skip-tag: true
 632           wipe-workspace: true
 633           submodule:
 634             disable: "{submodule-disable}"
 635             recursive: "{submodule-recursive}"
 636             timeout: "{submodule-timeout}"
 637           choosing-strategy: "{choosing-strategy}"
 638
 639 - scm:
 640     name: lf-infra-github-scm
 641     scm:
 642       - git:
 643           credentials-id: "{jenkins-ssh-credential}"
 644           url: "{url}"
 645           refspec: "{refspec}"
 646           branches:
 647             - "{branch}"
 648           skip-tag: true
 649           wipe-workspace: true
 650           submodule:
 651             disable: "{submodule-disable}"
 652             recursive: "{submodule-recursive}"
 653             timeout: "{submodule-timeout}"
 654           choosing-strategy: "{choosing-strategy}"
 655
 656 ############
 657 # WRAPPERS #
 658 ############
 659
 660 - wrapper:
 661     name: lf-infra-wrappers-common
 662     wrappers:
 663       - mask-passwords
 664       - timeout:
 665           type: absolute
 666           timeout: "{build-timeout}"
 667           timeout-var: "BUILD_TIMEOUT"
 668           fail: true
 669       - timestamps
 670       - openstack:
 671           single-use: true
 672
 673 - wrapper:
 674     name: lf-infra-wrappers
 675     wrappers:
 676       - lf-infra-wrappers-common:
 677           build-timeout: "{build-timeout}"
 678       - config-file-provider:
 679           files:
 680             - file-id: npmrc
 681               target: "$HOME/.npmrc"
 682             - file-id: pipconf
 683               target: "$HOME/.config/pip/pip.conf"
 684       - ssh-agent-credentials:
 685           users:
 686             - "{jenkins-ssh-credential}"
 687
 688 - wrapper:
 689     name: lf-infra-wrappers-windows
 690     wrappers:
 691       - lf-infra-wrappers-common:
 692           build-timeout: "{build-timeout}"