wbcore 2.2.1__py2.py3-none-any.whl → 2.2.4__py2.py3-none-any.whl

wbcore/contrib/example_app/tests/test_viewsets/test_sport_viewset.py

@@ -0,0 +1,75 @@
+import pytest
+from django.test import Client, TestCase
+from django.urls import reverse
+from wbcore.contrib.authentication.factories import SuperUserFactory
+from wbcore.contrib.example_app.factories import SportFactory
+from wbcore.contrib.example_app.models import Sport
+from wbcore.contrib.example_app.serializers import SportModelSerializer
+from wbcore.contrib.example_app.tests.test_viewsets.test_utils_viewsets import (
+    get_create_view,
+    get_delete_view,
+    get_detail_view,
+    get_partial_view,
+    get_update_view,
+)
+from wbcore.contrib.example_app.viewsets import SportModelViewSet
+
+
+@pytest.mark.django_db
+class TestSportModelViewSet(TestCase):
+    def setUp(self):
+        self.user = SuperUserFactory()
+        self.client = Client()
+        self.client.force_login(user=self.user)
+        self.list_url = reverse("example_app:sport-list")
+        self.detail_url_str = "example_app:sport-detail"
+
+    def test_list_view(self):
+        response = self.client.get(self.list_url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_create_view(self):
+        sport = SportFactory()
+        response = get_create_view(self.client, sport, self.user, self.list_url, SportModelViewSet)
+        self.assertEqual(response.status_code, 201)
+        self.assertTrue(Sport.objects.filter(name=sport.name).exists())
+
+    def test_detail_view(self):
+        instance = SportFactory()
+        response = get_detail_view(self.client, instance.pk, self.detail_url_str)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_update_view(self):
+        instance = SportFactory()
+        instance.name = "Updated Instance"
+        response = get_update_view(self.client, instance, SportModelSerializer, self.detail_url_str)
+        instance.refresh_from_db()
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_partial_update_view(self):
+        instance = SportFactory()
+        response = get_partial_view(self.client, instance.id, {"name": "Patched name"}, self.detail_url_str)
+        instance.refresh_from_db()
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_delete_view(self):
+        instance = SportFactory()
+        response = get_delete_view(self.client, self.detail_url_str, instance.pk)
+        self.assertEqual(response.status_code, 204)
+        self.assertFalse(Sport.objects.filter(pk=instance.pk).exists())
+
+    def test_ordering_fields(self):
+        first_name, second_name, third_name = "Team A", "Team B", "Team C"
+        SportFactory(name=second_name)
+        SportFactory(name=first_name)
+        SportFactory(name=third_name)
+
+        response = self.client.get(self.list_url)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], Sport.objects.count())
+        self.assertEqual(response.data["results"][0]["name"], first_name)
+        self.assertEqual(response.data["results"][1]["name"], second_name)
+        self.assertEqual(response.data["results"][2]["name"], third_name)

wbcore/contrib/example_app/tests/test_viewsets/test_stadium_viewset.py

@@ -0,0 +1,75 @@
+import pytest
+from django.test import Client, TestCase
+from django.urls import reverse
+from wbcore.contrib.authentication.factories import SuperUserFactory
+from wbcore.contrib.example_app.factories import StadiumFactory
+from wbcore.contrib.example_app.models import Stadium
+from wbcore.contrib.example_app.serializers import StadiumModelSerializer
+from wbcore.contrib.example_app.tests.test_viewsets.test_utils_viewsets import (
+    get_create_view,
+    get_delete_view,
+    get_detail_view,
+    get_partial_view,
+    get_update_view,
+)
+from wbcore.contrib.example_app.viewsets import StadiumModelViewSet
+
+
+@pytest.mark.django_db
+class TestStadiumModelViewSet(TestCase):
+    def setUp(self):
+        self.user = SuperUserFactory()
+        self.client = Client()
+        self.client.force_login(user=self.user)
+        self.list_url = reverse("example_app:stadium-list")
+        self.detail_url_str = "example_app:stadium-detail"
+
+    def test_list_view(self):
+        response = self.client.get(self.list_url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_create_view(self):
+        stadium = StadiumFactory()
+        response = get_create_view(self.client, stadium, self.user, self.list_url, StadiumModelViewSet)
+        self.assertEqual(response.status_code, 201)
+        self.assertTrue(Stadium.objects.filter(name=stadium.name).exists())
+
+    def test_detail_view(self):
+        instance = StadiumFactory()
+        response = get_detail_view(self.client, instance.pk, self.detail_url_str)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_update_view(self):
+        instance = StadiumFactory()
+        instance.name = "Updated Instance"
+        response = get_update_view(self.client, instance, StadiumModelSerializer, self.detail_url_str)
+        instance.refresh_from_db()
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_partial_update_view(self):
+        instance = StadiumFactory()
+        response = get_partial_view(self.client, instance.id, {"name": "Updated Instance"}, self.detail_url_str)
+        instance.refresh_from_db()
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_delete_view(self):
+        instance = StadiumFactory()
+        response = get_delete_view(self.client, self.detail_url_str, instance.pk)
+        self.assertEqual(response.status_code, 204)
+        self.assertFalse(Stadium.objects.filter(pk=instance.pk).exists())
+
+    def test_ordering_fields(self):
+        first_name, second_name, third_name = "Stadium A", "Stadium B", "Stadium C"
+        StadiumFactory(name=second_name)
+        StadiumFactory(name=first_name)
+        StadiumFactory(name=third_name)
+
+        response = self.client.get(self.list_url)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], Stadium.objects.count())
+        self.assertEqual(response.data["results"][0]["name"], first_name)
+        self.assertEqual(response.data["results"][1]["name"], second_name)
+        self.assertEqual(response.data["results"][2]["name"], third_name)

wbcore/contrib/example_app/tests/test_viewsets/test_team_viewset.py

@@ -0,0 +1,92 @@
+import pytest
+from django.test import Client, TestCase
+from django.urls import reverse
+from wbcore.contrib.authentication.factories import SuperUserFactory
+from wbcore.contrib.example_app.factories import TeamFactory
+from wbcore.contrib.example_app.models import Team
+from wbcore.contrib.example_app.serializers import TeamModelSerializer
+from wbcore.contrib.example_app.tests.test_viewsets.test_utils_viewsets import (  # get_update_view,
+    find_instances_in_response,
+    get_create_view,
+    get_delete_view,
+    get_detail_view,
+    get_partial_view,
+    get_update_view,
+)
+from wbcore.contrib.example_app.viewsets import TeamModelViewSet
+
+
+@pytest.mark.django_db
+class TestTeamModelViewSet(TestCase):
+    def setUp(self):
+        self.user = SuperUserFactory()
+        self.client = Client()
+        self.client.force_login(user=self.user)
+        self.list_url = reverse("example_app:team-list")
+        self.detail_url_str = "example_app:team-detail"
+
+    def test_list_view(self):
+        response = self.client.get(self.list_url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_create_view(self):
+        team = TeamFactory()
+        response = get_create_view(self.client, team, self.user, self.list_url, TeamModelViewSet)
+        self.assertEqual(response.status_code, 201)
+        self.assertTrue(Team.objects.filter(name=team.name).exists())
+
+    def test_detail_view(self):
+        team = TeamFactory()
+        response = get_detail_view(self.client, team.pk, self.detail_url_str)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], team.name)
+
+    def test_update_view(self):
+        instance = TeamFactory()
+        instance.name = "Updated Instance"
+        response = get_update_view(self.client, instance, TeamModelSerializer, self.detail_url_str)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_partial_update_view(self):
+        instance = TeamFactory()
+        response = get_partial_view(self.client, instance.id, {"name": "Updated Instance"}, self.detail_url_str)
+        instance.refresh_from_db()
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["name"], instance.name)
+
+    def test_delete_view(self):
+        team = TeamFactory()
+        response = get_delete_view(self.client, self.detail_url_str, team.pk)
+        self.assertEqual(response.status_code, 204)
+        self.assertFalse(Team.objects.filter(pk=team.pk).exists())
+
+    def test_ordering_fields(self):
+        team_a = TeamFactory(name="BBB", order=1)
+        team_b = TeamFactory(name="AAA", order=0)
+        team_c = TeamFactory(name="CCC", order=2)
+
+        response = self.client.get(self.list_url)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], Team.objects.count())
+        self.assertEqual(response.data["results"][0]["id"], team_b.id)
+        self.assertEqual(response.data["results"][1]["id"], team_a.id)
+        self.assertEqual(response.data["results"][2]["id"], team_c.id)
+
+    def test_team_stadium(self):
+        team_a = TeamFactory()
+        team_b = TeamFactory(home_stadium=team_a.home_stadium)
+        team_c = TeamFactory()
+        expected_number_of_teams = Team.objects.filter(home_stadium=team_a.home_stadium).count()
+        team_stadium_url = reverse("example_app:team-stadium-list", args=[team_a.home_stadium.id])
+        response = self.client.get(team_stadium_url)
+        team_a_found, team_b_found, team_c_found = find_instances_in_response([team_a, team_b, team_c], response)
+        self.assertEqual(
+            response.data["count"],
+            expected_number_of_teams,
+            f"The answer should contain {expected_number_of_teams} teams",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertTrue(team_a_found, "Team A was not found in Response")
+        self.assertTrue(team_b_found, "Team B was not found in Response")
+        self.assertFalse(team_c_found, "Team C was found in Response, but should not be found")

wbcore/contrib/example_app/tests/test_viewsets/test_teamresult_viewset.py

@@ -0,0 +1,58 @@
+import pytest
+from django.test import Client, TestCase
+from django.urls import reverse
+from wbcore.contrib.authentication.factories import SuperUserFactory
+from wbcore.contrib.example_app.factories import TeamResultsFactory
+from wbcore.contrib.example_app.serializers import TeamResultsModelSerializer
+from wbcore.contrib.example_app.tests.test_viewsets.test_utils_viewsets import (
+    get_create_view,
+    get_delete_view,
+    get_detail_view,
+    get_partial_view,
+    get_update_view,
+)
+from wbcore.contrib.example_app.viewsets import TeamResultsModelViewSet
+
+
+@pytest.mark.django_db
+class TestTeamResultsModelViewSet(TestCase):
+    def setUp(self):
+        self.user = SuperUserFactory()
+        self.client = Client()
+        self.client.force_login(user=self.user)
+        self.list_url = reverse("example_app:teamresults-list")
+        self.detail_url_str = "example_app:teamresults-detail"
+
+    def test_list_view(self):
+        response = self.client.get(self.list_url)
+        self.assertEqual(response.status_code, 200)
+
+    def test_create_view(self):
+        team_result = TeamResultsFactory()
+        response = get_create_view(self.client, team_result, self.user, self.list_url, TeamResultsModelViewSet)
+        # It is not possible to create an team results, since the get_endpoint_url returns None.
+        self.assertEqual(response.status_code, 405)
+
+    def test_detail_view(self):
+        instance = TeamResultsFactory()
+        response = get_detail_view(self.client, instance.pk, self.detail_url_str)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["instance"]["id"], instance.id)
+
+    def test_update_view(self):
+        instance = TeamResultsFactory()
+        instance.points = 5
+        response = get_update_view(self.client, instance, TeamResultsModelSerializer, self.detail_url_str)
+        # It is not possible to update an team results, since the get_endpoint_url returns None.
+        self.assertEqual(response.status_code, 405)
+
+    def test_partial_update_view(self):
+        instance = TeamResultsFactory()
+        response = get_partial_view(self.client, instance.id, {"points": 5}, self.detail_url_str)
+        self.assertEqual(response.status_code, 405)
+
+    def test_delete_view(self):
+        instance = TeamResultsFactory()
+        response = get_delete_view(self.client, self.detail_url_str, instance.pk)
+        # It is not possible to delete an team results, since the get_endpoint_url returns None.
+        self.assertEqual(response.status_code, 405)

wbcore/contrib/example_app/tests/test_viewsets/test_utils_viewsets.py

@@ -0,0 +1,124 @@
+from django.db.models import Model
+from django.http import HttpResponse
+from django.test import Client
+from django.urls import reverse
+from wbcore.contrib.authentication.models import User
+from wbcore.serializers import Serializer
+from wbcore.test.utils import get_data_from_factory
+from wbcore.viewsets import ModelViewSet
+
+
+def get_create_view(
+    client: Client,
+    instance: Model,
+    superuser: User,
+    url: str,
+    viewset: ModelViewSet,
+) -> HttpResponse:
+    """
+    Create a new instance through a view using the Django REST Framework client.
+
+    Parameters:
+        - client (django.test.Client): The Django test client.
+        - instance (django.db.models.Model): The model instance to be created.
+        - superuser (django.contrib.auth.models.User): The superuser for authentication.
+        - url (str): The URL endpoint for the view.
+        - viewset (wbcore.viewsets.ModelViewSet): The viewset for the model.
+
+    Returns:
+        django.http.HttpResponse: The HTTP response from the view.
+    """
+    instance_data = get_data_from_factory(instance, viewset, delete=True, superuser=superuser)
+    return client.post(url, instance_data)
+
+
+def get_detail_view(client: Client, pk: int, url: str) -> HttpResponse:
+    """
+    Retrieve the details of a model instance through a detail view using the Django REST Framework client.
+
+    Parameters:
+        - client (django.test.Client): The Django test client.
+        - pk (int): The primary key of the model instance to retrieve.
+        - url (str): The base URL endpoint for the detail view.
+
+    Returns:
+        django.http.HttpResponse: The HTTP response from the detail view.
+    """
+    detail_url = reverse(url, args=[pk])
+    return client.get(detail_url)
+
+
+def get_update_view(client: Client, instance: Model, serializer: Serializer, url: str) -> HttpResponse:
+    """
+    Update a model instance through an update view using the Django REST Framework client.
+
+    Parameters:
+        - client (django.test.Client): The Django test client.
+        - instance (django.db.models.Model): The model instance to be updated.
+        - serializer (Serializer): The serializer used to serialize the instance.
+        - url (str): The base URL endpoint for the update view.
+
+    Returns:
+        django.http.HttpResponse: The HTTP response from the update view.
+    """
+    update_url = reverse(url, args=[instance.pk])
+    serialized_data = serializer(instance).data
+    return client.put(update_url, data=serialized_data, content_type="application/json")
+
+
+def get_partial_view(client: Client, instance_id: int, data: dict, url: str) -> HttpResponse:
+    """
+    Facilitates partial updates to a specific instance of a model using the Django REST Framework client.
+
+    Parameters:
+        - client (django.test.Client): The Django test client.
+        - instance_id (int): The unique identifier (primary key) of the instance to be partially updated.
+        - data (dict): A dictionary containing the fields and their respective new values that need to be updated in the instance.
+        - url (str): The base URL endpoint for the patch view.
+    Returns:
+        django.http.HttpResponse: The HTTP response from the patch view.
+    """
+    update_url = reverse(url, args=[instance_id])
+    return client.patch(update_url, data=data, content_type="application/json")
+
+
+def get_delete_view(client: Client, url: str, pk: int) -> HttpResponse:
+    """
+    Delete a model instance through a delete view using the Django REST Framework client.
+
+    Parameters:
+        - client (django.test.Client): The Django test client.
+        - url (str): The base URL endpoint for the delete view.
+        - pk (int): The primary key of the model instance to delete.
+
+    Returns:
+        django.http.HttpResponse: The HTTP response from the delete view.
+    """
+    delete_url = reverse(url, args=[pk])
+    return client.delete(delete_url)
+
+
+def find_instances_in_response(instances: list[Model], response: HttpResponse) -> tuple:
+    """
+    Find instances in the data contained in an HTTP response.
+
+    This method takes a list of instances and an HTTP response object, and it checks if each instance
+    is present in the data of the response based on their unique identifier (e.g., 'id').
+
+    Parameters:
+        - instances (list): A list of instances (models) to search for in the response data.
+        - response (HttpResponse): An HTTP response object containing data to search within.
+
+    Returns:
+        tuple: A tuple of Boolean values indicating whether each instance was found in the response.
+            Each element in the tuple corresponds to an instance in the same order as in the 'instances' list.
+            If an instance is found, the corresponding value is True; otherwise, it is False.
+    """
+    found_instances = [False] * len(instances)
+
+    for item in response.data["results"]:
+        for index, instance in enumerate(instances):
+            if item.get("id") == instance.id:
+                found_instances[index] = True
+
+    return tuple(found_instances)