X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FTest.pm;h=f0410f9e13303e0fad241a3c79b660c60660cdce;hb=6d80e9d0fed5aaa368313563b0a51ac19967da35;hp=77728bc323730d6bae272b61272da692796494cf;hpb=76fbd8c4ea7bb4d7a18a2c0a1d508a67659f3068;p=p5sagit%2Fp5-mst-13.2.git diff --git a/lib/Test.pm b/lib/Test.pm index 77728bc..f0410f9 100644 --- a/lib/Test.pm +++ b/lib/Test.pm @@ -1,25 +1,36 @@ -package Test; require 5.004; +package Test; +# Time-stamp: "2002-10-11 17:38:48 MDT" use strict; use Carp; use vars (qw($VERSION @ISA @EXPORT @EXPORT_OK $ntest $TestLevel), #public-ish - qw($TESTOUT $ONFAIL %todo %history $planned @FAILDETAIL)#private-ish + qw($TESTOUT $TESTERR %Program_Lines + $ONFAIL %todo %history $planned @FAILDETAIL) #private-ish ); -$VERSION = '1.17_00'; +# In case a test is run in a persistent environment. +sub _reset_globals { + %todo = (); + %history = (); + @FAILDETAIL = (); + $ntest = 1; + $TestLevel = 0; # how many extra stack frames to skip + $planned = 0; +} + +$VERSION = '1.23'; require Exporter; @ISA=('Exporter'); @EXPORT = qw(&plan &ok &skip); -@EXPORT_OK = qw($ntest $TESTOUT); +@EXPORT_OK = qw($ntest $TESTOUT $TESTERR); -$TestLevel = 0; # how many extra stack frames to skip $|=1; -$ntest=1; $TESTOUT = *STDOUT{IO}; +$TESTERR = *STDERR{IO}; # Use of this variable is strongly discouraged. It is set mainly to # help test coverage analyzers know which test is running. @@ -41,6 +52,9 @@ Test - provides a simple framework for writing test scripts # load your module... use MyModule; + # Helpful notes. All note-lines must start with a "#". + print "# I'm testing MyModule version $MyModule::VERSION\n"; + ok(0); # failure ok(1); # success @@ -54,51 +68,82 @@ Test - provides a simple framework for writing test scripts ok(sub { 1+1 }, 2); # success: '2' eq '2' ok(sub { 1+1 }, 3); # failure: '2' ne '3' - ok(0, int(rand(2)); # (just kidding :-) my @list = (0,0); - ok @list, 3, "\@list=".join(',',@list); #extra diagnostics + ok @list, 3, "\@list=".join(',',@list); #extra notes ok 'segmentation fault', '/(?i)success/'; #regex match - skip($feature_is_missing, ...); #do platform specific test + skip( + $^O eq 'MSWin' ? "Skip unless MSWin" : 0, # whether to skip + $foo, $bar # arguments just like for ok(...) + ); + skip( + $^O eq 'MSWin' ? 0 : "Skip if MSWin", # whether to skip + $foo, $bar # arguments just like for ok(...) + ); =head1 DESCRIPTION -L expects to see particular output when it -executes tests. This module aims to make writing proper test scripts just -a little bit easier (and less error prone :-). +This module simplifies the task of writing test files for Perl modules, +such that their output is in the format that +L expects to see. + +=head1 QUICK START GUIDE +To write a test for your new (and probably not even done) module, create +a new file called F (in a new F directory). If you have +multiple test files, to test the "foo", "bar", and "baz" feature sets, +then feel free to call your files F, F, and +F =head2 Functions -All the following are exported by Test by default. +This module defines three public functions, C, C, +and C. By default, all three are exported by +the C statement. =over 4 -=item B +=item C BEGIN { plan %theplan; } This should be the first thing you call in your test script. It declares your testing plan, how many there will be, if any of them -should be allowed to fail, etc... +should be allowed to fail, and so on. Typical usage is just: use Test; BEGIN { plan tests => 23 } -Things you can put in the plan: +These are the things that you can put in the parameters to plan: + +=over + +=item C I> + +The number of tests in your script. +This means all ok() and skip() calls. + +=item C [I<1,5,14>]> + +A reference to a list of tests which are allowed to fail. +See L. + +=item C sub { ... }> - tests The number of tests in your script. - This means all ok() and skip() calls. - todo A reference to a list of tests which are allowed - to fail. See L. - onfail A subroutine reference to be run at the end of - the test script should any of the tests fail. - See L. +=item C \&some_sub> -You must call plan() once and only once. +A subroutine reference to be run at the end of the test script, if +any of the tests fail. See L. + +=back + +You must call C once and only once. You should call it +in a C block, like so: + + BEGIN { plan tests => 23 } =cut @@ -109,6 +154,10 @@ sub plan { local($\, $,); # guard against -l and other things that screw with # print + _reset_globals(); + + _read_program( (caller)[1] ); + my $max=0; for (my $x=0; $x < @_; $x+=2) { my ($k,$v) = @_[$x,$x+1]; @@ -128,11 +177,39 @@ sub plan { print $TESTOUT "1..$max\n"; } ++$planned; + print $TESTOUT "# Running under perl version $] for $^O", + (chr(65) eq 'A') ? "\n" : " in a non-ASCII world\n"; + + print $TESTOUT "# Win32::BuildNumber ", &Win32::BuildNumber(), "\n" + if defined(&Win32::BuildNumber) and defined &Win32::BuildNumber(); + + print $TESTOUT "# MacPerl verison $MacPerl::Version\n" + if defined $MacPerl::Version; - # Never used. + printf $TESTOUT + "# Current time local: %s\n# Current time GMT: %s\n", + scalar(localtime($^T)), scalar(gmtime($^T)); + + print $TESTOUT "# Using Test.pm version $VERSION\n"; + + # Retval never used: return undef; } +sub _read_program { + my($file) = shift; + return unless defined $file and length $file + and -e $file and -f _ and -r _; + open(SOURCEFILE, "<$file") || return; + $Program_Lines{$file} = []; + close(SOURCEFILE); + + foreach my $x (@{$Program_Lines{$file}}) + { $x =~ tr/[\cm\cj\n\r]//d } + + unshift @{$Program_Lines{$file}}, ''; + return 1; +} =begin _private @@ -140,8 +217,8 @@ sub plan { my $value = _to_value($input); -Converts an ok parameter to its value. Typically this just means -running it if its a code reference. You should run all inputed +Converts an C parameter to its value. Typically this just means +running it, if it's a code reference. You should run all inputted values through this. =cut @@ -153,17 +230,22 @@ sub _to_value { =end _private -=item B +=item C ok(1 + 1 == 2); ok($have, $expect); ok($have, $expect, $diagnostics); -This is the reason for Test's existance. Its the basic function that -handles printing "ok" or "not ok" along with the current test number. +This function is the reason for C's existence. It's +the basic function that +handles printing "C" or "C", along with the +current test number. (That's what C wants to see.) -In its most basic usage, it simply takes an expression. If its true, -the test passes, if false, the test fails. Simp. +In its most basic usage, C simply takes a single scalar +expression. If its value is true, the test passes; if false, +the test fails. Examples: + + # Examples of ok(scalar) ok( 1 + 1 == 2 ); # ok if 1 + 1 == 2 ok( $foo =~ /bar/ ); # ok if $foo contains 'bar' @@ -178,43 +260,78 @@ work: ok( !grep !defined $_, @stuff ); # ok if everything in @stuff is # defined. -A special case is if the expression is a subroutine reference. In +A special case is if the expression is a subroutine reference (in either +C syntax or C<\&foo> syntax). In that case, it is executed and its value (true or false) determines if -the test passes or fails. +the test passes or fails. For example, -In its two argument form it compares the two values to see if they -equal (with C). + ok( sub { # See whether sleep works at least passably + my $start_time = time; + sleep 5; + time() - $start_time >= 4 + }); - ok( "this", "that" ); # not ok, 'this' ne 'that' +In its two-argument form, C,I)> compares the two scalar +values to see if they equal. (The equality is checked with C). + + # Example of ok(scalar, scalar) -If either is a subroutine reference, that is run and used as a -comparison. + ok( "this", "that" ); # not ok, 'this' ne 'that' -Should $expect either be a regex reference (ie. qr//) or a string that -looks like a regex (ie. '/foo/') ok() will perform a pattern match -against it rather than using eq. +If either (or both!) is a subroutine reference, it is run and used +as the value for comparing. For example: + + ok 4, sub { + open(OUT, ">x.dat") || die $!; + print OUT "\x{e000}"; + close OUT; + my $bytecount = -s 'x.dat'; + unlink 'x.dat' or warn "Can't unlink : $!"; + return $bytecount; + }, + ; + +The above test passes two values to C -- the first is +the number 4, and the second is a coderef. Before C compares them, +it calls the coderef, and uses its return value as the real value of +this parameter. Assuming that C<$bytecount> returns 4, C ends up +testing C<4 eq 4>. Since that's true, this test passes. + +If C is either a regex object (i.e., C) or a string +that I a regex (e.g., C<'/foo/'>), then +C,I)> will perform a pattern +match against it, instead of using C. ok( 'JaffO', '/Jaff/' ); # ok, 'JaffO' =~ /Jaff/ ok( 'JaffO', qr/Jaff/ ); # ok, 'JaffO' =~ qr/Jaff/; ok( 'JaffO', '/(?i)jaff/ ); # ok, 'JaffO' =~ /jaff/i; -Finally, an optional set of $diagnostics will be printed should the -test fail. This should usually be some useful information about the -test pertaining to why it failed or perhaps a description of the test. -Or both. +Finally, you can append an optional third argument, in +C,I, I)>, where I is a string value that +will be printed if the test fails. This should be some useful +information about the test, pertaining to why it failed, and/or +a description of the test. For example: ok( grep($_ eq 'something unique', @stuff), 1, "Something that should be unique isn't!\n". '@stuff = '.join ', ', @stuff ); -Unfortunately, a diagnostic cannot be used with the single argument -style of ok(). +Unfortunately, a note cannot be used with the single argument +style of C. That is, if you try C, I)>, then +C will interpret this as C, I)>, and probably +end up testing C eq I> -- and that's not what you want! -All these special cases can cause some problems. See L. +All of the above special cases can occasionally cause some +problems. See L. =cut +# A past maintainer of this module said: +# <> +# + sub ok ($;$$) { croak "ok: plan before you test!" if !$planned; @@ -225,12 +342,17 @@ sub ok ($;$$) { my $repetition = ++$history{"$file:$line"}; my $context = ("$file at line $line". ($repetition > 1 ? " fail \#$repetition" : '')); + + # Are we comparing two values? + my $compare = 0; + my $ok=0; my $result = _to_value(shift); my ($expected,$diag,$isregex,$regex); if (@_ == 0) { $ok = $result; } else { + $compare = 1; $expected = _to_value(shift); if (!defined $expected) { $ok = !defined $result; @@ -270,29 +392,45 @@ sub ok ($;$$) { $diag =~ s/\n/\n#/g if defined $diag; $context .= ' *TODO*' if $todo; - if (!defined $expected) { + if (!$compare) { if (!$diag) { - print $TESTOUT "# Failed test $ntest in $context\n"; + print $TESTERR "# Failed test $ntest in $context\n"; } else { - print $TESTOUT "# Failed test $ntest in $context: $diag\n"; + print $TESTERR "# Failed test $ntest in $context: $diag\n"; } } else { my $prefix = "Test $ntest"; - print $TESTOUT "# $prefix got: ". + print $TESTERR "# $prefix got: ". (defined $result? "'$result'":'')." ($context)\n"; $prefix = ' ' x (length($prefix) - 5); if (defined $regex) { $expected = 'qr{'.$regex.'}'; } - else { + elsif (defined $expected) { $expected = "'$expected'"; } + else { + $expected = ''; + } if (!$diag) { - print $TESTOUT "# $prefix Expected: $expected\n"; + print $TESTERR "# $prefix Expected: $expected\n"; } else { - print $TESTOUT "# $prefix Expected: $expected ($diag)\n"; + print $TESTERR "# $prefix Expected: $expected ($diag)\n"; } } + + if(defined $Program_Lines{$file}[$line]) { + print $TESTERR + "# $file line $line is: $Program_Lines{$file}[$line]\n" + if + $Program_Lines{$file}[$line] =~ m/[^\s\#\(\)\{\}\[\]\;]/ + # Otherwise it's a pretty uninteresting line! + ; + + undef $Program_Lines{$file}[$line]; + # So we won't repeat it. + } + push @FAILDETAIL, $detail; } } @@ -300,6 +438,83 @@ sub ok ($;$$) { $ok; } +=item C, I)> + +This is used for tests that under some conditions can be skipped. It's +basically equivalent to: + + if( $skip_if_true ) { + ok(1); + } else { + ok( args... ); + } + +...except that the C emits not just "C>" but +actually "C # I>". + +The arguments after the I are what is fed to C if +this test isn't skipped. + +Example usage: + + my $if_MSWin = + $^O eq 'MSWin' ? 'Skip if under MSWin' : ''; + + # A test to be run EXCEPT under MSWin: + skip($if_MSWin, thing($foo), thing($bar) ); + +Or, going the other way: + + my $unless_MSWin = + $^O eq 'MSWin' ? 'Skip unless under MSWin' : ''; + + # A test to be run EXCEPT under MSWin: + skip($unless_MSWin, thing($foo), thing($bar) ); + +The tricky thing to remember is that the first parameter is true if +you want to I the test, not I it; and it also doubles as a +note about why it's being skipped. So in the first codeblock above, read +the code as "skip if MSWin -- (otherwise) test whether C is +C" or for the second case, "skip unless MSWin...". + +Also, when your I string is true, it really should (for +backwards compatibility with older Test.pm versions) start with the +string "Skip", as shown in the above examples. + +Note that in the above cases, C and C +I evaluated -- but as long as the C is true, +then we C just tosses out their value (i.e., not +bothering to treat them like values to C. But if +you need to I eval the arguments when skipping the +test, use +this format: + + skip( $unless_MSWin, + sub { + # This code returns true if the test passes. + # (But it doesn't even get called if the test is skipped.) + thing($foo) eq thing($bar) + } + ); + +or even this, which is basically equivalent: + + skip( $unless_MSWin, + sub { thing($foo) }, sub { thing($bar) } + ); + +That is, both are like this: + + if( $unless_MSWin ) { + ok(1); # but it actually appends "# $unless_MSWin" + # so that Test::Harness can tell it's a skip + } else { + # Not skipping, so actually call and evaluate... + ok( sub { thing($foo) }, sub { thing($bar) } ); + } + +=cut + sub skip ($;$$$) { local($\, $,); # guard against -l and other things that screw with # print @@ -326,7 +541,7 @@ sub skip ($;$$$) { #the documented interface as this has been deprecated. #WARN - local($TestLevel) = $TestLevel+1; #ignore this stack frame + local($TestLevel) = $TestLevel+1; #to ignore this stack frame return &ok(@_); } } @@ -348,27 +563,30 @@ __END__ =item * NORMAL TESTS -These tests are expected to succeed. If they don't something's -screwed up! +These tests are expected to succeed. Usually, most or all of your tests +are in this category. If a normal test doesn't succeed, then that +means that something is I. =item * SKIPPED TESTS -Skip is for tests that might or might not be possible to run depending -on the availability of platform specific features. The first argument +The C function is for tests that might or might not be +possible to run, depending +on the availability of platform-specific features. The first argument should evaluate to true (think "yes, please skip") if the required -feature is not available. After the first argument, skip works -exactly the same way as do normal tests. +feature is I available. After the first argument, C works +exactly the same way as C does. =item * TODO TESTS TODO tests are designed for maintaining an B. -These tests are expected NOT to succeed. If a TODO test does succeed, -the feature in question should not be on the TODO list, now should it? +These tests are I If a TODO test does succeed, +then the feature in question shouldn't be on the TODO list, now +should it? Packages should NOT be released with succeeding TODO tests. As soon -as a TODO test starts working, it should be promoted to a normal test +as a TODO test starts working, it should be promoted to a normal test, and the newly working feature should be documented in the release -notes or change log. +notes or in the change log. =back @@ -376,16 +594,16 @@ notes or change log. BEGIN { plan test => 4, onfail => sub { warn "CALL 911!" } } -While test failures should be enough, extra diagnostics can be +Although test failures should be enough, extra diagnostics can be triggered at the end of a test run. C is passed an array ref of hash refs that describe each test failure. Each hash will contain at least the following fields: C, C, and C. (The file, line, and test number are not included because their correspondence to a particular test is tenuous.) If the test -had an expected value or a diagnostic string, these will also be +had an expected value or a diagnostic (or "note") string, these will also be included. -The B C hook might be used simply to print out the +The I C hook might be used simply to print out the version of your package and/or how to report problems. It might also be used to generate extremely sophisticated diagnostics for a particularly bizarre test failure. However it's not a panacea. Core @@ -397,10 +615,24 @@ than the code it is testing, yes?) =head1 BUGS and CAVEATS -ok()'s special handling of subroutine references is an unfortunate -"feature" that can't be removed due to compatibility. +=over + +=item * -ok()'s use of string eq can sometimes cause odd problems when comparing +C's special handing of strings which look like they might be +regexes can also cause unexpected behavior. An innocent: + + ok( $fileglob, '/path/to/some/*stuff/' ); + +will fail, since Test.pm considers the second argument to be a regex! +The best bet is to use the one-argument form: + + ok( $fileglob eq '/path/to/some/*stuff/' ); + +=item * + +C's use of string C can sometimes cause odd problems +when comparing numbers, especially if you're casting a string to a number: $foo = "1.0"; @@ -410,43 +642,117 @@ Your best bet is to use the single argument form: ok( $foo == 1 ); # ok "1.0" == 1 -ok()'s special handing of strings which look like they might be -regexes can also cause unexpected behavior. An innocent: +=item * - ok( $fileglob, '/path/to/some/*stuff/' ); +As you may have inferred from the above documentation and examples, +C's prototype is C<($;$$)> (and, incidentally, C's is +C<($;$$$)>). This means, for example, that you can do C +to compare the I of the two arrays. But don't be fooled into +thinking that C means a comparison of the contents of two +arrays -- you're comparing I the number of elements of each. It's +so easy to make that mistake in reading C that you might +want to be very explicit about it, and instead write C. -will fail since Test.pm considers the second argument to a regex. -Again, best bet is to use the single argument form: +=item * - ok( $fileglob eq '/path/to/some/*stuff/' ); +This almost definitely doesn't do what you expect: + + ok $thingy->can('some_method'); +Why? Because C returns a coderef to mean "yes it can (and the +method is this...)", and then C sees a coderef and thinks you're +passing a function that you want it to call and consider the truth of +the result of! I.e., just like: -=head1 TODO + ok $thingy->can('some_method')->(); -Add todo(). +What you probably want instead is this: -Allow named tests. + ok $thingy->can('some_method') && 1; -Implement noplan(). +If the C returns false, then that is passed to C. If it +returns true, then the larger expression S<< C<< +$thingy->can('some_method') && 1 >> >> returns 1, which C sees as +a simple signal of success, as you would expect. + + +=item * + +The syntax for C is about the only way it can be, but it's still +quite confusing. Just start with the above examples and you'll +be okay. + +Moreover, users may expect this: + + skip $unless_mswin, foo($bar), baz($quux); + +to not evaluate C and C when the test is being +skipped. But in reality, they I evaluated, but C just won't +bother comparing them if C<$unless_mswin> is true. + +You could do this: + + skip $unless_mswin, sub{foo($bar)}, sub{baz($quux)}; + +But that's not terribly pretty. You may find it simpler or clearer in +the long run to just do things like this: + + if( $^O =~ m/MSWin/ ) { + print "# Yay, we're under $^O\n"; + ok foo($bar), baz($quux); + ok thing($whatever), baz($stuff); + ok blorp($quux, $whatever); + ok foo($barzbarz), thang($quux); + } else { + print "# Feh, we're under $^O. Watch me skip some tests...\n"; + for(1 .. 4) { skip "Skip unless under MSWin" } + } + +But be quite sure that C is called exactly as many times in the +first block as C is called in the second block. + +=back + +=head1 NOTE + +A past developer of this module once said that it was no longer being +actively developed. However, rumors of its demise were greatly +exaggerated. Feedback and suggestions are quite welcome. + +Be aware that the main value of this module is its simplicity. Note +that there are already more ambitious modules out there, such as +L and L. =head1 SEE ALSO -L, L, L, L +L + +L, L, L -L is an interesting alternative testing library. +L for building your own testing library. + +L is an interesting XUnit-style testing library. + +L and L let you embed tests in code. =head1 AUTHOR Copyright (c) 1998-2000 Joshua Nathaniel Pritikin. All rights reserved. -Copyright (c) 2001 Michael G Schwern. -Current maintainer, Michael G Schwern +Copyright (c) 2001-2002 Michael G. Schwern. + +Copyright (c) 2002 Sean M. Burke. + +Current maintainer: Sean M. Burke. Esburke@cpan.orgE This package is free software and is provided "as is" without express or implied warranty. It may be used, redistributed and/or modified -under the terms of the Perl Artistic License (see -http://www.perl.com/perl/misc/Artistic.html) +under the same terms as Perl itself. =cut + +# "Your mistake was a hidden intention." +# -- /Oblique Strategies/, Brian Eno and Peter Schmidt