-
Notifications
You must be signed in to change notification settings - Fork 68
/
tutorial04.rst
637 lines (432 loc) · 21.1 KB
/
tutorial04.rst
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
Welcome to part 4 of the tutorial! In this part at how we can let
users vote on our poll, in other words, **web forms!**. Hooray.
Let's start by extending our FT, to show Herbert voting on a poll:
.. sourcecode:: python
# Now, Herbert the regular user goes to the homepage of the site. He
# sees a list of polls.
self.browser.get(ROOT)
heading = self.browser.find_element_by_tag_name('h1')
self.assertEquals(heading.text, 'Polls')
# He clicks on the link to the first Poll, which is called
# 'How awesome is test-driven development?'
first_poll_title = 'How awesome is Test-Driven Development?'
self.browser.find_element_by_link_text(first_poll_title).click()
# He is taken to a poll 'results' page, which says
# "no-one has voted on this poll yet"
main_heading = self.browser.find_element_by_tag_name('h1')
self.assertEquals(main_heading.text, 'Poll Results')
sub_heading = self.browser.find_element_by_tag_name('h2')
self.assertEquals(sub_heading.text, first_poll_title)
body = self.browser.find_element_by_tag_name('body')
self.assertIn('No-one has voted on this poll yet', body.text)
# He also sees a form, which offers him several choices.
# There are three options with radio buttons
choices = self.browser.find_elements_by_css_selector(
"input[type='radio']"
)
self.assertEquals(len(choice_inputs), 3)
# The buttons have labels to explain them
choice_labels = choice_inputs = self.browser.find_elements_by_tag_name('label')
choices_text = [c.text for c in choice_labels]
self.assertEquals(choices_text, [
'Very awesome',
'Quite awesome',
'Moderately awesome',
])
# He decided to select "very awesome", which is answer #1
chosen = self.browser.find_element_by_css_selector(
"input[value='1']"
)
chosen.click()
# Herbert clicks 'submit'
self.browser.find_element_by_css_selector(
"input[type='submit']"
).click()
# The page refreshes, and he sees that his choice
# has updated the results. they now say
# "100 %: very awesome".
# The page also says "1 votes"
# Satisfied, he goes back to sleep
The functional tests are still telling us that we need to fix our polls view
though::
======================================================================
FAIL: test_voting_on_a_new_poll (test_polls.TestPolls)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/harry/workspace/tddjango_site/source/mysite/fts/test_polls.py", line 67, in test_voting_on_a_new_poll
self.assertEquals(heading.text, 'Poll Results')
AssertionError: u'TypeError at /poll/1/' != 'Poll Results'
----------------------------------------------------------------------
Ran 2 tests in 25.927s
Let's work on the unit tests for the ``poll`` view then:
.. sourcecode:: python
class TestSinglePollView(TestCase):
def test_page_shows_poll_title_and_no_votes_message(self):
# set up two polls, to check the right one is displayed
poll1 = Poll(question='6 times 7', pub_date='2001-01-01')
poll1.save()
poll2 = Poll(question='life, the universe and everything', pub_date='2001-01-01')
poll2.save()
client = Client()
response = client.get('/poll/%d/' % (poll2.id, ))
# check we've passed the right poll into the context
self.assertEquals(response.context['poll'], poll2)
# check the poll's question appears on the page
self.assertIn(poll2.question, response.content)
# check our 'no votes yet' message appears
self.assertIn('No-one has voted on this poll yet', response.content)
# check we've passed in a form of the right type
self.assertTrue(isinstance(response.context['form'], PollVoteForm))
Running the tests gives::
TypeError: poll() takes no arguments (2 given)
(I'm going to be shortening the test outputs from now on. You're a grown-up
now, you can handle it!)
Let's make our view take two arguments:
.. sourcecode:: python
def poll(request, poll_id):
pass
Now we get::
ValueError: The view mysite.polls.views.poll didn't return an HttpResponse object.
Again, a minimal fix:
.. sourcecode:: python
def poll(request, poll_id):
return HttpResponse()
Now we get this error::
self.assertEquals(response.templates[0].name, 'poll.html')
IndexError: list index out of range
A slightly unhelpful error, but essentially it's telling us that the
view didn't use a template. Let's try fixing that - but deliberately
using the wrong template (just to check we are testing it)
.. sourcecode:: python
def poll(request, poll_id):
return render(request, 'polls.html')
Good, looks like we are testiing it properly::
AssertionError: 'polls.html' != 'poll.html'
And changing it to ``poll.html`` gives us::
TemplateDoesNotExist: poll.html
Fine and dandy, let's make one::
touch polls/templates/poll.html
Now the tests want us to pass a `poll` variable in the template's context::
KeyError: 'poll'
So let's do that, again, the minimum possible change to satisfy the tests:
.. sourcecode:: python
def poll(request, poll_id):
return render(request, 'polls.html', {'poll': None})
And the tests get a little further on::
AssertionError: None != <Poll: life, the universe and everything>
And they even tell us what to do next - pass in the right `Poll` object:
.. sourcecode:: python
def poll(request, poll_id):
poll = Poll.objects.get(pk=poll_id)
return render(request, 'poll.html', {'poll': poll})
This is the first time we've used the Django API to fetch a single database
object, and ``objects.get`` is the helper function for this - it raises an
error if it can't find the object, or if it finds more than one. The special
keyword argument ``pk`` stands for `primary key`. In this case, Django is
using the default for primary keys, which is an automatically genereated
integer ``id`` column.
That raises the question of what to do if a user types in a url for a poll
that doesn't exist - ``/poll/0/`` for example. We'll come back to this in
a later tutorial.
In the meantime, what do the tests say::
self.assertIn(poll2.question, response.content)
AssertionError: 'life, the universe and everything' not found in ''
We need to get our template to include the poll's question. Let's make it
into a page heading:
.. sourcecode:: html+django
<html>
<body>
<h2>{{poll.question}}</h2>
</body>
</html>
Now the tests want our 'no polls yet' message::
AssertionError: 'No-one has voted on this poll yet' not found in '<html>\n <body>\n <h2>life, the universe and everything</h2>\n </body>\n</html>\n'
So let's include that:
.. sourcecode:: html+django
<html>
<body>
<h2>{{poll.question}}</h2>
<p>No-one has voted on this poll yet</p>
</body>
</html>
And that's enough to make the unit tests happy::
----------------------------------------------------------------------
Ran 7 tests in 0.013s
OK
Mmmh, `OK`. Let's see what the FTs think?::
NoSuchElementException: Message: u'Unable to locate element: {"method":"tag name","selector":"h1"}'
Ah, we forgot to include a general heading for the page
.. sourcecode:: python
main_heading = self.browser.find_element_by_tag_name('h1')
self.assertEquals(main_heading.text, 'Poll Results')
sub_heading = self.browser.find_element_by_tag_name('h2')
self.assertEquals(sub_heading.text, first_poll_title)
So let's add an ``h1`` with "Poll Results" in it:
.. sourcecode:: html+django
<html>
<body>
<h1>Poll Results</h1>
<h2>{{poll.question}}</h2>
<p>No-one has voted on this poll yet</p>
</body>
</html>
Now what?::
======================================================================
FAIL: test_voting_on_a_new_poll (test_polls.TestPolls)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/harry/workspace/tddjango_site/source/mysite/fts/test_polls.py", line 82, in test_voting_on_a_new_poll
'Moderately awesome',
AssertionError: Lists differ: [] != ['Very awesome', 'Quite awesom...
Second list contains 3 additional elements.
First extra element 0:
Very awesome
- []
+ ['Very awesome', 'Quite awesome', 'Moderately awesome']
----------------------------------------------------------------------
Ah, we need to add the poll Choices as a series of radio inputs. Now the official Django
tutorial shows you how to hard-code them in HTML, but Django can do even better than that:
https://docs.djangoproject.com/en/1.3/intro/tutorial04/
Django's forms system will generate radio buttons for us, if we can just give it the right
incantations. Let's create a new test in ``tests.py``:
.. sourcecode:: python
from polls.forms import PollVoteForm
class TestPollsVoteForm(TestCase):
def test_form_renders_poll_choices_as_radio_inputs(self):
# set up a poll with a couple of choices
poll1 = Poll(question='6 times 7', pub_date='2001-01-01')
poll1.save()
choice1 = Choice(poll=poll1, choice='42', votes=0)
choice1.save()
choice2 = Choice(poll=poll1, choice='The Ultimate Answer', votes=0)
choice2.save()
# set up another poll to make sure we only see the right choices
poll2 = Poll(question='time', pub_date='2001-01-01')
poll2.save()
choice3 = Choice(poll=poll2, choice='PM', votes=0)
choice3.save()
# build a voting form for poll1
form = PollVoteForm(poll=poll1)
# check it has a single field called 'vote', which has right choices:
self.assertEquals(form.fields.keys(), ['vote'])
# choices are tuples in the format (choice_number, choice_text):
self.assertEquals(form.fields['vote'].choices, [
(choice1.id, choice1.choice),
(choice2.id, choice2.choice),
])
# check it uses radio inputs to render
self.assertIn('input type="radio"', form.as_p())
You might prefer to put the import at the top of the file. And, for it to work, we
may as well create something minimal for it to import! Create a file called
``polls/forms.py``.
.. sourcecode:: python
class PollVoteForm(object):
pass
And let's start another test/code cycle, woo -::
./manage.py test polls
[...]
form = PollVoteForm(poll=poll)
TypeError: object.__new__() takes no parameters
We override __init__.py to change the constructor:
.. sourcecode:: python
class PollVoteForm(object):
def __init__(self, poll):
pass
::
self.assertEquals(form.fields.keys(), ['vote'])
AttributeError: 'PollVoteForm' object has no attribute 'fields'
to give the form a 'fields' attribute, we can make it inherit from
a real Django form class, and call its parent constructor:
.. sourcecode:: python
from django import forms
class PollVoteForm(forms.Form):
def __init__(self, poll):
super(self.__class__, self).__init__()
Now we get::
AssertionError: Lists differ: [] != ['vote']
Django form fields are defined a bit like model fields - as inline
class attributes. There are various types of fields, in this case
we want one that has `choices` - a ``ChoiceField``.
You can find out more about form fields here:
https://docs.djangoproject.com/en/1.3/ref/forms/fields/
.. sourcecode:: python
class PollVoteForm(forms.Form):
vote = forms.ChoiceField()
def __init__(self, poll):
super(self.__class__, self).__init__()
Now we get::
AssertionError: Lists differ: [] != [(1, '42'), (2, 'The Ultimate ...
So now let's set the choices from the ``poll`` we passed into the
constructor (you can read up on choices in Django here)
https://docs.djangoproject.com/en/1.3/ref/models/fields/#field-choices
.. sourcecode:: python
def __init__(self, poll):
super(self.__class__, self).__init__()
self.fields['vote'].choices = [(c.id, c.choice) for c in poll.choice_set.all()]
Mmmmmh, list comprehensions...
The final test is to make sure we have radio boxes as the HTML input type.
We're using ``as_p()``, a method provided on all Django forms which renders
the form to HTML for us - we can see exactly what the HTML looks like in the
next test output::
self.assertIn('input type="radio"', form.as_p())
AssertionError: 'input type="radio"' not found in u'<p><label for="id_vote">Vote:</label> <select name="vote" id="id_vote">\n<option value="1">42</option>\n<option value="2">The Ultimate Answer</option>\n</select></p>'
Django has defaulted to using a ``select/option`` input form. We can change
this using a `widget`, in this case a ``RadioSelect``
.. sourcecode:: python
class PollVoteForm(forms.Form):
vote = forms.ChoiceField(widget=forms.RadioSelect())
def __init__(self, poll):
super(self.__class__, self).__init__()
self.fields['vote'].choices = [(c.id, c.choice) for c in poll.choice_set.all()]
And that should get the tests passing! If you're curious to see what the form
HTML actually looks like, why not temporarily put a ``print form.as_p()`` at
the end of the test? Print statements in tests can be very useful for
exploratory programming... You could try ``form.as_table()`` too if you like...
Right, where where we? Let's do a quick check of the functional tests
(incidentally, are you rather bored of watching the FT run through the
admin test each time? I was, so I've built in a second argument to the FT
runner that lets you filter by name of test - just pass in ``polls`` and
it will only run FTs in files whose names contain the world ``polls``.)::
./functional_tests.py polls
[...]
AssertionError: Lists differ: [] != ['Very awesome', 'Quite awesom...
Ah yes, we still haven't actually used the form yet! Let's go back to
our ``TestSinglePollView``, and add some extra code (you can copy and
paste some of it from the form test)
.. sourcecode:: python
def test_page_shows_poll_title_and_no_votes_message(self):
# set up two polls, to check the right one gets used
poll1 = Poll(question='6 times 7', pub_date='2001-01-01')
poll1.save()
choice1 = Choice(poll=poll1, choice='42', votes=0)
choice1.save()
choice2 = Choice(poll=poll1, choice='The Ultimate Answer', votes=0)
choice2.save()
poll2 = Poll(question='time', pub_date='2001-01-01')
poll2.save()
choice3 = Choice(poll=poll2, choice='PM', votes=0)
choice3.save()
choice4 = Choice(poll=poll2, choice="Gardener's", votes=0)
choice4.save()
client = Client()
response = client.get('/poll/%d/' % (poll2.id, ))
# check we use the right template
self.assertEquals(response.templates[0].name, 'poll.html')
# check we've passed the right poll into the context
self.assertEquals(response.context['poll'], poll2)
# check the poll's question appears on the page
self.assertIn(poll2.question, response.content)
# check our 'no votes yet' message appears
self.assertIn('No-one has voted on this poll yet', response.content)
# check we've passed in a form of the right type
self.assertTrue(isinstance(response.context['form'], PollVoteForm))
# and check the check the form is being used in the template,
# by checking for the choice text
self.assertIn(choice3.choice, response.content)
self.assertIn(choice4.choice, response.content)
Now the unit tests give us::
KeyError: 'form'
So back in ``views.py``:
.. sourcecode:: python
def poll(request, poll_id):
poll = Poll.objects.get(pk=poll_id)
return render(request, 'poll.html', {'poll': poll, 'form': None})
Now::
self.assertTrue(isinstance(response.context['form'], PollVoteForm))
AssertionError: False is not true
So:
.. sourcecode:: python
def poll(request, poll_id):
poll = Poll.objects.get(pk=poll_id)
form = PollVoteForm(poll=poll)
return render(request, 'poll.html', {'poll': poll, 'form': form})
And::
self.assertIn(choice3.choice, response.content)
AssertionError: 'PM' not found in '<html>\n <body>\n <h1>Poll Results</h1>\n \n <h2>time</h2>\n\n <p>No-one has voted on this poll yet</p>\n \n </body>\n</html>\n'
So, in ``polls/templates/poll.html``:
.. sourcecode:: html+django
<html>
<body>
<h1>Poll Results</h1>
<h2>{{poll.question}}</h2>
<p>No-one has voted on this poll yet</p>
<h3>Add your vote</h3>
{{form.as_p}}
</body>
</html>
And re-running the tests - oh, a surprise!::
self.assertIn(choice4.choice, response.content)
AssertionError: "Gardener's" not found in '<html>\n <body>\n <h1>Poll Results</h1>\n \n <h2>time</h2>\n\n <p>No-one has voted on this poll yet</p>\n\n <h3>Add your vote</h3>\n <p><label for="id_vote_0">Vote:</label> <ul>\n<li><label for="id_vote_0"><input type="radio" id="id_vote_0" value="3" name="vote" /> PM</label></li>\n<li><label for="id_vote_1"><input type="radio" id="id_vote_1" value="4" name="vote" /> Gardener's</label></li>\n</ul></p>\n\n \n </body>\n</html>\n'
Django has converted an apostrophe (``'``) into an html-compliant ``'`` for
us. I suppose that's my come-uppance for trying to include British in-jokes in
my tutorial. Let's implement a minor hack in our test:
.. sourcecode:: html+django
self.assertIn(choice4.choice, response.content.replace(''', "'"))
And now we have passination::
........
----------------------------------------------------------------------
Ran 8 tests in 0.016s
OK
So let's ask the FTs again!::
======================================================================
FAIL: test_voting_on_a_new_poll (test_polls.TestPolls)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/home/harry/workspace/tddjango_site/source/mysite/fts/test_polls.py", line 84, in test_voting_on_a_new_poll
'Moderately awesome',
AssertionError: Lists differ: [u'Vote:', u'Very awesome', u'... != ['Very awesome', 'Quite awesom...
First differing element 0:
Vote:
Very awesome
First list contains 1 additional elements.
First extra element 3:
Moderately awesome
- [u'Vote:', u'Very awesome', u'Quite awesome', u'Moderately awesome']
? ----------- - -
+ ['Very awesome', 'Quite awesome', 'Moderately awesome']
----------------------------------------------------------------------
Hm, not quite according to the original plan - our form has auto-generated an
extra label which says "Vote:" above the radio buttons - well, since it doesn't
do any harm, for now maybe it's easiest to just change the FT:
.. sourcecode:: html+django
# He also sees a form, which offers him several choices.
# There are three options with radio buttons
choice_inputs = self.browser.find_elements_by_css_selector(
"input[type='radio']"
)
self.assertEquals(len(choice_inputs), 3)
# The buttons have labels to explain them
choice_labels = choice_inputs = self.browser.find_elements_by_tag_name('label')
choices_text = [c.text for c in choice_labels]
self.assertEquals(choices_text, [
'Vote:', # this label is auto-generated for the whole form
'Very awesome',
'Quite awesome',
'Moderately awesome',
])
The FT should now get a little further::
NoSuchElementException: Message: u'Unable to locate element: {"method":"css selector","selector":"input[type=\'submit\']"}'
There's no submit button on our form! When Django generates a form, it only
gives you the inputs for the fields you've defined, so no submit button (and no
``<form>`` tag either for that matter).
Well, a button is easy enough to add, although it may not do much... In the
template:
.. sourcecode:: html+django
<html>
<body>
<h1>Poll Results</h1>
<h2>{{poll.question}}</h2>
<p>No-one has voted on this poll yet</p>
<h3>Add your vote</h3>
{{form.as_p}}
<input type="submit" />
</body>
</html>
And now... our tests pass!::
.
----------------------------------------------------------------------
Ran 1 test in 16.946s
OK
Well, that's only because we haven't finished writing them really. Tune in
next week for when we finish our tests, handle POST requests, and do super-fun
form validation too...