Commit | Line | Data |
d442cc9f |
1 | =head1 NAME |
2 | |
3ab6187c |
3 | Catalyst::Manual::Tutorial::08_Testing - Catalyst Tutorial - Chapter 8: Testing |
d442cc9f |
4 | |
5 | |
6 | =head1 OVERVIEW |
7 | |
4b4d3884 |
8 | This is B<Chapter 8 of 10> for the Catalyst tutorial. |
d442cc9f |
9 | |
10 | L<Tutorial Overview|Catalyst::Manual::Tutorial> |
11 | |
12 | =over 4 |
13 | |
14 | =item 1 |
15 | |
3ab6187c |
16 | L<Introduction|Catalyst::Manual::Tutorial::01_Intro> |
d442cc9f |
17 | |
18 | =item 2 |
19 | |
3ab6187c |
20 | L<Catalyst Basics|Catalyst::Manual::Tutorial::02_CatalystBasics> |
d442cc9f |
21 | |
22 | =item 3 |
23 | |
3ab6187c |
24 | L<More Catalyst Basics|Catalyst::Manual::Tutorial::03_MoreCatalystBasics> |
d442cc9f |
25 | |
26 | =item 4 |
27 | |
3ab6187c |
28 | L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD> |
d442cc9f |
29 | |
30 | =item 5 |
31 | |
3ab6187c |
32 | L<Authentication|Catalyst::Manual::Tutorial::05_Authentication> |
d442cc9f |
33 | |
34 | =item 6 |
35 | |
3ab6187c |
36 | L<Authorization|Catalyst::Manual::Tutorial::06_Authorization> |
d442cc9f |
37 | |
38 | =item 7 |
39 | |
3ab6187c |
40 | L<Debugging|Catalyst::Manual::Tutorial::07_Debugging> |
d442cc9f |
41 | |
42 | =item 8 |
43 | |
3ab6187c |
44 | B<08_Testing> |
d442cc9f |
45 | |
46 | =item 9 |
47 | |
3ab6187c |
48 | L<Advanced CRUD|Catalyst::Manual::Tutorial::09_AdvancedCRUD> |
3533daff |
49 | |
50 | =item 10 |
51 | |
3ab6187c |
52 | L<Appendices|Catalyst::Manual::Tutorial::10_Appendices> |
d442cc9f |
53 | |
54 | =back |
55 | |
3533daff |
56 | |
d442cc9f |
57 | =head1 DESCRIPTION |
58 | |
4b4d3884 |
59 | You may have noticed that the Catalyst Helper scripts automatically |
60 | create basic C<.t> test scripts under the C<t> directory. This |
61 | chapter of the tutorial briefly looks at how these tests can be used |
3b1fa91b |
62 | not only to ensure that your application is working correctly at the |
4b4d3884 |
63 | present time, but also provide automated regression testing as you |
64 | upgrade various pieces of your application over time. |
d442cc9f |
65 | |
4d63a0d5 |
66 | You can check out the source code for this example from the Catalyst |
67 | Subversion repository as per the instructions in |
3ab6187c |
68 | L<Catalyst::Manual::Tutorial::01_Intro|Catalyst::Manual::Tutorial::01_Intro>. |
1390ef0e |
69 | |
3b1fa91b |
70 | For an excellent introduction to learning the many benefits of testing |
71 | your Perl applications and modules, you might want to read 'Perl Testing: |
72 | A Developer's Notebook' by Ian Langworth and chromatic. |
73 | |
d442cc9f |
74 | |
75 | =head1 RUNNING THE "CANNED" CATALYST TESTS |
76 | |
77 | There are a variety of ways to run Catalyst and Perl tests (for example, |
78 | C<perl Makefile.PL> and C<make test>), but one of the easiest is with the |
79 | C<prove> command. For example, to run all of the tests in the C<t> |
80 | directory, enter: |
81 | |
82 | $ prove --lib lib t |
83 | |
028b4e1a |
84 | There will be a lot of output because we have the C<-Debug> flag |
85 | enabled in C<lib/MyApp.pm> (see the C<CATALYST_DEBUG=0> tip below for |
86 | a quick and easy way to reduce the clutter). Look for lines like this |
87 | for errors: |
3533daff |
88 | |
89 | # Failed test 'Request should succeed' |
3b1fa91b |
90 | # at t/controller_Books.t line 8. |
3533daff |
91 | # Looks like you failed 1 test of 3. |
92 | |
93 | The redirection used by the Authentication plugins will cause several |
94 | failures in the default tests. You can fix this by making the following |
95 | changes: |
96 | |
acbd7bdd |
97 | 1) Change the line in C<t/01app.t> that reads: |
d442cc9f |
98 | |
99 | ok( request('/')->is_success, 'Request should succeed' ); |
100 | |
101 | to: |
102 | |
103 | ok( request('/login')->is_success, 'Request should succeed' ); |
104 | |
3b1fa91b |
105 | 2) Change the line in C<t/controller_Logout.t> that reads: |
106 | |
107 | ok( request('/logout')->is_success, 'Request should succeed' ); |
108 | |
109 | to: |
110 | |
111 | ok( request('/logout')->is_redirect, 'Request should succeed' ); |
112 | |
113 | 3) Change the line in C<t/controller_Books.t> that reads: |
114 | |
115 | ok( request('/books')->is_success, 'Request should succeed' ); |
116 | |
117 | to: |
118 | |
119 | ok( request('/books')->is_redirect, 'Request should succeed' ); |
d442cc9f |
120 | |
3b1fa91b |
121 | 4) Add the following statement to the top of C<t/view_TT.t>: |
d442cc9f |
122 | |
3b1fa91b |
123 | use MyApp; |
6a72d1bf |
124 | |
d442cc9f |
125 | As you can see in the C<prove> command line above, the C<--lib> option |
126 | is used to set the location of the Catalyst C<lib> directory. With this |
127 | command, you will get all of the usual development server debug output, |
128 | something most people prefer to disable while running tests cases. |
129 | Although you can edit the C<lib/MyApp.pm> to comment out the C<-Debug> |
130 | plugin, it's generally easier to simply set the C<CATALYST_DEBUG=0> |
131 | environment variable. For example: |
132 | |
133 | $ CATALYST_DEBUG=0 prove --lib lib t |
134 | |
ebde193e |
135 | B<Note:> Depending on the versions of various modules you have |
136 | installed, you might get some C<used only once> warnings -- you can |
3b1fa91b |
137 | ignore these. If you want to eliminate the warnings, you can |
ebde193e |
138 | edit C<Template::Base> to disable and then re-enable warnings |
139 | are the C</usr/lib/perl5/Template/Base.pm> line in C<sub new>. |
140 | You can locate where C<Template::Base> is located with the |
141 | following command (it's probably in a place similar to |
142 | C</usr/lib/perl5/Template/Base.pm>): |
143 | |
144 | perldoc -l Template::Base |
145 | |
146 | Edit the file and modify C<sub new> to match: |
147 | |
148 | ... |
149 | { no strict qw( refs ); |
150 | # Disable warnings |
151 | no warnings; |
152 | $argnames = \@{"$class\::BASEARGS"} || [ ]; |
153 | # Turn warnings back on |
154 | use warnings; |
155 | } |
156 | ... |
157 | |
d442cc9f |
158 | During the C<t/02pod> and C<t/03podcoverage> tests, you might notice the |
159 | C<all skipped: set TEST_POD to enable this test> warning message. To |
160 | execute the Pod-related tests, add C<TEST_POD=1> to the C<prove> |
161 | command: |
162 | |
163 | $ CATALYST_DEBUG=0 TEST_POD=1 prove --lib lib t |
164 | |
165 | If you omitted the Pod comments from any of the methods that were |
166 | inserted, you might have to go back and fix them to get these tests to |
167 | pass. :-) |
168 | |
169 | Another useful option is the C<verbose> (C<-v>) option to C<prove>. It |
170 | prints the name of each test case as it is being run: |
171 | |
172 | $ CATALYST_DEBUG=0 TEST_POD=1 prove --lib lib -v t |
173 | |
3533daff |
174 | |
d442cc9f |
175 | =head1 RUNNING A SINGLE TEST |
176 | |
177 | You can also run a single script by appending its name to the C<prove> |
178 | command. For example: |
179 | |
180 | $ CATALYST_DEBUG=0 prove --lib lib t/01app.t |
181 | |
3533daff |
182 | Also note that you can also run tests directly from Perl without C<prove>. |
d442cc9f |
183 | For example: |
184 | |
185 | $ CATALYST_DEBUG=0 perl -Ilib t/01app.t |
186 | |
3533daff |
187 | |
d442cc9f |
188 | =head1 ADDING YOUR OWN TEST SCRIPT |
189 | |
190 | Although the Catalyst helper scripts provide a basic level of checks |
191 | "for free," testing can become significantly more helpful when you write |
192 | your own script to exercise the various parts of your application. The |
193 | L<Test::WWW::Mechanize::Catalyst|Test::WWW::Mechanize::Catalyst> module |
194 | is very popular for writing these sorts of test cases. This module |
195 | extends L<Test::WWW::Mechanize|Test::WWW::Mechanize> (and therefore |
196 | L<WWW::Mechanize|WWW::Mechanize>) to allow you to automate the action of |
197 | a user "clicking around" inside your application. It gives you all the |
198 | benefits of testing on a live system without the messiness of having to |
199 | use an actual web server, and a real person to do the clicking. |
200 | |
201 | To create a sample test case, open the C<t/live_app01.t> file in your |
202 | editor and enter the following: |
203 | |
204 | #!/usr/bin/perl |
205 | |
206 | use strict; |
207 | use warnings; |
208 | |
209 | # Load testing framework and use 'no_plan' to dynamically pick up |
210 | # all tests. Better to replace "'no_plan'" with "tests => 30" so it |
211 | # knows exactly how many tests need to be run (and will tell you if |
212 | # not), but 'no_plan' is nice for quick & dirty tests |
213 | |
214 | use Test::More 'no_plan'; |
215 | |
216 | # Need to specify the name of your app as arg on next line |
217 | # Can also do: |
218 | # use Test::WWW::Mechanize::Catalyst "MyApp"; |
219 | |
220 | use ok "Test::WWW::Mechanize::Catalyst" => "MyApp"; |
221 | |
222 | # Create two 'user agents' to simulate two different users ('test01' & 'test02') |
223 | my $ua1 = Test::WWW::Mechanize::Catalyst->new; |
224 | my $ua2 = Test::WWW::Mechanize::Catalyst->new; |
225 | |
226 | # Use a simplified for loop to do tests that are common to both users |
227 | # Use get_ok() to make sure we can hit the base URL |
228 | # Second arg = optional description of test (will be displayed for failed tests) |
229 | # Note that in test scripts you send everything to 'http://localhost' |
230 | $_->get_ok("http://localhost/", "Check redirect of base URL") for $ua1, $ua2; |
231 | # Use title_is() to check the contents of the <title>...</title> tags |
232 | $_->title_is("Login", "Check for login title") for $ua1, $ua2; |
233 | # Use content_contains() to match on text in the html body |
234 | $_->content_contains("You need to log in to use this application", |
235 | "Check we are NOT logged in") for $ua1, $ua2; |
236 | |
237 | # Log in as each user |
238 | # Specify username and password on the URL |
239 | $ua1->get_ok("http://localhost/login?username=test01&password=mypass", "Login 'test01'"); |
2a6eb5f9 |
240 | # Could make user2 like user1 above, but use the form to show another way |
241 | $ua2->submit_form( |
242 | fields => { |
243 | username => 'test02', |
244 | password => 'mypass', |
245 | }); |
d442cc9f |
246 | |
247 | # Go back to the login page and it should show that we are already logged in |
248 | $_->get_ok("http://localhost/login", "Return to '/login'") for $ua1, $ua2; |
249 | $_->title_is("Login", "Check for login page") for $ua1, $ua2; |
250 | $_->content_contains("Please Note: You are already logged in as ", |
251 | "Check we ARE logged in" ) for $ua1, $ua2; |
252 | |
253 | # 'Click' the 'Logout' link (see also 'text_regex' and 'url_regex' options) |
028b4e1a |
254 | $_->follow_link_ok({n => 4}, "Logout via first link on page") for $ua1, $ua2; |
d442cc9f |
255 | $_->title_is("Login", "Check for login title") for $ua1, $ua2; |
256 | $_->content_contains("You need to log in to use this application", |
257 | "Check we are NOT logged in") for $ua1, $ua2; |
258 | |
259 | # Log back in |
260 | $ua1->get_ok("http://localhost/login?username=test01&password=mypass", "Login 'test01'"); |
261 | $ua2->get_ok("http://localhost/login?username=test02&password=mypass", "Login 'test02'"); |
262 | # Should be at the Book List page... do some checks to confirm |
263 | $_->title_is("Book List", "Check for book list title") for $ua1, $ua2; |
264 | |
265 | $ua1->get_ok("http://localhost/books/list", "'test01' book list"); |
266 | $ua1->get_ok("http://localhost/login", "Login Page"); |
267 | $ua1->get_ok("http://localhost/books/list", "'test01' book list"); |
268 | |
269 | $_->content_contains("Book List", "Check for book list title") for $ua1, $ua2; |
270 | # Make sure the appropriate logout buttons are displayed |
fbbb9084 |
271 | $_->content_contains("/logout\">User Logout</a>", |
d442cc9f |
272 | "Both users should have a 'User Logout'") for $ua1, $ua2; |
273 | $ua1->content_contains("/books/form_create\">Create</a>", |
274 | "Only 'test01' should have a create link"); |
275 | |
276 | $ua1->get_ok("http://localhost/books/list", "View book list as 'test01'"); |
277 | |
278 | # User 'test01' should be able to create a book with the "formless create" URL |
279 | $ua1->get_ok("http://localhost/books/url_create/TestTitle/2/4", |
280 | "'test01' formless create"); |
281 | $ua1->title_is("Book Created", "Book created title"); |
282 | $ua1->content_contains("Added book 'TestTitle'", "Check title added OK"); |
283 | $ua1->content_contains("by 'Stevens'", "Check author added OK"); |
284 | $ua1->content_contains("with a rating of 2.", "Check rating added"); |
285 | # Try a regular expression to combine the previous 3 checks & account for whitespace |
286 | $ua1->content_like(qr/Added book 'TestTitle'\s+by 'Stevens'\s+with a rating of 2./, "Regex check"); |
287 | |
288 | # Make sure the new book shows in the list |
289 | $ua1->get_ok("http://localhost/books/list", "'test01' book list"); |
290 | $ua1->title_is("Book List", "Check logged in and at book list"); |
291 | $ua1->content_contains("Book List", "Book List page test"); |
292 | $ua1->content_contains("TestTitle", "Look for 'TestTitle'"); |
293 | |
294 | # Make sure the new book can be deleted |
295 | # Get all the Delete links on the list page |
296 | my @delLinks = $ua1->find_all_links(text => 'Delete'); |
297 | # Use the final link to delete the last book |
298 | $ua1->get_ok($delLinks[$#delLinks]->url, 'Delete last book'); |
299 | # Check that delete worked |
300 | $ua1->content_contains("Book List", "Book List page test"); |
301 | $ua1->content_contains("Book deleted", "Book was deleted"); |
302 | |
303 | # User 'test02' should not be able to add a book |
304 | $ua2->get_ok("http://localhost/books/url_create/TestTitle2/2/5", "'test02' add"); |
305 | $ua2->content_contains("Unauthorized!", "Check 'test02' cannot add"); |
306 | |
307 | The C<live_app.t> test cases uses copious comments to explain each step |
308 | of the process. In addition to the techniques shown here, there are a |
309 | variety of other methods available in |
310 | L<Test::WWW::Mechanize::Catalyst|Test::WWW::Mechanize::Catalyst> (for |
311 | example, regex-based matching). Consult the documentation for more |
312 | detail. |
313 | |
314 | B<TIP>: For I<unit tests> vs. the "full application tests" approach used |
315 | by L<Test::WWW::Mechanize::Catalyst|Test::WWW::Mechanize::Catalyst>, see |
316 | L<Catalyst::Test|Catalyst::Test>. |
317 | |
318 | B<Note:> The test script does not test the C<form_create> and |
319 | C<form_create_do> actions. That is left as an exercise for the reader |
320 | (you should be able to complete that logic using the existing code as a |
321 | template). |
322 | |
323 | To run the new test script, use a command such as: |
324 | |
325 | $ CATALYST_DEBUG=0 prove --lib lib -v t/live_app01.t |
326 | |
327 | or |
328 | |
329 | $ DBIC_TRACE=0 CATALYST_DEBUG=0 prove --lib lib -v t/live_app01.t |
330 | |
4b4d3884 |
331 | Experiment with the C<DBIC_TRACE>, C<CATALYST_DEBUG> and C<-v> |
332 | settings. If you find that there are errors, use the techniques |
333 | discussed in the "Catalyst Debugging" section (Chapter 7) to isolate |
334 | and fix any problems. |
d442cc9f |
335 | |
336 | If you want to run the test case under the Perl interactive debugger, |
337 | try a command such as: |
338 | |
339 | $ DBIC_TRACE=0 CATALYST_DEBUG=0 perl -d -Ilib t/live_app01.t |
340 | |
341 | Note that although this tutorial uses a single custom test case for |
342 | simplicity, you may wish to break your tests into different files for |
343 | better organization. |
344 | |
345 | B<TIP:> If you have a test case that fails, you will receive an error |
346 | similar to the following: |
347 | |
348 | # Failed test 'Check we are NOT logged in' |
349 | # in t/live_app01.t at line 31. |
350 | # searched: "\x{0a}<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Tran"... |
351 | # can't find: "You need to log in to use this application." |
352 | |
353 | Unfortunately, this only shows us the first 50 characters of the HTML |
354 | returned by the request -- not enough to determine where the problem |
355 | lies. A simple technique that can be used in such situations is to |
356 | temporarily insert a line similar to the following right after the |
357 | failed test: |
358 | |
6daaedc0 |
359 | diag $ua1->content; |
d442cc9f |
360 | |
361 | This will cause the full HTML returned by the request to be displayed. |
362 | |
fbbb9084 |
363 | Another approach to see the full HTML content at the failure point in |
364 | a series of tests would be to insert a "C<$DB::single=1;> right above |
365 | the location of the failure and run the test under the perl debugger |
366 | (with C<-d>) as shown above. Then you can use the debugger to explore |
367 | the state of the application right before or after the failure. |
368 | |
d442cc9f |
369 | |
370 | =head1 SUPPORTING BOTH PRODUCTION AND TEST DATABASES |
371 | |
372 | You may wish to leverage the techniques discussed in this tutorial to |
373 | maintain both a "production database" for your live application and a |
374 | "testing database" for your test cases. One advantage to |
375 | L<Test::WWW::Mechanize::Catalyst|Test::WWW::Mechanize::Catalyst> is that |
376 | it runs your full application; however, this can complicate things when |
377 | you want to support multiple databases. One solution is to allow the |
378 | database specification to be overridden with an environment variable. |
d0496197 |
379 | For example, open C<lib/MyApp/Model/DB.pm> in your editor and |
d442cc9f |
380 | change the C<__PACKAGE__-E<gt>config(...> declaration to resemble: |
381 | |
382 | my $dsn = $ENV{MYAPP_DSN} ||= 'dbi:SQLite:myapp.db'; |
383 | __PACKAGE__->config( |
d0496197 |
384 | schema_class => 'MyApp::Schema', |
d442cc9f |
385 | connect_info => [ |
386 | $dsn, |
d442cc9f |
387 | ], |
388 | ); |
389 | |
390 | Then, when you run your test case, you can use commands such as: |
391 | |
392 | $ cp myapp.db myappTEST.db |
393 | $ CATALYST_DEBUG=0 MYAPP_DSN="dbi:SQLite:myappTEST.db" prove --lib lib -v t/live_app01.t |
394 | |
395 | This will modify the DSN only while the test case is running. If you |
396 | launch your normal application without the C<MYAPP_DSN> environment |
397 | variable defined, it will default to the same C<dbi:SQLite:myapp.db> as |
398 | before. |
399 | |
400 | |
401 | =head1 AUTHOR |
402 | |
403 | Kennedy Clark, C<hkclark@gmail.com> |
404 | |
405 | Please report any errors, issues or suggestions to the author. The |
406 | most recent version of the Catalyst Tutorial can be found at |
59884771 |
407 | L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>. |
d442cc9f |
408 | |
45c7830f |
409 | Copyright 2006-2008, Kennedy Clark, under Creative Commons License |
8482d557 |
410 | (L<http://creativecommons.org/licenses/by-sa/3.0/us/>). |
d442cc9f |
411 | |