test_script.yml

# This is the workflow file that runs the tests on every pull request.

name: 🧪 Tests

on:
  pull_request:
    branches: [ main ]

permissions:
  contents: read
  pull-requests: write

jobs:
  test:
    runs-on: ubuntu-latest

    steps:

      # Checkout the repository
      - name: 🛒 Checkout
        uses: actions/checkout@v3

      # Setting up Python
      - name: 🐍 Set up Python 3.11
        uses: actions/setup-python@v4
        with:
          python-version: "3.11"
          architecture: "x64"

      # Install pipenv
      - name: ⚙️ Install pipenv
        run: |
          python -m pip install --upgrade pipenv wheel

      # Cache pipenv
      - name: 🗃️ Cache pipenv
        id: cache-pipenv
        uses: actions/cache@v3
        with:
          path: ~/.local/share/virtualenvs
          key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile.lock') }}

      # Install dependencies from Pipfile.lock
      - name: ⚙️ Install dependencies
        if: steps.cache-pipenv.outputs.cache-hit != 'true'
        run: |
          pipenv install --deploy --dev

      # Run all the tests
      - name: 🧪 Tests with pytest
        run: |
          pipenv run pytest --junitxml=pytest.xml -v --cov script/ > pytest-coverage.txt 

      # Write the coverage report as a comment on the pull request
      - name: 💬 Pytest Coverage Comment
        uses: MishaKav/pytest-coverage-comment@main
        with:
          pytest-coverage-path: ./pytest-coverage.txt
          junitxml-path: ./pytest.xml