---
############
# BUILDERS #
############

- builder:
    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
    builders:
      - inject:
          properties-content: 'SERVER_ID={server-id}'
      - shell: !include-raw-escape: ../shell/create-netrc.sh

- 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.
    #
    # TODO: Verify signature after downloading users public key from a locally
    # created repository instead of the public keymesh. This requires a process
    # in place to get ODL developers public keys into a local repository without
    # increasing the job thoughput.
    builders:
      - shell: !include-raw: ../shell/gpg-verify-git-signature.sh

- builder:
    name: lf-infra-ship-logs
    builders:
      - config-file-provider:
          files:
            - file-id: 'jenkins-log-archives-settings'
              variable: 'SETTINGS_FILE'
      - lf-infra-create-netrc:
          server-id: logs
      - shell: !include-raw:
          - ../shell/lftools-install.sh
          - ../shell/logs-deploy.sh
      - shell: !include-raw:
          - ../shell/logs-clear-credentials.sh
      - description-setter:
          regexp: '^Build logs: .*'

- 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: |
              REPO_ID={repo-id}
              GROUP_ID={group-id}
              UPLOAD_FILES_PATH={files-dir}
      - shell: !include-raw-escape:
          - ../shell/lftools-install.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-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
          default: '{project}'
          description: |
              Parameter to identify a Gerrit project. This is typically the
              project repo path as exists in Gerrit.
              For example: ofextensions/circuitsw
      - string:
          name: GERRIT_PROJECT
          default: '{project}'
          description: |
              Parameter to identify Gerrit project. This is typically the
              project repo path as exists in Gerrit.
              For example: ofextensions/circuitsw

              Note that Gerrit will override this parameter automatically if a
              job is triggered by Gerrit.
      - string:
          name: GERRIT_BRANCH
          default: '{branch}'
          description: |
              Parameter to identify a Gerrit branch.

              Note that Gerrit will override this parameter automatically if a
              job is triggered by Gerrit.
      - string:
          name: GERRIT_REFSPEC
          default: ''
          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-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-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:
      - build-discarder:
          # Allow build data to be stored at a length configured by the
          # downstream project.
          days-to-keep: '{build-days-to-keep}'
          # 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.
    #
    # Handles the following:
    #   - Shipping logs to Nexus logs site repository
    #   - Cleanup workspace
    publishers:
      - postbuildscript:
          builders:
            - lf-infra-sysstat
            - lf-infra-ship-logs
          script-only-if-succeeded: false
          script-only-if-failed: false
          mark-unstable-if-failed: false
      - workspace-cleanup:
          exclude:
            # Do not clean up *.jenkins-trigger files for jobs that use a
            # properties file as input for triggering another build.
            - '**/*.jenkins-trigger'
          fail-build: false

#######
# SCM #
#######

- scm:
    name: lf-infra-gerrit-scm
    scm:
      - git:
          credentials-id: '{jenkins-ssh-credential}'
          url: '{git-url}'
          refspec: '{refspec}'
          branches:
            - 'refs/heads/{branch}'
          skip-tag: true
          wipe-workspace: true
          submodule:
            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}'

############
# WRAPPERS #
############

- wrapper:
    name: lf-infra-wrappers
    wrappers:
      - mask-passwords
      - timeout:
          type: absolute
          timeout: '{build-timeout}'
          timeout-var: 'BUILD_TIMEOUT'
          fail: true
      - timestamps
      - ssh-agent-credentials:
          users:
            - '{jenkins-ssh-credential}'
      - openstack:
          single-use: true