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-sysstat
  76     builders:
  77       - shell: !include-raw:
  78           - ../shell/sysstat.sh
  79
  80 - builder:
  81     name: lf-jacoco-nojava-workaround
  82     builders:
  83       - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
  84
  85 - builder:
  86     name: lf-infra-deploy-maven-file
  87     # Deploy files to a repository.
  88     #
  89     # The builder requires passing the following parameters
  90     # REPO_ID:           Repository ID
  91     # GROUP_ID:          Group ID of the repository
  92     # UPLOAD_FILES_PATH: Path to directory containing one or more files
  93     builders:
  94       - lf-maven-install:
  95           mvn-version: '{mvn-version}'
  96       - lf-provide-maven-settings:
  97           global-settings-file: '{global-settings-file}'
  98           settings-file: '{settings-file}'
  99       - inject:
 100           properties-content: |
 101               REPO_ID={repo-id}
 102               GROUP_ID={group-id}
 103               UPLOAD_FILES_PATH={files-dir}
 104       - shell: !include-raw-escape:
 105           - ../shell/lftools-install.sh
 106           - ../shell/deploy-maven-file.sh
 107       - lf-provide-maven-settings-cleanup
 108
 109 - builder:
 110     name: lf-maven-install
 111     # call maven-target builder with a goal of --version to force Jenkins to
 112     # install the needed maven version
 113     builders:
 114       # Create a $HOME/.wgetrc to make the Maven download quiet.
 115       - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
 116       - maven-target:
 117           maven-version: '{mvn-version}'
 118           goals: '--version'
 119       - shell: 'rm "$HOME/.wgetrc"'
 120
 121 - builder:
 122     name: lf-provide-maven-settings
 123     # Push a global settings and user settings maven files
 124     builders:
 125       - config-file-provider:
 126           files:
 127             - file-id: '{global-settings-file}'
 128               variable: 'GLOBAL_SETTINGS_FILE'
 129             - file-id: '{settings-file}'
 130               variable: 'SETTINGS_FILE'
 131
 132 - builder:
 133     name: lf-provide-maven-settings-cleanup
 134     # Clear maven settings files after we are done using them
 135     builders:
 136       - shell: |
 137           #!/bin/bash
 138           set +e  # DO NOT cause build failure if any of the rm calls fail.
 139
 140           rm "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
 141
 142           # In some cases we use the lf-provide-maven-settings macro to produce
 143           # a "$HOME/.netrc" file containing credentials. Remove that file here
 144           # too if it exists.
 145           rm "$HOME/.netrc"
 146
 147           # DO NOT fail build if any of the above lines fail.
 148           exit 0
 149
 150 ##############
 151 # PARAMETERS #
 152 ##############
 153
 154 - parameter:
 155     name: lf-infra-parameters
 156     # Standard parameters used in the LF CI environments. Gerrit variables are
 157     # not used by GitHub projects, but defining them isn't harmful.
 158     parameters:
 159       - string:
 160           name: PROJECT
 161           default: '{project}'
 162           description: |
 163               Parameter to identify a Gerrit project. This is typically the
 164               project repo path as exists in Gerrit.
 165               For example: ofextensions/circuitsw
 166       - string:
 167           name: STREAM
 168           default: '{stream}'
 169           description: |
 170               Stream is often set to the same name as 'branch' but can
 171               sometimes be used as a name representing a project's release code
 172               name.
 173       - string:
 174           name: GERRIT_PROJECT
 175           default: '{project}'
 176           description: |
 177               Parameter to identify Gerrit project. This is typically the
 178               project repo path as exists in Gerrit.
 179               For example: ofextensions/circuitsw
 180
 181               Note that Gerrit will override this parameter automatically if a
 182               job is triggered by Gerrit.
 183       - string:
 184           name: GERRIT_BRANCH
 185           default: '{branch}'
 186           description: |
 187               Parameter to identify a Gerrit branch.
 188
 189               Note that Gerrit will override this parameter automatically if a
 190               job is triggered by Gerrit.
 191       - string:
 192           name: GERRIT_REFSPEC
 193           default: ''
 194           description: |
 195               Parameter to identify a refspec when pulling from Gerrit.
 196
 197               Note that Gerrit will override this parameter automatically if a
 198               job is triggered by Gerrit.
 199
 200 - parameter:
 201     name: lf-infra-maven-parameters
 202     parameters:
 203       - string:
 204           name: MAVEN_OPTS
 205           default: '{mvn-opts}'
 206           description: |
 207               Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
 208       - string:
 209           name: MAVEN_PARAMS
 210           default: '{mvn-params}'
 211           description: |
 212               Maven parameters to pass to the mvn command.
 213       - string:
 214           name: MVN
 215           # Sets an env var for shell scripts to be able to call the dynamically
 216           # installed maven without having to calculate the path themselves.
 217           default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
 218           description: 'Maven selector to be used by shell scripts'
 219       - string:
 220           name: STAGING_PROFILE_ID
 221           default: '{staging-profile-id}'
 222           description: |
 223               Nexus staging profile ID.
 224
 225 - parameter:
 226     name: lf-infra-tox-parameters
 227     # Useful parameters when working with TOX
 228     # https://tox.readthedocs.io/
 229     parameters:
 230       - string:
 231           name: TOX_DIR
 232           default: '{tox-dir}'
 233           description: |
 234               Path to directory containing tox.ini file.
 235       - string:
 236           name: TOX_ENVS
 237           default: '{tox-envs}'
 238           description: |
 239               Tox environments to run build against.
 240               Example: docs,py2,py3
 241
 242 ##############
 243 # PROPERTIES #
 244 ##############
 245
 246 - property:
 247     name: lf-infra-properties
 248     properties:
 249       - build-discarder:
 250           # Allow build data to be stored at a length configured by the
 251           # downstream project.
 252           days-to-keep: '{build-days-to-keep}'
 253           # Do not allow artifacts to be stored in Jenkins.
 254           artifact-num-to-keep: 0
 255
 256 ##############
 257 # PUBLISHERS #
 258 ##############
 259
 260 - publisher:
 261     name: lf-infra-publish
 262     # lf-infra macro to finish up a build.
 263     #
 264     # Handles the following:
 265     #   - Shipping logs to Nexus logs site repository
 266     #   - Cleanup workspace
 267     publishers:
 268       - postbuildscript:
 269           builders:
 270             - lf-infra-sysstat
 271             - lf-infra-ship-logs
 272           script-only-if-succeeded: false
 273           script-only-if-failed: false
 274           mark-unstable-if-failed: false
 275       - workspace-cleanup:
 276           exclude:
 277             # Do not clean up *.jenkins-trigger files for jobs that use a
 278             # properties file as input for triggering another build.
 279             - '**/*.jenkins-trigger'
 280           fail-build: false
 281
 282 #######
 283 # SCM #
 284 #######
 285
 286 - scm:
 287     name: lf-infra-gerrit-scm
 288     scm:
 289       - git:
 290           credentials-id: '{jenkins-ssh-credential}'
 291           url: '{git-url}'
 292           refspec: '{refspec}'
 293           branches:
 294             - 'refs/heads/{branch}'
 295           skip-tag: true
 296           wipe-workspace: true
 297           submodule:
 298             recursive: '{submodule-recursive}'
 299           choosing-strategy: '{choosing-strategy}'
 300
 301 - scm:
 302     name: lf-infra-github-scm
 303     scm:
 304       - git:
 305           credentials-id: '{jenkins-ssh-credential}'
 306           url: '{url}'
 307           refspec: '{refspec}'
 308           skip-tag: true
 309           wipe-workspace: true
 310           submodule:
 311             recursive: '{submodule-recursive}'
 312           choosing-strategy: '{choosing-strategy}'
 313
 314 ############
 315 # TRIGGERS #
 316 ############
 317
 318 - trigger:
 319     name: lf-infra-github-pr-trigger
 320     triggers:
 321       - github-pull-request:
 322           trigger-phrase: '{trigger-phrase}'
 323           only-trigger-phrase: '{only-trigger-phrase}'
 324           status-context: '{status-context}'
 325           permit-all: '{permit-all}'
 326           github-hooks: '{github-hooks}'
 327           auto-close-on-fail: false
 328           org-list:
 329             - '{github-org}'
 330           white-list: '{obj:github_pr_whitelist}'
 331           admin-list: '{obj:github_pr_admin_list}'
 332
 333 ############
 334 # WRAPPERS #
 335 ############
 336
 337 - wrapper:
 338     name: lf-infra-wrappers
 339     wrappers:
 340       - mask-passwords
 341       - timeout:
 342           type: absolute
 343           timeout: '{build-timeout}'
 344           timeout-var: 'BUILD_TIMEOUT'
 345           fail: true
 346       - timestamps
 347       - ssh-agent-credentials:
 348           users:
 349             - '{jenkins-ssh-credential}'
 350       - openstack:
 351           single-use: true