lib/Test/Simple.pm

   1 package Test::Simple;
   2 # $Id$
   3
   4 use 5.004;
   5
   6 use strict;
   7
   8 our $VERSION = '0.86_01';
   9 $VERSION = eval $VERSION;    ## no critic (BuiltinFunctions::ProhibitStringyEval)
  10
  11 use Test::Builder::Module;
  12 our @ISA    = qw(Test::Builder::Module);
  13 our @EXPORT = qw(ok);
  14
  15 my $CLASS = __PACKAGE__;
  16
  17 =head1 NAME
  18
  19 Test::Simple - Basic utilities for writing tests.
  20
  21 =head1 SYNOPSIS
  22
  23   use Test::Simple tests => 1;
  24
  25   ok( $foo eq $bar, 'foo is bar' );
  26
  27
  28 =head1 DESCRIPTION
  29
  30 ** If you are unfamiliar with testing B<read Test::Tutorial> first! **
  31
  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
  35 for this one).
  36
  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).
  40
  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
  44 do this like so:
  45
  46     use Test::Simple tests => 23;
  47
  48 You must have a plan.
  49
  50
  51 =over 4
  52
  53 =item B<ok>
  54
  55   ok( $foo eq $bar, $name );
  56   ok( $foo eq $bar );
  57
  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.
  60
  61 ok() prints out either "ok" or "not ok" along with a test number (it
  62 keeps track of that for you).
  63
  64   # This produces "ok 1 - Hell not yet frozen over" (or not ok)
  65   ok( get_temperature($hell) > 0, 'Hell not yet frozen over' );
  66
  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.
  71
  72 All tests are run in scalar context.  So this:
  73
  74     ok( @stuff, 'I have some stuff' );
  75
  76 will do what you mean (fail if stuff is empty)
  77
  78 =cut
  79
  80 sub ok ($;$) {    ## no critic (Subroutines::ProhibitSubroutinePrototypes)
  81     return $CLASS->builder->ok(@_);
  82 }
  83
  84 =back
  85
  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.
  90
  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.
  98
  99 So the exit codes are...
 100
 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)
 104
 105 If you fail more than 254 tests, it will be reported as 254.
 106
 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>.
 110
 111
 112 =head1 EXAMPLE
 113
 114 Here's an example of a simple .t file for the fictional Film module.
 115
 116     use Test::Simple tests => 5;
 117
 118     use Film;  # What you're testing.
 119
 120     my $btaste = Film->new({ Title    => 'Bad Taste',
 121                              Director => 'Peter Jackson',
 122                              Rating   => 'R',
 123                              NumExplodingSheep => 1
 124                            });
 125     ok( defined($btaste) && ref $btaste eq 'Film,     'new() works' );
 126
 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' );
 131
 132 It will produce output like this:
 133
 134     1..5
 135     ok 1 - new() works
 136     ok 2 - Title() get
 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
 143
 144 Indicating the Film::Rating() method is broken.
 145
 146
 147 =head1 CAVEATS
 148
 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).
 153
 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.
 157
 158     0     SS$_NORMAL        all tests successful
 159     4     SS$_ABORT         something went wrong
 160
 161 Unfortunately, I can't differentiate any further.
 162
 163
 164 =head1 NOTES
 165
 166 Test::Simple is B<explicitly> tested all the way back to perl 5.004.
 167
 168 Test::Simple is thread-safe in perl 5.8.0 and up.
 169
 170 =head1 HISTORY
 171
 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.
 180
 181
 182 =head1 SEE ALSO
 183
 184 =over 4
 185
 186 =item L<Test::More>
 187
 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).
 192
 193 =back
 194
 195 Look in Test::More's SEE ALSO for more testing modules.
 196
 197
 198 =head1 AUTHORS
 199
 200 Idea by Tony Bowden and Paul Johnson, code by Michael G Schwern
 201 E<lt>schwern@pobox.comE<gt>, wardrobe by Calvin Klein.
 202
 203
 204 =head1 COPYRIGHT
 205
 206 Copyright 2001-2008 by Michael G Schwern E<lt>schwern@pobox.comE<gt>.
 207
 208 This program is free software; you can redistribute it and/or
 209 modify it under the same terms as Perl itself.
 210
 211 See F<http://www.perl.com/perl/misc/Artistic.html>
 212
 213 =cut
 214
 215 1;