test: refactor to adopt factories

Author: thisislawatts

chores/tests/factories.py

@@ -0,0 +1,15 @@
+import factory
+from django.contrib.auth import get_user_model
+
+User = get_user_model()
+
+
+class UserFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = User
+
+    email = factory.Faker('email')
+    first_name = factory.Faker('first_name')
+    last_name = factory.Faker('last_name')
+    telegram_user_id = factory.Faker('uuid4')
+    password = factory.PostGenerationMethodCall('set_password', 'password123')

chores/tests/test_commands.py

@@ -4,23 +4,17 @@
 
 import time_machine
 from django.core import mail
-from django.core.exceptions import ValidationError
 from django.core.management import call_command
 from django.test import TestCase
 
-from members.models import User
-
 from ..models import Chore, ChoreNotification, ChoreVolunteer
+from .factories import UserFactory
 
 
 class CustomCommandTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
+        self.user = UserFactory(
             email="[email protected]",
-            password="testpass123",
-            first_name="Task",
-            last_name="User",
-            telegram_user_id="987654321",
         )
 
     @time_machine.travel("2025-07-10 19:56")
@@ -218,12 +212,8 @@ def test_email_reminding_volunteers(self):
             },
             creator=self.user,
         )
-        volunteeruser = User.objects.create_user(
+        volunteeruser = UserFactory(
             email="[email protected]",
-            password="testpass123",
-            first_name="Task",
-            last_name="Volunteer",
-            telegram_user_id="987654322",
         )
         ChoreVolunteer.objects.create(
             user=volunteeruser, chore=chore, timestamp=1753041600
@@ -247,14 +237,10 @@ def test_email_reminding_volunteers(self):
         self.assertIn("Volunteering reminder", email.subject)
         self.assertIn("friendly reminder that you signed up for", email.body)
 
+
 class SingleOccurrenceChoreTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     @time_machine.travel("2025-07-10 19:56")
     def test_single_occurrence_chore_reminder(self):
@@ -299,12 +285,7 @@ def test_single_occurrence_chore_reminder(self):
 
 class NoVolunteersNeededTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     @time_machine.travel("2025-07-10 19:56")
     def test_no_reminder_when_volunteers_exist(self):
@@ -342,12 +323,7 @@ def test_no_reminder_when_volunteers_exist(self):
         )
 
         # Create a volunteer
-        volunteer_user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Volunteer",
-            last_name="User",
-        )
+        volunteer_user = UserFactory()
         ChoreVolunteer.objects.create(
             user=volunteer_user,
             chore=chore,
@@ -364,12 +340,7 @@ def test_no_reminder_when_volunteers_exist(self):
 
 class InvalidChoreTypeTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     def test_invalid_chore_type_raises_exception(self):
         """Test that invalid chore type raises exception"""
@@ -390,12 +361,7 @@ def test_invalid_chore_type_raises_exception(self):
 
 class InvalidReminderTypeTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     def test_invalid_reminder_type_raises_exception(self):
         """Test that invalid reminder type raises exception"""
@@ -430,12 +396,7 @@ def test_invalid_reminder_type_raises_exception(self):
 
 class MultipleVolunteersTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     @time_machine.travel("2025-07-13 21:56")
     def test_multiple_volunteers_reminder(self):
@@ -463,17 +424,11 @@ def test_multiple_volunteers_reminder(self):
         )
 
         # Create multiple volunteers
-        volunteer1 = User.objects.create_user(
+        volunteer1 = UserFactory(
             email="[email protected]",
-            password="testpass123",
-            first_name="Volunteer1",
-            last_name="User",
         )
-        volunteer2 = User.objects.create_user(
+        volunteer2 = UserFactory(
             email="[email protected]",
-            password="testpass123",
-            first_name="Volunteer2",
-            last_name="User",
         )
 
         ChoreVolunteer.objects.create(
@@ -496,18 +451,13 @@ def test_multiple_volunteers_reminder(self):
 
         # Check that both volunteers received notifications
         notification_emails = [email.to[0] for email in mail.outbox]
-        self.assertIn("volunteer1@example.com", notification_emails)
-        self.assertIn("volunteer2@example.com", notification_emails)
+        self.assertIn(volunteer1.email, notification_emails)
+        self.assertIn(volunteer2.email, notification_emails)
 
 
 class MultipleChoresTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     @time_machine.travel("2025-07-10 19:56")
     def test_multiple_chores_processed(self):
@@ -592,12 +542,7 @@ def test_multiple_chores_processed(self):
 
 class NoChoresTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     @time_machine.travel("2025-07-10 19:56")
     def test_no_chores_no_emails(self):
@@ -612,12 +557,7 @@ def test_no_chores_no_emails(self):
 
 class FutureEventTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     @time_machine.travel("2025-07-10 19:56")
     def test_future_event_no_reminder(self):
@@ -665,12 +605,7 @@ class VolunteerCrossContaminationTest(TestCase):
     """Test the defect where volunteers from one chore incorrectly affect another chore's reminder logic"""
 
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     @time_machine.travel("2025-07-10 19:56")
     def test_volunteer_cross_contamination_defect(self):
@@ -740,12 +675,7 @@ def test_volunteer_cross_contamination_defect(self):
         )
 
         # Create a volunteer for chore1 only
-        volunteer = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Volunteer",
-            last_name="User",
-        )
+        volunteer = UserFactory()
         ChoreVolunteer.objects.create(
             user=volunteer,
             chore=chore1,  # Only volunteer for chore1

chores/tests/test_models.py

@@ -2,19 +2,13 @@
 from django.core.exceptions import ValidationError
 from django.test import TestCase
 
-from members.models import User
-
 from ..models import Chore, ChoreNotification, ChoreVolunteer
+from .factories import UserFactory
 
 
 class ChoreModelTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
 
     def test_chore_creation(self):
         """Test basic chore creation"""
@@ -63,12 +57,7 @@ def test_chore_unique_name_constraint(self):
 
 class ChoreVolunteerModelTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = UserFactory()
         self.chore = Chore.objects.create(
             name="Test Chore",
             description="A test chore",
@@ -95,18 +84,13 @@ def test_chore_volunteer_properties(self):
             chore=self.chore,
             timestamp=1753041600,
         )
-        self.assertEqual(volunteer.first_name, "Test")
-        self.assertEqual(volunteer.full_name, "Test User")
+        self.assertEqual(volunteer.first_name, self.user.first_name)
+        self.assertEqual(volunteer.full_name, self.user.full_name)
 
 
 class ChoreNotificationModelTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(
-            email="[email protected]",
-            password="testpass123",
-            first_name="Test",
-            last_name="User",
-        )
+        self.user = self.user = UserFactory()
         self.chore = Chore.objects.create(
             name="Test Chore",
             description="A test chore",
@@ -167,5 +151,5 @@ def test_notification_str_representation(self):
             recipient_user=self.user,
         )
         self.assertIn("Notification to", str(notification))
-        self.assertIn("Test User", str(notification))
+        self.assertIn(self.user.full_name, str(notification))
         self.assertIn("Test Chore", str(notification))

pyproject.toml

@@ -45,6 +45,7 @@ dependencies = [
     "croniter>=6.0.0",
     "humanize>=4.12.3",
     "time-machine>=2.16.0",
+    "factory-boy>=3.3.3",
 ]
 
 [dependency-groups]