Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes in Makefile and Workflows #3

Merged
merged 10 commits into from
Apr 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 79 additions & 66 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -1,67 +1,80 @@
#name: Python package
#
#on:
# pull_request:
#
#jobs:
# test:
# name: Unit tests
# runs-on: ubuntu-latest
# steps:
# - name: Checkout
# uses: actions/checkout@v4
# - name: Set up docker
# uses: docker-practice/actions-setup-docker@master
# - name: Run postgres
# run: |
# docker run -d -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust --name db-test postgres:15-alpine
# - uses: actions/setup-python@v4
# with:
# python-version: '3.11'
# - name: Install dependencies
# run: |
# python -m ensurepip
# python -m pip install --upgrade --no-cache-dir pip
# python -m pip install --upgrade --no-cache-dir -r requirements.txt -r requirements.dev.txt
# - name: Migrate DB
# run: |
# DB_DSN=postgresql://postgres@localhost:5432/postgres alembic upgrade head
# - name: Build coverage file
# run: |
# DB_DSN=postgresql://postgres@localhost:5432/postgres pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=achievement_api tests/ | tee pytest-coverage.txt
# - name: Print report
# if: always()
# run: |
# cat pytest-coverage.txt
# - name: Pytest coverage comment
# uses: MishaKav/pytest-coverage-comment@main
# with:
# pytest-coverage-path: ./pytest-coverage.txt
# title: Coverage Report
# badge-title: Code Coverage
# hide-badge: false
# hide-report: false
# create-new-comment: false
# hide-comment: false
# report-only-changed-files: false
# remove-link-from-badge: false
# junitxml-path: ./pytest.xml
# junitxml-title: Summary
# linting:
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# - uses: actions/setup-python@v2
# with:
# python-version: 3.11
# - uses: isort/isort-action@master
# with:
# requirementsFiles: "requirements.txt requirements.dev.txt"
# - uses: psf/black@stable
# - name: Comment if linting failed
# if: ${{ failure() }}
# uses: thollander/actions-comment-pull-request@v2
# with:
# message: |
# :poop: Code linting failed, use `black` and `isort` to fix it.
name: Python tests

on:
pull_request:


jobs:
test:
name: Unit tests
runs-on: ubuntu-latest
services:
postgres:
image: postgres:15
env:
POSTGRES_HOST_AUTH_METHOD: trust
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
-p 5432:5432
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m ensurepip
python -m pip install --upgrade --no-cache-dir pip
python -m pip install --upgrade --no-cache-dir -r requirements.txt -r requirements.dev.txt
- name: Migrate DB
run: |
DB_DSN=postgresql://postgres@localhost:5432/postgres alembic upgrade head
- name: Build coverage file
id: pytest
run: |
DB_DSN=postgresql://postgres@localhost:5432/postgres pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=achievement_api tests/ | tee pytest-coverage.txt
exit ${PIPESTATUS[0]}
- name: Print report
if: always()
run: |
cat pytest-coverage.txt
- name: Pytest coverage comment
uses: MishaKav/pytest-coverage-comment@main
if: always()
with:
pytest-coverage-path: ./pytest-coverage.txt
title: Coverage Report
badge-title: Code Coverage
hide-badge: false
hide-report: false
create-new-comment: false
hide-comment: false
report-only-changed-files: false
remove-link-from-badge: false
junitxml-path: ./pytest.xml
junitxml-title: Summary
- name: Fail on pytest errors
if: steps.pytest.outcome == 'failure'
run: exit 1

linting:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v2
with:
python-version: 3.11
- uses: isort/isort-action@master
with:
requirementsFiles: "requirements.txt requirements.dev.txt"
- uses: psf/black@stable
- name: Comment if linting failed
if: failure()
uses: thollander/actions-comment-pull-request@v2
with:
message: |
:poop: Code linting failed, use `black` and `isort` to fix it.
12 changes: 9 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,15 @@ venv:
python3.11 -m venv venv

format:
autoflake -r --in-place --remove-all-unused-imports ./achievement_api
isort ./achievement_api
black ./achievement_api
source ./venv/bin/activate && autoflake -r --in-place --remove-all-unused-imports ./achievement_api
source ./venv/bin/activate && isort ./achievement_api
source ./venv/bin/activate && black ./achievement_api
source ./venv/bin/activate && autoflake -r --in-place --remove-all-unused-imports ./tests
source ./venv/bin/activate && isort ./tests
source ./venv/bin/activate && black ./tests
source ./venv/bin/activate && autoflake -r --in-place --remove-all-unused-imports ./migrations
source ./venv/bin/activate && isort ./migrations
source ./venv/bin/activate && black ./migrations

db:
docker run -d -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust --name db-achievement_api postgres:15
Expand Down
2 changes: 1 addition & 1 deletion achievement_api/routes/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
description='Программный интерфейс ачивок для Твой ФФ!',
version=__version__,
# Отключаем нелокальную документацию
root_path=settings.ROOT_PATH if __version__ != 'dev' else '/',
root_path=settings.ROOT_PATH if __version__ != 'dev' else '',
docs_url=None if __version__ != 'dev' else '/docs',
redoc_url=None,
)
Expand Down
7 changes: 4 additions & 3 deletions achievement_api/routes/user.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import logging

from auth_lib.fastapi import UnionAuth
from fastapi import APIRouter, Depends, HTTPException
from fastapi import APIRouter
from fastapi_sqlalchemy import db
from pydantic import BaseModel, ConfigDict

Expand Down Expand Up @@ -33,5 +32,7 @@ class UserGet(BaseModel):

@router.get("/{user_id}")
def get_all_achievements(user_id: int) -> UserGet:
achievements = db.session.query(Achievement).join(AchievementReciever).where(AchievementReciever.user_id == user_id).all()
achievements = (
db.session.query(Achievement).join(AchievementReciever).where(AchievementReciever.user_id == user_id).all()
)
return UserGet(user_id=user_id, achievement=achievements)
2 changes: 2 additions & 0 deletions migrations/env.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

from alembic import context
from sqlalchemy import engine_from_config, pool

from achievement_api.models.base import Base
from achievement_api.settings import get_settings


# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config
Expand Down
3 changes: 2 additions & 1 deletion migrations/versions/c06c1cd9939c_init.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
Create Date: 2023-08-18 03:21:29.803878

"""
from alembic import op

import sqlalchemy as sa
from alembic import op


# revision identifiers, used by Alembic.
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ pydantic[dotenv]
pydantic-settings
SQLAlchemy
uvicorn
python-multipart
File renamed without changes.
9 changes: 9 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import pytest
from fastapi.testclient import TestClient

from achievement_api.routes.base import app


@pytest.fixture
def client():
yield TestClient(app)
3 changes: 3 additions & 0 deletions tests/test_routes/test_openapi.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
def test_unprocessable_jsons_no_token(client):
response = client.get(f"/openapi.json")
assert response.status_code == 200
Loading