#
# Copyright (c) 2025 Huawei Technologies Co., Ltd. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# This file is a part of the vllm-ascend project.
#

name: Doc Test

on:
  workflow_dispatch:
  workflow_call:
  pull_request:
    branches:
      - 'main'
      - '*-dev'
      - 'releases/v*'
    paths:
      # If we are changing the doctest we should do a PR test
      - '.github/workflows/labeled_doctest.yaml'
      - 'tests/e2e/doctests/**'
      - 'tests/e2e/common.sh'
      - 'tests/e2e/run_doctests.sh'

# Bash shells do not use ~/.profile or ~/.bashrc so these shells need to be explicitly
# declared as "shell: bash -el {0}" on steps that need to be properly activated.
# It's used to activate ascend-toolkit environment variables.
defaults:
  run:
    shell: bash -el {0}

concurrency:
  group: "labeled_doctest-${{ github.ref }}"
  cancel-in-progress: true

jobs:
  test:
    strategy:
      # Each version should be tested
      fail-fast: false
      matrix:
        vllm_version: [nightly-releases-v0.18.0, nightly-releases-v0.18.0-openeuler, nightly-main, nightly-main-openeuler]
    name: vLLM Ascend test
    runs-on: linux-aarch64-a2b3-1
    container:
      image: swr.cn-southwest-2.myhuaweicloud.com/base_image/ascend-ci/vllm-ascend:${{ matrix.vllm_version }}
    steps:
      - name: Check NPU/CANN and git info
        run: |
          echo "====> Print NPU/CANN info"
          npu-smi info
          cat /usr/local/Ascend/ascend-toolkit/latest/"$(uname -i)"-linux/ascend_toolkit_install.info

          echo "====> Print vllm-ascend git info"
          cd /vllm-workspace/vllm-ascend
          git --no-pager log -1 || true
          echo "====> Print vllm git info"
          cd /vllm-workspace/vllm
          git --no-pager log -1 || true

      - name: Checkout vllm-project/vllm-ascend repo
        uses: actions/checkout@v6

      - name: Run vllm-ascend/tests/e2e/run_doctests.sh
        run: |
          # PWD: /__w/vllm-ascend/vllm-ascend
          # Make sure e2e tests are latest
          echo "Replacing /vllm-workspace/vllm-ascend/tests/e2e ..."
          rm -rf /vllm-workspace/vllm-ascend/tests/e2e
          mkdir -p /vllm-workspace/vllm-ascend/tests
          # Overwrite e2e and examples
          cp -r tests/e2e /vllm-workspace/vllm-ascend/tests/
          cp -r examples /vllm-workspace/vllm-ascend/
          # We are now maintain version policy in the main, so we need to copy docs to make sure the doctest can be run successfully.
          cp -r docs /vllm-workspace/vllm-ascend/

          # Simulate container to enter directory
          cd /workspace

          # Run real test
          echo "Test:"
          /vllm-workspace/vllm-ascend/tests/e2e/run_doctests.sh