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