Add pytest to test the code (tomasvotava#48)

* chore: rename legacy dev-dependencies
* chore: add test deps
* chore: make work with latest pylint
* remove outdated `requirements.txt`
* add isort config
* add poethepoet for common tasks
    - linting (pylint, mypy, isort, black)
    - formatting (isort, black)
* use poe commands in workflow
* feat(tests): implement basic testing functionality
* feat: use coverage report comment in PRs
* dev: upload coverage.json as a gist
* fix: examples should use context manager
* chore: rebuild docs
* chore: paralelize tests
* docs: add pytest to contributing
* dev: setup pre-commit

Author: tomasvotava

.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: Pylint
+name: Code quality
 
 on: [push, pull_request]
 
@@ -8,10 +8,10 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - "3.7"
           - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
@@ -25,11 +25,10 @@ jobs:
         run: |
           POETRY_VIRTUALENVS_CREATE=false ~/.local/bin/poetry install
       - name: Analysing the code with pylint
-        run: |
-          python -m pylint --disable fixme fastapi_sso
+        run: ~/.local/bin/poetry run poe pylint
       - name: Static type-checking using mypy
-        run: |
-          python -m mypy fastapi_sso
+        run: ~/.local/bin/poetry run poe mypy
       - name: Format checking using black
-        run: |
-          python -m black --check fastapi_sso
+        run: ~/.local/bin/poetry run poe black-check
+      - name: Format checking using isort
+        run: ~/.local/bin/poetry run poe isort-check

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      POETRY_VIRTUALENVS_CREATE: "false"
+      coverage_json: "{}"
+    strategy:
+      matrix:
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+    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 poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python -
+      - name: Install dependencies
+        run: ~/.local/bin/poetry install
+      - name: pytest
+        run: ~/.local/bin/poetry run poe test --junitxml=pytest-results-${{ matrix.python-version }}.xml
+      - name: coverage
+        run: ~/.local/bin/poetry run poe coverage
+      - name: Get Coverage Report Comment
+        uses: orgoro/[email protected]
+        with:
+          coverageFile: coverage.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+        if: ${{ github.event_name == 'pull_request'}}
+      - name: Upload coverage.json as a gist
+        uses: exuanbo/actions-deploy-gist@v1
+        with:
+          token: ${{ secrets.GIST_TOKEN }}
+          gist_id: 328acf6207500c2e836b1c68b5c910f7
+          file_path: coverage.json
+          file_type: text
+        if: ${{ matrix.python-version == '3.11' && github.ref_name == 'master' }}

.gitignore

@@ -48,6 +48,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage.json
 *.cover
 *.py,cover
 .hypothesis/

.isort.cfg

@@ -0,0 +1,4 @@
+[settings]
+multi_line_output=3
+include_trailing_comma=True
+line_length=120

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: poe pylint
+        language: system
+        types: [python]
+
+      - id: black
+        name: black
+        entry: poe black-check
+        language: system
+        types: [python]
+
+      - id: mypy
+        name: mypy
+        entry: poe mypy
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: isort
+        name: isort
+        entry: poe isort-check
+        language: system
+        types: [python]
+        pass_filenames: false