1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
import sys
from importlib import import_module
from django import forms, http
from django.conf import settings
from django.contrib.auth.models import User
from django.db import models
from django.template.response import TemplateResponse
from django.test import TestCase
from formtools.wizard.views import (
CookieWizardView, SessionWizardView, WizardView,
)
class DummyRequest(http.HttpRequest):
def __init__(self, POST=None):
super().__init__()
self.method = "POST" if POST else "GET"
if POST is not None:
self.POST.update(POST)
self.session = {}
self._dont_enforce_csrf_checks = True
def get_request(*args, **kwargs):
request = DummyRequest(*args, **kwargs)
engine = import_module(settings.SESSION_ENGINE)
request.session = engine.SessionStore(None)
return request
class Step1(forms.Form):
name = forms.CharField()
class Step2(forms.Form):
name = forms.CharField()
class Step3(forms.Form):
data = forms.CharField()
class CustomKwargsStep1(Step1):
def __init__(self, test=None, *args, **kwargs):
self.test = test
super().__init__(*args, **kwargs)
class TestModel(models.Model):
name = models.CharField(max_length=100)
class Meta:
app_label = 'formtools'
class TestModelForm(forms.ModelForm):
class Meta:
model = TestModel
fields = '__all__'
TestModelFormSet = forms.models.modelformset_factory(TestModel, form=TestModelForm, extra=2, fields='__all__')
class TestWizard(WizardView):
storage_name = 'formtools.wizard.storage.session.SessionStorage'
def dispatch(self, request, *args, **kwargs):
response = super().dispatch(request, *args, **kwargs)
return response, self
def get_form_kwargs(self, step, *args, **kwargs):
kwargs = super().get_form_kwargs(step, *args, **kwargs)
if step == 'kwargs_test':
kwargs['test'] = True
return kwargs
class TestWizardWithInitAttrs(TestWizard):
form_list = [Step1, Step2]
condition_dict = {'step2': True}
initial_dict = {'start': {'name': 'value1'}}
instance_dict = {'start': User()}
class TestWizardWithTypeCheck(TestWizard):
def done(self, form_list, **kwargs):
assert type(form_list) is list, "`form_list` was {}, should be a list".format(type(form_list))
return http.HttpResponse("All good")
class TestWizardWithCustomGetFormList(TestWizard):
form_list = [Step1]
def get_form_list(self):
return {'start': Step1, 'step2': Step2}
class FormTests(TestCase):
def test_form_init(self):
testform = TestWizard.get_initkwargs([Step1, Step2])
self.assertEqual(testform['form_list'], {'0': Step1, '1': Step2})
testform = TestWizard.get_initkwargs([('start', Step1), ('step2', Step2)])
self.assertEqual(testform['form_list'], {'start': Step1, 'step2': Step2})
testform = TestWizard.get_initkwargs([Step1, Step2, ('finish', Step3)])
self.assertEqual(testform['form_list'], {'0': Step1, '1': Step2, 'finish': Step3})
testform = TestWizardWithInitAttrs.get_initkwargs()
self.assertEqual(testform['form_list'], {'0': Step1, '1': Step2})
def test_first_step(self):
request = get_request()
testform = TestWizard.as_view([Step1, Step2])
response, instance = testform(request)
self.assertEqual(instance.steps.current, '0')
testform = TestWizard.as_view([('start', Step1), ('step2', Step2)])
response, instance = testform(request)
self.assertEqual(instance.steps.current, 'start')
def test_persistence(self):
testform = TestWizard.as_view([('start', Step1), ('step2', Step2)])
request = get_request({'test_wizard-current_step': 'start', 'name': 'data1'})
response, instance = testform(request)
self.assertEqual(instance.steps.current, 'start')
instance.storage.current_step = 'step2'
testform2 = TestWizard.as_view([('start', Step1), ('step2', Step2)])
request.POST = {'test_wizard-current_step': 'step2'}
response, instance = testform2(request)
self.assertEqual(instance.steps.current, 'step2')
def test_form_condition(self):
request = get_request()
testform = TestWizard.as_view(
[('start', Step1), ('step2', Step2), ('step3', Step3)],
condition_dict={'step2': True}
)
response, instance = testform(request)
self.assertEqual(instance.get_next_step(), 'step2')
testform = TestWizard.as_view(
[('start', Step1), ('step2', Step2), ('step3', Step3)],
condition_dict={'step2': False}
)
response, instance = testform(request)
self.assertEqual(instance.get_next_step(), 'step3')
testform = TestWizardWithInitAttrs.as_view(
[('start', Step1), ('step2', Step2), ('step3', Step3)]
)
response, instance = testform(request)
self.assertEqual(instance.get_next_step(), 'step2')
def test_form_condition_avoid_recursion(self):
def subsequent_step_check(wizard):
data = wizard.get_cleaned_data_for_step('step3') or {}
return data.get('foo')
testform = TestWizard.as_view(
[('start', Step1), ('step2', Step2), ('step3', Step3)],
condition_dict={'step3': subsequent_step_check}
)
request = get_request()
old_limit = sys.getrecursionlimit()
sys.setrecursionlimit(80)
try:
response, instance = testform(request)
self.assertEqual(instance.get_next_step(), 'step2')
except RecursionError:
self.fail("RecursionError happened during wizard test.")
finally:
sys.setrecursionlimit(old_limit)
def test_form_condition_unstable(self):
request = get_request()
testform = TestWizard.as_view(
[('start', Step1), ('step2', Step2), ('step3', Step3)],
condition_dict={'step2': True}
)
response, instance = testform(request)
self.assertEqual(instance.get_step_index('step2'), 1)
self.assertEqual(instance.get_next_step('step2'), 'step3')
instance.condition_dict['step2'] = False
self.assertEqual(instance.get_step_index('step2'), None)
self.assertEqual(instance.get_next_step('step2'), 'start')
def test_form_kwargs(self):
request = get_request()
testform = TestWizard.as_view([
('start', Step1),
('kwargs_test', CustomKwargsStep1),
])
response, instance = testform(request)
self.assertEqual(instance.get_form_kwargs('start'), {})
self.assertEqual(instance.get_form_kwargs('kwargs_test'), {'test': True})
self.assertEqual(instance.get_form('kwargs_test').test, True)
def test_form_prefix(self):
request = get_request()
testform = TestWizard.as_view([('start', Step1), ('step2', Step2)])
response, instance = testform(request)
self.assertEqual(instance.get_form_prefix(), 'start')
self.assertEqual(instance.get_form_prefix('another'), 'another')
def test_form_initial(self):
request = get_request()
testform = TestWizard.as_view(
[('start', Step1), ('step2', Step2)],
initial_dict={'start': {'name': 'value1'}}
)
response, instance = testform(request)
self.assertEqual(instance.get_form_initial('start'), {'name': 'value1'})
self.assertEqual(instance.get_form_initial('step2'), {})
testform = TestWizardWithInitAttrs.as_view(
[('start', Step1), ('step2', Step2)]
)
response, instance = testform(request)
self.assertEqual(instance.get_form_initial('start'), {'name': 'value1'})
self.assertEqual(instance.get_form_initial('step2'), {})
def test_form_instance(self):
request = get_request()
the_instance = TestModel()
testform = TestWizard.as_view(
[('start', TestModelForm), ('step2', Step2)],
instance_dict={'start': the_instance}
)
response, instance = testform(request)
self.assertEqual(instance.get_form_instance('start'), the_instance)
self.assertIsNone(instance.get_form_instance('non_exist_instance'))
testform = TestWizardWithInitAttrs.as_view([('start', TestModelForm), ('step2', Step2)])
response, instance = testform(request)
self.assertEqual(
instance.get_form_instance('start'),
TestWizardWithInitAttrs.instance_dict['start']
)
def test_formset_instance(self):
request = get_request()
the_instance1, created = TestModel.objects.get_or_create(name='test object 1')
the_instance2, created = TestModel.objects.get_or_create(name='test object 2')
testform = TestWizard.as_view(
[('start', TestModelFormSet), ('step2', Step2)],
instance_dict={'start': TestModel.objects.filter(name='test object 1')}
)
response, instance = testform(request)
self.assertEqual(list(instance.get_form_instance('start')), [the_instance1])
self.assertEqual(instance.get_form_instance('non_exist_instance'), None)
self.assertEqual(instance.get_form().initial_form_count(), 1)
def test_done(self):
request = get_request()
testform = TestWizard.as_view([('start', Step1), ('step2', Step2)])
response, instance = testform(request)
self.assertRaises(NotImplementedError, instance.done, None)
def test_goto_step_kwargs(self):
"""Any extra kwarg given to render_goto_step is added to response context."""
request = get_request()
testform = TestWizard.as_view([('start', Step1), ('step2', Step2)])
_, instance = testform(request)
response = instance.render_goto_step('start', context_var='Foo')
self.assertIn('context_var', response.context_data.keys())
def test_revalidation(self):
request = get_request()
testform = TestWizard.as_view([('start', Step1), ('step2', Step2)])
response, instance = testform(request)
instance.render_done(None)
self.assertEqual(instance.storage.current_step, 'start')
def test_form_list_type(self):
request = get_request({'test_wizard_with_type_check-current_step': 'start', 'start-name': 'data1'})
testform = TestWizardWithTypeCheck.as_view([('start', Step1)])
response, instance = testform(request)
self.assertEqual(response.status_code, 200)
def test_get_form_list_default(self):
request = get_request()
testform = TestWizard.as_view([('start', Step1)])
response, instance = testform(request)
form_list = instance.get_form_list()
self.assertEqual(form_list, {'start': Step1})
with self.assertRaises(KeyError):
instance.get_form('step2')
def test_get_form_list_custom(self):
request = get_request()
testform = TestWizardWithCustomGetFormList.as_view([('start', Step1)])
response, instance = testform(request)
form_list = instance.get_form_list()
self.assertEqual(form_list, {'start': Step1, 'step2': Step2})
self.assertIsInstance(instance.get_form('step2'), Step2)
class SessionFormTests(TestCase):
def test_init(self):
request = get_request()
testform = SessionWizardView.as_view([('start', Step1)])
self.assertIsInstance(testform(request), TemplateResponse)
class CookieFormTests(TestCase):
def test_init(self):
request = get_request()
testform = CookieWizardView.as_view([('start', Step1)])
self.assertIsInstance(testform(request), TemplateResponse)
|
