# SPDX-License-Identifier: Apache-2.0
##############################################################################
# Copyright (c) 2019 The Linux Foundation and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
---
####################
# COMMON FUNCTIONS #
####################

- _lf_release_common: &lf_release_common
    name: lf-release-common

    #####################
    # Job Configuration #
    #####################

    project-type: freestyle
    node: "{build-node}"

    properties:
      - lf-infra-properties:
          build-days-to-keep: 7

    publishers:
      - lf-infra-publish

##################
# RELEASE VERIFY #
##################

- _lf_release_verify: &lf_release_verify
    name: lf-release-verify

    ######################
    # Default parameters #
    ######################

    build-days-to-keep: 7
    build-timeout: 15
    disable-job: false
    git-url: "$GIT_URL/$PROJECT"
    gerrit-skip-vote: false
    stream: master
    use-release-file: true

    gerrit_verify_triggers:
      - patchset-created-event:
          exclude-drafts: true
          exclude-trivial-rebase: false
          exclude-no-code-change: false
      - draft-published-event
      - comment-added-contains-event:
          # yamllint disable-line rule:line-length
          comment-contains-value: '^Patch Set\s+\d+:\s+(recheck|reverify)\s*$'

    github_included_regions:
      - '(releases\/.*\.yaml|\.releases\/.*\.yaml)'

    #####################
    # Job Configuration #
    #####################

    disabled: "{disable-job}"

    parameters:
      - lf-infra-parameters:
          project: "{project}"
          branch: "$GERRIT_BRANCH"
          stream: "$GERRIT_BRANCH"
      - lf-build-with-parameters-maven-release:
          use-release-file: "{use-release-file}"

    builders:
      - lf-infra-pre-build
      - conditional-step:
          condition-kind: regex-match
          regex: "^.*-docker-.*"
          label: "{build-node}"
          steps:
            - lf-provide-maven-settings:
                global-settings-file: "global-settings"
                settings-file: "{mvn-settings}"
            - shell: !include-raw-escape: ../shell/docker-login.sh
            - lf-provide-maven-settings-cleanup
      - config-file-provider:
          files:
            - file-id: sigul-config
              variable: SIGUL_CONFIG
            - file-id: sigul-password
              variable: SIGUL_PASSWORD
            - file-id: sigul-pki
              variable: SIGUL_PKI
            - file-id: signing-pubkey
              variable: SIGNING_PUBKEY
      - shell: !include-raw-escape: ../shell/sigul-configuration.sh
      - shell: !include-raw-escape: ../shell/sigul-install.sh
      - lf-release

- job-template:
    name: "{project-name}-release-verify-{stream}"
    id: gerrit-release-verify
    <<: *lf_release_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_release_verify

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    scm:
      - lf-infra-gerrit-scm:
          git-url: "{git-url}"
          refspec: "$GERRIT_REFSPEC"
          branch: "$GERRIT_BRANCH"
          submodule-disable: true
          submodule-recursive: false
          submodule-timeout: 10
          choosing-strategy: gerrit
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on: "{obj:gerrit_verify_triggers}"
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project}"
              branches:
                - branch-compare-type: "ANT"
                  branch-pattern: "**/{branch}"
              file-paths:
                - compare-type: REG_EXP
                  pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'
          skip-vote:
            successful: "{gerrit-skip-vote}"
            failed: "{gerrit-skip-vote}"
            unstable: "{gerrit-skip-vote}"
            notbuilt: "{gerrit-skip-vote}"

- job-template:
    name: "{project-name}-release-verify-{stream}"
    id: github-release-verify
    <<: *lf_release_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_release_verify

    properties:
      - lf-infra-properties:
          build-days-to-keep: "{build-days-to-keep}"
      - github:
          url: "{github-url}/{github-org}/{project}"

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    scm:
      - lf-infra-github-scm:
          url: "{git-clone-url}{github-org}/{project}"
          refspec: "+refs/pull/*:refs/remotes/origin/pr/*"
          branch: "$sha1"
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          choosing-strategy: default
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    triggers:
      - github-pull-request:
          trigger-phrase: ^(recheck|reverify)$
          only-trigger-phrase: false
          status-context: "Github Release Verify"
          permit-all: true
          github-hooks: true
          white-list-target-branches:
            - "{branch}"
          included-regions: "{obj:github_included_regions}"

#################
# RELEASE MERGE #
#################

- _lf_release_merge: &lf_release_merge
    name: lf-release-merge

    ######################
    # Default parameters #
    ######################

    build-days-to-keep: 7
    build-timeout: 15
    cosign-password-id: cosign-password
    cosign-private-key-id: cosign-private-key
    disable-job: false
    git-url: "$GIT_URL/$PROJECT"
    stream: master
    use-release-file: true

    gerrit_merge_triggers:
      - change-merged-event
      - comment-added-contains-event:
          comment-contains-value: '^Patch Set\s+\d+:\s+remerge\s*$'

    github_included_regions:
      - '(releases\/.*\.yaml|\.releases\/.*\.yaml)'

    #####################
    # Job Configuration #
    #####################

    disabled: "{disable-job}"

    parameters:
      - lf-infra-parameters:
          project: "{project}"
          branch: "$GERRIT_BRANCH"
          stream: "$GERRIT_BRANCH"
      - lf-build-with-parameters-maven-release:
          use-release-file: "{use-release-file}"
      - bool:
          name: TAG_RELEASE
          default: true
          description: |
            Tag Gerrit repo after release.
      - bool:
          name: DRY_RUN
          default: false
          description: |
            If DRY_RUN is enabled artifacts are not published.

    builders:
      - lf-infra-pre-build
      - conditional-step:
          condition-kind: regex-match
          regex: "^.*-docker-.*"
          label: "{build-node}"
          steps:
            - lf-provide-maven-settings:
                global-settings-file: "global-settings"
                settings-file: "{mvn-settings}"
            - shell: !include-raw-escape: ../shell/docker-login.sh
            - lf-provide-maven-settings-cleanup
      - config-file-provider:
          files:
            - file-id: sigul-config
              variable: SIGUL_CONFIG
            - file-id: sigul-password
              variable: SIGUL_PASSWORD
            - file-id: sigul-pki
              variable: SIGUL_PKI
            - file-id: signing-pubkey
              variable: SIGNING_PUBKEY
      - shell: !include-raw-escape: ../shell/sigul-configuration.sh
      - shell: !include-raw-escape: ../shell/sigul-install.sh
      - lf-release

- job-template:
    name: "{project-name}-release-merge-{stream}"
    id: gerrit-release-merge
    <<: *lf_release_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_release_merge

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-release-credential}"
      - credentials-binding:
          - file:
              credential-id: "{cosign-private-key-id}"
              variable: COSIGN_PRIVATE_KEY
          - text:
              credential-id: "{cosign-password-id}"
              variable: COSIGN_PASSWORD

    scm:
      - lf-infra-gerrit-scm:
          jenkins-ssh-credential: "{jenkins-ssh-credential}"
          git-url: "{git-url}"
          refspec: "$GERRIT_REFSPEC"
          branch: "$GERRIT_BRANCH"
          submodule-disable: true
          submodule-recursive: false
          submodule-timeout: 10
          # release merge jobs build from commit not tip
          choosing-strategy: gerrit

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on: "{obj:gerrit_merge_triggers}"
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project}"
              branches:
                - branch-compare-type: "ANT"
                  branch-pattern: "**/{branch}"
              file-paths:
                - compare-type: REG_EXP
                  pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'

- job-template:
    name: "{project-name}-release-merge-{stream}"
    id: github-release-merge
    <<: *lf_release_common
    # yamllint disable-line rule:key-duplicates
    <<: *lf_release_merge

    properties:
      - lf-infra-properties:
          build-days-to-keep: "{build-days-to-keep}"
      - github:
          url: "{github-url}/{github-org}/{project}"

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-credential}"
      - credentials-binding:
          - file:
              credential-id: "{cosign-private-key-id}"
              variable: COSIGN_PRIVATE_KEY
          - text:
              credential-id: "{cosign-password-id}"
              variable: COSIGN_PASSWORD

    scm:
      - lf-infra-github-scm:
          url: "{git-clone-url}{github-org}/{project}"
          refspec: "+refs/pull/*:refs/remotes/origin/pr/*"
          branch: "$sha1"
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          choosing-strategy: default
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    triggers:
      - github-pull-request:
          trigger-phrase: "^remerge$"
          only-trigger-phrase: true
          status-context: "Github Release Merge"
          permit-all: true
          github-hooks: true
          white-list-target-branches:
            - "{branch}"
          included-regions: "{obj:github_included_regions}"

################
# PyPI RELEASE #
################

- _lf_pypi_verify_wrappers: &lf_pypi_verify_wrappers
    name: lf-pypi-verify-wrappers

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

- _lf_pypi_release_wrappers: &lf_pypi_release_wrappers
    name: lf-pypi-release-wrappers

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-release-credential}"

- _lf_pypi_release: &lf_pypi_release
    name: lf-pypi-release

    ######################
    # Default parameters #
    ######################

    branch: master # for github
    build-days-to-keep: 7
    build-timeout: 15
    disable-job: false
    gerrit-skip-vote: false
    git-url: "$GIT_URL/$PROJECT"
    github-url: "https://github.com"
    pypi-repo: pypi
    pypi-stage-index: https://test.pypi.org/simple
    submodule-disable: true
    submodule-recursive: false
    submodule-timeout: 10
    use-release-file: true

    # define once and use twice; jobs MUST NOT override
    gerrit_release_trigger_file_paths:
      - compare-type: REG_EXP
        pattern: '(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)'

    # yamllint disable-line rule:line-length
    # github_release_included_regions MUST match gerrit_release_trigger_file_paths
    github_release_included_regions:
      - 'releases\/pypi.*\.yaml'
      - '.releases\/pypi.*\.yaml'

    parameters:
      - lf-infra-parameters:
          project: "{project}"
          branch: "$GERRIT_BRANCH"
          stream: "$GERRIT_BRANCH"
      # accept all entries defined in the release-yaml file
      - string:
          name: DISTRIBUTION_TYPE
          default: "pypi"
          description: "The Jenkins release job distribution type."
      - string:
          name: LOG_DIR
          default: ""
          description: "The partial path of logs from the PyPI merge job."
      - string:
          name: GIT_TAG
          default: ""
          description: "Tag to push to git repo; optional, defaults to VERSION."
      - string:
          name: PYPI_PROJECT
          default: ""
          description: "The PyPI project name."
      - string:
          name: PYTHON_VERSION
          default: ""
          description: "The Python compatibility version, example: 3.6"
      - string:
          name: VERSION
          default: ""
          description: "The module version, example: 1.0.0"
      # special parameters for manual use of the Jenkins job
      - bool:
          name: USE_RELEASE_FILE
          default: true
          description: "Set to False (unchecked) to build with parameters"
      - bool:
          name: TAG_RELEASE
          default: true
          description: |
            Tag Gerrit repo after release.
      - bool:
          name: DRY_RUN
          default: false
          description: "Set to True (checked) to skip uploading artifacts"

    builders:
      - lf-infra-pre-build
      - config-file-provider:
          files:
            - file-id: sigul-config
              variable: SIGUL_CONFIG
            - file-id: sigul-password
              variable: SIGUL_PASSWORD
            - file-id: sigul-pki
              variable: SIGUL_PKI
            - file-id: signing-pubkey
              variable: SIGNING_PUBKEY
            - file-id: pypirc
              target: "$HOME/.pypirc"
      - shell: !include-raw-escape: ../shell/sigul-configuration.sh
      - shell: !include-raw-escape: ../shell/sigul-install.sh
      - inject:
          properties-content: |
            PYPI_INDEX={pypi-stage-index}
            REPOSITORY={pypi-repo}
      - shell: !include-raw-escape: ../shell/release-job.sh

- job-template:
    name: "{project-name}-pypi-release-merge"
    id: gerrit-pypi-release-merge
    <<: *lf_release_common
    <<: *lf_pypi_release_wrappers
    <<: *lf_pypi_release

    scm:
      - lf-infra-gerrit-scm:
          jenkins-ssh-credential: "{jenkins-ssh-credential}"
          git-url: "{git-url}"
          refspec: "$GERRIT_REFSPEC"
          branch: "$GERRIT_BRANCH"
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          # release merge jobs build from commit not tip
          choosing-strategy: gerrit

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on:
            - change-merged-event
            - comment-added-contains-event:
                comment-contains-value: '^Patch Set\s+\d+:\s+remerge\s*$'
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project}"
              branches:
                - branch-compare-type: ANT
                  branch-pattern: "**/{branch}"
              file-paths: "{obj:gerrit_release_trigger_file_paths}"

- job-template:
    name: "{project-name}-pypi-release-merge"
    id: github-pypi-release-merge
    <<: *lf_release_common
    <<: *lf_pypi_release_wrappers
    <<: *lf_pypi_release

    properties:
      - github:
          url: "{github-url}/{github-org}/{project}"

    scm:
      - lf-infra-github-scm:
          url: "{git-clone-url}{github-org}/{project}"
          refspec: ""
          branch: "refs/heads/{branch}"
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          choosing-strategy: default
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    triggers:
      - github-pull-request:
          trigger-phrase: "^(remerge)$"
          only-trigger-phrase: false
          status-context: "PyPI Release Merge"
          permit-all: true
          github-hooks: true
          white-list-target-branches:
            - "{branch}"
          included-regions: "{obj:github_release_included_regions}"

- job-template:
    name: "{project-name}-pypi-release-verify"
    id: gerrit-pypi-release-verify
    <<: *lf_release_common
    <<: *lf_pypi_verify_wrappers
    <<: *lf_pypi_release

    scm:
      - lf-infra-gerrit-scm:
          jenkins-ssh-credential: "{jenkins-ssh-credential}"
          git-url: "{git-url}"
          refspec: "$GERRIT_REFSPEC"
          branch: "$GERRIT_BRANCH"
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          choosing-strategy: gerrit

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on:
            - patchset-created-event:
                exclude-drafts: true
                exclude-trivial-rebase: false
                exclude-no-code-change: false
            - draft-published-event
            - comment-added-contains-event:
                # yamllint disable-line rule:line-length
                comment-contains-value: '^Patch Set\s+\d+:\s+(recheck|reverify)\s*$'
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project}"
              branches:
                - branch-compare-type: ANT
                  branch-pattern: "**/{branch}"
              file-paths: "{obj:gerrit_release_trigger_file_paths}"

- job-template:
    name: "{project-name}-pypi-release-verify"
    id: github-pypi-release-verify
    <<: *lf_release_common
    <<: *lf_pypi_verify_wrappers
    <<: *lf_pypi_release

    properties:
      - github:
          url: "{github-url}/{github-org}/{project}"

    scm:
      - lf-infra-github-scm:
          url: "{git-clone-url}{github-org}/{project}"
          refspec: ""
          branch: "refs/heads/{branch}"
          submodule-recursive: "{submodule-recursive}"
          submodule-timeout: "{submodule-timeout}"
          submodule-disable: "{submodule-disable}"
          choosing-strategy: default
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    triggers:
      - github-pull-request:
          trigger-phrase: "^(recheck|reverify)$"
          only-trigger-phrase: false
          status-context: "PyPI Release Verify"
          permit-all: true
          github-hooks: true
          white-list-target-branches:
            - "{branch}"
          included-regions: "{obj:github_release_included_regions}"

########################
# PackageCloud RELEASE #
########################

- _lf_packagecloud_release_common: &lf_packagecloud_release_common
    name: lf-packagecloud-release-common

    ######################
    # Default parameters #
    ######################

    build-days-to-keep: 7
    build-timeout: 15
    disable-job: false
    git-url: "$GIT_URL/$PROJECT"
    gerrit-skip-vote: false
    use-release-file: true
    account-name: ""
    source-repo: ""

    #####################
    # Job Configuration #
    #####################

    disabled: "{disable-job}"

    parameters:
      - lf-infra-parameters:
          project: "{project}"
          branch: "$GERRIT_BRANCH"
          stream: "$GERRIT_BRANCH"
      - string:
          name: DISTRIBUTION_TYPE
          default: "packagecloud"
          description: "The Jenkins release job distribution type."
      - bool:
          name: TAG_RELEASE
          default: true
          description: |
            Tag Gerrit repo after release.
      - bool:
          name: DRY_RUN
          default: false
          description: |
            If DRY_RUN is enabled artifacts are not promoted.
      - bool:
          name: USE_RELEASE_FILE
          default: "{use-release-file}"
          description: "Set to False for job built with parameters"

    builders:
      - lf-infra-pre-build
      - config-file-provider:
          files:
            - file-id: sigul-config
              variable: SIGUL_CONFIG
            - file-id: sigul-password
              variable: SIGUL_PASSWORD
            - file-id: sigul-pki
              variable: SIGUL_PKI
            - file-id: signing-pubkey
              variable: SIGNING_PUBKEY
            - file-id: "packagecloud_api"
              target: "$HOME/packagecloud_api"
            - file-id: packagecloud-account
              variable: ACCOUNT_NAME_FILE
      - shell: !include-raw-escape: ../shell/sigul-configuration.sh
      - shell: !include-raw-escape: ../shell/sigul-install.sh
      - lf-release

- job-template:
    name: "{project-name}-packagecloud-release-verify"
    id: gerrit-packagecloud-release-verify
    <<: *lf_release_common
    <<: *lf_packagecloud_release_common

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    scm:
      - lf-infra-gerrit-scm:
          git-url: "{git-url}"
          refspec: "$GERRIT_REFSPEC"
          branch: "$GERRIT_BRANCH"
          submodule-disable: true
          submodule-recursive: false
          submodule-timeout: 10
          choosing-strategy: gerrit
          jenkins-ssh-credential: "{jenkins-ssh-credential}"

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on:
            - patchset-created-event:
                exclude-drafts: true
                exclude-trivial-rebase: false
                exclude-no-code-change: false
            - draft-published-event
            - comment-added-contains-event:
                # yamllint disable-line rule:line-length
                comment-contains-value: '^Patch Set\s+\d+:\s+(recheck|reverify)\s*$'
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project}"
              branches:
                - branch-compare-type: "ANT"
                  branch-pattern: "**/{branch}"
              file-paths:
                - compare-type: REG_EXP
                  pattern: '(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)'
          skip-vote:
            successful: "{gerrit-skip-vote}"
            failed: "{gerrit-skip-vote}"
            unstable: "{gerrit-skip-vote}"
            notbuilt: "{gerrit-skip-vote}"

- job-template:
    name: "{project-name}-packagecloud-release-merge"
    id: gerrit-packagecloud-release-merge
    <<: *lf_release_common
    <<: *lf_packagecloud_release_common

    wrappers:
      - lf-infra-wrappers:
          build-timeout: "{build-timeout}"
          jenkins-ssh-credential: "{jenkins-ssh-release-credential}"

    scm:
      - lf-infra-gerrit-scm:
          jenkins-ssh-credential: "{jenkins-ssh-credential}"
          git-url: "{git-url}"
          refspec: "$GERRIT_REFSPEC"
          branch: "$GERRIT_BRANCH"
          submodule-disable: true
          submodule-recursive: false
          submodule-timeout: 10
          # release merge jobs build from commit not tip
          choosing-strategy: gerrit

    triggers:
      - gerrit:
          server-name: "{gerrit-server-name}"
          trigger-on:
            - change-merged-event
            - comment-added-contains-event:
                comment-contains-value: '^Patch Set\s+\d+:\s+remerge\s*$'
          projects:
            - project-compare-type: "ANT"
              project-pattern: "{project}"
              branches:
                - branch-compare-type: "ANT"
                  branch-pattern: "**/{branch}"
              file-paths:
                - compare-type: REG_EXP
                  pattern: '(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)'