docs/jjb/lf-macros.rst

   1 #############
   2 Global Macros
   3 #############
   4
   5 Builders
   6 ========
   7
   8 lf-fetch-dependent-patches
   9 --------------------------
  10
  11 Fetch all patches provided via comment trigger
  12
  13 This macro will fetch all patches provided via comment trigger and will
  14 create a list of projects from those patches via environment variable
  15 called DEPENDENCY_BUILD_ORDER which can be used if necessary to build
  16 projects in the specified order. The order is determined by first patch
  17 instance for a project in the patch list.
  18
  19 lf-license-check
  20 ----------------
  21
  22 Checks files for
  23
  24 :Required parameters:
  25
  26     :file-patterns: Space-separated list of file patterns to scan.
  27         For example: \*.go \*.groovy \*.java \*.py \*.sh
  28     :spdx-disable: Disable the SPDX-Identifier checker.
  29     :lhc-version: Version of LHC to use.
  30     :license-exclude-paths: Comma-separated list of paths to exclude from the
  31         license checker. The paths used here will be matched using a contains
  32         rule so it is best to be as precise with the path as possible.
  33         For example a path of '/src/generated/' will be searched as
  34         '**/src/generated/**'.
  35         Example: org/opendaylight/yang/gen,protobuff/messages
  36     :licenses-allowed: Comma-separated list of allowed licenses.
  37         For example: Apache-2.0,EPL-1.0,MIT
  38
  39 lf-infra-create-netrc
  40 ---------------------
  41
  42 Create a ~/.netrc file from a Maven settings.xml
  43
  44 :Required parameters:
  45
  46     :server-id: The id of a server as defined in settings.xml.
  47
  48 :Optional parameters:
  49
  50     :ALT_NEXUS_SERVER: URL of custom nexus server.
  51         If set this will take precedence.
  52         Use this to point at nexus3.$PROJECTDOMAIN
  53         for example.
  54
  55 lf-infra-deploy-maven-file
  56 --------------------------
  57
  58 Deploy files to a repository.
  59
  60 :Required parameters:
  61
  62     :global-settings-file: Global settings file to use.
  63     :group-id: Group ID of the repository.
  64     :maven-repo-url: URL of a Maven repository to upload to.
  65     :mvn-version: Version of Maven to use.
  66     :repo-id: Repository ID
  67     :settings-file: Maven settings file to use.
  68     :upload-files-dir: Path to directory containing one or more files
  69
  70 lf-infra-docker-login
  71 ---------------------
  72
  73 Login into a custom hosted docker registry and / or docker.io
  74
  75 The Jenkins system should have the following global variables defined
  76
  77 :Environment variables:
  78
  79     :DOCKER_REGISTRY: The DNS address of the registry (IP or FQDN)
  80         ex: nexus3.example.com (GLOBAL variable)
  81
  82     :REGISTRY_PORTS: Required if DOCKER_REGISTRY is set. Space separated list
  83         of the registry ports to login to. ex: 10001 10002 10003 10004
  84         (GLOBAL variable)
  85
  86     :DOCKERHUB_EMAIL: If this variable is set then an attempt to login to
  87         DockerHub (docker.io) will be also made. It should be set to the email
  88         address for the credentials that will get looked up. Only _one_
  89         credential will ever be found in the maven settings file for DockerHub.
  90         (GLOBAL variable)
  91
  92 lf-infra-gpg-verify-git-signature
  93 ---------------------------------
  94
  95 Verify gpg signature of the latest commit message in $WORKSPACE.
  96 This command assumes that $WORKSPACE is a git repo.
  97
  98 lf-infra-pre-build
  99 ------------------
 100
 101 Macro that runs before all builders to prepare the system for job use.
 102
 103 lf-infra-package-listing
 104 ------------------------
 105
 106 Lists distro level packages.
 107
 108 lf-infra-packer-build
 109 ---------------------
 110
 111 Run `packer build` to build system images.
 112
 113 :Required parameters:
 114
 115     :openstack: Packer template uses an OpenStack builder (true|false).
 116     :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
 117     :packer-version: Version of packer to use.
 118     :platform: Build platform as found in the vars directory.
 119     :template: Packer template to build as found in the templates directory.
 120
 121 lf-infra-packer-validate
 122 ------------------------
 123
 124 Run `packer validate` to verify packer configuration.
 125
 126 :Required parameters:
 127
 128     :openstack: Packer template uses an OpenStack builder (true|false).
 129     :openstack-cloud: Sets OS_CLOUD variable to the value of this parameter.
 130     :packer-cloud-settings: Cloud configuration file. Loaded on the build
 131         server as CLOUDENV environment variable.
 132     :packer-version: Version of packer to use.
 133
 134 lf-infra-push-gerrit-patch
 135 --------------------------
 136
 137 Push a change through a Jenkins job to a Gerrit repository in an automated
 138 way using git-review.
 139
 140 :Required parameters:
 141
 142     :gerrit-commit-message: Commit message to assign.
 143     :gerrit-host: Gerrit hostname.
 144     :gerrit-topic: Gerrit topic.
 145     :gerrit-user: Gerrit user-id used for submitting the change.
 146     :reviewers-email: Reviewers email. Space-separated list of
 147         email addresses to CC on the patch.
 148     :project: Gerrit project name.
 149
 150 .. _lf-infra-ship-logs:
 151
 152 lf-infra-ship-logs
 153 ------------------
 154
 155 Gather and deploy logs to a log server.
 156
 157 lf-infra-sysstat
 158 ----------------
 159
 160 Retrieves system stats.
 161
 162 lf-jacoco-nojava-workaround
 163 ---------------------------
 164
 165 Workaround for Jenkins not able to find Java in JaCoCo runs.
 166
 167 .. _lf-maven-central:
 168
 169 lf-maven-central
 170 ----------------
 171
 172 Publish artifacts to OSSRH (Maven Central) staging.
 173
 174 Requires that the project's settings.xml contains a ServerId 'ossrh' with the
 175 credentials for the project's OSSRH account.
 176
 177 This macro assumes the directory ``$WORKSPACE/m2repo`` contains a Maven 2
 178 repository which is to upload to OSSRH.
 179
 180 :Required parameters:
 181
 182     :mvn-central: Whether or not to upload to mvn-central. (true|false)
 183     :ossrh-profile-id: Nexus staging profile ID as provided by OSSRH.
 184
 185 .. literalinclude:: ../../.jjb-test/lf-macros/lf-maven-central-minimal.yaml
 186    :language: yaml
 187
 188 .. _lf-maven-install:
 189
 190 lf-maven-install
 191 ----------------
 192
 193 Call maven-target builder with a goal of --version to force Jenkins to
 194 install the need provided version of Maven. This is needed for any shell scripts
 195 that want to use Maven.
 196
 197 :Required parameters:
 198
 199     :mvn-version: Version of Maven to install.
 200
 201 lf-pip-install
 202 --------------
 203
 204 Call pip install to install packages into a virtualenv located in
 205 /tmp/v/VENV
 206
 207 .. note:: The first package listed in PIP_PACKAGES is used as the VENV name.
 208
 209 .. _lf-provide-maven-settings:
 210
 211 lf-provide-maven-settings
 212 -------------------------
 213
 214 Push a global settings and user settings maven files to the build node.
 215
 216 lf-provide-maven-settings-cleanup
 217 ---------------------------------
 218
 219 Cleanup maven settings.xml configuration. This should be called at the end of
 220 any macros that calles the
 221 :ref:`lf-provide-maven-settings <lf-provide-maven-settings>` macro.
 222
 223 lf-rtd-trigger-build
 224 --------------------
 225
 226 Script to trigger a build on http://readthedocs.org
 227
 228 lf-rtd-verify
 229 -------------
 230
 231 ReadTheDocs verify script.
 232
 233 lf-sigul-sign-dir
 234 -----------------
 235
 236 Use Sigul to sign a directory via {sign-dir}.
 237
 238 Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
 239
 240 :Required Parameters:
 241     :sign-artifacts: Whether or not to sign artifacts with Sigul.
 242     :sign-dir: Directory to sign.
 243
 244 lf-infra-provide-docker-cleanup
 245 -------------------------------
 246
 247 Forcibly removes all of the docker images.
 248
 249 Parameters
 250 ==========
 251
 252 lf-clm-parameters
 253 -------------------
 254
 255 Provides the policy evaluation stage to run against Nexus IQ Server.
 256 Valid values include: 'build', 'stage-release', 'operate'.
 257
 258 lf-cmake-parameters
 259 -------------------
 260
 261 Provides parameters needed by CMake. Should be used by any jobs that need to
 262 call the ``cmake && make && make install`` pattern.
 263
 264 lf-infra-maven-parameters
 265 -------------------------
 266
 267 Provides parameters needed by Maven. Should be used by any jobs that need to
 268 call the mvn cli.
 269
 270 lf-infra-openstack-parameters
 271 -----------------------------
 272
 273 Provides parameters needed by OpenStack client CLI. Use in jobs that need to
 274 call the openstack cli.
 275
 276 :Required Parameters:
 277
 278     :os-cloud: Configures ``OS_CLOUD`` envvar as used by openstack cli.
 279
 280 lf-infra-parameters
 281 -------------------
 282
 283 Standard parameters used in the LF CI environments. Gerrit variables are
 284 not used by GitHub projects, but defining them is not harmful. Should be used
 285 in every job template.
 286
 287 lf-infra-node-parameters
 288 ------------------------
 289
 290 Provides parameters needed by NodeJS and NPM. Should be used by any jobs that
 291 need to run NodeJS or NPM.
 292
 293 lf-infra-tox-parameters
 294 -----------------------
 295
 296 Provides parameters needed by python-tox. Should be used by any jobs that need
 297 to run `tox <https://tox.readthedocs.io>`.
 298
 299 Properties
 300 ==========
 301
 302 lf-infra-properties
 303 -------------------
 304
 305 Configures the build-discarder plugin for Jenkins with the recommended lf-infra
 306 settings. Should be used in all job-templates.
 307
 308 Publishers
 309 ==========
 310
 311 lf-jacoco-report
 312 ----------------
 313
 314 Provides basic configuration for the JaCoCo plugin.
 315
 316 lf-infra-publish
 317 ----------------
 318
 319 Provides basic lf-infra recommended publisher configurations which should be
 320 used in all job templates. This primary objective of this trigger is to
 321 gather build logs and copy them to a log server.
 322
 323 lf-infra-publish-windows
 324 ------------------------
 325
 326 Windows publisher for use at the end of Windows job templates. Takes care of
 327 cleaning out the workspace at the end of a job.
 328
 329 SCM
 330 ===
 331
 332 lf-infra-gerrit-scm
 333 -------------------
 334
 335 Basic SCM configuration for Gerrit based projects.
 336
 337 :Required parameters:
 338
 339     :submodule-timeout: Timeout (in minutes) for checkout operation.
 340         (default: 10)
 341
 342 lf-infra-github-scm
 343 -------------------
 344
 345 Basic SCM configuration for GitHub based projects.
 346
 347 On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
 348 as the value.  This will require that the job be triggered via
 349 the GHPRB plugin and not manually.
 350
 351 :Required parameters:
 352
 353     :submodule-timeout: Timeout (in minutes) for checkout operation.
 354         (default: 10)
 355
 356 Wrappers
 357 ========
 358
 359 lf-infra-wrappers-common
 360 ------------------------
 361
 362 Provides lf-infra recommended wrappers which should be used in every
 363 job-template. It's meant to be used by more specific wrappers below.
 364
 365 lf-infra-wrappers
 366 -----------------
 367
 368 Provides lf-infra recommended wrappers which should be used in every
 369 job-template that's run on Linux systems.
 370
 371 This wrapper requires that a managed file called `npmrc` exists in the Jenkins.
 372 The main use case here is to point to a npm proxy, on Nexus for example.
 373 The type of the file should be "Custom file".  You can set various npmrc
 374 settings in it. Documentation on npm configuration can be found at
 375 https://docs.npmjs.com/files/npmrc. If you are not using npm then it is fine
 376 for the file to be empty.
 377
 378 Example npmrc:
 379
 380 .. code-block:: bash
 381
 382    registry=https://nexus3.onap.org/repository/npm.public/
 383
 384 lf-infra-wrappers-windows
 385 -------------------------
 386
 387 Provides lf-infra recommended wrappers which should be used in every
 388 job-template that's run on Windows systems.