Исправлены недочеты в оформлении

Для запуска docker-compose exec web python manage.py test

.gitignore

@@ -65,6 +65,5 @@ target/
 *.jsl
 *.db
 tmp*
-test_*
 .env*
 venv*

README.md

@@ -53,3 +53,8 @@ docker-compose up
 ```bash
 docker-compose exec web python manage.py makemigrations backend
 ```
+
+Для запуска тестов использовать
+```bash
+docker-compose run -e DJANGO_SETTINGS_MODULE=backend.settings web pytest --cov=backend
+```

backend/.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit =
+  backend/migrations/*

backend/backend/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
 
-from .models import ToDoList
+from .models import ToDoList, ToDoItem
 
 
 class ToDoListAdmin(admin.ModelAdmin):
@@ -9,4 +9,11 @@ class ToDoListAdmin(admin.ModelAdmin):
     list_editable = ["title"]
 
 
+class ToDoItemAdmin(admin.ModelAdmin):
+    model = ToDoItem
+    list_display = ["parent", "finished", "text", "created_at"]
+    list_editable = ["finished", "text"]
+
+
 admin.site.register(ToDoList, ToDoListAdmin)
+admin.site.register(ToDoItem, ToDoItemAdmin)

backend/backend/api.py

@@ -1,20 +1,62 @@
 from rest_framework import viewsets, serializers, permissions
 from rest_framework import routers
+from django_filters.rest_framework import DjangoFilterBackend
 
-from .models import ToDoList
+from .models import ToDoList, ToDoItem
+
+
+class ToDoListField(serializers.PrimaryKeyRelatedField):
+    def get_queryset(self):
+        user = self.context["request"].user
+        return ToDoList.objects.filter(user=user)
+
+
+class ToDoItemSerializer(serializers.HyperlinkedModelSerializer):
+    parent = ToDoListField(many=False, read_only=False, help_text="ID родительского списка")
+
+    class Meta:
+        model = ToDoItem
+        fields = ["id", "text", "finished", "created_at", "parent"]
+
+
+class ToDoItemViewSet(viewsets.ModelViewSet):
+    serializer_class = ToDoItemSerializer
+    permission_classes = [permissions.IsAuthenticated]
+    filter_backends = [DjangoFilterBackend]
+    filterset_fields = ["parent", "finished"]
+
+    def get_queryset(self):
+        user = self.request.user
+        if not user.is_authenticated:
+            # ветка только для генерации схемы
+            return ToDoItem.objects.all()
+        return ToDoItem.objects.filter(parent__user=user)
 
 
 class ToDoListSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = ToDoList
-        fields = ["title", "created_at"]
+        fields = ["id", "title", "created_at"]
+
+    def create(self, validated_data):
+        todo_list = ToDoList.objects.create(
+            user=self.context["request"].user, title=validated_data["title"]
+        )
+        return todo_list
 
 
 class ToDoListViewSet(viewsets.ModelViewSet):
-    queryset = ToDoList.objects.all()
     serializer_class = ToDoListSerializer
     permission_classes = [permissions.IsAuthenticated]
 
+    def get_queryset(self):
+        user = self.request.user
+        if not user.is_authenticated:
+            # ветка только для генерации схемы
+            return ToDoList.objects.all()
+        return ToDoList.objects.filter(user=user)
+
 
 router = routers.DefaultRouter()
-router.register(r"lists", ToDoListViewSet)
+router.register(r"lists", ToDoListViewSet, basename="ToDoLists")
+router.register(r"todo_items", ToDoItemViewSet, basename="ToDoItems")

backend/backend/migrations/0002_todoitem_finished.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2 on 2021-04-17 11:15
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("backend", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="todoitem",
+            name="finished",
+            field=models.BooleanField(default=False),
+        ),
+    ]

backend/backend/migrations/0003_auto_20210417_1157.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2 on 2021-04-17 11:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("backend", "0002_todoitem_finished"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="todoitem",
+            name="created_at",
+            field=models.DateTimeField(auto_now_add=True, db_index=True),
+        ),
+        migrations.AlterField(
+            model_name="todoitem",
+            name="finished",
+            field=models.BooleanField(db_index=True, default=False),
+        ),
+        migrations.AlterField(
+            model_name="todolist",
+            name="created_at",
+            field=models.DateTimeField(auto_now_add=True, db_index=True),
+        ),
+    ]

backend/backend/models.py

@@ -5,10 +5,11 @@ from django.contrib.auth.models import User
 class ToDoList(models.Model):
     user = models.ForeignKey(User, on_delete=models.CASCADE, null=False, default=None)
     title = models.CharField(max_length=250)
-    created_at = models.DateTimeField(auto_now_add=True)
+    created_at = models.DateTimeField(auto_now_add=True, db_index=True)
 
 
 class ToDoItem(models.Model):
     parent = models.ForeignKey(ToDoList, on_delete=models.CASCADE, null=False, default=None)
     text = models.TextField()
-    created_at = models.DateTimeField(auto_now_add=True)
+    finished = models.BooleanField(default=False, null=False, db_index=True)
+    created_at = models.DateTimeField(auto_now_add=True, db_index=True)

backend/backend/settings.py

@@ -27,7 +27,8 @@ SECRET_KEY = "django-insecure-toz+*lt(ejm!l*)92w2ciqoh^1kz#a(abbpcn54-dbw(nxoy&7
 DEBUG = True
 
 ALLOWED_HOSTS = []
-
+if DEBUG:
+    ALLOWED_HOSTS = ["0.0.0.0", "localhost", "127.0.0.1", "ALLOWED_HOSTS", "testserver"]
 
 # Application definition
 
@@ -40,8 +41,13 @@ INSTALLED_APPS = [
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "rest_framework",
+    "drf_yasg",
 ]
 
+SWAGGER_SETTINGS = {
+    "SECURITY_DEFINITIONS": {"Bearer": {"type": "apiKey", "name": "Authorization", "in": "header"}}
+}
+
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
@@ -118,7 +124,12 @@ SIMPLE_JWT = {
 }
 
 REST_FRAMEWORK = {
-    "DEFAULT_AUTHENTICATION_CLASSES": ("rest_framework_simplejwt.authentication.JWTAuthentication",)
+    "DEFAULT_AUTHENTICATION_CLASSES": (
+        "rest_framework_simplejwt.authentication.JWTAuthentication",
+    ),
+    "DEFAULT_FILTER_BACKENDS": ["django_filters.rest_framework.DjangoFilterBackend"],
+    "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
+    "PAGE_SIZE": 100,
 }
 
 

backend/backend/urls.py

@@ -6,8 +6,21 @@ from rest_framework_simplejwt.views import (
     TokenRefreshView,
 )
 
+from rest_framework import permissions
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
+
 from .api import router
 
+schema_view = get_schema_view(
+    openapi.Info(
+        title="ToDo List",
+        default_version="v1",
+        description="Swagger Interface for ToDo List",
+    ),
+    public=True,
+    permission_classes=(permissions.AllowAny,),
+)
 
 urlpatterns = [
     path("admin/", admin.site.urls),
@@ -15,4 +28,5 @@ urlpatterns = [
     path("api/token/refresh/", TokenRefreshView.as_view(), name="token_refresh"),
     path("api/", include(router.urls)),
     path("api-auth/", include("rest_framework.urls", namespace="rest_framework")),
+    path("swagger/", schema_view.with_ui("swagger", cache_timeout=0), name="schema-swagger-ui"),
 ]

backend/requirements.txt

@@ -1,4 +1,7 @@
+pytest==6.2.3
+pytest-cov==2.11.1
 djangorestframework==3.12.4
+django-filter==2.4.0
 markdown==3.3.4
 appdirs==1.4.4
 asgiref==3.3.4
@@ -21,3 +24,4 @@ toml==0.10.2
 urllib3==1.26.4
 djangorestframework-simplejwt==4.6.0
 psycopg2-binary>=2.8
+drf-yasg==1.20.0

backend/tests/__init__.py

@@ -0,0 +1,3 @@
+from django.core.wsgi import get_wsgi_application
+
+application = get_wsgi_application()

backend/tests/test_item.py

@@ -0,0 +1,154 @@
+from django.urls import reverse
+from rest_framework import status
+from rest_framework.test import APITestCase
+from django.contrib.auth.models import User
+from .test_todo import create_todo
+
+
+class ItemTest(APITestCase):
+    """Tests API for items."""
+
+    def prepare(self):
+        user = User.objects.create_user("test_user4", "test@test.com", "test_password")
+        self.client.force_authenticate(user=user)
+        to_do_id_1 = create_todo(self.client, "ToDoList1").data["id"]
+        to_do_id_2 = create_todo(self.client, "ToDoList2").data["id"]
+        return to_do_id_1, to_do_id_2
+
+    def get(self, expected_titles, todo_id=None, finished=None):
+        url = reverse("ToDoItems-list")
+        data = {}
+        if finished is not None:
+            data["finished"] = finished
+        if todo_id is not None:
+            data["parent"] = todo_id
+
+        response = self.client.get(url, data, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        real_titles = [(d["text"], d["parent"]) for d in response.data["results"]]
+        self.assertEqual(real_titles, expected_titles)
+
+        if finished is not None:
+            item_status = [data["finished"] for data in response.data["results"]]
+            self.assertEqual(finished, all(item_status))
+
+    def post(self, item_text, todo_id, finished=None):
+        url = reverse("ToDoItems-list")
+        if finished is not None:
+            data = {"text": item_text, "parent": todo_id, "finished": finished}
+        else:
+            data = {"text": item_text, "parent": todo_id}
+        response = self.client.post(url, data, format="json")
+
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+        check_finished = False if (finished is None) else finished
+        self.assertEqual(response.data["text"], item_text)
+        self.assertEqual(response.data["parent"], todo_id)
+        self.assertEqual(response.data["finished"], check_finished)
+
+        return response.data["id"], response.data["finished"]
+
+    def get_by_id(self, id, text, finished, parent):
+        url_with_id = reverse("ToDoItems-detail", args=(id,))
+        response = self.client.get(url_with_id, {id: id}, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["text"], text)
+        self.assertEqual(response.data["finished"], finished)
+        self.assertEqual(response.data["parent"], parent)
+
+    def put(self, id, text, parent, finished=None):
+        url_with_id = reverse("ToDoItems-detail", args=(id,))
+        data = {"text": text, "parent": parent}
+        if finished is not None:
+            data["finished"] = finished
+        response = self.client.put(url_with_id, data, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["text"], text)
+        self.assertEqual(response.data["parent"], parent)
+        if finished is not None:
+            self.assertEqual(response.data["finished"], finished)
+
+    def patch(self, id, text=None, finished=None, parent=None):
+        url_with_id = reverse("ToDoItems-detail", args=(id,))
+        data = {}
+        if text is not None:
+            data["text"] = text
+        if finished is not None:
+            data["finished"] = finished
+        if parent is not None:
+            data["parent"] = parent
+        response = self.client.patch(url_with_id, data, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        if text is not None:
+            self.assertEqual(response.data["text"], text)
+        if finished is not None:
+            self.assertEqual(response.data["finished"], finished)
+        if parent is not None:
+            self.assertEqual(response.data["parent"], parent)
+
+    def delete(self, id, title, finished, to_do_id):
+        self.get_by_id(id, title, finished, to_do_id)
+        url_with_id = reverse("ToDoItems-detail", args=(id,))
+        response = self.client.delete(url_with_id, {}, format="json")
+        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
+
+    def test_create_delete(self):
+        """
+        /todo_items/: get, post (create)
+        /todo_items/{id}/: get (read), delete
+        """
+        to_do_id_1, to_do_id_2 = self.prepare()
+        self.get([], to_do_id_1)
+        item_text_1, item_text_2, item_text_3, item_text_4 = "Item1", "Item2", "Item3", "Item4"
+        item_id_1, item_finished_1 = self.post(item_text_1, to_do_id_1)
+        self.get([(item_text_1, to_do_id_1)], to_do_id_1)
+        item_id_2, item_finished_2 = self.post(item_text_2, to_do_id_1, finished=False)
+        self.get([(item_text_1, to_do_id_1), (item_text_2, to_do_id_1)], to_do_id_1)
+        item_id_3, item_finished_3 = self.post(item_text_3, to_do_id_1, finished=True)
+        self.get(
+            [(item_text_1, to_do_id_1), (item_text_2, to_do_id_1), (item_text_3, to_do_id_1)],
+            to_do_id_1,
+        )
+        item_id_4, item_finished_4 = self.post(item_text_4, to_do_id_2, finished=False)
+        self.get(
+            [
+                (item_text_1, to_do_id_1),
+                (item_text_2, to_do_id_1),
+                (item_text_3, to_do_id_1),
+                (item_text_4, to_do_id_2),
+            ]
+        )
+
+        self.get(
+            [(item_text_1, to_do_id_1), (item_text_2, to_do_id_1), (item_text_3, to_do_id_1)],
+            to_do_id_1,
+        )
+        self.get([(item_text_1, to_do_id_1), (item_text_2, to_do_id_1)], to_do_id_1, finished=False)
+        self.get([(item_text_3, to_do_id_1)], to_do_id_1, finished=True)
+
+        self.get_by_id(item_id_1, item_text_1, item_finished_1, to_do_id_1)
+        self.get_by_id(item_id_2, item_text_2, item_finished_2, to_do_id_1)
+        self.get_by_id(item_id_3, item_text_3, item_finished_3, to_do_id_1)
+
+        self.delete(item_id_3, item_text_3, item_finished_3, to_do_id_1)
+        self.get([(item_text_1, to_do_id_1), (item_text_2, to_do_id_1)], to_do_id_1)
+
+    def test_update(self):
+        """
+        /todo_items/{id}/: put (update), patch (partial_update)
+        """
+
+        to_do_id_1, to_do_id_2 = self.prepare()
+
+        item_text_1 = "Item1"
+        item_id_1, item_finished_1 = self.post(item_text_1, to_do_id_1)
+
+        item_text_1_2 = "Item5"
+        self.put(item_id_1, item_text_1_2, to_do_id_2)
+        self.put(item_id_1, item_text_1_2, to_do_id_2, finished=False)
+        self.put(item_id_1, item_text_1_2, to_do_id_2, finished=True)
+
+        item_text_1_3 = "Item6"
+        self.patch(item_id_1, parent=to_do_id_1)
+        self.patch(item_id_1, finished=True)
+        self.patch(item_id_1, text=item_text_1_3)

backend/tests/test_todo.py

@@ -0,0 +1,85 @@
+from django.urls import reverse
+from rest_framework import status
+from rest_framework.test import APITestCase
+from django.contrib.auth.models import User
+
+
+def create_todo(client, title):
+    url = reverse("ToDoLists-list")
+    response = client.post(url, {"title": title}, format="json")
+    return response
+
+
+class ToDoTest(APITestCase):
+    """Tests API for todo."""
+
+    def get(self, expected_titles):
+        url = reverse("ToDoLists-list")
+        response = self.client.get(url, {}, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        real_titles = [data["title"] for data in response.data["results"]]
+        self.assertEqual(real_titles, expected_titles)
+
+    def post(self, to_do_title):
+        response = create_todo(self.client, to_do_title)
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+        self.assertEqual(response.data["title"], to_do_title)
+        return response.data["id"]
+
+    def get_by_id(self, id, expected_title):
+        url_with_id = reverse("ToDoLists-detail", args=(id,))
+        response = self.client.get(url_with_id, {id: id}, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["title"], expected_title)
+
+    def put(self, id, new_title):
+        url_with_id = reverse("ToDoLists-detail", args=(id,))
+        response = self.client.put(url_with_id, {"title": new_title}, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["title"], new_title)
+
+    def patch(self, id, new_title):
+        url_with_id = reverse("ToDoLists-detail", args=(id,))
+        response = self.client.patch(url_with_id, {"title": new_title}, format="json")
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["title"], new_title)
+
+    def delete(self, id, title):
+        self.get_by_id(id, title)
+        url_with_id = reverse("ToDoLists-detail", args=(id,))
+        response = self.client.delete(url_with_id, {}, format="json")
+        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
+
+    def prepare(self):
+        user = User.objects.create_user("test_user", "test@test.com", "test_password")
+        self.client.force_authenticate(user=user)
+
+    def test_create_delete(self):
+        """
+        lists/{id}/: put (update), patch (partial_update)
+        """
+        self.prepare()
+        to_do_title_1 = "ToDoList1"
+        to_do_id1 = self.post(to_do_title_1)
+        self.put(to_do_id1, "ToDoList11")
+        self.patch(to_do_id1, "ToDoList12")
+
+    def test_todo(self):
+        """
+        lists/: get, post
+        lists/{id}/: get, delete
+        """
+
+        self.prepare()
+        self.get([])
+        to_do_title_1, to_do_title_2 = "ToDoList1", "ToDoList2"
+        to_do_id1 = self.post(to_do_title_1)
+        self.get([to_do_title_1])
+        to_do_id2 = self.post(to_do_title_2)
+        self.get([to_do_title_1, to_do_title_2])
+
+        self.get_by_id(to_do_id1, to_do_title_1)
+        self.get_by_id(to_do_id2, to_do_title_2)
+
+        self.delete(to_do_id2, to_do_title_2)
+        self.get([to_do_title_1])