Add default refspec reference
[releng/global-jjb.git] / jjb / lf-macros.yaml
index 0c0e69b..eb25459 100644 (file)
@@ -1,6 +1,10 @@
 ---
+############
+# BUILDERS #
+############
+
 - builder:
-    name: create-netrc
+    name: lf-infra-create-netrc
     # Macro to create a ~/.netrc file from a Maven settings.xml
     # Parameters:
     #     {server-id} The id of a server as defined in settings.xml
       - shell: !include-raw-escape: ../shell/create-netrc.sh
 
 - builder:
-    name: gpg-verify-git-signature
+    name: lf-infra-docker-login
+    # Login into a custom hosted docker registry and / or docker.io
+    #
+    # The Jenkins system should have the following global variables defined
+    #
+    # DOCKER_REGISTRY : Optional
+    #                   The DNS address of the registry (IP or FQDN)
+    #                   ex: nexus3.example.com
+    #
+    # REGISTRY_PORTS  : Required if DOCKER_REGISTRY is set
+    #                   Space separated listing of the registry ports to login
+    #                   to
+    #                   ex: 10001 10002 10003 10004
+    #
+    # DOCKERHUB_EMAIL : Optional
+    #                   If this variable is set then an attempt to login to
+    #                   DockerHub (docker.io) will be also made. It should be
+    #                   set to the email address for the credentials that will
+    #                   get looked up. Only _one_ credential will ever be found
+    #                   in the maven settings file for DockerHub
+    builders:
+      - lf-provide-maven-settings:
+          global-settings-file: '{global-settings-file}'
+          settings-file: '{settings-file}'
+      - shell: !include-raw-escape: ../shell/docker-login.sh
+      - lf-provide-maven-settings-cleanup
+
+- builder:
+    name: lf-infra-gpg-verify-git-signature
     # Verify gpg signature of the latest commit message in $WORKSPACE
     #
     # This command assumes that $WORKSPACE is a git repo.
@@ -29,7 +61,7 @@
           files:
             - file-id: 'jenkins-log-archives-settings'
               variable: 'SETTINGS_FILE'
-      - create-netrc:
+      - lf-infra-create-netrc:
           server-id: logs
       - shell: !include-raw:
           - ../shell/lftools-install.sh
       - description-setter:
           regexp: '^Build logs: .*'
 
+- builder:
+    name: lf-infra-packer-build
+    builders:
+      - config-file-provider:
+          files:
+            - file-id: '{packer-cloud-settings}'
+              variable: CLOUDENV
+      - inject:
+          properties-content: |
+              PACKER_PLATFORM={platform}
+              PACKER_TEMPLATE={template}
+              PACKER_VERSION={packer-version}
+      - shell: !include-raw-escape:
+          - ../shell/packer-install.sh
+          - ../shell/packer-build.sh
+      - shell: !include-raw:
+          - ../shell/packer-clear-credentials.sh
+
+- builder:
+    name: lf-infra-packer-validate
+    builders:
+      - config-file-provider:
+          files:
+            - file-id: '{packer-cloud-settings}'
+              variable: 'CLOUDENV'
+      - inject:
+          properties-content: |
+              PACKER_VERSION={packer-version}
+      - shell: !include-raw-escape:
+          - ../shell/packer-install.sh
+          - ../shell/packer-validate.sh
+      - shell: !include-raw:
+          - ../shell/packer-clear-credentials.sh
+
+- builder:
+    name: lf-infra-sysstat
+    builders:
+      - shell: !include-raw:
+          - ../shell/sysstat.sh
+
+- builder:
+    name: lf-jacoco-nojava-workaround
+    builders:
+      - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
+
+- builder:
+    name: lf-infra-deploy-maven-file
+    # Deploy files to a repository.
+    #
+    # The builder requires passing the following parameters
+    # REPO_ID:           Repository ID
+    # GROUP_ID:          Group ID of the repository
+    # UPLOAD_FILES_PATH: Path to directory containing one or more files
+    builders:
+      - lf-maven-install:
+          mvn-version: '{mvn-version}'
+      - lf-provide-maven-settings:
+          global-settings-file: '{global-settings-file}'
+          settings-file: '{settings-file}'
+      - inject:
+          properties-content: |
+              MAVEN_REPO_URL={maven-repo-url}
+              REPO_ID={repo-id}
+              GROUP_ID={group-id}
+              UPLOAD_FILES_PATH={upload-files-dir}
+      - shell: !include-raw-escape:
+          - ../shell/lftools-install.sh
+          - ../shell/common-variables.sh
+          - ../shell/deploy-maven-file.sh
+      - lf-provide-maven-settings-cleanup
+
+- builder:
+    name: lf-maven-install
+    # call maven-target builder with a goal of --version to force Jenkins to
+    # install the needed maven version
+    builders:
+      # Create a $HOME/.wgetrc to make the Maven download quiet.
+      - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
+      - maven-target:
+          maven-version: '{mvn-version}'
+          goals: '--version'
+      - shell: 'rm "$HOME/.wgetrc"'
+
+- builder:
+    name: lf-provide-maven-settings
+    # Push a global settings and user settings maven files
+    builders:
+      - config-file-provider:
+          files:
+            - file-id: '{global-settings-file}'
+              variable: 'GLOBAL_SETTINGS_FILE'
+            - file-id: '{settings-file}'
+              variable: 'SETTINGS_FILE'
+
+- builder:
+    name: lf-provide-maven-settings-cleanup
+    # Clear maven settings files after we are done using them
+    builders:
+      - shell: |
+          #!/bin/bash
+          set +e  # DO NOT cause build failure if any of the rm calls fail.
+
+          rm "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
+
+          # In some cases we use the lf-provide-maven-settings macro to produce
+          # a "$HOME/.netrc" file containing credentials. Remove that file here
+          # too if it exists.
+          rm "$HOME/.netrc"
+
+          # DO NOT fail build if any of the above lines fail.
+          exit 0
+
+##############
+# PARAMETERS #
+##############
+
+- parameter:
+    name: lf-infra-maven-parameters
+    parameters:
+      - string:
+          name: MAVEN_OPTS
+          default: '{mvn-opts}'
+          description: |
+              Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
+      - string:
+          name: MAVEN_PARAMS
+          default: '{mvn-params}'
+          description: |
+              Maven parameters to pass to the mvn command.
+      - string:
+          name: MVN
+          # Sets an env var for shell scripts to be able to call the dynamically
+          # installed maven without having to calculate the path themselves.
+          default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
+          description: 'Maven selector to be used by shell scripts'
+      - string:
+          name: STAGING_PROFILE_ID
+          default: '{staging-profile-id}'
+          description: |
+              Nexus staging profile ID.
+
+
+- parameter:
+    name: lf-infra-openstack-parameters
+    parameters:
+      - string:
+          name: OS_CLOUD
+          default: '{os-cloud}'
+          description: |
+              The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
+              variable name that is significant to openstack client as a
+              environment variable. Please refer to the documentation for
+              further details.
+              https://docs.openstack.org/developer/python-openstackclient/
+
+
 - parameter:
     name: lf-infra-parameters
+    # Standard parameters used in the LF CI environments. Gerrit variables are
+    # not used by GitHub projects, but defining them isn't harmful.
     parameters:
       - string:
           name: PROJECT
               Parameter to identify a Gerrit project. This is typically the
               project repo path as exists in Gerrit.
               For example: ofextensions/circuitsw
-
-              (Deprecated) Please use GERRIT_PROJECT instead. A future version
-              of global-jjb will remove this variable.
+      - string:
+          name: STREAM
+          default: '{stream}'
+          description: |
+              Stream is often set to the same name as 'branch' but can
+              sometimes be used as a name representing a project's release code
+              name.
       - string:
           name: GERRIT_PROJECT
           default: '{project}'
               job is triggered by Gerrit.
       - string:
           name: GERRIT_REFSPEC
-          default: ''
+          default: 'refs/heads/{branch}'
           description: |
               Parameter to identify a refspec when pulling from Gerrit.
 
               Note that Gerrit will override this parameter automatically if a
               job is triggered by Gerrit.
 
+
+- parameter:
+    name: lf-infra-tox-parameters
+    # Useful parameters when working with TOX
+    # https://tox.readthedocs.io/
+    parameters:
+      - string:
+          name: TOX_DIR
+          default: '{tox-dir}'
+          description: |
+              Path to directory containing tox.ini file.
+      - string:
+          name: TOX_ENVS
+          default: '{tox-envs}'
+          description: |
+              Tox environments to run build against.
+              Example: docs,py2,py3
+
+##############
+# PROPERTIES #
+##############
+
 - property:
     name: lf-infra-properties
     properties:
           # Do not allow artifacts to be stored in Jenkins.
           artifact-num-to-keep: 0
 
+##############
+# PUBLISHERS #
+##############
+
 - publisher:
     name: lf-infra-publish
     # lf-infra macro to finish up a build.
     publishers:
       - postbuildscript:
           builders:
+            - lf-infra-sysstat
             - lf-infra-ship-logs
           script-only-if-succeeded: false
           script-only-if-failed: false
             - '**/*.jenkins-trigger'
           fail-build: false
 
+#######
+# SCM #
+#######
+
 - scm:
     name: lf-infra-gerrit-scm
     scm:
       - git:
           credentials-id: '{jenkins-ssh-credential}'
-          url: '$GIT_URL/$GERRIT_PROJECT'
+          url: '{git-url}'
           refspec: '{refspec}'
           branches:
             - 'refs/heads/{branch}'
             recursive: '{submodule-recursive}'
           choosing-strategy: '{choosing-strategy}'
 
+- scm:
+    name: lf-infra-github-scm
+    scm:
+      - git:
+          credentials-id: '{jenkins-ssh-credential}'
+          url: '{url}'
+          refspec: '{refspec}'
+          skip-tag: true
+          wipe-workspace: true
+          submodule:
+            recursive: '{submodule-recursive}'
+          choosing-strategy: '{choosing-strategy}'
+
+############
+# TRIGGERS #
+############
+
+- trigger:
+    name: lf-infra-github-pr-trigger
+    triggers:
+      - github-pull-request:
+          trigger-phrase: '{trigger-phrase}'
+          only-trigger-phrase: '{only-trigger-phrase}'
+          status-context: '{status-context}'
+          permit-all: '{permit-all}'
+          github-hooks: '{github-hooks}'
+          auto-close-on-fail: false
+          org-list:
+            - '{github-org}'
+          white-list: '{obj:github_pr_whitelist}'
+          admin-list: '{obj:github_pr_admin_list}'
+
+############
+# WRAPPERS #
+############
+
 - wrapper:
     name: lf-infra-wrappers
     wrappers: