Source code for fobi.tests.test_browser_build_dynamic_forms
import logging
from django.test import override_settings
from django.urls import reverse
from selenium.webdriver.common.by import By
from selenium.webdriver.support.wait import WebDriverWait
from fobi.models import FormEntry
from . import constants
from .base import BaseFobiBrowserBuldDynamicFormsTest
from .core import print_info
from .data import (
TEST_FORM_ELEMENT_PLUGIN_DATA,
TEST_FORM_FIELD_DATA,
TEST_FORM_HANDLER_PLUGIN_DATA,
)
from .helpers import db_clean_up
__title__ = "fobi.tests.test_browser_build_dynamic_forms"
__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
__copyright__ = "2014-2022 Artur Barseghyan"
__license__ = "GPL 2.0/LGPL 2.1"
__all__ = ("FobiBrowserBuldDynamicFormsTest",)
logger = logging.getLogger(__name__)
TRAVIS_TIMEOUT = 32
TIMEOUT = TRAVIS_TIMEOUT
LONG_TIMEOUT = TRAVIS_TIMEOUT
WAIT = False
WAIT_FOR = 0
[docs]class FobiBrowserBuldDynamicFormsTest(BaseFobiBrowserBuldDynamicFormsTest):
"""Browser tests django-fobi bulding forms functionality.
Backed up by selenium. This test is based on the bootstrap3 theme.
"""
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# ++++++++++++++++++++++ Form related +++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
def _go_to_dashboard(self, wait=WAIT_FOR):
"""Go to dashboard."""
# Authenticate user.
self._authenticate()
# Open the dashboard.
url = reverse("fobi.dashboard")
self.driver.get("{0}{1}".format(self._get_live_server_url(), url))
# Wait until the edit widget form opens
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH, '//body[contains(@class, "theme-bootstrap3")]'
)
)
self._sleep(wait)
def _test_add_form(self, wait=WAIT_FOR):
"""Test add form."""
# First open the dashboard
self._go_to_dashboard()
# Follow the create form link.
# Click the button to go to dashboard edit
self.driver.find_element(
By.XPATH, '//a[contains(@class, "list-group-item")]'
).click()
# Wait until the dashboard edit view opens
WebDriverWait(self.driver, timeout=TIMEOUT).until(
# lambda driver: driver.find_element(By.ID, 'id_main')
lambda driver: driver.find_element(
By.XPATH, '//body[contains(@class, "theme-bootstrap3")]'
)
)
form_data = {
"name": constants.TEST_FORM_NAME,
# 'user': get_or_create_admin_user(),
# 'slug': constants.TEST_FORM_SLUG,
"is_public": True,
"success_page_title": "Success page title",
"success_page_message": "Success page message",
}
if form_data:
for field_name, field_value in form_data.items():
field_input = self.driver.find_element(By.NAME, field_name)
field_input.send_keys(field_value)
# Click add widget button
self.driver.find_element(By.XPATH, '//button[@type="submit"]').click()
logger.debug(
"""//div[contains(text(), 'Form {0} was created """
"""successfully.') and contains(@class, "alert-info")]""".format(
constants.TEST_FORM_NAME
)
)
# Wait until the fobi page opens with the form element in
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//div[contains(text(), 'Form {0} was created """
"""successfully.') """
"""and contains(@class, "alert-info")]""".format(
constants.TEST_FORM_NAME
),
)
)
self._sleep(wait)
return self.driver.current_url
def _get_form(self):
"""Get form object."""
return FormEntry._default_manager.get(name=constants.TEST_FORM_NAME)
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# ++++++++++++++++++++ Form element specific ++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
def _add_form_element(
self, form_element_name, form_element_data, wait=WAIT_FOR
):
"""Add a single plugin to the form.
At this stage we should be in the edit form entry interface.
"""
# # Wait until the add widget view opens
# WebDriverWait(self.driver, timeout=TIMEOUT).until(
# lambda driver: driver.find_element(
# By.XPATH,
# """//a[contains(text(), 'Choose form element to add') and """
# """contains(@class, "dropdown-toggle")]"""
# )
# )
# try:
# add_form_element_link = self.driver.find_element(
# By.XPATH,
# """//a[contains(text(), 'Choose form element to add') and """
# """contains(@class, "dropdown-toggle")]"""
# )
# except Exception as err:
# import pytest; pytest.set_trace()
# Click the add form element button to add a new form element to the
# form.
add_form_element_link = self.driver.find_element(
By.XPATH,
"""//a[contains(text(), 'Choose form element to add') and """
"""contains(@class, "dropdown-toggle")]""",
)
self._scroll_to(0, 0)
add_form_element_link.click()
# Find the parent element
add_form_element_parent_container = add_form_element_link.find_element(
By.XPATH, ".."
)
# Find the container of the available form elements
add_form_element_available_elements_container = (
add_form_element_parent_container.find_element(
By.XPATH, '//ul[contains(@class, "dropdown-menu")]'
)
)
# Click on the element we want
form_element_to_add = (
add_form_element_available_elements_container.find_element(
By.XPATH, '//a[text()="{0}"]'.format(form_element_name)
)
)
# self._scroll_to_element(form_element_to_add, simple=True)
# self._scroll_by(0, -150)
# form_element_to_add.click()
# self.driver.get('{0}{1}'.format(
# self._get_live_server_url(),
# form_element_to_add.get_attribute('href'))
# )
# self.driver.get(form_element_to_add.get_attribute('href'))
self._move_to_element(form_element_to_add, simple=True)
form_element_to_add.click()
# Adding form data
if form_element_data:
# Wait until the add widget view opens
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//h1[contains(text(), 'Add "{0}" element to """
"""the form')]""".format(form_element_name),
)
)
for field_name, field_value in form_element_data.items():
# Wait until element is visible
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(By.NAME, field_name)
)
field_input = self.driver.find_element(By.NAME, field_name)
# field_input.clear()
field_input.send_keys(field_value)
# Click add widget button
submit_button = self.driver.find_element(
By.XPATH, '//button[@type="submit"]'
)
submit_button.click()
try:
submit_button.click()
except Exception as err:
pass
logger.debug("--------------------------------------")
logger.debug(form_element_name)
# Wait until the fobi page opens with the form element in.
self._maximize_window()
WebDriverWait(self.driver, timeout=LONG_TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//div[contains(text(), 'The form element plugin "{0}" """
"""was added successfully.') """
"""and contains(@class, "alert-info")]""".format(
form_element_name
),
)
)
def _test_add_form_elements(self, create_form=False):
"""Test of adding multiple form elements.
At this point form should be created.
"""
edit_form_url = None
if create_form:
# Adding a form first
edit_form_url = self._test_add_form()
# One by one adding form elements with data.
# Example follows:
#
# self._add_form_element(
# force_str(BooleanSelectPlugin.name),
# {
# 'label': "Test boolean",
# 'name': "test_boolean",
# 'help_text': "Lorem ipsum boolean",
# 'required': False,
# }
# )
for plugin_name, plugin_data in TEST_FORM_ELEMENT_PLUGIN_DATA.items():
# TODO: something isn't right here. Adding of a form element
# does not go always well in tests and we're not always on the
# edit form page initially. Fix that.
if edit_form_url is not None:
self.driver.get(edit_form_url)
# Add form element to the form
self._add_form_element(plugin_name, plugin_data)
def _remove_form_element(
self, form_element_name, form_element_data, wait=WAIT_FOR
):
"""Add a single plugin to the form.
At this stage we should be in the edit form entry interface.
"""
# Get the label of the given form element in order to delete it later
# from the form.
delete_form_element_label = self.driver.find_element(
By.XPATH,
"""//label[contains(text(), '({0})') """
"""and contains(@class, "control-label")]""".format(
form_element_name
),
)
# Get the parent of the label
delete_form_element_label_parent_container = (
delete_form_element_label.find_element(By.XPATH, "..")
)
# Click the add form element button to add a new form element to the
# form.
delete_form_element_link = (
delete_form_element_label_parent_container.find_element(
By.PARTIAL_LINK_TEXT, "Delete"
)
)
# delete_form_element_link.click()
# self._click(delete_form_element_link)
self._aggressive_click(delete_form_element_link)
logger.debug(form_element_name)
# Wait until the fobi page opens with the form element in.
WebDriverWait(self.driver, timeout=LONG_TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//div[contains(text(), 'The form element plugin "{0}" """
"""was deleted successfully.') """
"""and contains(@class, "alert-info")]""".format(
form_element_name
),
)
)
def _test_remove_form_elements(self):
"""Test of removing multiple form elements.
At this point form should be created.
"""
for plugin_name, plugin_data in TEST_FORM_ELEMENT_PLUGIN_DATA.items():
# Add form element to the form
self._remove_form_element(plugin_name, plugin_data)
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# ++++++++++++++++++++ Form handler specific ++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
def _add_form_handler(
self, form_handler_name, form_handler_data, wait=WAIT_FOR
):
"""Add a single handler to the form.
At this stage we should be in the edit form entry interface.
"""
# This part is necessary, since we need to activate the
# tab with form handlers. Otherwise Selenium raises
# an exception about non-visible element on the page
# that we're trying to fetch.
form_handlers_tab_link = self.driver.find_element(
By.XPATH, """//a[@href="#tab-form-handlers"]"""
)
form_handlers_tab_link.click()
# Click the add form element button to add a new form element to the
# form.
add_form_handler_link = self.driver.find_element(
By.XPATH,
"""//a[contains(text(), 'Choose form handler to add') """
"""and contains(@class, "dropdown-toggle")]""",
)
add_form_handler_link.click()
# Find the parent element
add_form_handler_parent_container = add_form_handler_link.find_element(
By.XPATH, ".."
)
# Find the container of the available form elements
add_form_handler_available_elements_container = (
add_form_handler_parent_container.find_element(
By.XPATH, '//ul[contains(@class, "dropdown-menu")]'
)
)
# Click on the element we want
form_handler_to_add = (
add_form_handler_available_elements_container.find_element(
By.XPATH, '//a[text()="{0}"]'.format(form_handler_name)
)
)
form_handler_to_add.click()
# If has config, there's a need to perform some extra tests.
if form_handler_data:
# Wait until the add widget view opens
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//h1[contains(text(), 'Add "{0}" handler to """
"""the form')]""".format(form_handler_name),
)
)
# Config
for field_name, field_value in form_handler_data.items():
field_input = self.driver.find_element(By.NAME, field_name)
field_input.send_keys(field_value)
# Click add widget button
self.driver.find_element(
By.XPATH, '//button[@type="submit"]'
).click()
# Wait until the fobi page opens with the form element in.
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//div[contains(text(), 'The form handler plugin "{0}" """
"""was added successfully.') """
"""and contains(@class, "alert-info")]""".format(
form_handler_name
),
)
)
def _test_add_form_handlers(self, create_form=False):
"""Test of adding multiple form handlers.
At this point form should be created.
"""
if create_form:
# Adding a form first
self._test_add_form()
# One by one adding form elements with data.
# Example follows:
#
# self._add_form_element(
# force_str(BooleanSelectPlugin.name),
# {
# 'label': "Test boolean",
# 'name': "test_boolean",
# 'help_text': "Lorem ipsum boolean",
# 'required': False,
# }
# )
for plugin_name, plugin_data in TEST_FORM_HANDLER_PLUGIN_DATA.items():
# Add form element to the form
self._add_form_handler(plugin_name, plugin_data)
def _remove_form_handler(
self, form_handler_name, form_handler_data, wait=WAIT_FOR
):
"""Remove a single handler from the form.
At this stage we should be in the edit form entry interface.
"""
# This part is necessary, since we need to activate the
# tab with form handlers. Otherwise Selenium raises
# an exception about non-visible element on the page
# that we're trying to fetch.
form_handlers_tab_link = self.driver.find_element(
By.XPATH, """//a[@href="#tab-form-handlers"]"""
)
form_handlers_tab_link.click()
# Get the label of the given form element in order to delete it later
# from the form.
delete_form_handler_label = self.driver.find_element(
By.XPATH,
"""//td[contains(text(), '{0}')]""".format(form_handler_name),
)
# Get the parent of the label
delete_form_handler_label_parent_container = (
delete_form_handler_label.find_element(By.XPATH, "..")
)
# Click the add form element button to add a new form element to the
# form.
delete_form_handler_link = (
delete_form_handler_label_parent_container.find_element(
By.PARTIAL_LINK_TEXT, "Delete"
)
)
delete_form_handler_link.click()
logger.debug(form_handler_name)
# Wait until the fobi page opens with the form element in.
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//div[contains(text(), 'The form handler plugin "{0}" """
"""was deleted successfully.') """
"""and contains(@class, "alert-info")]""".format(
form_handler_name
),
)
)
def _test_remove_form_handlers(self):
"""Test of removing multiple form handlers.
At this point form should be created.
"""
for plugin_name, plugin_data in TEST_FORM_HANDLER_PLUGIN_DATA.items():
# Remove form handler from the form
self._remove_form_handler(plugin_name, plugin_data)
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++ Tests +++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# +++++++++++++++++++++++++++ General +++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
def _test_1001_open_dashboard(self):
"""Test open dashboard."""
self._go_to_dashboard()
@print_info
def test_1001_open_dashboard(self):
"""Test open dashboard."""
self._test_1001_open_dashboard()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_1001_open_dashboard_fbv(self):
"""Test open dashboard."""
self._test_1001_open_dashboard()
# class GeneralFobiBrowserBuldDynamicFormsTest(
# BaseFobiBrowserBuldDynamicFormsTest):
# """General tests."""
#
#
# class FormSpecificFobiBrowserBuldDynamicFormsTest(
# BaseFobiBrowserBuldDynamicFormsTest):
# """Form specific tests."""
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# ++++++++++++++++++++++ Form specific ++++++++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
def _test_2001_add_form(self):
"""Test add a new form."""
# Clean up database
db_clean_up()
self._test_add_form(wait=WAIT_FOR)
# Make sure the success message is there
# self.driver.find_element(
# By.XPATH,
# """//div[text()='Form {0} was created successfully.']""".format(
# constants.TEST_FORM_NAME
# )
# )
@print_info
def test_2001_add_form(self):
"""Test add a new form."""
self._test_2001_add_form()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_2001_add_form_fbv(self):
"""Test add a new form."""
self._test_2001_add_form()
def _test_2002_edit_form(self):
"""Test edit a form."""
# TODO
@print_info
def test_2002_edit_form(self):
"""Test edit a form."""
self._test_2002_edit_form()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_2002_edit_form_fbv(self):
"""Test edit a form."""
self._test_2002_edit_form()
def _test_2003_delete_form(self):
"""Test delete a form."""
# TODO
@print_info
def test_2003_delete_form(self):
"""Test delete a form."""
self._test_2003_delete_form()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_2003_delete_form_fbv(self):
"""Test delete a form."""
self._test_2003_delete_form()
def _test_2004_submit_form(self, wait=WAIT_FOR):
"""Test submit form."""
# Clean up database
db_clean_up()
# Add form elements
self._test_add_form_elements(create_form=True)
self._test_add_form_handlers(create_form=False)
# self._sleep(wait)
# Getting a form object
form = self._get_form()
# Getting the form URL
url = reverse("fobi.view_form_entry", args=[form.slug])
self.driver.get("{0}{1}".format(self._get_live_server_url(), url))
# Wait until the edit widget form opens
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH, '//body[contains(@class, "theme-bootstrap3")]'
)
)
for field_name, field_value in TEST_FORM_FIELD_DATA.items():
field_input = self.driver.find_element(By.NAME, field_name)
field_input.send_keys(field_value)
self.take_screenshot("filled_form_page")
self._sleep(2)
footer = self.driver.find_element(By.XPATH, "//footer")
footer.click()
self._scroll_page_bottom()
# Wait until button is there
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH, '//button[@type="submit"]'
)
)
# Click add widget button
submit_button = self.driver.find_element(
By.XPATH, '//button[@type="submit"]'
)
self._sleep(2)
self.take_screenshot("filled_form_page_scroll")
submit_button.click()
try:
submit_button.click()
except Exception as err:
pass
# Wait until the submit success page opens a clear success message.
# TODO: This is really weird. Somehow it takes longer time to render
# the class based views than the correspondent function based views.
# find out why and fix. As temporary workaround, we're waiting
# twice as long as the normal timeout.
self.take_screenshot("submit_success_page")
WebDriverWait(self.driver, timeout=TIMEOUT).until(
lambda driver: driver.find_element(
By.XPATH,
"""//div[contains(text(), 'Form {0} was submitted """
"""successfully.') """
"""and contains(@class, "alert-info")]""".format(
constants.TEST_FORM_NAME
),
)
)
self._sleep(wait)
# class FormElementSpecificFobiBrowserBuldDynamicFormsTest(
# BaseFobiBrowserBuldDynamicFormsTest):
# """Form element specific."""
@print_info
@override_settings(
EMAIL_BACKEND="django.core.mail.backends.locmem.EmailBackend"
)
def test_2004_submit_form(self, wait=WAIT_FOR):
"""Test submit form."""
self._test_2004_submit_form()
@print_info
@override_settings(
EMAIL_BACKEND="django.core.mail.backends.locmem.EmailBackend",
ROOT_URLCONF="urls.function_based",
)
def test_2004_submit_form_fbv(self, wait=WAIT_FOR):
"""Test submit form."""
self._test_2004_submit_form()
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# ++++++++++++++++++++ Form element specific ++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
def _test_3001_add_form_elements(self, wait=WAIT_FOR):
"""Test adding form elements."""
db_clean_up() # Clean up database
self._test_add_form_elements(create_form=True)
self._sleep(wait)
@print_info
def test_3001_add_form_elements(self, wait=WAIT_FOR):
"""Test adding form elements."""
self._test_3001_add_form_elements()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_3001_add_form_elements_fbv(self, wait=WAIT_FOR):
"""Test adding form elements."""
self._test_3001_add_form_elements()
def _test_3002_remove_form_elements(self):
"""Test remove form element."""
# Clean up database
db_clean_up()
self._test_add_form_elements(create_form=True)
self._test_remove_form_elements()
@print_info
def test_3002_remove_form_elements(self):
"""Test remove form element."""
self._test_3002_remove_form_elements()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_3002_remove_form_elements_fbv(self):
"""Test remove form element."""
self._test_3002_remove_form_elements()
def _test_3003_edit_form_elements(self):
"""Test edit form element."""
db_clean_up() # Clean up database
@print_info
def test_3003_edit_form_elements(self):
"""Test edit form element."""
self._test_3003_edit_form_elements()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_3003_edit_form_elements_fbv(self):
"""Test edit form element."""
self._test_3003_edit_form_elements()
# class FormHandlerSpecificFobiBrowserBuldDynamicFormsTest(
# BaseFobiBrowserBuldDynamicFormsTest):
# """Form handler specific."""
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# ++++++++++++++++++++ Form handler specific ++++++++++++++++++++
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
def _test_4001_add_form_handlers(self, wait=WAIT_FOR):
"""Test of adding a single form handler.
At this point, if form isn't created, it should be.
"""
db_clean_up() # Clean up database
self._test_add_form_handlers(create_form=True)
self._sleep(wait)
@print_info
def test_4001_add_form_handlers(self, wait=WAIT_FOR):
"""Test of adding a single form handler.
At this point, if form isn't created, it should be.
"""
self._test_4001_add_form_handlers()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_4001_add_form_handlers_fbv(self, wait=WAIT_FOR):
"""Test of adding a single form handler.
At this point, if form isn't created, it should be.
"""
self._test_4001_add_form_handlers()
def _test_4002_remove_form_handlers(self):
"""Test remove form handler."""
db_clean_up() # Clean up database
self._test_add_form_handlers(create_form=True)
self._test_remove_form_handlers()
@print_info
def test_4002_remove_form_handlers(self):
"""Test remove form handler."""
self._test_4002_remove_form_handlers()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_4002_remove_form_handlers_fbv(self):
"""Test remove form handler."""
self._test_4002_remove_form_handlers()
def _test_4003_edit_form_handlers(self):
"""Test edit form handler."""
# TODO
@print_info
def test_4003_edit_form_handlers(self):
"""Test edit form handler."""
self._test_4003_edit_form_handlers()
@override_settings(ROOT_URLCONF="urls.function_based")
@print_info
def test_4003_edit_form_handlers_fbv(self):
"""Test edit form handler."""
self._test_4003_edit_form_handlers()