path: root/.github/workflows/unit-test.yml

name: Unit Test

env:
  OPENBB_ENABLE_QUICK_EXIT: true
  OPENBB_LOG_COLLECT: false
  OPENBB_USE_ION: false
  OPENBB_USE_PROMPT_TOOLKIT: false
  OPENBB_FILE_OVERWRITE: true
  OPENBB_ENABLE_CHECK_API: false
  OPENBB_PREVIOUS_USER: true
  PIP_DEFAULT_TIMEOUT: 100

on:
  pull_request:
    branches:
      - develop
      - main
    types: [opened, synchronize, edited, closed]
  push:
    branches:
      - release/*
  merge_group:
    types: [checks_requested]
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  check-files-changed:
    name: Check for changes
    runs-on: ubuntu-latest
    # Run this job only if the PR is not merged, PR != draft and the event is not a push
    if: github.event.pull_request.merged == false && github.event_name != 'push' && github.event.pull_request.draft == false
    outputs:
      check-changes: ${{ steps.check-changes.outputs.check-changes }}
    steps:
      - name: Checkout
        uses: actions/checkout@v1 # v1 is used to preserve the git history and works with the git diff command
        with:
          fetch-depth: 100
          # The GitHub token is preserved by default but this job doesn't need
          # to be able to push to GitHub.
          persist-credentials: false

      # Check for changes to python files, lockfiles and the openbb_terminal folder
      - name: Check for changes to files to trigger unit test
        id: check-changes
        run: |
          current_branch=$(jq -r .pull_request.base.ref "$GITHUB_EVENT_PATH")

          if git diff --name-only origin/$current_branch HEAD | grep -E ".py$|openbb_terminal\/.*|pyproject.toml|poetry.lock|requirements.txt|requirements-full.txt"; then
            echo "check-changes=true" >> $GITHUB_OUTPUT
          else
            echo "check-changes=false" >> $GITHUB_OUTPUT
          fi

      - name: Show output of previous step
        run:  echo "check-changes=${{ steps.check-changes.outputs.check-changes }}"

  base-test:
    name: Base Tests - Ubuntu-latest - Python 3.9
    needs: [check-files-changed]
    runs-on: ubuntu-latest
    if: needs.check-files-changed.outputs.check-changes == 'true' && github.event.pull_request.base.ref == 'develop'
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Setup Python 3.9
        uses: actions/setup-python@v4
        with:
          python-version: "3.9"
          architecture: x64

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.3.2
          virtualenvs-create: true
          virtualenvs-in-project: true

      - name: Install nightly rust
        run: curl --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly

      - name: Setup sudo apt installs for ubuntu-latest
        run: |
          sudo apt-get update
          sudo apt-get install -y \
              build-essential \
              libgtk-3-dev \
              libsoup-3.0-dev \
              libssl-dev \
              curl \
              wget \
              squashfs-tools \
              gcc \
              g++ \
              make \
              file \
              librsvg2-dev \
              libwebkit2gtk-4.1-dev \
              libayatana-appindicator3-dev

      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v3
        with:
          path: .venv
          key: venv-${{ runner.os }}-v1-${{ hashFiles('**/poetry.lock') }}

      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction -E optimization

      - name: Run tests and coverage test
        env:
          MPLBACKEND: Agg
        run: |
          source $VENV
          pytest tests/ --optimization --cov --cov-fail-under=50 --autodoc -n auto --durations=10 --timeout=30

      - name: Start Terminal and exit
        run: |
          source $VENV
          python terminal.py

  tests-python:
    name: Vanilla Python Tests - ${{ matrix.python-version }}
    needs: [base-test]
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: true
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
        os: [ubuntu-latest]
        exclude:
          - os: ubuntu-latest
            python-version: "3.9"
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Setup Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          architecture: x64

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.3.2
          virtualenvs-create: true
          virtualenvs-in-project: true

      - name: Setup sudo apt installs for ubuntu-latest
        run: |
          sudo apt-get update
          sudo apt-get install -y \
              build-essential \
              libgtk-3-dev \
              libsoup-3.0-dev \
              libssl-dev \
              curl \
              wget \
              squashfs-tools \
              gcc \
              g++ \
              make \
              file \
              librsvg2-dev \
              libwebkit2gtk-4.1-dev \
              libayatana-appindicator3-dev

      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v3
        with:
          path: .venv
          key: venv-${{ runner.os }}-v1-${{ hashFiles('**/poetry.lock') }}

      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction -E optimization

      - name: List installed packages
        shell: bash -l {0}
        run: |
          source $VENV
          pip list

      - name: Run tests
        env:
          MPLBACKEND: Agg
        run: |
          source $VENV
          pytest tests/ --optimization --autodoc -n auto --timeout=30

      - name: Start Terminal and exit
        run: |
          source $VENV
          python terminal.py

  full-test:
    name: Full Test Suite - (${{ matrix.python-version }}, ${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    # Run only when a PR is merged or a push to release/* branch
    if: github.event_name == 'push' || github.event.pull_request.merged == true
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
        os: [ubuntu-latest, macos-latest]
        exclude:
          - os: ubuntu-latest
            python-version: "3.9"
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Setup Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          architecture: x64

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.3.2
          virtualenvs-create: true
          virtualenvs-in-project: true

      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v3
        with:
          path: .venv
          key: venv-${{ runner.os }}-v1-${{ hashFiles('**/poetry.lock') }}

      -