added tests for web app

Author: gpizzorno

app/tests/conftest.py

@@ -1,17 +1,12 @@
 """Configure pytest for the tests module."""
 
-import io
 import uuid
-from pathlib import Path
 from unittest import mock
 
 import pytest
-from faker import Faker
-from PIL import Image
 from rest_framework.test import APIRequestFactory
 
 from django.conf import settings
-from django.core.files.uploadedfile import SimpleUploadedFile
 
 from app.settings import TenantTypes
 from oauth.models import User
@@ -142,44 +137,27 @@ def auth_user(client, factories, test_username, test_password):
 
 
 @pytest.fixture
-def admin_user(factories):
+def admin_user(factories, test_username, test_password):
     """Inject a staff user."""
-    return factories.users.create(is_staff=True)
+    return factories.users.create(
+        username=test_username,
+        password=test_password,
+        is_staff=True,
+    )
 
 
 @pytest.fixture
-def superuser(factories):
+def superuser(factories, test_username, test_password):
     """Inject a superuser."""
-    return factories.users.create(is_superuser=True)
+    return factories.users.create(
+        username=test_username,
+        password=test_password,
+        is_staff=True,
+        is_superuser=True,
+    )
 
 
 @pytest.fixture
 def bare_agent(factories):
     """Inject a **Bare Agent**, ie. a person without a related user."""
     return factories.people(bare_agent=True)
-
-
-@pytest.fixture
-def team_member(factories):
-    """Inject a regular team member."""
-    return factories.team_members.create()
-
-
-@pytest.fixture
-def avatar_image():
-    """Inject an avatar image."""
-    fake = Faker()
-    filename = fake.file_name(category='image', extension='png')
-
-    with io.BytesIO() as buffer:
-        image = Image.new('RGBA', size=(50, 50), color=(155, 0, 0))
-        image.save(buffer, 'png')
-        buffer.name = filename
-        buffer.seek(0)
-        image_file = SimpleUploadedFile(name=filename, content=buffer.getvalue(), content_type='image/png')
-
-        # Manifest handling and filename collisions can cause a non-deterministic
-        # hash to be added to the filename, so we retrieve the *actual* name next.
-        filename = Path(image_file.name).name
-
-        return image_file

app/tests/domain/conftest.py

@@ -0,0 +1 @@
+"""Configure pytest for the tests.domain module."""

app/tests/factories/web.py

@@ -24,7 +24,7 @@ class Meta:
 
     user = factory.SubFactory(UserFactory)
     name = factory.Faker('name')
-    roles = factory.RelatedFactory(TeamMemberRoleFactory, factory_related_name='team_member')
+    roles = factory.RelatedFactory(TeamMemberRoleFactory)
     title = factory.Faker('job')
     affiliation = factory.Faker('company')
     biography = factory.Faker('paragraph')

app/tests/web/cms/test_cms_avatar_functionality.py

@@ -0,0 +1,64 @@
+"""Test basic avatar functionality in the CMS."""
+
+import pytest
+
+from django.conf import settings
+from django.test import Client
+from django.urls import reverse
+
+
+@pytest.mark.django_db
+def test_avatar_saving_user(auth_user, avatar_image):
+    auth_user.avatar.save(avatar_image.name, avatar_image, save=True)
+
+    assert (
+        auth_user.avatar.url
+        == f'/{settings.MEDIA_LOCATION}/public/{settings.AVATARS_LOCATION}/user/{avatar_image.name}'
+    )
+
+
+@pytest.mark.django_db
+def test_avatar_saving_teammember(team_member, avatar_image):
+    team_member.avatar.save(avatar_image.name, avatar_image, save=True)
+
+    assert (
+        team_member.avatar.url
+        == f'/{settings.MEDIA_LOCATION}/public/{settings.AVATARS_LOCATION}/teammember/{avatar_image.name}'
+    )
+
+
+@pytest.mark.django_db
+def test_avatar_url_retrieval(team_member, avatar_image):
+    user = team_member.user
+    # Because the property `avatar_url` favours a team_member avatar over a user
+    # avatar, the following assertion only works if the avatar is set in the `user` model first
+    user.avatar.save(avatar_image.name, avatar_image, save=True)
+    assert (
+        team_member.avatar_url
+        == f'/{settings.MEDIA_LOCATION}/public/{settings.AVATARS_LOCATION}/user/{avatar_image.name}'
+    )
+
+    # If the team member avatar is set, it should now override the user's avatar
+    team_member.avatar.save(avatar_image.name, avatar_image, save=True)
+    assert (
+        team_member.avatar_url
+        == f'/{settings.MEDIA_LOCATION}/public/{settings.AVATARS_LOCATION}/teammember/{avatar_image.name}'
+    )
+
+
+@pytest.mark.django_db
+@pytest.mark.urls('app.urls.urls_tenant')
+def test_avatar_rendering_in_views(superuser, avatar_image, test_username, test_password):
+    client = Client(HTTP_HOST='dalme.localhost')
+    client.login(username=test_username, password=test_password)
+    response = client.get(reverse('wagtailadmin_home'))
+
+    assert '<img src="//www.gravatar.com/avatar' in response.content.decode(response.charset)
+
+    superuser.avatar.save(avatar_image.name, avatar_image, save=True)
+
+    response = client.get(reverse('wagtailadmin_home'))
+    assert (
+        f'<img src="/{settings.MEDIA_LOCATION}/public/{settings.AVATARS_LOCATION}/user/{avatar_image.name}"'
+        in response.content.decode(response.charset)
+    )

app/tests/web/conftest.py

@@ -0,0 +1,73 @@
+"""Configure pytest for the tests.web module."""
+
+import io
+from pathlib import Path
+
+import pytest
+from django_tenants.utils import schema_context
+from faker import Faker
+from PIL import Image
+
+from django.conf import settings
+from django.core.files.uploadedfile import SimpleUploadedFile
+from django.core.management import call_command
+from django.db import connection
+
+from tenants.models import Domain, Tenant
+
+
+@pytest.fixture(scope='session', autouse=True)
+def setup_tenant_schema(django_db_setup, django_db_blocker):  # noqa: ARG001
+    tenants = settings.TENANTS()
+    with django_db_blocker.unblock(), schema_context('public'):
+        for tenant in tenants:
+            domain, additional_domains, name, schema_name, is_primary, tenant_type = tenant.value
+
+            if not Tenant.objects.filter(name=name).exists():
+                tenant_obj = Tenant.objects.create(
+                    name=name,
+                    schema_name=schema_name,
+                    tenant_type=tenant_type.value,
+                )
+                Domain.objects.create(
+                    domain=domain,
+                    tenant=tenant_obj,
+                    is_primary=is_primary,
+                )
+
+                if schema_name not in [
+                    row[0]
+                    for row in connection.cursor()
+                    .execute('SELECT schema_name FROM information_schema.schemata')
+                    .fetchall()
+                ]:
+                    connection.cursor().execute(f'CREATE SCHEMA "{schema_name}"')
+                    call_command(
+                        'migrate_schemas', tenant=True, schema_name=schema_name, interactive=False, verbosity=0
+                    )
+
+
+@pytest.fixture
+def team_member(factories):
+    """Inject a regular team member."""
+    return factories.team_members.create()
+
+
+@pytest.fixture
+def avatar_image():
+    """Inject an avatar image."""
+    fake = Faker()
+    filename = fake.file_name(category='image', extension='png')
+
+    with io.BytesIO() as buffer:
+        image = Image.new('RGBA', size=(50, 50), color=(155, 0, 0))
+        image.save(buffer, 'png')
+        buffer.name = filename
+        buffer.seek(0)
+        image_file = SimpleUploadedFile(name=filename, content=buffer.getvalue(), content_type='image/png')
+
+        # Manifest handling and filename collisions can cause a non-deterministic
+        # hash to be added to the filename, so we retrieve the *actual* name next.
+        filename = Path(image_file.name).name
+
+        return image_file

app/tests/web/management/test_public_commands.py

@@ -0,0 +1,16 @@
+"""Test the web.management module."""
+
+import os
+from unittest import mock
+
+from web.management.commands.generate_tree import Command as GenerateTree
+
+
+@mock.patch.dict(os.environ, {'ENV': 'production'})
+@mock.patch('web.management.commands.generate_tree.logger')
+def test_generate_tree_production(mock_logger):
+    GenerateTree().handle()
+
+    assert mock_logger.mock_calls == [
+        mock.call.error('This command should never be run in production'),
+    ]