Merge pull request #60 from HackSoftware/test-examples

Test examples

Author: RadoRado

.github/workflows/django.yml

@@ -24,6 +24,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements/local.txt
+        pip install -r requirements/tests.txt
     - name: Run migrations
       run: python manage.py migrate
     - name: Run tests

README.md

@@ -9,6 +9,7 @@ Few important things:
 * Linux / Ubuntu is our primary OS and things are tested for that. It will mostly not work on Mac & certainly not work on Windows.
 * It uses Postgres as primary database.
 * It comes with GitHub Actions support, [based on that article](https://hacksoft.io/github-actions-in-action-setting-up-django-and-postgres/)
+* It comes with examples for writing tests with fakes & factories, based on the following articles - <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories>, <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories-advanced-usage>
 * It comes with [`whitenoise`](http://whitenoise.evans.io/en/stable/) setup.
 * It can be easily deployed to Heroku.
 * It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.

config/django/base.py

@@ -40,14 +40,16 @@
     'styleguide_example.api.apps.ApiConfig',
     'styleguide_example.users.apps.UsersConfig',
     'styleguide_example.errors.apps.ErrorsConfig',
+    'styleguide_example.testing_examples.apps.TestingExamplesConfig',
 ]
 
 THIRD_PARTY_APPS = [
     'rest_framework',
     'django_celery_results',
     'django_celery_beat',
     'django_filters',
-    'corsheaders'
+    'corsheaders',
+    'django_extensions',
 ]
 
 INSTALLED_APPS = [
@@ -105,12 +107,12 @@
 if os.environ.get('GITHUB_WORKFLOW'):
     DATABASES = {
         'default': {
-           'ENGINE': 'django.db.backends.postgresql',
-           'NAME': 'github_actions',
-           'USER': 'postgres',
-           'PASSWORD': 'postgres',
-           'HOST': '127.0.0.1',
-           'PORT': '5432',
+            'ENGINE': 'django.db.backends.postgresql',
+            'NAME': 'github_actions',
+            'USER': 'postgres',
+            'PASSWORD': 'postgres',
+            'HOST': '127.0.0.1',
+            'PORT': '5432',
         }
     }
 

requirements/base.txt

@@ -11,3 +11,4 @@ whitenoise==5.3.0
 
 django-filter==21.1
 django-cors-headers==3.10.1
+django-extensions==3.1.5

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

requirements/tests.txt

@@ -0,0 +1,6 @@
+-r base.txt
+
+pytest==6.2.5
+pytest-django==4.4.0
+factory-boy==3.2.1
+Faker==9.8.2

styleguide_example/common/apps.py

@@ -2,4 +2,5 @@
 
 
 class CommonConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
     name = 'styleguide_example.common'

styleguide_example/common/migrations/0002_alter_randommodel_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.9 on 2021-11-18 09:46
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('common', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='randommodel',
+            name='id',
+            field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID'),
+        ),
+    ]

styleguide_example/testing_examples/__init__.py

@@ -0,0 +1,45 @@
+from django.contrib import admin
+
+from styleguide_example.testing_examples.models import (
+    School,
+    SchoolCourse,
+    Student,
+    Roster
+)
+
+
+@admin.register(School)
+class SchoolAdmin(admin.ModelAdmin):
+    list_display = ('name', 'slug', )
+
+
+@admin.register(Roster)
+class RosterAdmin(admin.ModelAdmin):
+    list_display = ('student', 'school_course', 'start_date', 'end_date', 'active', )
+    list_filter = ('student', 'school_course')
+
+
+class RosterStudentInline(admin.TabularInline):
+    model = Roster
+    fields = ('school_course', 'start_date', 'end_date', 'active', 'deactivated_at', )
+    extra = 1
+
+
+class RosterSchoolCourseInline(admin.TabularInline):
+    model = Roster
+    fields = ('student', 'start_date', 'end_date', 'active', 'deactivated_at', )
+    extra = 1
+
+
+@admin.register(SchoolCourse)
+class SchoolCourseAdmin(admin.ModelAdmin):
+    list_display = ('name', 'slug', 'school', 'start_date', 'end_date', )
+    list_filter = ('school', )
+    inlines = (RosterSchoolCourseInline, )
+
+
+@admin.register(Student)
+class StudentAdmin(admin.ModelAdmin):
+    list_display = ('email', 'identifier', 'school', )
+    list_filter = ('school', )
+    inlines = (RosterStudentInline, )