1package Test::Simple; 2 3use 5.004; 4 5use strict 'vars'; 6use vars qw($VERSION); 7$VERSION = '0.49'; 8 9 10use Test::Builder; 11my $Test = Test::Builder->new; 12 13sub import { 14 my $self = shift; 15 my $caller = caller; 16 *{$caller.'::ok'} = \&ok; 17 18 $Test->exported_to($caller); 19 $Test->plan(@_); 20} 21 22 23=head1 NAME 24 25Test::Simple - Basic utilities for writing tests. 26 27=head1 SYNOPSIS 28 29 use Test::Simple tests => 1; 30 31 ok( $foo eq $bar, 'foo is bar' ); 32 33 34=head1 DESCRIPTION 35 36** If you are unfamiliar with testing B<read Test::Tutorial> first! ** 37 38This is an extremely simple, extremely basic module for writing tests 39suitable for CPAN modules and other pursuits. If you wish to do more 40complicated testing, use the Test::More module (a drop-in replacement 41for this one). 42 43The basic unit of Perl testing is the ok. For each thing you want to 44test your program will print out an "ok" or "not ok" to indicate pass 45or fail. You do this with the ok() function (see below). 46 47The only other constraint is you must pre-declare how many tests you 48plan to run. This is in case something goes horribly wrong during the 49test and your test program aborts, or skips a test or whatever. You 50do this like so: 51 52 use Test::Simple tests => 23; 53 54You must have a plan. 55 56 57=over 4 58 59=item B<ok> 60 61 ok( $foo eq $bar, $name ); 62 ok( $foo eq $bar ); 63 64ok() is given an expression (in this case C<$foo eq $bar>). If it's 65true, the test passed. If it's false, it didn't. That's about it. 66 67ok() prints out either "ok" or "not ok" along with a test number (it 68keeps track of that for you). 69 70 # This produces "ok 1 - Hell not yet frozen over" (or not ok) 71 ok( get_temperature($hell) > 0, 'Hell not yet frozen over' ); 72 73If you provide a $name, that will be printed along with the "ok/not 74ok" to make it easier to find your test when if fails (just search for 75the name). It also makes it easier for the next guy to understand 76what your test is for. It's highly recommended you use test names. 77 78All tests are run in scalar context. So this: 79 80 ok( @stuff, 'I have some stuff' ); 81 82will do what you mean (fail if stuff is empty) 83 84=cut 85 86sub ok ($;$) { 87 $Test->ok(@_); 88} 89 90 91=back 92 93Test::Simple will start by printing number of tests run in the form 94"1..M" (so "1..5" means you're going to run 5 tests). This strange 95format lets Test::Harness know how many tests you plan on running in 96case something goes horribly wrong. 97 98If all your tests passed, Test::Simple will exit with zero (which is 99normal). If anything failed it will exit with how many failed. If 100you run less (or more) tests than you planned, the missing (or extras) 101will be considered failures. If no tests were ever run Test::Simple 102will throw a warning and exit with 255. If the test died, even after 103having successfully completed all its tests, it will still be 104considered a failure and will exit with 255. 105 106So the exit codes are... 107 108 0 all tests successful 109 255 test died 110 any other number how many failed (including missing or extras) 111 112If you fail more than 254 tests, it will be reported as 254. 113 114This module is by no means trying to be a complete testing system. 115It's just to get you started. Once you're off the ground its 116recommended you look at L<Test::More>. 117 118 119=head1 EXAMPLE 120 121Here's an example of a simple .t file for the fictional Film module. 122 123 use Test::Simple tests => 5; 124 125 use Film; # What you're testing. 126 127 my $btaste = Film->new({ Title => 'Bad Taste', 128 Director => 'Peter Jackson', 129 Rating => 'R', 130 NumExplodingSheep => 1 131 }); 132 ok( defined($btaste) and ref $btaste eq 'Film', 'new() works' ); 133 134 ok( $btaste->Title eq 'Bad Taste', 'Title() get' ); 135 ok( $btaste->Director eq 'Peter Jackson', 'Director() get' ); 136 ok( $btaste->Rating eq 'R', 'Rating() get' ); 137 ok( $btaste->NumExplodingSheep == 1, 'NumExplodingSheep() get' ); 138 139It will produce output like this: 140 141 1..5 142 ok 1 - new() works 143 ok 2 - Title() get 144 ok 3 - Director() get 145 not ok 4 - Rating() get 146 # Failed test (t/film.t at line 14) 147 ok 5 - NumExplodingSheep() get 148 # Looks like you failed 1 tests of 5 149 150Indicating the Film::Rating() method is broken. 151 152 153=head1 CAVEATS 154 155Test::Simple will only report a maximum of 254 failures in its exit 156code. If this is a problem, you probably have a huge test script. 157Split it into multiple files. (Otherwise blame the Unix folks for 158using an unsigned short integer as the exit status). 159 160Because VMS's exit codes are much, much different than the rest of the 161universe, and perl does horrible mangling to them that gets in my way, 162it works like this on VMS. 163 164 0 SS$_NORMAL all tests successful 165 4 SS$_ABORT something went wrong 166 167Unfortunately, I can't differentiate any further. 168 169 170=head1 NOTES 171 172Test::Simple is B<explicitly> tested all the way back to perl 5.004. 173 174Test::Simple is thread-safe in perl 5.8.0 and up. 175 176=head1 HISTORY 177 178This module was conceived while talking with Tony Bowden in his 179kitchen one night about the problems I was having writing some really 180complicated feature into the new Testing module. He observed that the 181main problem is not dealing with these edge cases but that people hate 182to write tests B<at all>. What was needed was a dead simple module 183that took all the hard work out of testing and was really, really easy 184to learn. Paul Johnson simultaneously had this idea (unfortunately, 185he wasn't in Tony's kitchen). This is it. 186 187 188=head1 SEE ALSO 189 190=over 4 191 192=item L<Test::More> 193 194More testing functions! Once you outgrow Test::Simple, look at 195Test::More. Test::Simple is 100% forward compatible with Test::More 196(i.e. you can just use Test::More instead of Test::Simple in your 197programs and things will still work). 198 199=item L<Test> 200 201The original Perl testing module. 202 203=item L<Test::Unit> 204 205Elaborate unit testing. 206 207=item L<Test::Inline>, L<SelfTest> 208 209Embed tests in your code! 210 211=item L<Test::Harness> 212 213Interprets the output of your test program. 214 215=back 216 217 218=head1 AUTHORS 219 220Idea by Tony Bowden and Paul Johnson, code by Michael G Schwern 221E<lt>schwern@pobox.comE<gt>, wardrobe by Calvin Klein. 222 223 224=head1 COPYRIGHT 225 226Copyright 2001 by Michael G Schwern E<lt>schwern@pobox.comE<gt>. 227 228This program is free software; you can redistribute it and/or 229modify it under the same terms as Perl itself. 230 231See F<http://www.perl.com/perl/misc/Artistic.html> 232 233=cut 234 2351; 236