2 # $Id: /mirror/googlecode/test-more-trunk/lib/Test/Simple.pm 67223 2008-10-15T03:08:18.888155Z schwern $
8 our $VERSION = '0.86_01';
9 $VERSION = eval $VERSION; ## no critic (BuiltinFunctions::ProhibitStringyEval)
11 use Test::Builder::Module;
12 our @ISA = qw(Test::Builder::Module);
15 my $CLASS = __PACKAGE__;
19 Test::Simple - Basic utilities for writing tests.
23 use Test::Simple tests => 1;
25 ok( $foo eq $bar, 'foo is bar' );
30 ** If you are unfamiliar with testing B<read Test::Tutorial> first! **
32 This is an extremely simple, extremely basic module for writing tests
33 suitable for CPAN modules and other pursuits. If you wish to do more
34 complicated testing, use the Test::More module (a drop-in replacement
37 The basic unit of Perl testing is the ok. For each thing you want to
38 test your program will print out an "ok" or "not ok" to indicate pass
39 or fail. You do this with the ok() function (see below).
41 The only other constraint is you must pre-declare how many tests you
42 plan to run. This is in case something goes horribly wrong during the
43 test and your test program aborts, or skips a test or whatever. You
46 use Test::Simple tests => 23;
55 ok( $foo eq $bar, $name );
58 ok() is given an expression (in this case C<$foo eq $bar>). If it's
59 true, the test passed. If it's false, it didn't. That's about it.
61 ok() prints out either "ok" or "not ok" along with a test number (it
62 keeps track of that for you).
64 # This produces "ok 1 - Hell not yet frozen over" (or not ok)
65 ok( get_temperature($hell) > 0, 'Hell not yet frozen over' );
67 If you provide a $name, that will be printed along with the "ok/not
68 ok" to make it easier to find your test when if fails (just search for
69 the name). It also makes it easier for the next guy to understand
70 what your test is for. It's highly recommended you use test names.
72 All tests are run in scalar context. So this:
74 ok( @stuff, 'I have some stuff' );
76 will do what you mean (fail if stuff is empty)
80 sub ok ($;$) { ## no critic (Subroutines::ProhibitSubroutinePrototypes)
81 return $CLASS->builder->ok(@_);
86 Test::Simple will start by printing number of tests run in the form
87 "1..M" (so "1..5" means you're going to run 5 tests). This strange
88 format lets Test::Harness know how many tests you plan on running in
89 case something goes horribly wrong.
91 If all your tests passed, Test::Simple will exit with zero (which is
92 normal). If anything failed it will exit with how many failed. If
93 you run less (or more) tests than you planned, the missing (or extras)
94 will be considered failures. If no tests were ever run Test::Simple
95 will throw a warning and exit with 255. If the test died, even after
96 having successfully completed all its tests, it will still be
97 considered a failure and will exit with 255.
99 So the exit codes are...
101 0 all tests successful
102 255 test died or all passed but wrong # of tests run
103 any other number how many failed (including missing or extras)
105 If you fail more than 254 tests, it will be reported as 254.
107 This module is by no means trying to be a complete testing system.
108 It's just to get you started. Once you're off the ground its
109 recommended you look at L<Test::More>.
114 Here's an example of a simple .t file for the fictional Film module.
116 use Test::Simple tests => 5;
118 use Film; # What you're testing.
120 my $btaste = Film->new({ Title => 'Bad Taste',
121 Director => 'Peter Jackson',
123 NumExplodingSheep => 1
125 ok( defined($btaste) && ref $btaste eq 'Film, 'new() works' );
127 ok( $btaste->Title eq 'Bad Taste', 'Title() get' );
128 ok( $btaste->Director eq 'Peter Jackson', 'Director() get' );
129 ok( $btaste->Rating eq 'R', 'Rating() get' );
130 ok( $btaste->NumExplodingSheep == 1, 'NumExplodingSheep() get' );
132 It will produce output like this:
137 ok 3 - Director() get
138 not ok 4 - Rating() get
139 # Failed test 'Rating() get'
140 # in t/film.t at line 14.
141 ok 5 - NumExplodingSheep() get
142 # Looks like you failed 1 tests of 5
144 Indicating the Film::Rating() method is broken.
149 Test::Simple will only report a maximum of 254 failures in its exit
150 code. If this is a problem, you probably have a huge test script.
151 Split it into multiple files. (Otherwise blame the Unix folks for
152 using an unsigned short integer as the exit status).
154 Because VMS's exit codes are much, much different than the rest of the
155 universe, and perl does horrible mangling to them that gets in my way,
156 it works like this on VMS.
158 0 SS$_NORMAL all tests successful
159 4 SS$_ABORT something went wrong
161 Unfortunately, I can't differentiate any further.
166 Test::Simple is B<explicitly> tested all the way back to perl 5.004.
168 Test::Simple is thread-safe in perl 5.8.0 and up.
172 This module was conceived while talking with Tony Bowden in his
173 kitchen one night about the problems I was having writing some really
174 complicated feature into the new Testing module. He observed that the
175 main problem is not dealing with these edge cases but that people hate
176 to write tests B<at all>. What was needed was a dead simple module
177 that took all the hard work out of testing and was really, really easy
178 to learn. Paul Johnson simultaneously had this idea (unfortunately,
179 he wasn't in Tony's kitchen). This is it.
188 More testing functions! Once you outgrow Test::Simple, look at
189 Test::More. Test::Simple is 100% forward compatible with Test::More
190 (i.e. you can just use Test::More instead of Test::Simple in your
191 programs and things will still work).
195 Look in Test::More's SEE ALSO for more testing modules.
200 Idea by Tony Bowden and Paul Johnson, code by Michael G Schwern
201 E<lt>schwern@pobox.comE<gt>, wardrobe by Calvin Klein.
206 Copyright 2001-2008 by Michael G Schwern E<lt>schwern@pobox.comE<gt>.
208 This program is free software; you can redistribute it and/or
209 modify it under the same terms as Perl itself.
211 See F<http://www.perl.com/perl/misc/Artistic.html>