hmtcelik / fastapi-pytest

pytest with FastAPI

Testing Fastapi

Test Types:

• Unit Tests
• Integration Tests
• E2E Tests
• ...

Frameworks and libraries:

• FastAPI
• Pytest
• SQLAlchemy
• Docker

• Will Use:
  • docker-compose
  • PostgreSQL

For Github Actions:

# python-package.yml

name: Python package

on:
  push:
    branches: [ "branch_name" ]
  pull_request:
    branches: [ "branch_name" ]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.8", "3.9", "3.10"]

    steps:
    - uses: actions/checkout@v3
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v3
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install flake8 pytest
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    - name: Test with pytest
      run: |
        pytest