jjb/lf-macros.yaml

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