Added tests for the populate utils

flaskbb/utils/populate.py

@@ -15,31 +15,41 @@ from flaskbb.forum.models import Post, Topic, Forum, Category
 
 def delete_settings_from_fixture(fixture):
     """Deletes the settings from a fixture from the database.
+    Returns the deleted groups and settings.
 
     :param fixture: The fixture that should be deleted.
     """
+    deleted_settings = {}
+
     for settingsgroup in fixture:
         group = SettingsGroup.query.filter_by(key=settingsgroup[0]).first()
+        deleted_settings[group] = []
 
         for settings in settingsgroup[1]["settings"]:
             setting = Setting.query.filter_by(key=settings[0]).first()
+            deleted_settings[group].append(setting)
             setting.delete()
+
         group.delete()
 
+    return deleted_settings
+
 
 def create_settings_from_fixture(fixture):
     """Inserts the settings from a fixture into the database.
+    Returns the created groups and settings.
 
     :param fixture: The fixture which should inserted.
     """
+    created_settings = {}
     for settingsgroup in fixture:
         group = SettingsGroup(
             key=settingsgroup[0],
             name=settingsgroup[1]["name"],
             description=settingsgroup[1]["description"]
         )
-
         group.save()
+        created_settings[group] = []
 
         for settings in settingsgroup[1]["settings"]:
             setting = Setting(
@@ -53,12 +63,15 @@ def create_settings_from_fixture(fixture):
                 settingsgroup=group.key
             )
             setting.save()
+            created_settings[group].append(setting)
+
+    return created_settings
 
 
 def update_settings_from_fixture(fixture, overwrite_group=False,
                                  overwrite_setting=False):
     """Updates the database settings from a fixture.
-    Returns the number of updated groups and settings.
+    Returns the updated groups and settings.
 
     :param fixture: The fixture which should be inserted/updated.
 
@@ -70,14 +83,13 @@ def update_settings_from_fixture(fixture, overwrite_group=False,
                               setting if it already exists.
                               Defaults to ``False``.
     """
-    groups_count = 0
-    settings_count = 0
+    updated_settings = {}
+
     for settingsgroup in fixture:
 
         group = SettingsGroup.query.filter_by(key=settingsgroup[0]).first()
 
         if (group is not None and overwrite_group) or group is None:
-            groups_count += 1
 
             if group is not None:
                 group.name = settingsgroup[1]["name"]
@@ -90,13 +102,13 @@ def update_settings_from_fixture(fixture, overwrite_group=False,
                 )
 
             group.save()
+            updated_settings[group] = []
 
         for settings in settingsgroup[1]["settings"]:
 
             setting = Setting.query.filter_by(key=settings[0]).first()
 
             if (setting is not None and overwrite_setting) or setting is None:
-                settings_count += 1
 
                 if setting is not None:
                     setting.value = settings[1]["value"]
@@ -117,8 +129,9 @@ def update_settings_from_fixture(fixture, overwrite_group=False,
                     )
 
                 setting.save()
+                updated_settings[group].append(setting)
 
-    return groups_count, settings_count
+    return updated_settings
 
 
 def create_default_settings():
@@ -144,6 +157,7 @@ def create_default_groups():
 
 def create_admin_user(username, password, email):
     """Creates the administrator user.
+    Returns the created admin user.
 
     :param username: The username of the user.
 
@@ -161,13 +175,16 @@ def create_admin_user(username, password, email):
     user.primary_group_id = admin_group.id
 
     user.save()
+    return user
 
 
 def create_welcome_forum():
-    """This will create the `welcome forum` with a welcome topic."""
+    """This will create the `welcome forum` with a welcome topic.
+    Returns True if it's created successfully.
+    """
 
     if User.query.count() < 1:
-        raise "You need to create the admin user first!"
+        return False
 
     user = User.query.filter_by(id=1).first()
 
@@ -182,35 +199,53 @@ def create_welcome_forum():
     post = Post(content="Have fun with your new FlaskBB Forum!")
 
     topic.save(user=user, forum=forum, post=post)
+    return True
 
 
-def create_test_data():
+def create_test_data(users=5, categories=2, forums=2, topics=1, posts=1):
     """Creates 5 users, 2 categories and 2 forums in each category.
     It also creates a new topic topic in each forum with a post.
+    Returns the amount of created users, categories, forums, topics and posts
+    as a dict.
+
+    :param users: The number of users.
+
+    :param categories: The number of categories.
+
+    :param forums: The number of forums which are created in each category.
+
+    :param topics: The number of topics which are created in each forum.
+
+    :param posts: The number of posts which are created in each topic.
     """
     create_default_groups()
     create_default_settings()
 
+    data_created = {'users': 0, 'categories': 0, 'forums': 0,
+                    'topics': 0, 'posts': 0}
+
     # create 5 users
-    for u in range(1, 6):
+    for u in range(1, users + 1):
         username = "test%s" % u
         email = "test%s@example.org" % u
         user = User(username=username, password="test", email=email)
         user.primary_group_id = u
         user.save()
+        data_created['users'] += 1
 
     user1 = User.query.filter_by(id=1).first()
     user2 = User.query.filter_by(id=2).first()
 
     # create 2 categories
-    for i in range(1, 3):
+    for i in range(1, categories + 1):
         category_title = "Test Category %s" % i
         category = Category(title=category_title,
                             description="Test Description")
         category.save()
+        data_created['categories'] += 1
 
         # create 2 forums in each category
-        for j in range(1, 3):
+        for j in range(1, forums + 1):
             if i == 2:
                 j += 2
 
@@ -218,24 +253,32 @@ def create_test_data():
             forum = Forum(title=forum_title, description="Test Description",
                           category_id=i)
             forum.save()
+            data_created['forums'] += 1
 
-            # create a topic
-            topic = Topic()
-            post = Post()
+            for t in range(1, topics + 1):
+                # create a topic
+                topic = Topic()
+                post = Post()
 
-            topic.title = "Test Title %s" % j
-            post.content = "Test Content"
-            topic.save(post=post, user=user1, forum=forum)
+                topic.title = "Test Title %s" % j
+                post.content = "Test Content"
+                topic.save(post=post, user=user1, forum=forum)
+                data_created['topics'] += 1
 
-            # create a second post in the forum
-            post = Post()
-            post.content = "Test Post"
-            post.save(user=user2, topic=topic)
+                for p in range(1, posts + 1):
+                    # create a second post in the forum
+                    post = Post()
+                    post.content = "Test Post"
+                    post.save(user=user2, topic=topic)
+                    data_created['posts'] += 1
+
+    return data_created
 
 
 def insert_mass_data(topics=100, posts=100):
-    """Creates 100 topics in the first forum and each topic has 100 posts.
-    Returns ``True`` if the topics and posts were successfully created.
+    """Creates a few topics in the first forum and each topic has
+    a few posts. WARNING: This might take very long!
+    Returns the count of created topics and posts.
 
     :param topics: The amount of topics in the forum.
     :param posts: The number of posts in each topic.
@@ -244,8 +287,11 @@ def insert_mass_data(topics=100, posts=100):
     user2 = User.query.filter_by(id=2).first()
     forum = Forum.query.filter_by(id=1).first()
 
-    if not user1 or user2 or forum:
-        raise "Please make sure that there are at least 2 users and 1 forum."
+    created_posts = 0
+    created_topics = 0
+
+    if not (user1 or user2 or forum):
+        return False
 
     # create 1000 topics
     for i in range(1, topics + 1):
@@ -257,9 +303,13 @@ def insert_mass_data(topics=100, posts=100):
         topic.title = "Test Title %s" % i
         post.content = "Test Content"
         topic.save(post=post, user=user1, forum=forum)
+        created_topics += 1
 
         # create 100 posts in each topic
-        for j in range(1, posts):
+        for j in range(1, posts + 1):
             post = Post()
             post.content = "Test Post"
             post.save(user=user2, topic=topic)
+            created_posts += 1
+
+    return created_topics, created_posts

tests/unit/utils/test_populate.py

@@ -1,6 +1,81 @@
-from flaskbb.utils.populate import create_default_groups
-from flaskbb.fixtures.groups import fixture
+import pytest
+from flaskbb.utils.populate import *
+from flaskbb.fixtures.groups import fixture as group_fixture
+from flaskbb.fixtures.settings import fixture as settings_fixture
 from flaskbb.user.models import Group
+from flaskbb.forum.models import Category, Topic, Post
+
+# 184-199, 218-268, 278-307
+def test_delete_settings_from_fixture(default_settings):
+    groups_count = SettingsGroup.query.count()
+    assert len(settings_fixture) == groups_count
+
+    deleted = delete_settings_from_fixture(settings_fixture)
+
+    assert len(settings_fixture) == len(deleted)
+    assert not SettingsGroup.query.count()
+    assert not Setting.query.count()
+
+
+def test_create_settings_from_fixture(database):
+    assert not SettingsGroup.query.count()
+    assert not Setting.query.count()
+
+    created = create_settings_from_fixture(settings_fixture)
+
+    assert len(settings_fixture) == len(created)
+    assert SettingsGroup.query.count() == len(created)
+
+
+def test_update_settings_from_fixture(database):
+    # No force-overwrite - the fixtures will be created because
+    # do not exist.
+    assert not SettingsGroup.query.count()
+    assert not Setting.query.count()
+    updated = update_settings_from_fixture(settings_fixture)
+    assert len(updated) == SettingsGroup.query.count()
+
+    # force-overwrite - the fixtures exist, but they will be overwritten now.
+    force_updated = update_settings_from_fixture(settings_fixture,
+                                                 overwrite_group=True,
+                                                 overwrite_setting=True)
+    assert len(force_updated) == SettingsGroup.query.count()
+
+
+def test_create_admin_user(default_groups):
+    user = User.query.filter_by(username="admin").first()
+    assert not user
+
+    user = create_admin_user(username="admin", password="test",
+                             email="test@example.org")
+    assert user.username == "admin"
+    assert user.permissions["admin"]
+
+
+def test_create_welcome_forum(default_groups):
+    assert not create_welcome_forum()
+
+    create_admin_user(username="admin", password="test",
+                      email="test@example.org")
+    assert create_welcome_forum()
+
+
+def test_create_test_data(database):
+    assert Category.query.count() == 0
+    data_created = create_test_data()
+    assert Category.query.count() == data_created['categories']
+
+
+def test_insert_mass_data(database):
+    assert not insert_mass_data(topics=1, posts=1)
+
+    create_test_data(categories=1, forums=1, topics=0)
+    assert Topic.query.count() == 0
+
+    topics, posts = insert_mass_data(topics=1, posts=1)
+    assert Topic.query.count() == topics
+    # -1 bc the topic post also counts as post
+    assert Post.query.count() - 1 == posts
 
 
 def test_create_default_groups(database):
@@ -10,9 +85,9 @@ def test_create_default_groups(database):
 
     create_default_groups()
 
-    assert Group.query.count() == len(fixture)
+    assert Group.query.count() == len(group_fixture)
 
-    for key, attributes in fixture.items():
+    for key, attributes in group_fixture.items():
         group = Group.query.filter_by(name=key).first()
 
         for attribute, value in attributes.items():