chore: enhance GitHub Actions for testing and dependency management

chore: add PostgreSQL service configuration to GitHub Actions for testing

chore: remove unnecessary blank lines in tests.py and urls.py

chore: update flake8 configuration to ignore specific warnings and add isort integration

chore: remove unnecessary blank line in tests.py and urls.py

chore: update flake8 command in GitHub Actions to use configuration file

chore: refine flake8 configuration and improve isort compatibility

Author: hawkxdev

.github/workflows/main.yml

@@ -1,4 +1,3 @@
-# .github/workflows/main.yml
 name: Main Taski workflow
 
 on:
@@ -8,27 +7,47 @@ on:
 
 jobs:
   tests:
-    # Разворачиваем окружение:
     runs-on: ubuntu-latest
-
+    # Блок services аналогичен docker-compose.yml
+    services:
+      postgres:
+        image: postgres:13.10
+        # Указываем имя тестовой базы, имя и пароль пользователя в открытом виде,
+        # ведь эта база будет работать только во время прогона тестов
+        env:
+          POSTGRES_USER: django_user
+          POSTGRES_PASSWORD: django_password
+          POSTGRES_DB: django_db
+        ports:
+          - 5432:5432
+        # Эта конструкция описывает проверку готовности сервиса postgres
+        # Если её не будет, то тесты могут запуститься раньше, чем сервер PostgreSQL
+        # В результате тесты опять решат, что базы нет, — и упадут
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
     steps:
-    # Копируем код проекта
-    - name: Check out code
-      uses: actions/checkout@v3
-    # Устанавливаем Python с помощью action
+    - uses: actions/checkout@v3
     - name: Set up Python
       uses: actions/setup-python@v4
-    # В action setup-python@v4 передаём параметр — версию Python
       with:
         python-version: 3.12
-    # Обновляем pip, устанавливаем flake8 и flake8-isort,
-    # устанавливаем зависимости проекта
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip setuptools
         pip install flake8==6.0.0 flake8-isort==6.0.0
-    # Запускаем flake8
-    - name: Test with flake8
-      # Вызываем flake8 и указываем ему,
-      # что нужно проверить файлы только в папке backend/
-      run: python -m flake8 backend/
+        pip install -r ./backend/requirements.txt
+    # Этот шаг дополним переменными для доступа к БД
+    - name: Test with flake8 and django tests
+      # Добавляем env-переменные для доступа к БД
+      env:
+        POSTGRES_USER: django_user
+        POSTGRES_PASSWORD: django_password
+        POSTGRES_DB: django_db
+        # Сервер БД запущен в Docker, но его порт проброшен на хост
+        # Поэтому подключаемся к 127.0.0.1:5432
+        DB_HOST: 127.0.0.1
+        DB_PORT: 5432
+      run: |
+        flake8 --config=setup.cfg backend/
+        cd backend/
+        python manage.py test

backend/api/tests.py

@@ -0,0 +1,22 @@
+from http import HTTPStatus
+
+from django.test import Client, TestCase
+
+from api import models
+
+
+class TaskiAPITestCase(TestCase):
+    def setUp(self):
+        self.guest_client = Client()
+
+    def test_list_exists(self):
+        """Проверка доступности списка задач."""
+        response = self.guest_client.get('/api/tasks/')
+        self.assertEqual(response.status_code, HTTPStatus.OK)
+
+    def test_task_creation(self):
+        """Проверка создания задачи."""
+        data = {'title': 'Test', 'description': 'Test'}
+        response = self.guest_client.post('/api/tasks/', data=data)
+        self.assertEqual(response.status_code, HTTPStatus.CREATED)
+        self.assertTrue(models.Task.objects.filter(title='Test').exists())

backend/backend/urls.py

@@ -1,8 +1,9 @@
-from api import views
 from django.contrib import admin
 from django.urls import include, path
 from rest_framework import routers
 
+from api import views
+
 router = routers.DefaultRouter()
 router.register('tasks', views.TaskView, 'task')
 

setup.cfg

@@ -1,16 +1,26 @@
 [flake8]
-# Не проверять код на соответствие стандартам W503 и F811
-ignore =
-    W503,
-    F811
-# Не проверять код в перечисленных директориях:
+# Игнорируем очевидные и неважные предупреждения
+ignore = W503, F811
+
+# Исключаем служебные и виртуальные директории из проверки
 exclude =
-    tests/,
-    */migrations/,
-    venv/,
-    */venv/,
-    env/,
-    */env/,
-# Не проверять указанные файлы на соответствие определённым правилам:
+    migrations,
+    venv,
+    env,
+    __pycache__,
+    .git,
+    .github
+
+# Игнорируем длину строк только в settings.py
 per-file-ignores =
     */settings.py:E501
+
+# Интеграция с isort
+import-order-style = google
+application-import-names = api, backend
+
+[isort]
+# Настройки для совместимости с Black
+profile = black
+known_first_party = api, backend
+line_length = 88