mesa/.gitlab-ci/test/gitlab-ci.yml

.test:
  # Cancel job if a newer commit is pushed to the same branch
  interruptible: true
  variables:
    GIT_STRATEGY: none  # testing doesn't build anything from source
  # `before_script:` is only used by test jobs on generic fdo runners
  # it's overwritten by hardware test jobs
  before_script:
    - !reference [.download_s3, before_script]
    - section_start ldd_section "Checking ldd on driver build"
    - LD_LIBRARY_PATH=install/lib find install/lib -name "*.so" -print -exec ldd {} \;
    - section_end ldd_section
  artifacts:
    when: always
    name: "${CI_PROJECT_NAME}_${CI_JOB_NAME}"
    paths:
      - results/
  rules:
    - !reference [.common-rules, rules]
    - !reference [.never-post-merge-rules, rules]

.formatting-check:
  # Cancel job if a newer commit is pushed to the same branch
  interruptible: true
  stage: code-validation
  extends:
    - .use-debian/x86_64_build
  variables:
    GIT_STRATEGY: fetch
  timeout: 10m
  script:
    - git diff --color=always --exit-code  # Fails if there are diffs

rustfmt:
  extends:
    - .formatting-check
    - .lint-rustfmt-rules
  before_script:
    - shopt -s globstar
    - source "$HOME/.cargo/env"
    - rustfmt --version
    - rustfmt --verbose src/**/lib.rs

shader-db:
  stage: code-validation
  extends:
    - .use-debian/x86_64_build
  rules:
    - !reference [.never-post-merge-rules, rules]
    - !reference [.core-rules, rules]
    # Keep this list in sync with the drivers tested in run-shader-db.sh
    - !reference [.freedreno-common-rules, rules]
    - !reference [.intel-common-rules, rules]
    - !reference [.lima-rules, rules]
    - !reference [.v3d-rules, rules]
    - !reference [.vc4-rules, rules]
    - !reference [.nouveau-rules, rules]
    - !reference [.r300-rules, rules]
    # Also run if this job's own config or script changes
    - changes:
        - .gitlab-ci/build/gitlab-ci.yml
        - .gitlab-ci/run-shader-db.sh
  needs:
    - debian-build-testing
  variables:
    S3_ARTIFACT_NAME: debian-build-testing
  before_script:
    - !reference [.download_s3, before_script]
  script: |
    .gitlab-ci/run-shader-db.sh
  artifacts:
    paths:
      - shader-db
  timeout: 15m
  tags:
    # FIXME: kvm is a hack, should not be needed
    - $FDO_RUNNER_JOB_PRIORITY_TAG_X86_64_KVM

yaml-toml-shell-py-test:
  extends:
    - .use-debian/x86_64_pyutils
    - .no-auto-retry  # this job can't be flaky
  stage: code-validation
  script:
    - uncollapsed_section_start tomllint "tomllint"
    - echo "If your change looks right but this script rejects it, contact @eric (GitLab) / eric_engestrom (IRC)."
    - python3 bin/toml_lint.py
    - uncollapsed_section_switch yamllint "yamllint"
    - .gitlab-ci/run-yamllint.sh
    - uncollapsed_section_switch shellcheck "shellcheck"
    - .gitlab-ci/run-shellcheck.sh
    - section_end shellcheck
    - .gitlab-ci/run-pytest.sh
  rules:
    - !reference [.disable-farm-mr-rules, rules]
    - !reference [.never-post-merge-rules, rules]
    - !reference [.no_scheduled_pipelines-rules, rules]
    # merge pipeline
    - if: $GITLAB_USER_LOGIN == "marge-bot" && $CI_PIPELINE_SOURCE == "merge_request_event"
      changes: &lint_files
        - .gitlab-ci/test/gitlab-ci.yml
        - .gitlab-ci/**/*.sh
        - .shellcheckrc
        - bin/toml_lint.py
        - src/**/ci/*.toml
        - .gitlab-ci/tests/**/*
        - bin/ci/**/*
      when: on_success
    # direct pushes that bypassed the CI
    - if: $CI_PROJECT_NAMESPACE == "mesa" && $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
      changes: *lint_files
      when: on_success
    # direct pushes from release manager
    - if: $CI_PROJECT_NAMESPACE == "mesa" && $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_REF_NAME =~ /^staging\//
      changes: *lint_files
      when: on_success
    - changes: *lint_files
      when: manual

.test-gl:
  extends:
    - .test
    - .use-debian/x86_64_test-gl
  needs:
    - debian/x86_64_test-gl
    - debian-testing
    - !reference [.required-for-hardware-jobs, needs]
  variables:
    DEBIAN_ARCH: amd64
    S3_ARTIFACT_NAME: mesa-x86_64-default-debugoptimized

.test-vk:
  extends:
    - .test
    - .use-debian/x86_64_test-vk
  needs:
    - debian-testing
    - debian/x86_64_test-vk
    - !reference [.required-for-hardware-jobs, needs]
  variables:
    DEBIAN_ARCH: amd64
    S3_ARTIFACT_NAME: mesa-x86_64-default-debugoptimized

.test-cl:
  extends:
    - .test
    - .use-debian/x86_64_test-gl
  needs:
    - debian/x86_64_test-gl
    - !reference [.required-for-hardware-jobs, needs]
  variables:
    S3_ARTIFACT_NAME: mesa-x86_64-default-debugoptimized

.test-android:
  extends:
    - .test
    - .use-debian/x86_64_test-android
  variables:
    # This is for the guest artifacts from debian-android which will be
    # downloaded explicitly by cuttlefish-runner.sh
    S3_ANDROID_ARTIFACT_NAME: mesa-x86_64-android-debug
    S3_ARTIFACT_NAME: mesa-x86_64-default-debugoptimized
    # Set the default Vulkan driver to lavapipe for some preliminary checks
    # that Cuttlefish always performs before starting the VM. This can be
    # overwritten depending on the physical machine running the job.
    VK_DRIVER: "lvp"
  needs:
    - job: debian-testing
      artifacts: true  # On the host we want the Linux build
    - job: debian-android
      artifacts: false  # The Android build will be downloaded later
    - job: debian/x86_64_test-android
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]
  timeout: 20m
  script:
    - ./install/cuttlefish-runner.sh
  artifacts:
    paths:
      - results/

.test-angle:
  variables:
    ANGLE_TAG: ${CONDITIONAL_BUILD_ANGLE_TAG}

.test-crosvm:
  variables:
    CROSVM_TAG: ${CONDITIONAL_BUILD_CROSVM_TAG}

.test-fluster:
  variables:
    FLUSTER_TAG: ${CONDITIONAL_BUILD_FLUSTER_TAG}
    FLUSTER_RESULTS: "${GPU_VERSION}-${FLUSTER_CODEC}"
    HWCI_TEST_SCRIPT: install/fluster-runner.sh

.test-piglit:
  variables:
    PIGLIT_TAG: ${CONDITIONAL_BUILD_PIGLIT_TAG}

.test-vkd3d-proton:
  variables:
    HWCI_TEST_SCRIPT: install/vkd3d-runner.sh

.piglit-traces-test:
  artifacts:
    when: on_failure
    name: "${CI_PROJECT_NAME}_${CI_JOB_NAME}"
    reports:
      junit: results/junit.xml
    paths:
      - results/
    exclude:
      - results/*.shader_cache
  extends:
    - .test-piglit
  variables:
    # until we overcome Infrastructure issues, give traces extra 5 min before timeout
    DEVICE_HANGING_TIMEOUT_SEC: 600
    PIGLIT_REPLAY_EXTRA_ARGS: --db-path ${CI_PROJECT_DIR}/replayer-db/ --minio_bucket=${S3_TRACIE_PUBLIC_BUCKET} --jwt-file=${S3_JWT_FILE}
    PIGLIT_NO_WINDOW: 1
    HWCI_TEST_SCRIPT: "/install/piglit/piglit-traces.sh"
  script:
    - section_start variables "Variables passed through:"
    - install/common/export-gitlab-job-env-for-dut.sh
    - section_end variables
    - install/piglit/piglit-traces.sh

.deqp-test:
  script:
    - rm -rf results  # Clear out old results if the docker container was cached
    - ./install/deqp-runner.sh
  artifacts:
    exclude:
      - results/*.shader_cache
    reports:
      junit: results/junit.xml

.fossilize-test:
  script:
    - ./install/fossilize-runner.sh
  artifacts:
    when: on_failure
    name: "${CI_PROJECT_NAME}_${CI_JOB_NAME}"
    paths:
      - results/

.download_s3:
  before_script:
    - !reference [default, before_script]
    # Use this instead of gitlab's artifacts download because it hits packet.net
    # instead of fd.o.  Set FDO_HTTP_CACHE_URI to an http cache for your test lab to
    # improve it even more (see https://docs.mesa3d.org/ci/bare-metal.html for
    # setup).
    - section_start artifacts_download "Downloading artifacts from s3"
    # Note: Build dir (and thus install) may be dirty due to GIT_STRATEGY
    - rm -rf install
    - (set -x; curl -L --retry 4 -f --retry-all-errors --retry-delay 60 ${FDO_HTTP_CACHE_URI:-}https://${PIPELINE_ARTIFACTS_BASE}/${S3_ARTIFACT_NAME}.tar.zst | tar --zstd -x)
    - section_end artifacts_download

.baremetal-test:
  extends:
    - .test
  # Cancel job if a newer commit is pushed to the same branch
  interruptible: true
  before_script:
    - !reference [.download_s3, before_script]
  variables:
    BM_ROOTFS: /rootfs-${DEBIAN_ARCH}
  artifacts:
    when: always
    name: "${CI_PROJECT_NAME}_${CI_JOB_NAME}"
    paths:
      - results/
      - serial*.txt
    exclude:
      - results/*.shader_cache
    reports:
      junit: results/junit.xml

# ARM testing of bare-metal boards attached to an x86 gitlab-runner system
.baremetal-test-arm32-gl:
  extends:
    - .baremetal-test
    - .use-debian/baremetal_arm32_test-gl
  variables:
    DEBIAN_ARCH: armhf
    S3_ARTIFACT_NAME: mesa-arm32-default-debugoptimized
  needs:
    - debian/baremetal_arm32_test-gl
    - job: debian-arm32
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

# ARM64 testing of bare-metal boards attached to an x86 gitlab-runner system
.baremetal-test-arm64-gl:
  extends:
    - .baremetal-test
    - .use-debian/baremetal_arm64_test-gl
  variables:
    DEBIAN_ARCH: arm64
    S3_ARTIFACT_NAME: mesa-arm64-default-debugoptimized
  needs:
    - debian/baremetal_arm64_test-gl
    - job: debian-arm64
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

# ARM64 testing of bare-metal boards attached to an x86 gitlab-runner system
.baremetal-test-arm64-vk:
  extends:
    - .baremetal-test
    - .use-debian/baremetal_arm64_test-vk
  variables:
    DEBIAN_ARCH: arm64
    S3_ARTIFACT_NAME: mesa-arm64-default-debugoptimized
  needs:
    - debian/baremetal_arm64_test-vk
    - job: debian-arm64
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

# ARM32/64 testing of bare-metal boards attached to an x86 gitlab-runner system, using an asan mesa build
.baremetal-arm32-asan-test-gl:
  variables:
    S3_ARTIFACT_NAME: mesa-arm32-asan-debugoptimized
    DEQP_FORCE_ASAN: 1
  needs:
    - debian/baremetal_arm32_test-gl
    - job: debian-arm32-asan
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

.baremetal-arm64-asan-test-gl:
  variables:
    S3_ARTIFACT_NAME: mesa-arm64-asan-debugoptimized
    DEQP_FORCE_ASAN: 1
  needs:
    - debian/baremetal_arm64_test-gl
    - job: debian-arm64-asan
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

.baremetal-arm64-asan-test-vk:
  variables:
    S3_ARTIFACT_NAME: mesa-arm64-asan-debugoptimized
    DEQP_FORCE_ASAN: 1
  needs:
    - debian/baremetal_arm64_test-vk
    - job: debian-arm64-asan
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

.baremetal-arm64-ubsan-test-gl:
  extends:
    - .baremetal-test
    - .use-debian/baremetal_arm64_test-gl
  variables:
    S3_ARTIFACT_NAME: mesa-arm64-ubsan-debugoptimized
  needs:
    - debian/baremetal_arm64_test-gl
    - job: debian-arm64-ubsan
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

.baremetal-arm64-ubsan-test-vk:
  extends:
    - .baremetal-test
    - .use-debian/baremetal_arm64_test-vk
  variables:
    S3_ARTIFACT_NAME: mesa-arm64-ubsan-debugoptimized
  needs:
    - debian/baremetal_arm64_test-vk
    - job: debian-arm64-ubsan
      artifacts: false
    - !reference [.required-for-hardware-jobs, needs]

.baremetal-deqp-test:
  variables:
    HWCI_TEST_SCRIPT: "/install/deqp-runner.sh"
    FDO_CI_CONCURRENT: 0  # Default to number of CPUs

# For CI-tron based testing farm jobs.
.b2c-test:
  extends:
    - .ci-tron-b2c-job-v1
  timeout: 1h 40m
  variables:
    GIT_STRATEGY: none
    # boot2container initrd configuration parameters.
    B2C_VERSION: v0.9.14

    SCRIPTS_DIR: install

    CI_TRON_PATTERN__JOB_SUCCESS__REGEX: 'hwci: mesa: pass, exit_code: 0\r$'
    CI_TRON_PATTERN__SESSION_END__REGEX: '^.*It''s now safe to turn off your computer\r$'

    CI_TRON_TIMEOUT__BOOT_CYCLE__MINUTES: 45
    CI_TRON_TIMEOUT__FIRST_CONSOLE_ACTIVITY__MINUTES: 2
    CI_TRON_TIMEOUT__FIRST_CONSOLE_ACTIVITY__RETRIES: 3
    CI_TRON_TIMEOUT__CONSOLE_ACTIVITY__MINUTES: 5
    CI_TRON_TIMEOUT__OVERALL__MINUTES: 90

    CI_TRON__B2C_ARTIFACT_EXCLUSION: "*.shader_cache,install/*,*/install/*,*/vkd3d-proton.cache*,vkd3d-proton.cache*,*.qpa"
    CI_TRON_HTTP_ARTIFACT__INSTALL__PATH: "/install.tar.zst"
    CI_TRON_HTTP_ARTIFACT__INSTALL__URL: "https://$PIPELINE_ARTIFACTS_BASE/$S3_ARTIFACT_NAME.tar.zst"

    CI_TRON__B2C_MACHINE_REGISTRATION_CMD: "setup --tags $CI_TRON_DUT_SETUP_TAGS"
    CI_TRON__B2C_IMAGE_UNDER_TEST: $MESA_IMAGE
    CI_TRON__B2C_EXEC_CMD: "curl --silent --fail-with-body {{ job.http.url }}$CI_TRON_HTTP_ARTIFACT__INSTALL__PATH | tar --zstd --extract && $SCRIPTS_DIR/common/init-stage2.sh"

    # Assume by default this is running deqp, as that's almost always true
    HWCI_TEST_SCRIPT: install/deqp-runner.sh
  needs:
    - !reference [.required-for-hardware-jobs, needs]
  tags:
    - farm:$RUNNER_FARM_LOCATION
    - $CI_TRON_DUT_SETUP_TAGS

  # Override the default before_script, as it is not compatible with the CI-tron environment. We just keep the clearing
  # of the JWT token for security reasons
  before_script:
    - |
      set -eu

      eval "$S3_JWT_FILE_SCRIPT"

      for var in CI_TRON_DUT_SETUP_TAGS; do
        if [[ -z "$(eval echo \${$var:-})" ]]; then
          echo "The required variable '$var' is missing"
          exit 1
        fi
      done


      # Open a section that will be closed by b2c
      echo -e "\n\e[0Ksection_start:`date +%s`:b2c_kernel_boot[collapsed=true]\r\e[0K\e[0;36m[$(cut -d ' ' -f1 /proc/uptime)]: Submitting the CI-tron job and booting the DUT\e[0m\n"

      # Print all the variables, for debugging and for easier reproducibility.
      # Note: a better solution will be implemented soon, but this is enough
      # for now.
      printenv

  # Anything our job places in results/ will be collected by the
  # Gitlab coordinator for status presentation. results/junit.xml
  # will be parsed by the UI for more detailed explanations of
  # test execution.
  artifacts:
    when: always
    name: "${CI_PROJECT_NAME}_${CI_JOB_NAME}"
    paths:
      - results
    reports:
      junit: results/**/junit.xml

.b2c-x86_64-test:
  extends:
    - .b2c-test
  variables:
    CI_TRON_INITRAMFS__B2C__URL: 'https://gitlab.freedesktop.org/gfx-ci/boot2container/-/releases/$B2C_VERSION/downloads/initramfs.linux_amd64.cpio.xz'
    CI_TRON_KERNEL__URL: 'https://gitlab.freedesktop.org/gfx-ci/ci-tron/-/package_files/519/download'  # Linux 6.1

    # Set the following variables if you need AMD, Intel, or NVIDIA support
    # CI_TRON_INITRAMFS__DEPMOD__URL: "https://gitlab.freedesktop.org/gfx-ci/boot2container/-/releases/$B2C_VERSION/downloads/linux-x86_64.depmod.cpio.xz"
    # CI_TRON_INITRAMFS__GPU__URL: "https://gitlab.freedesktop.org/gfx-ci/boot2container/-/releases/$B2C_VERSION/downloads/linux-x86_64.gpu.cpio"
    # CI_TRON_INITRAMFS__GPU__FORMAT__0__ARCHIVE__KEEP__0__PATH: "(lib/(modules|firmware/amdgpu)/.*)"

    S3_ARTIFACT_NAME: "mesa-x86_64-default-debugoptimized"

.b2c-x86_64-test-vk:
  extends:
    - .use-debian/x86_64_test-vk
    - .b2c-x86_64-test
  needs:
    - job: debian/x86_64_test-vk
      artifacts: false
    - job: debian-testing
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-x86_64-test-vk-manual:
  extends:
    - .use-debian/x86_64_test-vk
    - .b2c-x86_64-test
  variables:
    S3_ARTIFACT_NAME: "debian-build-testing"
  needs:
    - job: debian/x86_64_test-vk
      artifacts: false
    - job: debian-build-testing
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-x86_64-test-gl:
  extends:
    - .use-debian/x86_64_test-gl
    - .b2c-x86_64-test
  needs:
    - job: debian/x86_64_test-gl
      artifacts: false
    - job: debian-testing
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-x86_64-test-gl-manual:
  extends:
    - .use-debian/x86_64_test-gl
    - .b2c-x86_64-test
  variables:
    S3_ARTIFACT_NAME: "debian-build-testing"
  needs:
    - job: debian/x86_64_test-gl
      artifacts: false
    - job: debian-build-testing
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-arm64-test:
  extends:
    - .b2c-test
  variables:
    CI_TRON_INITRAMFS__B2C__URL: 'https://gitlab.freedesktop.org/gfx-ci/boot2container/-/releases/$B2C_VERSION/downloads/initramfs.linux_arm64.cpio.xz'
    CI_TRON_KERNEL__URL: 'https://gitlab.freedesktop.org/gfx-ci/boot2container/-/releases/$B2C_VERSION/downloads/linux-arm64'
    S3_ARTIFACT_NAME: "mesa-arm64-default-debugoptimized"

.b2c-arm64-test-vk:
  extends:
    - .use-debian/arm64_test-vk
    - .b2c-arm64-test
  needs:
    - job: debian/arm64_test-vk
      artifacts: false
    - job: debian-arm64
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-arm64-test-gl:
  extends:
    - .use-debian/arm64_test-gl
    - .b2c-arm64-test
  needs:
    - job: debian/arm64_test-gl
      artifacts: false
    - job: debian-arm64
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-arm32-test:
  extends:
    - .b2c-test
  variables:
    CI_TRON_INITRAMFS__B2C__URL: 'https://gitlab.freedesktop.org/gfx-ci/boot2container/-/releases/$B2C_VERSION/downloads/initramfs.linux_arm.cpio.xz'
    CI_TRON_KERNEL__URL: 'https://gitlab.freedesktop.org/gfx-ci/boot2container/-/releases/$B2C_VERSION/downloads/linux-arm'
    S3_ARTIFACT_NAME: "mesa-arm32-default-debugoptimized"

.b2c-arm32-test-vk:
  extends:
    - .use-debian/arm32_test-vk
    - .b2c-arm32-test
  needs:
    - job: debian/arm32_test-vk
      artifacts: false
    - job: debian-arm32
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-arm32-test-gl:
  extends:
    - .use-debian/arm32_test-gl
    - .b2c-arm32-test
  needs:
    - job: debian/arm32_test-gl
      artifacts: false
    - job: debian-arm32
      artifacts: false
    - !reference [.b2c-test, needs]

.b2c-arm32-test-asan-gl:
  extends:
    - .use-debian/arm32_test-gl
    - .b2c-arm32-test
  variables:
    S3_ARTIFACT_NAME: "mesa-arm32-asan-debugoptimized"
    DEQP_FORCE_ASAN: 1
  needs:
    - job: debian/arm32_test-gl
      artifacts: false
    - job: debian-arm32-asan
      artifacts: false
    - !reference [.b2c-test, needs]