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