tests_linux_x86.yml

name: Tests::Linux::x86_64
on:
  workflow_call:
    inputs:
      lightning-gpu-version:
        type: string
        required: true
        description: The version of lightning to use. Valid values are either 'stable' (most recent git-tag) or 'latest' (most recent commit from master)
      pennylane-version:
        type: string
        required: true
        description: The version of PennyLane to use. Valid values are either 'stable' (most recent git-tag) or 'latest' (most recent commit from master)
  release:
  push:
    branches:
      - main
  pull_request:

env:
  COVERAGE_FLAGS: "--cov=pennylane_lightning_gpu --cov-report=term-missing --cov-report=xml:./coverage.xml --no-flaky-report -p no:warnings --tb=native" 
  GCC_VERSION: 11
  OMP_NUM_THREADS: "2"
  CI_CUDA_ARCH: 86
  MULTI_GPU_SUPPORT_REQUIRED: ${{ contains(github.event.pull_request.labels.*.name, 'ci:use-multi-gpu-runner') }}

concurrency:
  group: gpu-test-${{ github.ref }}-${{ inputs.lightning-gpu-version }}-${{ inputs.pennylane-version }}
  cancel-in-progress: true

jobs:
  set_runs_on_values:
    runs-on: ubuntu-latest

    steps:
      - name: Set GPU Label
        id: gpu_label
        run: |
          if [[ "${{ env.MULTI_GPU_SUPPORT_REQUIRED }}" == "true" ]]; then
            echo "gpu_type=multi-gpu" >> $GITHUB_OUTPUT
          else
            echo "gpu_type=gpu" >> $GITHUB_OUTPUT
          fi

    outputs:
      gpu_type: ${{ steps.gpu_label.outputs.gpu_type }}
      runs-on: '["self-hosted", "linux", "x64", "ubuntu-22.04", "${{ steps.gpu_label.outputs.gpu_type }}"]'

  cpptests:
    needs:
      - set_runs_on_values

    runs-on: ${{ fromJson(needs.set_runs_on_values.outputs.runs-on) }}

    strategy:
      max-parallel: 1

    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          # Checkout entire git-history if workflow_call passes 'stable' as we need to find the most recent git-tag
          fetch-depth: ${{ inputs.lightning-gpu-version == 'stable' && 0 || 1 }}

      - name: Switch to stable build of Lightning-GPU
        if: inputs.lightning-gpu-version == 'stable'
        run: git checkout $(git tag | sort -V | tail -1)

      - uses: actions/setup-python@v4
        id: setup_python
        name: Install Python
        with:
          python-version: '3.9'

      # Since the self-hosted runner can be re-used. It is best to set up all package
      # installations in a virtual environment that gets cleaned at the end of each workflow run
      - name: Setup Python virtual environment
        id: setup_venv
        env:
          VENV_NAME: ${{ github.workspace }}/venv_${{ steps.setup_python.outputs.python-version }}_${{ github.sha }}
        run: |
          # Clear any pre-existing venvs
          rm -rf venv_*

          # Create new venv for this workflow_run
          python --version
          python -m venv ${{ env.VENV_NAME }}

          # Add the venv to PATH for subsequent steps
          echo ${{ env.VENV_NAME }}/bin >> $GITHUB_PATH

          # Adding venv name as an output for subsequent steps to reference if needed
          echo "venv_name=${{ env.VENV_NAME }}" >> $GITHUB_OUTPUT

      - name: Display Python-Path
        id: python_path
        run: |
          py_path=$(which python)
          echo "Python Interpreter Path => $py_path"
          echo "python=$py_path" >> $GITHUB_OUTPUT
          
          pip_path=$(which python)
          echo "PIP Path => $pip_path"
          echo "pip=$pip_path" >> $GITHUB_OUTPUT

      - name: Install required packages
        run: |
          python -m pip install ninja cmake custatevec-cu11 

      - name: Validate GPU version and installed compiler
        run: |
          nvidia-smi
          /usr/local/cuda/bin/nvcc --version

      - name: Validate Multi-GPU packages
        if: needs.set_runs_on_values.outputs.gpu_type == 'multi-gpu'
        run: |
          source /etc/profile.d/modules.sh

          module use /opt/modules/

          echo 'Checking for OpenMPI'
          module load openmpi
          mpirun --version
          module unload openmpi

          echo 'Checking for MPICH'
          module load mpich
          mpiexec --version
          module unload mpich

      - name: Install Latest PennyLane
        if: inputs.pennylane-version == 'latest'
        run: python -m pip install git+https://github.com/PennyLaneAI/pennylane.git@master

      - name: Build and run unit tests
        run: |
            cmake . -BBuild \
              -DCMAKE_BUILD_TYPE=RelWithDebInfo \
              -DPLLGPU_BUILD_TESTS=ON \
              -DCMAKE_CXX_COMPILER="$(which g++-${{ env.GCC_VERSION }})" \
              -DLIGHTNING_RELEASE_TAG="v0.31.0" \
              -DCMAKE_CUDA_COMPILER="/usr/local/cuda/bin/nvcc" \
              -DCMAKE_CUDA_ARCHITECTURES="86" \
              -DPython_EXECUTABLE:FILE="${{ steps.python_path.outputs.python }}" \
              -G Ninja
            cmake --build ./Build
            cd ./Build
            mkdir -p ./tests/results
            ./pennylane_lightning_gpu/src/tests/runner_gpu --order lex --reporter junit --out ./tests/results/report_${{ github.job }}.xml

      - name: Upload test results
        uses: actions/upload-artifact@v3
        if: always()
        with:
          name: ubuntu-tests-reports
          path: ./Build/tests/results/report_${{ github.job }}.xml

      - name: Build and run unit tests for code coverage
        run: |
            cmake . -BBuildCov \
              -DCMAKE_BUILD_TYPE=Debug \
              -DPLLGPU_BUILD_TESTS=ON \
              -DPLLGPU_ENABLE_COVERAGE=ON \
              -DCMAKE_CXX_COMPILER="$(which g++-${{ env.GCC_VERSION }})" \
              -DLIGHTNING_RELEASE_TAG="v0.31.0" \
              -DCMAKE_CUDA_COMPILER="/usr/local/cuda/bin/nvcc" \
              -DCMAKE_CUDA_ARCHITECTURES="86" \
              -DPython_EXECUTABLE:FILE="${{ steps.python_path.outputs.python }}" \
              -G Ninja
            cmake --build ./BuildCov
            cd ./BuildCov
            ./pennylane_lightning_gpu/src/tests/runner_gpu
            lcov --directory . -b ../pennylane_lightning_gpu/src --capture --output-file coverage.info
            lcov --remove coverage.info '/usr/*' --output-file coverage.info
            mv coverage.info coverage-${{ github.job }}.info

      - name: Upload code coverage results
        uses: actions/upload-artifact@v3
        with:
          name: ubuntu-codecov-results-cpp
          path: ./BuildCov/coverage-${{ github.job }}.info

      - name: Cleanup
        if: always()
        run: |
          rm -rf ${{ steps.setup_venv.outputs.venv_name }}
          rm -rf *
          rm -rf .git
          rm -rf .gitignore
          rm -rf .github
          pip cache purge


  pythontests:
    needs:
      - set_runs_on_values

    runs-on: ${{ fromJson(needs.set_runs_on_values.outputs.runs-on) }}

    strategy:
      max-parallel: 1

    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          # Checkout entire git-history if workflow_call passes 'stable' as we need to find the most recent git-tag
          fetch-depth: ${{ inputs.lightning-gpu-version == 'stable' && 0 || 1 }}

      - name: Switch to stable build of Lightning-GPU
        if: inputs.lightning-gpu-version == 'stable'
        run: git checkout $(git tag | sort -V | tail -1)

      - uses: actions/setup-python@v4
        id: setup_python
        name: Install Python
        with:
          python-version: '3.9'

      # Since the self-hosted runner can be re-used. It is best to set up all package
      # installations in a virtual environment that gets cleaned at the end of each workflow run
      - name: Setup Python virtual environment
        id: setup_venv
        env:
          VENV_NAME: ${{ github.workspace }}/venv_${{ steps.setup_python.outputs.python-version }}_${{ github.sha }}
        run: |
          # Clear any pre-existing venvs
          rm -rf venv_*

          # Create new venv for this workflow_run
          python --version
          python -m venv ${{ env.VENV_NAME }}

          # Add the venv to PATH for subsequent steps
          echo ${{ env.VENV_NAME }}/bin >> $GITHUB_PATH

          # Adding venv name as an output for subsequent steps to reference if needed
          source ${{ env.VENV_NAME }}/bin/activate
          echo "venv_name=${{ env.VENV_NAME }}" >> $GITHUB_OUTPUT

      - name: Display Python-Path
        id: python_path
        run: |
          py_path=$(which python)
          echo "Python Interpreter Path => $py_path"
          echo "python=$py_path" >> $GITHUB_OUTPUT
          
          pip_path=$(which python)
          echo "PIP Path => $pip_path"
          echo "pip=$pip_path" >> $GITHUB_OUTPUT

      - name: Install Latest PennyLane
        # We want to install the latest PL on non workflow_call events
        if: inputs.pennylane-version == 'latest'  || inputs.pennylane-version == ''
        run: python -m pip install git+https://github.com/PennyLaneAI/pennylane.git@master

      - name: Install required packages
        run: |
          python -m pip install pip~=22.0
          python -m pip install ninja cmake custatevec-cu11 pytest pytest-mock flaky pytest-cov
          # Sync with latest master branches
          python -m pip install --index-url https://test.pypi.org/simple/ pennylane-lightning==0.32.0.dev5 --pre --force-reinstall --no-deps

      - name: Build and install package
        env: 
          CUQUANTUM_SDK: $(python -c "import site; print( f'{site.getsitepackages()[0]}/cuquantum/lib')")
        run: |
          python setup.py build_ext -i --define="CMAKE_CXX_COMPILER=$(which g++-${{ env.GCC_VERSION }});LIGHTNING_RELEASE_TAG=v0.31.0;CMAKE_CUDA_COMPILER=/usr/local/cuda/bin/nvcc;CMAKE_CUDA_ARCHITECTURES=${{ env.CI_CUDA_ARCH }};Python_EXECUTABLE=${{ steps.python_path.outputs.python }}"
          python -m pip install -e . --verbose

      - name: Run PennyLane-Lightning-GPU unit tests
        run: |
          python -m pytest ./tests/ ${{ env.COVERAGE_FLAGS }}
          pl-device-test --device lightning.gpu --skip-ops --shots=20000 ${{ env.COVERAGE_FLAGS }} --cov-append
          pl-device-test --device lightning.gpu --shots=None --skip-ops ${{ env.COVERAGE_FLAGS }} --cov-append
          mv coverage.xml coverage-${{ github.job }}.xml

      - name: Upload code coverage results
        uses: actions/upload-artifact@v3
        with:
          name: ubuntu-codecov-results-python
          path: ./coverage-${{ github.job }}.xml

      - name: Cleanup
        if: always()
        run: |
          rm -rf ${{ steps.setup_venv.outputs.venv_name }}
          rm -rf *
          rm -rf .git
          rm -rf .gitignore
          rm -rf .github
          pip cache purge