jjb/lf-macros.yaml

   1 ---
   2 ############
   3 # BUILDERS #
   4 ############
   5
   6 - builder:
   7     name: lf-infra-create-netrc
   8     # Macro to create a ~/.netrc file from a Maven settings.xml
   9     # Parameters:
  10     #     {server-id} The id of a server as defined in settings.xml
  11     builders:
  12       - inject:
  13           properties-content: 'SERVER_ID={server-id}'
  14       - shell: !include-raw-escape: ../shell/create-netrc.sh
  15
  16 - builder:
  17     name: lf-infra-docker-login
  18     # Login into a custom hosted docker registry and / or docker.io
  19     #
  20     # The Jenkins system should have the following global variables defined
  21     #
  22     # DOCKER_REGISTRY : Optional
  23     #                   The DNS address of the registry (IP or FQDN)
  24     #                   ex: nexus3.example.com
  25     #
  26     # REGISTRY_PORTS  : Required if DOCKER_REGISTRY is set
  27     #                   Space separated listing of the registry ports to login
  28     #                   to
  29     #                   ex: 10001 10002 10003 10004
  30     #
  31     # DOCKERHUB_EMAIL : Optional
  32     #                   If this variable is set then an attempt to login to
  33     #                   DockerHub (docker.io) will be also made. It should be
  34     #                   set to the email address for the credentials that will
  35     #                   get looked up. Only _one_ credential will ever be found
  36     #                   in the maven settings file for DockerHub
  37     builders:
  38       - lf-provide-maven-settings:
  39           global-settings-file: '{global-settings-file}'
  40           settings-file: '{settings-file}'
  41       - shell: !include-raw-escape: ../shell/docker-login.sh
  42       - lf-provide-maven-settings-cleanup
  43
  44 - builder:
  45     name: lf-infra-gpg-verify-git-signature
  46     # Verify gpg signature of the latest commit message in $WORKSPACE
  47     #
  48     # This command assumes that $WORKSPACE is a git repo.
  49     #
  50     # TODO: Verify signature after downloading users public key from a locally
  51     # created repository instead of the public keymesh. This requires a process
  52     # in place to get ODL developers public keys into a local repository without
  53     # increasing the job thoughput.
  54     builders:
  55       - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
  56
  57 - builder:
  58     name: lf-infra-ship-logs
  59     builders:
  60       - config-file-provider:
  61           files:
  62             - file-id: 'jenkins-log-archives-settings'
  63               variable: 'SETTINGS_FILE'
  64       - lf-infra-create-netrc:
  65           server-id: logs
  66       - shell: !include-raw:
  67           - ../shell/lftools-install.sh
  68           - ../shell/logs-deploy.sh
  69       - shell: !include-raw:
  70           - ../shell/logs-clear-credentials.sh
  71       - description-setter:
  72           regexp: '^Build logs: .*'
  73
  74 - builder:
  75     name: lf-infra-packer-build
  76     builders:
  77       - config-file-provider:
  78           files:
  79             - file-id: '{packer-cloud-settings}'
  80               variable: CLOUDENV
  81       - inject:
  82           properties-content: |
  83               PACKER_PLATFORM={platform}
  84               PACKER_TEMPLATE={template}
  85               PACKER_VERSION={packer-version}
  86       - shell: !include-raw-escape:
  87           - ../shell/packer-install.sh
  88           - ../shell/packer-build.sh
  89       - shell: !include-raw:
  90           - ../shell/packer-clear-credentials.sh
  91
  92 - builder:
  93     name: lf-infra-packer-validate
  94     builders:
  95       - config-file-provider:
  96           files:
  97             - file-id: '{packer-cloud-settings}'
  98               variable: 'CLOUDENV'
  99       - inject:
 100           properties-content: |
 101               PACKER_VERSION={packer-version}
 102       - shell: !include-raw-escape:
 103           - ../shell/packer-install.sh
 104           - ../shell/packer-validate.sh
 105       - shell: !include-raw:
 106           - ../shell/packer-clear-credentials.sh
 107
 108 - builder:
 109     name: lf-infra-sysstat
 110     builders:
 111       - shell: !include-raw:
 112           - ../shell/sysstat.sh
 113
 114 - builder:
 115     name: lf-jacoco-nojava-workaround
 116     builders:
 117       - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
 118
 119 - builder:
 120     name: lf-infra-deploy-maven-file
 121     # Deploy files to a repository.
 122     #
 123     # The builder requires passing the following parameters
 124     # REPO_ID:           Repository ID
 125     # GROUP_ID:          Group ID of the repository
 126     # UPLOAD_FILES_PATH: Path to directory containing one or more files
 127     builders:
 128       - lf-maven-install:
 129           mvn-version: '{mvn-version}'
 130       - lf-provide-maven-settings:
 131           global-settings-file: '{global-settings-file}'
 132           settings-file: '{settings-file}'
 133       - inject:
 134           properties-content: |
 135               MAVEN_REPO_URL={maven-repo-url}
 136               REPO_ID={repo-id}
 137               GROUP_ID={group-id}
 138               UPLOAD_FILES_PATH={upload-files-dir}
 139       - shell: !include-raw-escape:
 140           - ../shell/lftools-install.sh
 141           - ../shell/common-variables.sh
 142           - ../shell/deploy-maven-file.sh
 143       - lf-provide-maven-settings-cleanup
 144
 145 - builder:
 146     name: lf-maven-install
 147     # call maven-target builder with a goal of --version to force Jenkins to
 148     # install the needed maven version
 149     builders:
 150       # Create a $HOME/.wgetrc to make the Maven download quiet.
 151       - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
 152       - maven-target:
 153           maven-version: '{mvn-version}'
 154           goals: '--version'
 155       - shell: 'rm "$HOME/.wgetrc"'
 156
 157 - builder:
 158     name: lf-provide-maven-settings
 159     # Push a global settings and user settings maven files
 160     builders:
 161       - config-file-provider:
 162           files:
 163             - file-id: '{global-settings-file}'
 164               variable: 'GLOBAL_SETTINGS_FILE'
 165             - file-id: '{settings-file}'
 166               variable: 'SETTINGS_FILE'
 167
 168 - builder:
 169     name: lf-pip-install
 170     # Call pip install to install packages into a virtualenv
 171     # The first package listed in PIP_PACKAGES is used as the virtualenv name.
 172     builders:
 173       - inject:
 174           properties-content: PIP_PACKAGES={pip-packages}
 175       - shell: !include-raw-escape: ../shell/pip-install.sh
 176
 177 - builder:
 178     name: lf-provide-maven-settings-cleanup
 179     # Clear maven settings files after we are done using them
 180     builders:
 181       - shell: |
 182           #!/bin/bash
 183           set +e  # DO NOT cause build failure if any of the rm calls fail.
 184
 185           rm "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
 186
 187           # In some cases we use the lf-provide-maven-settings macro to produce
 188           # a "$HOME/.netrc" file containing credentials. Remove that file here
 189           # too if it exists.
 190           rm "$HOME/.netrc"
 191
 192           # DO NOT fail build if any of the above lines fail.
 193           exit 0
 194
 195 ##############
 196 # PARAMETERS #
 197 ##############
 198
 199 - parameter:
 200     name: lf-infra-maven-parameters
 201     parameters:
 202       - string:
 203           name: MAVEN_OPTS
 204           default: '{mvn-opts}'
 205           description: |
 206               Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
 207       - string:
 208           name: MAVEN_PARAMS
 209           default: '{mvn-params}'
 210           description: |
 211               Maven parameters to pass to the mvn command.
 212       - string:
 213           name: MVN
 214           # Sets an env var for shell scripts to be able to call the dynamically
 215           # installed maven without having to calculate the path themselves.
 216           default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
 217           description: 'Maven selector to be used by shell scripts'
 218       - string:
 219           name: STAGING_PROFILE_ID
 220           default: '{staging-profile-id}'
 221           description: |
 222               Nexus staging profile ID.
 223
 224
 225 - parameter:
 226     name: lf-infra-openstack-parameters
 227     parameters:
 228       - string:
 229           name: OS_CLOUD
 230           default: '{os-cloud}'
 231           description: |
 232               The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
 233               variable name that is significant to openstack client as a
 234               environment variable. Please refer to the documentation for
 235               further details.
 236               https://docs.openstack.org/developer/python-openstackclient/
 237
 238
 239 - parameter:
 240     name: lf-infra-parameters
 241     # Standard parameters used in the LF CI environments. Gerrit variables are
 242     # not used by GitHub projects, but defining them isn't harmful.
 243     parameters:
 244       - string:
 245           name: PROJECT
 246           default: '{project}'
 247           description: |
 248               Parameter to identify a Gerrit project. This is typically the
 249               project repo path as exists in Gerrit.
 250               For example: ofextensions/circuitsw
 251       - string:
 252           name: STREAM
 253           default: '{stream}'
 254           description: |
 255               Stream is often set to the same name as 'branch' but can
 256               sometimes be used as a name representing a project's release code
 257               name.
 258       - string:
 259           name: GERRIT_PROJECT
 260           default: '{project}'
 261           description: |
 262               Parameter to identify Gerrit project. This is typically the
 263               project repo path as exists in Gerrit.
 264               For example: ofextensions/circuitsw
 265
 266               Note that Gerrit will override this parameter automatically if a
 267               job is triggered by Gerrit.
 268       - string:
 269           name: GERRIT_BRANCH
 270           default: '{branch}'
 271           description: |
 272               Parameter to identify a Gerrit branch.
 273
 274               Note that Gerrit will override this parameter automatically if a
 275               job is triggered by Gerrit.
 276       - string:
 277           name: GERRIT_REFSPEC
 278           default: 'refs/heads/{branch}'
 279           description: |
 280               Parameter to identify a refspec when pulling from Gerrit.
 281
 282               Note that Gerrit will override this parameter automatically if a
 283               job is triggered by Gerrit.
 284       - string:
 285           name: LFTOOLS_VERSION
 286           default: '{lftools-version}'
 287           description: |
 288               Version of lftools to install. Can be a specific version like
 289               '0.6.0' or a PEP-440 definition.
 290               https://www.python.org/dev/peps/pep-0440/
 291               For example '<1.0.0' or '>=1.0.0,<2.0.0'.
 292
 293 - parameter:
 294     name: lf-infra-tox-parameters
 295     # Useful parameters when working with TOX
 296     # https://tox.readthedocs.io/
 297     parameters:
 298       - string:
 299           name: TOX_DIR
 300           default: '{tox-dir}'
 301           description: |
 302               Path to directory containing tox.ini file.
 303       - string:
 304           name: TOX_ENVS
 305           default: '{tox-envs}'
 306           description: |
 307               Tox environments to run build against.
 308               Example: docs,py2,py3
 309
 310 ##############
 311 # PROPERTIES #
 312 ##############
 313
 314 - property:
 315     name: lf-infra-properties
 316     properties:
 317       - build-discarder:
 318           # Allow build data to be stored at a length configured by the
 319           # downstream project.
 320           days-to-keep: '{build-days-to-keep}'
 321           # Do not allow artifacts to be stored in Jenkins.
 322           artifact-num-to-keep: 0
 323
 324 ##############
 325 # PUBLISHERS #
 326 ##############
 327
 328 - publisher:
 329     name: lf-jacoco-report
 330     publishers:
 331       - jacoco:
 332           exec-pattern: "**/**.exec"
 333           class-pattern: "**/classes"
 334           source-pattern: "**/src/main/java"
 335           exclusion-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
 336           status-update: true
 337           targets:
 338             - branch:
 339                 healthy: 10
 340                 unhealthy: 20
 341             - method:
 342                 healthy: 50
 343                 unhealthy: 40
 344
 345 - publisher:
 346     name: lf-infra-publish
 347     # lf-infra macro to finish up a build.
 348     #
 349     # Handles the following:
 350     #   - Shipping logs to Nexus logs site repository
 351     #   - Cleanup workspace
 352     publishers:
 353       - postbuildscript:
 354           builders:
 355             - lf-infra-sysstat
 356             - lf-infra-ship-logs
 357           script-only-if-succeeded: false
 358           script-only-if-failed: false
 359           mark-unstable-if-failed: false
 360       - workspace-cleanup:
 361           exclude:
 362             # Do not clean up *.jenkins-trigger files for jobs that use a
 363             # properties file as input for triggering another build.
 364             - '**/*.jenkins-trigger'
 365           fail-build: false
 366
 367 #######
 368 # SCM #
 369 #######
 370
 371 - scm:
 372     name: lf-infra-gerrit-scm
 373     scm:
 374       - git:
 375           credentials-id: '{jenkins-ssh-credential}'
 376           url: '{git-url}'
 377           refspec: '{refspec}'
 378           branches:
 379             - 'refs/heads/{branch}'
 380           skip-tag: true
 381           wipe-workspace: true
 382           submodule:
 383             recursive: '{submodule-recursive}'
 384           choosing-strategy: '{choosing-strategy}'
 385
 386 - scm:
 387     name: lf-infra-github-scm
 388     scm:
 389       - git:
 390           credentials-id: '{jenkins-ssh-credential}'
 391           url: '{url}'
 392           refspec: '{refspec}'
 393           skip-tag: true
 394           wipe-workspace: true
 395           submodule:
 396             recursive: '{submodule-recursive}'
 397           choosing-strategy: '{choosing-strategy}'
 398
 399 ############
 400 # TRIGGERS #
 401 ############
 402
 403 - trigger:
 404     name: lf-infra-github-pr-trigger
 405     triggers:
 406       - github-pull-request:
 407           trigger-phrase: '{trigger-phrase}'
 408           only-trigger-phrase: '{only-trigger-phrase}'
 409           status-context: '{status-context}'
 410           permit-all: '{permit-all}'
 411           github-hooks: '{github-hooks}'
 412           auto-close-on-fail: false
 413           org-list:
 414             - '{github-org}'
 415           white-list: '{obj:github_pr_whitelist}'
 416           admin-list: '{obj:github_pr_admin_list}'
 417
 418 ############
 419 # WRAPPERS #
 420 ############
 421
 422 - wrapper:
 423     name: lf-infra-wrappers
 424     wrappers:
 425       - mask-passwords
 426       - timeout:
 427           type: absolute
 428           timeout: '{build-timeout}'
 429           timeout-var: 'BUILD_TIMEOUT'
 430           fail: true
 431       - timestamps
 432       - ssh-agent-credentials:
 433           users:
 434             - '{jenkins-ssh-credential}'
 435       - openstack:
 436           single-use: true