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