7 name: lf-fetch-dependent-patches
9 - shell: !include-raw: ../shell/gerrit-fetch-dependencies.sh
11 properties-file: $WORKSPACE/.dependency.properties
14 name: lf-license-check
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
27 name: lf-infra-create-netrc
30 properties-content: 'SERVER_ID={server-id}'
31 - shell: !include-raw-escape: ../shell/create-netrc.sh
34 name: lf-infra-docker-login
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
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.
49 - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
52 name: lf-infra-pre-build
54 - shell: !include-raw-escape: ../shell/python-tools-install.sh
57 name: lf-infra-ship-logs
59 - config-file-provider:
61 - file-id: 'jenkins-log-archives-settings'
62 variable: 'SETTINGS_FILE'
63 - lf-infra-create-netrc:
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
73 regexp: '^Build logs: .*'
76 name: lf-infra-package-listing
78 - shell: !include-raw:
79 - ../shell/package-listing.sh
82 name: lf-infra-packer-build
84 - config-file-provider:
86 - file-id: '{packer-cloud-settings}'
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
100 name: lf-infra-packer-validate
102 - config-file-provider:
104 - file-id: '{packer-cloud-settings}'
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
116 name: lf-infra-push-gerrit-patch
119 properties-content: |
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
129 name: lf-infra-sysstat
131 - shell: !include-raw:
132 - ../shell/sysstat.sh
135 name: lf-jacoco-nojava-workaround
137 - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
140 name: lf-infra-deploy-maven-file
143 mvn-version: '{mvn-version}'
144 - lf-provide-maven-settings:
145 global-settings-file: '{global-settings-file}'
146 settings-file: '{settings-file}'
148 properties-content: |
149 MAVEN_REPO_URL={maven-repo-url}
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
160 name: lf-maven-install
162 # Create a $HOME/.wgetrc to make the Maven download quiet.
163 - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
165 maven-version: '{mvn-version}'
167 - shell: 'rm "$HOME/.wgetrc"'
170 name: lf-provide-maven-settings
172 - config-file-provider:
174 - file-id: '{global-settings-file}'
175 variable: 'GLOBAL_SETTINGS_FILE'
176 - file-id: '{settings-file}'
177 variable: 'SETTINGS_FILE'
183 properties-content: PIP_PACKAGES={pip-packages}
184 - shell: !include-raw-escape: ../shell/pip-install.sh
187 name: lf-provide-maven-settings-cleanup
191 set +e # DO NOT cause build failure if any of the rm calls fail.
193 rm -f "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
195 # In some cases we use the lf-provide-maven-settings macro to produce
196 # a "$HOME/.netrc" file containing credentials. Remove that file here
200 # DO NOT fail build if any of the above lines fail.
204 name: lf-rtd-trigger-build
207 properties-content: |
208 RTD_BUILD_URL={rtd-build-url}
209 RTD_TOKEN={rtd-token}
210 - shell: !include-raw-escape: ../shell/rtd-trigger-build.sh
216 properties-content: DOC_DIR={doc-dir}
217 - shell: !include-raw-escape:
218 - ../shell/tox-install.sh
219 - ../shell/rtd-verify.sh
222 name: lf-sigul-sign-dir
223 # Requires that Jenkins be configured with SIGUL_BRIDGE_IP as a global
224 # Environment variable
227 condition-kind: boolean-expression
228 condition-expression: '{sign-artifacts}'
230 - config-file-provider:
232 - file-id: sigul-config
233 variable: SIGUL_CONFIG
234 - file-id: sigul-password
235 variable: SIGUL_PASSWORD
238 - shell: !include-raw-escape: ../shell/sigul-configuration.sh
239 - shell: !include-raw-escape: ../shell/sigul-install.sh
241 properties-content: SIGN_DIR={sign-dir}
242 - shell: !include-raw-escape:
243 - ../shell/common-variables.sh
244 - ../shell/sigul-sign-dir.sh
245 - shell: !include-raw-escape: ../shell/sigul-configuration-cleanup.sh
248 name: lf-infra-provide-docker-cleanup
252 set +e # DO NOT cause build failure if docker rmi fails
253 docker rmi -f $(docker images -a -q)
262 name: lf-clm-parameters
266 default: '{nexus-iq-stage}'
268 Stage the policy evaluation will be run against on the Nexus IQ Server.
271 name: lf-cmake-parameters
272 # Parameters useful in CMake builds.
276 default: '{build-dir}'
277 description: 'Directory to build the project in.'
280 default: '{cmake-opts}'
282 Options to pass to CMAKE.
283 Example: -DCMAKE_INSTALL_PREFIX=$WORKSPACE/target/output
286 default: '{install-prefix}'
287 description: 'Install prefix for C/C++ builds. Example: /usr/local'
290 default: '{make-opts}'
291 description: 'Options to pass to make. Example: -j8'
294 name: lf-infra-maven-parameters
298 # Sets an env var for shell scripts to be able to call the dynamically
299 # installed maven without having to calculate the M2_HOME themselves.
300 default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}'
301 description: 'Maven selector to be used by shell scripts'
304 default: '{mvn-opts}'
306 Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
309 default: '{mvn-params}'
311 Maven parameters to pass to the mvn command.
314 # Sets an env var for shell scripts to be able to call the dynamically
315 # installed maven without having to calculate the path themselves.
316 # yamllint disable-line rule:line-length
317 default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
318 description: 'Maven selector to be used by shell scripts'
321 name: lf-infra-openstack-parameters
325 default: '{os-cloud}'
327 The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
328 variable name that is significant to openstack client as a
329 environment variable. Please refer to the documentation for
331 https://docs.openstack.org/developer/python-openstackclient/
335 name: lf-infra-parameters
336 # Standard parameters used in the LF CI environments. Gerrit variables are
337 # not used by GitHub projects, but defining them isn't harmful.
343 Parameter to identify a SCM project to build. This is typically
344 the project repo path. For example: ofextensions/circuitsw
349 Stream is often set to the same name as 'branch' but can
350 sometimes be used as a name representing a project's release code
356 Gerrit Trigger provided parameter to identify Gerrit project that
357 triggered the build. This is typically the project repo path as
358 exists in Gerrit. For example: ofextensions/circuitsw
360 If using Gerrit, in a manual build this should match the PROJECT
366 Gerrit Trigger provided parameter to identify a Gerrit branch.
368 If using Gerrit, in a manual build override with the branch to
372 default: 'refs/heads/{branch}'
374 Gerrit Trigger provided parameter to identify a refspec to fetch
377 If using Gerrit, in a manual build override with a refspec.
378 https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
379 For example: 'refs/heads/master'
382 default: 'origin/{branch}'
384 GitHub PR Trigger provided parameter for specifying the commit
387 If using GitHub, in a manual build override with a branch path or
388 sha1 hash to a specific commit. For example: 'origin/master'
391 name: LFTOOLS_VERSION
392 default: '{lftools-version}'
394 Version of lftools to install. Can be a specific version like
395 '0.6.0' or a PEP-440 definition.
396 https://www.python.org/dev/peps/pep-0440/
397 For example '<1.0.0' or '>=1.0.0,<2.0.0'.
400 name: lf-infra-node-parameters
404 default: '{node-dir}'
405 description: Path to a Node project directory.
408 default: '{node-version}'
409 description: Version of NodeJS to install.
412 name: lf-infra-tox-parameters
418 Path to directory containing tox.ini file.
421 default: '{tox-envs}'
423 Tox environments to run build against.
424 Example: docs,py2,py3
431 name: lf-infra-properties
434 # Allow build data to be stored at a length configured by the
435 # downstream project.
436 days-to-keep: '{build-days-to-keep}'
437 # Do not allow artifacts to be stored in Jenkins.
438 artifact-num-to-keep: 0
445 name: lf-jacoco-report
448 exec-pattern: "**/**.exec"
449 class-pattern: "**/classes"
450 source-pattern: "**/src/main/java"
451 # yamllint disable-line rule:line-length
452 exclusion-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**,**/pax/**"
463 name: lf-infra-publish
464 # lf-infra macro to finish up a build.
466 # Handles the following:
467 # - Shipping logs to Nexus logs site repository
468 # - Cleanup workspace
481 - lf-infra-package-listing
483 mark-unstable-if-failed: true
486 # Do not clean up *.jenkins-trigger files for jobs that use a
487 # properties file as input for triggering another build.
488 - '**/*.jenkins-trigger'
496 name: lf-infra-gerrit-scm
499 credentials-id: '{jenkins-ssh-credential}'
503 - 'refs/heads/{branch}'
507 recursive: '{submodule-recursive}'
508 choosing-strategy: '{choosing-strategy}'
511 name: lf-infra-github-scm
514 credentials-id: '{jenkins-ssh-credential}'
522 recursive: '{submodule-recursive}'
523 choosing-strategy: '{choosing-strategy}'
530 name: lf-infra-wrappers
535 timeout: '{build-timeout}'
536 timeout-var: 'BUILD_TIMEOUT'
539 - ssh-agent-credentials:
541 - '{jenkins-ssh-credential}'
544 - config-file-provider:
547 target: '$HOME/.npmrc'
549 target: '$HOME/.config/pip/pip.conf'