Source code for fobi.tests.helpers
__title__ = 'fobi.tests.helpers'
__author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
__copyright__ = '2014-2016 Artur Barseghyan'
__license__ = 'GPL 2.0/LGPL 2.1'
__all__ = (
'get_or_create_admin_user', 'get_or_create_admin_user',
'create_form_with_entries', 'db_clean_up',
)
from django.core.management import call_command
from django.core.exceptions import ObjectDoesNotExist
from django.conf import settings
from django.contrib.auth import get_user_model
from fobi.models import FormEntry, FormElementEntry, FormHandlerEntry
from fobi.contrib.plugins.form_elements.content.content_text.fobi_form_elements \
import ContentTextPlugin
from fobi.contrib.plugins.form_elements.content.content_image.fobi_form_elements \
import ContentImagePlugin
from fobi.contrib.plugins.form_elements.fields.boolean.fobi_form_elements \
import BooleanSelectPlugin
from fobi.contrib.plugins.form_elements.fields.email.fobi_form_elements \
import EmailInputPlugin
from fobi.contrib.plugins.form_elements.fields.hidden.fobi_form_elements \
import HiddenInputPlugin
from fobi.contrib.plugins.form_elements.fields.integer.fobi_form_elements \
import IntegerInputPlugin
from fobi.contrib.plugins.form_elements.fields.text.fobi_form_elements \
import TextInputPlugin
from fobi.contrib.plugins.form_elements.fields.textarea.fobi_form_elements \
import TextareaPlugin
from fobi.contrib.plugins.form_handlers.db_store.fobi_form_handlers \
import DBStoreHandlerPlugin
from fobi.contrib.plugins.form_handlers.mail.fobi_form_handlers \
import MailHandlerPlugin
from fobi.tests.base import (
is_fobi_setup_completed, mark_fobi_setup_as_completed
)
from fobi.tests.constants import (
FOBI_TEST_USER_USERNAME, FOBI_TEST_USER_PASSWORD,
TEST_FORM_NAME, TEST_FORM_SLUG
)
# ****************************************************************************
# **************** Safe User import for Django > 1.5, < 1.8 ******************
# ****************************************************************************
AUTH_USER_MODEL = settings.AUTH_USER_MODEL
# Note, that this may cause circular imports - thus the ``get_user_model``
# should be moved elsewhere (be used on the function/method level). For
# now leave commented and solve in future. Possible use the DjangoCMS solution
# https://github.com/divio/django-cms/blob/develop/cms/models/permissionmodels.py#L18
# Sanity checks.
#user = User()
#
#if not hasattr(user, 'username'):
# from fobi.exceptions import ImproperlyConfigured
# raise ImproperlyConfigured("Your custom user model ({0}.{1}) doesn't "
# "have ``username`` property, while "
# "``django-fobi`` relies on its' presence"
# ".".format(user._meta.app_label, user._meta.object_name))
# ****************************************************************************
# ****************************************************************************
# ****************************************************************************
[docs]def get_or_create_admin_user():
"""
Create a user for testing the fobi.
TODO: At the moment an admin account is being tested. Automated tests
with diverse accounts are to be implemented.
"""
User = get_user_model()
try:
kwargs = {
User.USERNAME_FIELD: FOBI_TEST_USER_USERNAME,
}
u = User._default_manager.get(**kwargs)
return u
except ObjectDoesNotExist as e:
u = User()
setattr(u, User.USERNAME_FIELD, FOBI_TEST_USER_USERNAME)
u.email = 'admin@dev.django-fobi.example.com'
u.is_superuser = True
u.is_staff = True
u.set_password(FOBI_TEST_USER_PASSWORD)
try:
u.save()
return u
except Exception as e:
pass
def setup_fobi(collectstatic=False, fobi_sync_plugins=False):
"""
Set up fobi.
"""
if is_fobi_setup_completed():
return False
if collectstatic:
call_command('collectstatic', verbosity=3, interactive=False)
if fobi_sync_plugins:
call_command('fobi_sync_plugins', verbosity=3, interactive=False)
#call_command('loaddata', 'dash', verbosity=3, interactive=False)
mark_fobi_setup_as_completed()
[docs]def create_form_with_entries(user=None, create_entries_if_form_exist=True):
"""
Create test form with entries. Fills the form with pre-defined
plugins.
:param django.contrib.auth.models.User user:
:param bool create_entries_if_form_exist: If set to True, entries
are being created even if form already exists (a database
record).
:return fobi.models.FormEntry: Instance of ``fobi.models.FormEntry``
with a number of form elements and handlers filled in.
"""
if not user:
user = get_or_create_admin_user()
try:
form_entry = FormEntry._default_manager.get(slug=TEST_FORM_SLUG)
if not create_entries_if_form_exist:
return None
except Exception as e:
form_entry = FormEntry(
name = TEST_FORM_NAME,
slug = TEST_FORM_SLUG,
user = user
)
form_entry.save()
# *************************************************************************
# ******************************** Form elements **************************
# *************************************************************************
position = 1
# Text input
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = TextInputPlugin.uid,
plugin_data = '{"name": "username", "required": true, '
'"max_length": "200", "label": "Username"}',
position = position
)
form_element_entry.save()
position += 1
# Email
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = EmailInputPlugin.uid,
plugin_data = '{"name": "email", "required": true, "label": "E-mail"}',
position = position
)
form_element_entry.save()
position += 1
# Integer
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = IntegerInputPlugin.uid,
plugin_data = '{"name": "age", "required": true, '
'"max_value": "200", "label": "Age"}',
position = position
)
form_element_entry.save()
position += 1
# Boolean select
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = BooleanSelectPlugin.uid,
plugin_data = '{"name": "drivers_license", "required": false, '
'"label": "Drivers license?"}',
position = position
)
form_element_entry.save()
position += 1
# Hidden
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = HiddenInputPlugin.uid,
plugin_data = '{"name": "special_fields", "required": false, '
'"label": "Special fields"}',
position = position
)
form_element_entry.save()
position += 1
# Content image
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = ContentImagePlugin.uid,
plugin_data = '{"fit_method": "center", '
'"file": "fobi_plugins/content_plugin_images/04.jpg", '
'"alt": "Cute girl"}',
position = position
)
form_element_entry.save()
position += 1
# Integer
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = IntegerInputPlugin.uid,
plugin_data = '{"name": "number_of_children", "required": false, '
'"label": "Number of children"}',
position = position
)
form_element_entry.save()
position += 1
# Textarea
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = TextareaPlugin.uid,
plugin_data = '{"name": "bio", "required": true, "label": "Biography"}',
position = position
)
form_element_entry.save()
position += 1
# Content text
form_element_entry = FormElementEntry(
form_entry = form_entry,
plugin_uid = ContentTextPlugin.uid,
plugin_data = ''
'{"text": "Suspendisse potenti. Etiam in nunc sodales, congue '
'lectus ut, suscipit massa. In commodo fringilla orci, in varius '
'eros gravida a! Aliquam erat volutpat. Donec sodales orci nec '
'massa aliquam bibendum. Aenean sed condimentum velit. Mauris '
'luctus bibendum nulla vel tempus. Integer tempor condimentum '
'ligula sed feugiat. Aenean scelerisque ultricies vulputate. '
'Donec semper lorem rhoncus sem cras amet."}',
position = 9
)
form_element_entry.save()
position += 1
# *************************************************************************
# ******************************** Form handlers **************************
# *************************************************************************
# DB save
form_handler_entry = FormHandlerEntry(
form_entry = form_entry,
plugin_uid = DBStoreHandlerPlugin.uid,
plugin_data = ''
)
form_handler_entry.save()
# Mail
form_handler_entry = FormHandlerEntry(
form_entry = form_entry,
plugin_uid = MailHandlerPlugin.uid,
plugin_data = '{"from_name": "Fobi administration", '
'"from_email": "noreply@fobi.mail.example.com", '
'"to_name": "Artur Barseghyan", '
'"to_email": "artur.barseghyan@gmail.com", '
'"subject": "Test mail", "body": "Test body"}'
)
form_handler_entry.save()
return form_entry
[docs]def db_clean_up():
"""
Cleans up the database by removing all form element and form handler
entries.
"""
FormElementEntry._default_manager.all().delete()
FormHandlerEntry._default_manager.all().delete()