418 lines
15 KiB
Python
418 lines
15 KiB
Python
from __future__ import unicode_literals
|
|
|
|
import os
|
|
import re
|
|
import warnings
|
|
|
|
from django import http
|
|
from django.conf import settings
|
|
from django.contrib.formtools import preview, utils
|
|
from django.contrib.formtools.wizard import FormWizard
|
|
from django.test import TestCase
|
|
from django.test.utils import override_settings
|
|
from django.utils import unittest
|
|
|
|
from django.contrib.formtools.tests.wizard import *
|
|
from django.contrib.formtools.tests.forms import *
|
|
|
|
success_string = "Done was called!"
|
|
|
|
class TestFormPreview(preview.FormPreview):
|
|
def get_context(self, request, form):
|
|
context = super(TestFormPreview, self).get_context(request, form)
|
|
context.update({'custom_context': True})
|
|
return context
|
|
|
|
def get_initial(self, request):
|
|
return {'field1': 'Works!'}
|
|
|
|
def done(self, request, cleaned_data):
|
|
return http.HttpResponse(success_string)
|
|
|
|
@override_settings(
|
|
TEMPLATE_DIRS=(
|
|
os.path.join(os.path.dirname(__file__), 'templates'),
|
|
),
|
|
)
|
|
class PreviewTests(TestCase):
|
|
urls = 'django.contrib.formtools.tests.urls'
|
|
|
|
def setUp(self):
|
|
super(PreviewTests, self).setUp()
|
|
# Create a FormPreview instance to share between tests
|
|
self.preview = preview.FormPreview(TestForm)
|
|
input_template = '<input type="hidden" name="%s" value="%s" />'
|
|
self.input = input_template % (self.preview.unused_name('stage'), "%d")
|
|
self.test_data = {'field1': 'foo', 'field1_': 'asdf'}
|
|
|
|
def test_unused_name(self):
|
|
"""
|
|
Verifies name mangling to get uniue field name.
|
|
"""
|
|
self.assertEqual(self.preview.unused_name('field1'), 'field1__')
|
|
|
|
def test_form_get(self):
|
|
"""
|
|
Test contrib.formtools.preview form retrieval.
|
|
|
|
Use the client library to see if we can sucessfully retrieve
|
|
the form (mostly testing the setup ROOT_URLCONF
|
|
process). Verify that an additional hidden input field
|
|
is created to manage the stage.
|
|
|
|
"""
|
|
response = self.client.get('/preview/')
|
|
stage = self.input % 1
|
|
self.assertContains(response, stage, 1)
|
|
self.assertEqual(response.context['custom_context'], True)
|
|
self.assertEqual(response.context['form'].initial, {'field1': 'Works!'})
|
|
|
|
def test_form_preview(self):
|
|
"""
|
|
Test contrib.formtools.preview form preview rendering.
|
|
|
|
Use the client library to POST to the form to see if a preview
|
|
is returned. If we do get a form back check that the hidden
|
|
value is correctly managing the state of the form.
|
|
|
|
"""
|
|
# Pass strings for form submittal and add stage variable to
|
|
# show we previously saw first stage of the form.
|
|
self.test_data.update({'stage': 1})
|
|
response = self.client.post('/preview/', self.test_data)
|
|
# Check to confirm stage is set to 2 in output form.
|
|
stage = self.input % 2
|
|
self.assertContains(response, stage, 1)
|
|
|
|
def test_form_submit(self):
|
|
"""
|
|
Test contrib.formtools.preview form submittal.
|
|
|
|
Use the client library to POST to the form with stage set to 3
|
|
to see if our forms done() method is called. Check first
|
|
without the security hash, verify failure, retry with security
|
|
hash and verify sucess.
|
|
|
|
"""
|
|
# Pass strings for form submittal and add stage variable to
|
|
# show we previously saw first stage of the form.
|
|
self.test_data.update({'stage':2})
|
|
response = self.client.post('/preview/', self.test_data)
|
|
self.assertNotEqual(response.content, success_string)
|
|
hash = self.preview.security_hash(None, TestForm(self.test_data))
|
|
self.test_data.update({'hash': hash})
|
|
response = self.client.post('/preview/', self.test_data)
|
|
self.assertEqual(response.content, success_string)
|
|
|
|
def test_bool_submit(self):
|
|
"""
|
|
Test contrib.formtools.preview form submittal when form contains:
|
|
BooleanField(required=False)
|
|
|
|
Ticket: #6209 - When an unchecked BooleanField is previewed, the preview
|
|
form's hash would be computed with no value for ``bool1``. However, when
|
|
the preview form is rendered, the unchecked hidden BooleanField would be
|
|
rendered with the string value 'False'. So when the preview form is
|
|
resubmitted, the hash would be computed with the value 'False' for
|
|
``bool1``. We need to make sure the hashes are the same in both cases.
|
|
|
|
"""
|
|
self.test_data.update({'stage':2})
|
|
hash = self.preview.security_hash(None, TestForm(self.test_data))
|
|
self.test_data.update({'hash': hash, 'bool1': 'False'})
|
|
with warnings.catch_warnings(record=True):
|
|
response = self.client.post('/preview/', self.test_data)
|
|
self.assertEqual(response.content, success_string)
|
|
|
|
def test_form_submit_good_hash(self):
|
|
"""
|
|
Test contrib.formtools.preview form submittal, using a correct
|
|
hash
|
|
"""
|
|
# Pass strings for form submittal and add stage variable to
|
|
# show we previously saw first stage of the form.
|
|
self.test_data.update({'stage':2})
|
|
response = self.client.post('/preview/', self.test_data)
|
|
self.assertNotEqual(response.content, success_string)
|
|
hash = utils.form_hmac(TestForm(self.test_data))
|
|
self.test_data.update({'hash': hash})
|
|
response = self.client.post('/preview/', self.test_data)
|
|
self.assertEqual(response.content, success_string)
|
|
|
|
|
|
def test_form_submit_bad_hash(self):
|
|
"""
|
|
Test contrib.formtools.preview form submittal does not proceed
|
|
if the hash is incorrect.
|
|
"""
|
|
# Pass strings for form submittal and add stage variable to
|
|
# show we previously saw first stage of the form.
|
|
self.test_data.update({'stage':2})
|
|
response = self.client.post('/preview/', self.test_data)
|
|
self.assertEqual(response.status_code, 200)
|
|
self.assertNotEqual(response.content, success_string)
|
|
hash = utils.form_hmac(TestForm(self.test_data)) + "bad"
|
|
self.test_data.update({'hash': hash})
|
|
response = self.client.post('/previewpreview/', self.test_data)
|
|
self.assertNotEqual(response.content, success_string)
|
|
|
|
|
|
class FormHmacTests(unittest.TestCase):
|
|
|
|
def test_textfield_hash(self):
|
|
"""
|
|
Regression test for #10034: the hash generation function should ignore
|
|
leading/trailing whitespace so as to be friendly to broken browsers that
|
|
submit it (usually in textareas).
|
|
"""
|
|
f1 = HashTestForm({'name': 'joe', 'bio': 'Nothing notable.'})
|
|
f2 = HashTestForm({'name': ' joe', 'bio': 'Nothing notable. '})
|
|
hash1 = utils.form_hmac(f1)
|
|
hash2 = utils.form_hmac(f2)
|
|
self.assertEqual(hash1, hash2)
|
|
|
|
def test_empty_permitted(self):
|
|
"""
|
|
Regression test for #10643: the security hash should allow forms with
|
|
empty_permitted = True, or forms where data has not changed.
|
|
"""
|
|
f1 = HashTestBlankForm({})
|
|
f2 = HashTestForm({}, empty_permitted=True)
|
|
hash1 = utils.form_hmac(f1)
|
|
hash2 = utils.form_hmac(f2)
|
|
self.assertEqual(hash1, hash2)
|
|
|
|
|
|
#
|
|
# FormWizard tests
|
|
#
|
|
|
|
class TestWizardClass(FormWizard):
|
|
|
|
def get_template(self, step):
|
|
return 'forms/wizard.html'
|
|
|
|
def done(self, request, cleaned_data):
|
|
return http.HttpResponse(success_string)
|
|
|
|
|
|
class DummyRequest(http.HttpRequest):
|
|
|
|
def __init__(self, POST=None):
|
|
super(DummyRequest, self).__init__()
|
|
self.method = POST and "POST" or "GET"
|
|
if POST is not None:
|
|
self.POST.update(POST)
|
|
self._dont_enforce_csrf_checks = True
|
|
|
|
|
|
@override_settings(
|
|
SECRET_KEY="123",
|
|
TEMPLATE_DIRS=(
|
|
os.path.join(os.path.dirname(__file__), 'templates'),
|
|
),
|
|
)
|
|
class WizardTests(TestCase):
|
|
urls = 'django.contrib.formtools.tests.urls'
|
|
input_re = re.compile('name="([^"]+)" value="([^"]+)"')
|
|
wizard_step_data = (
|
|
{
|
|
'0-name': 'Pony',
|
|
'0-thirsty': '2',
|
|
},
|
|
{
|
|
'1-address1': '123 Main St',
|
|
'1-address2': 'Djangoland',
|
|
},
|
|
{
|
|
'2-random_crap': 'blah blah',
|
|
}
|
|
)
|
|
|
|
def setUp(self):
|
|
super(WizardTests, self).setUp()
|
|
self.save_warnings_state()
|
|
warnings.filterwarnings('ignore', category=DeprecationWarning,
|
|
module='django.contrib.formtools.wizard')
|
|
|
|
def tearDown(self):
|
|
super(WizardTests, self).tearDown()
|
|
self.restore_warnings_state()
|
|
|
|
def test_step_starts_at_zero(self):
|
|
"""
|
|
step should be zero for the first form
|
|
"""
|
|
response = self.client.get('/wizard1/')
|
|
self.assertEqual(0, response.context['step0'])
|
|
|
|
def test_step_increments(self):
|
|
"""
|
|
step should be incremented when we go to the next page
|
|
"""
|
|
response = self.client.post('/wizard1/', {"0-field":"test", "wizard_step":"0"})
|
|
self.assertEqual(1, response.context['step0'])
|
|
|
|
def test_bad_hash(self):
|
|
"""
|
|
Form should not advance if the hash is missing or bad
|
|
"""
|
|
response = self.client.post('/wizard1/',
|
|
{"0-field":"test",
|
|
"1-field":"test2",
|
|
"wizard_step": "1"})
|
|
self.assertEqual(0, response.context['step0'])
|
|
|
|
def test_good_hash(self):
|
|
"""
|
|
Form should advance if the hash is present and good, as calculated using
|
|
current method.
|
|
"""
|
|
data = {"0-field": "test",
|
|
"1-field": "test2",
|
|
"hash_0": "cd13b1db3e8f55174bc5745a1b1a53408d4fd1ca",
|
|
"wizard_step": "1"}
|
|
response = self.client.post('/wizard1/', data)
|
|
self.assertEqual(2, response.context['step0'])
|
|
|
|
def test_11726(self):
|
|
"""
|
|
Regression test for ticket #11726.
|
|
Wizard should not raise Http404 when steps are added dynamically.
|
|
"""
|
|
reached = [False]
|
|
that = self
|
|
|
|
class WizardWithProcessStep(TestWizardClass):
|
|
def process_step(self, request, form, step):
|
|
if step == 0:
|
|
if self.num_steps() < 2:
|
|
self.form_list.append(WizardPageTwoForm)
|
|
if step == 1:
|
|
that.assertTrue(isinstance(form, WizardPageTwoForm))
|
|
reached[0] = True
|
|
|
|
wizard = WizardWithProcessStep([WizardPageOneForm])
|
|
data = {"0-field": "test",
|
|
"1-field": "test2",
|
|
"hash_0": "cd13b1db3e8f55174bc5745a1b1a53408d4fd1ca",
|
|
"wizard_step": "1"}
|
|
wizard(DummyRequest(POST=data))
|
|
self.assertTrue(reached[0])
|
|
|
|
data = {"0-field": "test",
|
|
"1-field": "test2",
|
|
"hash_0": "cd13b1db3e8f55174bc5745a1b1a53408d4fd1ca",
|
|
"hash_1": "1e6f6315da42e62f33a30640ec7e007ad3fbf1a1",
|
|
"wizard_step": "2"}
|
|
self.assertRaises(http.Http404, wizard, DummyRequest(POST=data))
|
|
|
|
def test_14498(self):
|
|
"""
|
|
Regression test for ticket #14498. All previous steps' forms should be
|
|
validated.
|
|
"""
|
|
reached = [False]
|
|
that = self
|
|
|
|
class WizardWithProcessStep(TestWizardClass):
|
|
def process_step(self, request, form, step):
|
|
that.assertTrue(hasattr(form, 'cleaned_data'))
|
|
reached[0] = True
|
|
|
|
wizard = WizardWithProcessStep([WizardPageOneForm,
|
|
WizardPageTwoForm,
|
|
WizardPageThreeForm])
|
|
data = {"0-field": "test",
|
|
"1-field": "test2",
|
|
"hash_0": "cd13b1db3e8f55174bc5745a1b1a53408d4fd1ca",
|
|
"wizard_step": "1"}
|
|
wizard(DummyRequest(POST=data))
|
|
self.assertTrue(reached[0])
|
|
|
|
def test_14576(self):
|
|
"""
|
|
Regression test for ticket #14576.
|
|
|
|
The form of the last step is not passed to the done method.
|
|
"""
|
|
reached = [False]
|
|
that = self
|
|
|
|
class Wizard(TestWizardClass):
|
|
def done(self, request, form_list):
|
|
reached[0] = True
|
|
that.assertTrue(len(form_list) == 2)
|
|
|
|
wizard = Wizard([WizardPageOneForm,
|
|
WizardPageTwoForm])
|
|
|
|
data = {"0-field": "test",
|
|
"1-field": "test2",
|
|
"hash_0": "cd13b1db3e8f55174bc5745a1b1a53408d4fd1ca",
|
|
"wizard_step": "1"}
|
|
wizard(DummyRequest(POST=data))
|
|
self.assertTrue(reached[0])
|
|
|
|
def test_15075(self):
|
|
"""
|
|
Regression test for ticket #15075. Allow modifying wizard's form_list
|
|
in process_step.
|
|
"""
|
|
reached = [False]
|
|
that = self
|
|
|
|
class WizardWithProcessStep(TestWizardClass):
|
|
def process_step(self, request, form, step):
|
|
if step == 0:
|
|
self.form_list[1] = WizardPageTwoAlternativeForm
|
|
if step == 1:
|
|
that.assertTrue(isinstance(form, WizardPageTwoAlternativeForm))
|
|
reached[0] = True
|
|
|
|
wizard = WizardWithProcessStep([WizardPageOneForm,
|
|
WizardPageTwoForm,
|
|
WizardPageThreeForm])
|
|
data = {"0-field": "test",
|
|
"1-field": "test2",
|
|
"hash_0": "cd13b1db3e8f55174bc5745a1b1a53408d4fd1ca",
|
|
"wizard_step": "1"}
|
|
wizard(DummyRequest(POST=data))
|
|
self.assertTrue(reached[0])
|
|
|
|
def grab_field_data(self, response):
|
|
"""
|
|
Pull the appropriate field data from the context to pass to the next wizard step
|
|
"""
|
|
previous_fields = response.context['previous_fields']
|
|
fields = {'wizard_step': response.context['step0']}
|
|
|
|
def grab(m):
|
|
fields[m.group(1)] = m.group(2)
|
|
return ''
|
|
|
|
self.input_re.sub(grab, previous_fields)
|
|
return fields
|
|
|
|
def check_wizard_step(self, response, step_no):
|
|
"""
|
|
Helper function to test each step of the wizard
|
|
- Make sure the call succeeded
|
|
- Make sure response is the proper step number
|
|
- return the result from the post for the next step
|
|
"""
|
|
step_count = len(self.wizard_step_data)
|
|
|
|
self.assertEqual(response.status_code, 200)
|
|
self.assertContains(response, 'Step %d of %d' % (step_no, step_count))
|
|
|
|
data = self.grab_field_data(response)
|
|
data.update(self.wizard_step_data[step_no - 1])
|
|
|
|
return self.client.post('/wizard2/', data)
|
|
|
|
def test_9473(self):
|
|
response = self.client.get('/wizard2/')
|
|
for step_no in range(1, len(self.wizard_step_data) + 1):
|
|
response = self.check_wizard_step(response, step_no)
|