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-package-listing
  99 ------------------------
 100
 101 Lists distro level packages.
 102
 103 lf-infra-packer-build
 104 ---------------------
 105
 106 Run `packer build` to build system images.
 107
 108 lf-infra-packer-validate
 109 ------------------------
 110
 111 Run `packer validate` to verify packer configuration.
 112
 113 :Required parameters:
 114
 115     :packer-cloud-settings: Cloud configuration file. Loaded on the build
 116         server as CLOUDENV environment variable.
 117     :packer-version: Version of packer to use.
 118
 119 lf-infra-push-gerrit-patch
 120 --------------------------
 121
 122 Push a change through a Jenkins job to a Gerrit repository in an automated
 123 way using git-review.
 124
 125 :Required parameters:
 126
 127     :gerrit-commit-message: Commit message to assign.
 128     :gerrit-host: Gerrit hostname.
 129     :gerrit-topic: Gerrit topic.
 130     :gerrit-user: Gerrit user-id used for submitting the change.
 131     :reviewers-email: Reviewers email. Space-separated list of
 132         email addresses to CC on the patch.
 133     :project: Gerrit project name.
 134
 135 .. _lf-infra-ship-logs:
 136
 137 lf-infra-ship-logs
 138 ------------------
 139
 140 Gather and deploy logs to a log server.
 141
 142 lf-infra-sysstat
 143 ----------------
 144
 145 Retrieves system stats.
 146
 147 lf-jacoco-nojava-workaround
 148 ---------------------------
 149
 150 Workaround for Jenkins not able to find Java in JaCoCo runs.
 151
 152 lf-maven-install
 153 ----------------
 154
 155 Call maven-target builder with a goal of --version to force Jenkins to
 156 install the need provided version of Maven. This is needed for any shell scripts
 157 that want to use Maven.
 158
 159 :Required parameters:
 160
 161     :mvn-version: Version of Maven to install.
 162
 163 lf-pip-install
 164 --------------
 165
 166 Call pip install to install packages into a virtualenv located in
 167 /tmp/v/VENV
 168
 169 .. note:: The first package listed in PIP_PACKAGES is used as the VENV name.
 170
 171 .. _lf-provide-maven-settings:
 172
 173 lf-provide-maven-settings
 174 -------------------------
 175
 176 Push a global settings and user settings maven files to the build node.
 177
 178 lf-provide-maven-settings-cleanup
 179 ---------------------------------
 180
 181 Cleanup maven settings.xml configuration. This should be called at the end of
 182 any macros that calles the
 183 :ref:`lf-provide-maven-settings <lf-provide-maven-settings>` macro.
 184
 185 .. _provide-sigul-config:
 186
 187 lf-provide-sigul-configuration
 188 ------------------------------
 189
 190 Provides sigual configuration to the Jenkins build node.
 191
 192 Requires the following Config File Provider managed files in Jenkins
 193 preconfigured.
 194
 195 * sigul-config
 196 * sigul-password
 197 * sigul-pki
 198
 199 .. _provide-sigul-config-cleanup:
 200
 201 lf-provide-sigul-configuration-cleanup
 202 --------------------------------------
 203
 204 Cleanup configuration provided by `provide-sigul-config`.
 205
 206 lf-rtd-trigger-build
 207 --------------------
 208
 209 Script to trigger a build on http://readthedocs.org
 210
 211 lf-rtd-verify
 212 -------------
 213
 214 ReadTheDocs verify script.
 215
 216 lf-sigul-install
 217 ----------------
 218
 219 Install Sigul.
 220
 221 Requires ``SIGUL_BRIDGE_IP`` configured as a global envvar.
 222
 223 lf-infra-provide-docker-cleanup
 224 -------------------------------
 225
 226 Forcibly removes all of the docker images.
 227
 228 Parameters
 229 ==========
 230
 231 lf-infra-maven-parameters
 232 -------------------------
 233
 234 Provides parameters needed by Maven. Should be used by any jobs that need to
 235 call the mvn cli.
 236
 237 lf-infra-openstack-parameters
 238 -----------------------------
 239
 240 Provides parameters needed by OpenStack client CLI. Use in jobs that need to
 241 call the openstack cli.
 242
 243 :Required Parameters:
 244
 245     :os-cloud: Configures ``OS_CLOUD`` envvar as used by openstack cli.
 246
 247 lf-infra-parameters
 248 -------------------
 249
 250 Standard parameters used in the LF CI environments. Gerrit variables are
 251 not used by GitHub projects, but defining them is not harmful. Should be used
 252 in every job template.
 253
 254 lf-infra-node-parameters
 255 ------------------------
 256
 257 Provides parameters needed by NodeJS and NPM. Should be used by any jobs that
 258 need to run NodeJS or NPM.
 259
 260 lf-infra-tox-parameters
 261 -----------------------
 262
 263 Provides parameters needed by python-tox. Should be used by any jobs that need
 264 to run `tox <https://tox.readthedocs.io>`.
 265
 266 Properties
 267 ==========
 268
 269 lf-infra-properties
 270 -------------------
 271
 272 Configures the build-discarder plugin for Jenkins with the recommended lf-infra
 273 settings. Should be used in all job-templates.
 274
 275 Publishers
 276 ==========
 277
 278 lf-jacoco-report
 279 ----------------
 280
 281 Provides basic configuration for the JaCoCo plugin.
 282
 283 lf-infra-publish
 284 ----------------
 285
 286 Provides basic lf-infra recommended publisher configurations which should be
 287 used in all job templates. This primary objective of this trigger is to
 288 gather build logs and copy them to a log server.
 289
 290 SCM
 291 ===
 292
 293 lf-infra-gerrit-scm
 294 -------------------
 295
 296 Basic SCM configuration for Gerrit based projects.
 297
 298 lf-infra-github-scm
 299 -------------------
 300
 301 Basic SCM configuration for GitHub based projects.
 302
 303 On the `branch` variable you can assign `$sha1` or `$ghprbActualCommit`
 304 as the value.  This will require that the job be triggered via
 305 the GHPRB plugin and not manually.
 306
 307 Wrappers
 308 ========
 309
 310 lf-infra-wrappers
 311 -----------------
 312
 313 Provides lf-infra recommended wrappers which should be used in every
 314 job-template.
 315
 316 This wrapper requires that a managed file called `npmrc` exists in the Jenkins.  The main use
 317 case here is to point to a npm proxy, on Nexus for example.
 318 The type of the file should be "Custom file".  You can set various npmrc settings in it.
 319 Documentation on npm configuration can be found at https://docs.npmjs.com/files/npmrc.
 320 If you are not using npm then it is fine for the file to be empty.
 321
 322 Example npmrc:
 323
 324 .. code-block:: bash
 325
 326    registry=https://nexus3.onap.org/repository/npm.public/