From dc23f6343a1412bbb96f0f04f031bae9f30e854b Mon Sep 17 00:00:00 2001
From: Tim Van Baak <tim.vanbaak@gmail.com>
Date: Tue, 1 Jun 2021 18:46:19 -0700
Subject: [PATCH] Add unit test object factory

---
 tests/conftest.py        | 49 ++++++++++++++++++++++++++++++++++++----
 tests/test_character.py  |  4 ++--
 tests/test_membership.py |  6 ++---
 3 files changed, 50 insertions(+), 9 deletions(-)

diff --git a/tests/conftest.py b/tests/conftest.py
index c80c7f8..dc6662a 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -4,6 +4,7 @@ pytest test fixtures
 import pytest
 
 from amanuensis.db import DbContext
+import amanuensis.backend.character as charq
 import amanuensis.backend.lexicon as lexiq
 import amanuensis.backend.membership as memq
 import amanuensis.backend.user as userq
@@ -62,12 +63,52 @@ def make_membership(db: DbContext):
 
 
 @pytest.fixture
-def lexicon_with_editor(make_user, make_lexicon, make_membership):
+def make_character(db: DbContext):
+    """Provides a factory function for creating characters, with valid default values."""
+    def character_factory(state={'nonce': 1}, **kwargs):
+        default_kwargs = {
+            'name': f'Character {state["nonce"]}',
+            'signature': None,
+        }
+        state['nonce'] += 1
+        updated_kwargs = {**default_kwargs, **kwargs}
+        return charq.create(db, **updated_kwargs)
+    return character_factory
+
+
+class TestFactory:
+    def __init__(self, db, **factories):
+        self.db = db
+        self.factories = factories
+
+    def __getattr__(self, name):
+        return self.factories[name]
+
+
+@pytest.fixture
+def make(
+    db: DbContext,
+    make_user,
+    make_lexicon,
+    make_membership,
+    make_character) -> TestFactory:
+    """Fixture that groups all factory fixtures together."""
+    return TestFactory(
+        db,
+        user=make_user,
+        lexicon=make_lexicon,
+        membership=make_membership,
+        character=make_character,
+    )
+
+
+@pytest.fixture
+def lexicon_with_editor(make):
     """Shortcut setup for a lexicon game with an editor."""
-    editor = make_user()
+    editor = make.user()
     assert editor
-    lexicon = make_lexicon()
+    lexicon = make.lexicon()
     assert lexicon
-    membership = make_membership(user_id=editor.id, lexicon_id=lexicon.id, is_editor=True)
+    membership = make.membership(user_id=editor.id, lexicon_id=lexicon.id, is_editor=True)
     assert membership
     return (lexicon, editor)
diff --git a/tests/test_character.py b/tests/test_character.py
index 26134ed..0a1e2e5 100644
--- a/tests/test_character.py
+++ b/tests/test_character.py
@@ -5,7 +5,7 @@ import amanuensis.backend.character as charq
 from amanuensis.errors import ArgumentError
 
 
-def test_create_character(db: DbContext, lexicon_with_editor, make_user):
+def test_create_character(db: DbContext, lexicon_with_editor, make):
     """Test creating a character."""
     lexicon, user = lexicon_with_editor
     kwargs = {
@@ -33,7 +33,7 @@ def test_create_character(db: DbContext, lexicon_with_editor, make_user):
     assert char.signature is not None
 
     # User must be in lexicon
-    new_user = make_user()
+    new_user = make.user()
     with pytest.raises(ArgumentError):
         charq.create(**{**kwargs, 'user_id': new_user.id})
 
diff --git a/tests/test_membership.py b/tests/test_membership.py
index 3e76c2a..d478394 100644
--- a/tests/test_membership.py
+++ b/tests/test_membership.py
@@ -7,12 +7,12 @@ from amanuensis.errors import ArgumentError
 import amanuensis.backend.membership as memq
 
 
-def test_create_membership(db: DbContext, make_user, make_lexicon):
+def test_create_membership(db: DbContext, make):
     """Test joining a game."""
     # Set up a user and a lexicon
-    new_user = make_user()
+    new_user = make.user()
     assert new_user.id, 'Failed to create user'
-    new_lexicon = make_lexicon()
+    new_lexicon = make.lexicon()
     assert new_lexicon.id, 'Failed to create lexicon'
 
     # Add the user to the lexicon as an editor