Add test_examples factories

Author: martin056

requirements/local.txt

@@ -4,3 +4,4 @@ pytest==6.2.5
 pytest-django==4.5.1
 flake8==4.0.1
 ipdb==0.13.9
+ipython==7.29.0

styleguide_example/test_examples/admin.py

@@ -2,7 +2,7 @@
 
 from styleguide_example.test_examples.models import (
     School,
-    SchoolClass,
+    SchoolCourse,
     Student,
     Roster
 )
@@ -15,27 +15,27 @@ class SchoolAdmin(admin.ModelAdmin):
 
 @admin.register(Roster)
 class RosterAdmin(admin.ModelAdmin):
-    list_display = ('student', 'school_class', 'start_date', 'end_date', 'active', )
-    list_filter = ('student', 'school_class')
+    list_display = ('student', 'school_course', 'start_date', 'end_date', 'active', )
+    list_filter = ('student', 'school_course')
 
 
 class RosterStudentInline(admin.TabularInline):
     model = Roster
-    fields = ('school_class', 'start_date', 'end_date', 'active', 'deactivated_at', )
+    fields = ('school_course', 'start_date', 'end_date', 'active', 'deactivated_at', )
     extra = 1
 
 
-class RosterSchoolClassInline(admin.TabularInline):
+class RosterSchoolCourseInline(admin.TabularInline):
     model = Roster
     fields = ('student', 'start_date', 'end_date', 'active', 'deactivated_at', )
     extra = 1
 
 
-@admin.register(SchoolClass)
-class SchoolClassAdmin(admin.ModelAdmin):
+@admin.register(SchoolCourse)
+class SchoolCourseAdmin(admin.ModelAdmin):
     list_display = ('name', 'short_name', 'slug', 'school', 'start_date', 'end_date', )
     list_filter = ('school', )
-    inlines = (RosterSchoolClassInline, )
+    inlines = (RosterSchoolCourseInline, )
 
 
 @admin.register(Student)

styleguide_example/test_examples/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 3.2.9 on 2021-11-18 10:11
+# Generated by Django 3.2.9 on 2021-11-18 12:21
 
 from django.db import migrations, models
 import django.db.models.deletion
@@ -31,19 +31,19 @@ class Migration(migrations.Migration):
                 ('school', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='students', to='test_examples.school')),
             ],
             options={
-                'unique_together': {('identifier', 'school'), ('email', 'school')},
+                'unique_together': {('email', 'school'), ('identifier', 'school')},
             },
         ),
         migrations.CreateModel(
-            name='SchoolClass',
+            name='SchoolCourse',
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('name', models.CharField(max_length=255)),
                 ('short_name', models.CharField(max_length=50)),
                 ('slug', models.SlugField(max_length=255)),
                 ('start_date', models.DateField()),
                 ('end_date', models.DateField()),
-                ('school', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='school_classes', to='test_examples.school')),
+                ('school', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='school_courses', to='test_examples.school')),
             ],
         ),
         migrations.CreateModel(
@@ -54,13 +54,17 @@ class Migration(migrations.Migration):
                 ('end_date', models.DateField()),
                 ('active', models.BooleanField(default=True)),
                 ('deactivated_at', models.DateField(blank=True, null=True)),
-                ('school_class', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rosters', to='test_examples.schoolclass')),
+                ('school_course', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rosters', to='test_examples.schoolcourse')),
                 ('student', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rosters', to='test_examples.student')),
             ],
         ),
         migrations.AddConstraint(
-            model_name='schoolclass',
-            constraint=models.CheckConstraint(check=models.Q(('start_date__lt', django.db.models.expressions.F('end_date'))), name='school_class_start_before_end'),
+            model_name='schoolcourse',
+            constraint=models.CheckConstraint(check=models.Q(('start_date__lt', django.db.models.expressions.F('end_date'))), name='school_course_start_before_end'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='schoolcourse',
+            unique_together={('name', 'slug', 'start_date', 'end_date')},
         ),
         migrations.AddConstraint(
             model_name='roster',

styleguide_example/test_examples/models.py

@@ -27,30 +27,34 @@ def __str__(self):
         return f'Student {self.email} ({self.identifier})'
 
 
-class SchoolClass(models.Model):
+class SchoolCourse(models.Model):
     name = models.CharField(max_length=255)
     short_name = models.CharField(max_length=50)
     slug = models.SlugField(max_length=255)
-    school = models.ForeignKey(School, related_name='school_classes', on_delete=models.CASCADE)
+    school = models.ForeignKey(School, related_name='school_courses', on_delete=models.CASCADE)
 
     start_date = models.DateField()
     end_date = models.DateField()
 
     class Meta:
         constraints = [
             models.CheckConstraint(
-                name="school_class_start_before_end",
+                name="school_course_start_before_end",
                 check=Q(start_date__lt=F("end_date"))
             )
         ]
 
+        unique_together = (
+            ('name', 'slug', 'start_date', 'end_date', ),
+        )
+
     def __str__(self):
         return f'{self.name} in {self.school}'
 
 
 class Roster(models.Model):
     student = models.ForeignKey(Student, related_name='rosters', on_delete=models.CASCADE)
-    school_class = models.ForeignKey(SchoolClass, related_name='rosters', on_delete=models.CASCADE)
+    school_course = models.ForeignKey(SchoolCourse, related_name='rosters', on_delete=models.CASCADE)
 
     start_date = models.DateField()
     end_date = models.DateField()

styleguide_example/test_examples/tests/__init__.py

@@ -0,0 +1,99 @@
+from datetime import timedelta
+
+import factory
+
+from django.utils.text import slugify
+
+from styleguide_example.utils.tests import faker
+from styleguide_example.test_examples.models import (
+    School,
+    Student,
+    Roster,
+    SchoolCourse
+)
+
+
+class SchoolFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = School
+
+    name = factory.LazyAttribute(lambda _: f'{faker.unique.company()} School')
+    slug = factory.LazyAttribute(lambda self: slugify(self.name))
+
+
+class StudentFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = Student
+
+    email = factory.LazyAttribute(lambda _: faker.unique.email())
+    identifier = factory.LazyAttribute(lambda _: faker.unique.uuid4())
+    school = factory.SubFactory(SchoolFactory)
+
+
+class SchoolWithStudentsFactory(SchoolFactory):
+    @factory.post_generation
+    def students(obj, created, extracted, **kwargs):
+        if created and extracted is None:
+            students = StudentFactory.create_batch(kwargs.get('count', 5))
+            obj.students.set(students)
+
+            return students
+
+
+class SchoolCourseFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = SchoolCourse
+
+    name = factory.LazyAttribute(lambda _: faker.unique.sentence(nb_words=3)[:-1])  # remove the end punctuation
+    short_name = factory.LazyAttribute(lambda self: self.name.split(' ')[0])
+    slug = factory.LazyAttribute(lambda self: slugify(self.name))
+    school = factory.SubFactory(SchoolFactory)
+
+    start_date = factory.LazyAttribute(lambda _: faker.past_date())
+    # The code below might cause bugs if you only pass start_date to you factory
+    # end_date = factory.LazyAttribute(lambda _: faker.future_date())
+    end_date = factory.LazyAttribute(lambda self: self.start_date + timedelta(days=365))
+
+
+class RosterFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = Roster
+
+    student = factory.SubFactory(StudentFactory)
+    # Make sure the student and the school_course are from the same school
+    school_course = factory.SubFactory(SchoolCourseFactory, school=factory.SelfAttribute('..student.school'))
+
+    # The code below might cause bugs because of the school_course period
+    # start_date = factory.LazyAttribute(lambda _: faker.past_date())
+    # end_date = factory.LazyAttribute(lambda _: faker.future_date())
+    start_date = factory.LazyAttribute(lambda self: faker.date_between_dates(
+        date_start=self.school_course.start_date,
+        date_end=self.school_course.end_date - timedelta(days=1)
+    ))
+    end_date = factory.LazyAttribute(lambda self: faker.date_between_dates(
+        date_start=self.start_date,
+        date_end=self.school_course.end_date
+    ))
+
+    active = True
+    deactivated_at = factory.Maybe(
+        'active',
+        no_declaration=factory.LazyAttribute(lambda self: faker.date_between_dates(
+            date_start=self.start_date,
+            date_end=self.end_date
+        )),
+        yes_declaration=None
+    )
+
+
+class SchoolCourseWithRostersFactory(SchoolCourseFactory):
+    @factory.post_generation
+    def rosters(obj, created, extracted, **kwargs):
+        if created and extracted is None:
+            rosters = RosterFactory.create_batch(
+                kwargs.get('count', 5),
+                student__school=obj.school  # NOTE!
+            )
+            obj.rosters.set(rosters)
+
+            return rosters

styleguide_example/test_examples/tests/factories.py

@@ -0,0 +1,3 @@
+# flake8: noqa
+
+from .base import faker

styleguide_example/utils/tests/__init__.py

@@ -0,0 +1,3 @@
+from faker import Faker
+
+faker = Faker()