#-------------------------------------------------------------------------------
# Copyright (c) 2020-2023, Arm Limited. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
#-------------------------------------------------------------------------------

- job:
    name: tf-m-lava-submit
    description: 'Generates and submits LAVA jobs'
    project-type: pipeline
    disabled: false
    sandbox: true
    concurrent: true
    properties:
      - build-discarder:
          days-to-keep: 15
          num-to-keep: 6000
# Instance specific parameters can be set as environment variables in
# * docker image (ENV)
# * Jenkins -> configure system -> global properties -> environment variables
# e.g. DOCKER_PREFIX, LICENSE_VARIABLE
    parameters:

      - string:
          name: 'CONFIG_NAME'
      - string:
          name: 'TFM_PLATFORM'
          description: |
            Specifies the target platform.
            For more information see <a href="https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/plain/docs/getting_started/tfm_build_instruction.rst">here</a>.
          default: ''
      - string:
          name: 'ISOLATION_LEVEL'
          default: '1'
      - string:
          name: 'TEST_REGRESSION'
          default: 'False'
      - string:
          name: 'TEST_PSA_API'
          default: 'OFF'
      - string:
          name: 'PROFILE'
          default: 'N.A'
      - string:
          name: 'EXTRA_PARAMS'
          default: 'N.A'
      - string:
          name: 'GERRIT_HOST'
          default: ''
          description: |
            No need to change.
      - string:
          name: 'GERRIT_PATCHSET_REVISION'
          default: ''
          description: |
            No need to change.
      - string:
          name: 'GERRIT_CHANGE_NUMBER'
          default: ''
          description: |
            No need to change.
      - string:
          name: 'MCUBOOT_REFSPEC'
          default: ''
          description: |
            Specify which MCUboot version to use
            refs/heads/<branch_name> : Pick up latest HEAD on branch
            TAG_NAME                 : Pick up a tagged version
            full commit hash         : Pick up a specific commit
      - string:
          name: 'MCUBOOT_URL'
          default: 'https://git.trustedfirmware.org/mirror/mcuboot.git'
      - string:
          name: 'TFM_TESTS_URL'
          default: 'https://git.trustedfirmware.org/TF-M/tf-m-tests.git'
      - string:
          name: 'TFM_TESTS_REFSPEC'
          default: ''
          description: |
            Specify which tf-m-tests version to use
            refs/heads/<branch_name> : Pick up latest HEAD on branch
            TAG_NAME                 : Pick up a tagged version
            full commit hash         : Pick up a specific commit
      - string:
          name: 'TFM_EXTRAS_URL'
          default: 'https://git.trustedfirmware.org/TF-M/tf-m-extras.git'
      - string:
          name: 'TFM_EXTRAS_REFSPEC'
          default: ''
          description: |
            Specify which tf-m-extras version to use
            refs/heads/<branch_name> : Pick up latest HEAD on branch
            TAG_NAME                 : Pick up a tagged version
            full commit hash         : Pick up a specific commit
      - string:
          name: 'PSA_ARCH_TESTS_URL'
          default: 'https://git.trustedfirmware.org/mirror/psa-arch-tests.git'
      - string:
          name: 'PSA_ARCH_TESTS_VERSION'
          default: ''
          description: |
            Specify which psa-arch-tests version to use
            refs/heads/<branch_name> : Pick up latest HEAD on branch
            TAG_NAME                 : Pick up a tagged version
            full commit hash         : Pick up a specific commit
      - string:
          name: 'QCBOR_URL'
          default: 'https://github.com/laurencelundblade/QCBOR.git'
      - string:
          name: 'QCBOR_VERSION'
          default: ''
          description: |
            Specify which QCBOR version to use
            refs/heads/<branch_name> : Pick up latest HEAD on branch
            TAG_NAME                 : Pick up a tagged version
            full commit hash         : Pick up a specific commit
      - string:
          name: 'CODE_COVERAGE_EN'
          default: 'FALSE'
      - string:
          name: SHARE_FOLDER
          default: '/srv/shared/${JOB_NAME}/${BUILD_NUMBER}'
          description: 'Folder containing shared repositories for downstream pipeline jobs'
      - string:
          name: DOCKER_PREFIX
          default: ${PRIVATE_CONTAINER_REGISTRY}
          description: PRIVATE_CONTAINER_REGISTRY is a system-wide environment variable
      - string:
          name: 'TARGET_PLATFORM'
          description: |
            Specifies the target platform.
            For more information see <a href="https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/plain/docs/getting_started/tfm_build_instruction.rst">here</a>.
          default: ''
      - string:
          name: 'PROJ_CONFIG'
          description: |
            Specifies the way the application is built.
            For more information see <a href="https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/plain/docs/getting_started/tfm_build_instruction.rst">here</a>.
          default: ''
      - string:
          name: 'COMPILER'
          description: |
            Specifies the compiler toolchain.
            For more information see <a href="https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/plain/docs/getting_started/tfm_build_instruction.rst">here</a>.
          default: ''
      - string:
          name: 'CMAKE_BUILD_TYPE'
          description: |
            Configures debugging support.
            For more information see <a href="https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/plain/docs/getting_started/tfm_build_instruction.rst">here</a>.
          default: ''
      - string:
          name: 'BL2'
          default: 'True'
          description: |
            Whether to build BL2.
            For more information see <a href="https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/plain/docs/getting_started/tfm_secure_boot.rst">here</a>.
      - string:
          name: 'GERRIT_REFSPEC'
          default: 'refs/heads/main'
          description: |
            Specify which TF-M version to use
            refs/heads/<branch_name> : Pick up latest HEAD on branch
            TAG_NAME                 : Pick up a tagged version
            full commit hash         : Pick up a specific commit
      - string:
          name: 'GERRIT_BRANCH'
          default: 'main'
          description: |
            TF-M branch.
      - string:
          name: 'CODE_REPO'
          default: 'https://review.trustedfirmware.org/TF-M/trusted-firmware-m'
      - string:
          name: 'CI_SCRIPTS_REPO'
          default: 'https://git.trustedfirmware.org/ci/tf-m-ci-scripts'
      - string:
          name: 'CI_SCRIPTS_BRANCH'
          default: 'master'
          description: |
            Branch of CI_SCRIPTS_REPO to use; also accepts Gerrit patch refspec like 'refs/changes/98/29798/1'
      - string:
          name: 'MBEDTLS_VERSION'
          default: ''
          description: |
            Specify which MBEDTLS version to use
            refs/heads/<branch_name> : Pick up latest HEAD on branch
            TAG_NAME                 : Pick up a tagged version
            full commit hash         : Pick up a specific commit
      - string:
          name: 'MBEDTLS_URL'
          default: 'https://git.trustedfirmware.org/mirror/mbed-tls.git'
      - string:
          name: 'BUILD_NUMBER'
          default: ''
      - string:
          name: 'BUILD_URL'
          default: ''
      - string:
          name: 'LAVA_URL'
          default: 'https://tf.validation.linaro.org'
      - string:
          name: 'PSA_API_SUITE'
          default: ''
      - string:
          name: 'CODE_COVERAGE_EN'
          default: 'FALSE'
      - string:
          name: 'LAVA_CREDENTIALS'
          default: 'LAVA_CREDENTIALS'
          description: "Name of Jenkins credential for authentication with LAVA."
      - string:
          name: 'DEVICE_FILTER'
          default: ''
          description: |
            Parameter to lava_create_jobs.py to filter by device type (e.g. --fvp-only or --physical-board-only)
    wrappers:
        - timestamps
    pipeline-scm:
      scm:
        - git:
            url: '$CI_SCRIPTS_REPO'
            branches:
            - '$CI_SCRIPTS_BRANCH'
            refspec: '+refs/heads/*:refs/remotes/origin/* +refs/changes/*:refs/remotes/origin/refs/changes/*'
            credentials-id: GIT_SSH_KEY
            wipe-workspace: false
      script-path: jenkins/lava-submit.jpl