forked from mjgardner/test-class
/
Class.pm
1832 lines (1250 loc) · 60.9 KB
/
Class.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use strict;
use warnings;
use 5.006;
package Test::Class;
use Attribute::Handlers;
use Carp;
use MRO::Compat;
use Storable qw(dclone);
use Test::Builder;
use Test::Class::MethodInfo;
our $VERSION = '0.37';
my $Check_block_has_run;
{
no warnings 'void';
CHECK { $Check_block_has_run = 1 };
}
use constant NO_PLAN => "no_plan";
use constant SETUP => "setup";
use constant TEST => "test";
use constant TEARDOWN => "teardown";
use constant STARTUP => "startup";
use constant SHUTDOWN => "shutdown";
our $Current_method = undef;
sub current_method { $Current_method };
my $Builder = Test::Builder->new;
sub builder { $Builder };
my $Tests = {};
my @Filters = ();
my %_Test; # inside-out object field indexed on $self
sub DESTROY {
my $self = shift;
delete $_Test{ $self };
};
sub _test_info {
my $self = shift;
return ref($self) ? $_Test{$self} : $Tests;
};
sub _method_info {
my ($self, $class, $method) = @_;
return( _test_info($self)->{$class}->{$method} );
};
sub _methods_of_class {
my ( $self, $class ) = @_;
my $test_info = _test_info($self)
or die "Test::Class internals seem confused. Did you override "
. "new() in a sub-class or via multiple inheritence?\n";
return values %{ $test_info->{$class} };
};
sub _parse_attribute_args {
my $args = shift || '';
my $num_tests;
my $type;
$args =~ s/\s+//sg;
foreach my $arg (split /=>/, $args) {
if (Test::Class::MethodInfo->is_num_tests($arg)) {
$num_tests = $arg;
} elsif (Test::Class::MethodInfo->is_method_type($arg)) {
$type = $arg;
} else {
die 'bad attribute args';
};
};
return( $type, $num_tests );
};
sub _is_public_method {
my ($class, $name) = @_;
my @parents = @{mro::get_linear_isa($class)};
shift @parents;
foreach my $parent_class ( @parents ) {
return unless $parent_class->can( $name );
return if _method_info( $class, $parent_class, $name );
}
return 1;
}
sub Test : ATTR(CODE,RAWDATA) {
my ($class, $symbol, $code_ref, $attr, $args) = @_;
if ($symbol eq "ANON") {
warn "cannot test anonymous subs - you probably loaded a Test::Class too late (after the CHECK block was run). See 'A NOTE ON LOADING TEST CLASSES' in perldoc Test::Class for more details\n";
} else {
my $name = *{$symbol}{NAME};
warn "overriding public method $name with a test method in $class\n"
if _is_public_method( $class, $name );
eval { $class->add_testinfo($name, _parse_attribute_args($args)) }
|| warn "bad test definition '$args' in $class->$name\n";
};
};
sub Tests : ATTR(CODE,RAWDATA) {
my ($class, $symbol, $code_ref, $attr, $args) = @_;
$args ||= 'no_plan';
Test( $class, $symbol, $code_ref, $attr, $args );
};
sub add_testinfo {
my($class, $name, $type, $num_tests) = @_;
$Tests->{$class}->{$name} = Test::Class::MethodInfo->new(
name => $name,
num_tests => $num_tests,
type => $type,
);
}
sub _class_of {
my $self = shift;
return ref $self ? ref $self : $self;
}
sub new {
my $proto = shift;
my $class = _class_of( $proto );
$proto = {} unless ref($proto);
my $self = bless {%$proto, @_}, $class;
$_Test{$self} = dclone($Tests);
return($self);
};
sub _get_methods {
my ( $self, @types ) = @_;
my $test_class = _class_of( $self );
my $test_method_regexp = $ENV{ TEST_METHOD } || '.*';
my $method_regexp = eval { qr/\A$test_method_regexp\z/ };
die "TEST_METHOD ($test_method_regexp) is not a valid regexp: $@" if $@;
my %methods = ();
foreach my $class ( @{mro::get_linear_isa( $test_class )} ) {
FILTER:
foreach my $info ( _methods_of_class( $self, $class ) ) {
my $name = $info->name;
if ( $info->type eq TEST ) {
# determine if method is filtered, true if *any* filter
# returns false.
foreach my $filter ( @Filters ) {
next FILTER unless $filter->( $class, $name );
}
}
foreach my $type ( @types ) {
if ( $info->is_type( $type ) ) {
$methods{ $name } = 1
unless $type eq TEST && $name !~ $method_regexp;
}
};
};
};
my @methods = sort keys %methods;
return @methods;
};
sub _num_expected_tests {
my $self = shift;
if (my $reason = $self->SKIP_CLASS ) {
return $reason eq "1" ? 0 : 1;
};
my @test_methods = _get_methods($self, TEST);
return 0 unless @test_methods;
my @startup_shutdown_methods =
_get_methods($self, STARTUP, SHUTDOWN);
my $num_startup_shutdown_methods =
_total_num_tests($self, @startup_shutdown_methods);
return(NO_PLAN) if $num_startup_shutdown_methods eq NO_PLAN;
my @fixture_methods = _get_methods($self, SETUP, TEARDOWN);
my $num_fixture_tests = _total_num_tests($self, @fixture_methods);
return(NO_PLAN) if $num_fixture_tests eq NO_PLAN;
my $num_tests = _total_num_tests($self, @test_methods);
return(NO_PLAN) if $num_tests eq NO_PLAN;
return($num_startup_shutdown_methods + $num_tests + @test_methods * $num_fixture_tests);
};
sub expected_tests {
my $total = 0;
foreach my $test (@_) {
if ( _isa_class( __PACKAGE__, $test ) ) {
my $n = _num_expected_tests($test);
return NO_PLAN if $n eq NO_PLAN;
$total += $n;
} elsif ( defined $test && $test =~ m/^\d+$/ ) {
$total += $test;
} else {
$test = 'undef' unless defined $test;
croak "$test is not a Test::Class or an integer";
};
};
return $total;
};
sub _total_num_tests {
my ($self, @methods) = @_;
my $class = _class_of( $self );
my $total_num_tests = 0;
foreach my $method (@methods) {
foreach my $class (@{mro::get_linear_isa($class)}) {
my $info = _method_info($self, $class, $method);
next unless $info;
my $num_tests = $info->num_tests;
return(NO_PLAN) if ($num_tests eq NO_PLAN);
$total_num_tests += $num_tests;
last unless $num_tests =~ m/^\+/
};
};
return($total_num_tests);
};
sub _has_no_tests {
my ( $self, $method ) = @_;
return _total_num_tests( $self, $method ) eq '0';
}
sub _all_ok_from {
my ($self, $start_test) = @_;
# The Test::Builder 1.5 way to do it
if( $Builder->can("history") ) {
return $Builder->history->can_succeed;
}
# The Test::Builder 0.x way to do it
else {
my $current_test = $Builder->current_test;
return(1) if $start_test == $current_test;
my @results = ($Builder->summary)[$start_test .. $current_test-1];
foreach my $result (@results) { return(0) unless $result };
return(1);
}
};
sub _exception_failure {
my ($self, $method, $exception, $tests) = @_;
local $Test::Builder::Level = 3;
my $message = $method;
$message .= " (for test method '$Current_method')"
if defined $Current_method && $method ne $Current_method;
_show_header($self, @$tests);
$Builder->ok(0, "$message died ($exception)");
_threw_exception( $self, $method => 1 );
};
my %threw_exception;
sub _threw_exception {
my ( $self, $method, $optional_value) = @_;
my $class = ref( $self );
$threw_exception{ $class }{ $method } = $optional_value
if defined $optional_value;
return $threw_exception{ $class }{ $method };
}
sub _run_method {
my ($self, $method, $tests) = @_;
_threw_exception( $self, $method => 0 );
my $num_start = $Builder->current_test;
my $skip_reason;
my $original_ok = \&Test::Builder::ok;
no warnings;
local *Test::Builder::ok = sub {
my ($builder, $test, $description) = @_;
local $Test::Builder::Level = $Test::Builder::Level+1;
unless ( defined($description) ) {
$description = $self->current_method;
$description =~ tr/_/ /;
};
my $is_ok = $original_ok->($builder, $test, $description);
unless ( $is_ok ) {
my $class = ref $self;
$Builder->diag( " (in $class->$method)" );
};
return $is_ok;
};
$skip_reason = eval {$self->$method};
$skip_reason = $method unless $skip_reason;
my $exception = $@;
chomp($exception) if $exception;
my $num_done = $Builder->current_test - $num_start;
my $num_expected = _total_num_tests($self, $method);
$num_expected = $num_done if $num_expected eq NO_PLAN;
if ($num_done == $num_expected) {
_exception_failure($self, $method, $exception, $tests)
unless $exception eq '';
} elsif ($num_done > $num_expected) {
my $class = ref $self;
$Builder->diag("expected $num_expected test(s) in $class\::$method, $num_done completed\n");
} else {
until (($Builder->current_test - $num_start) >= $num_expected) {
if ($exception ne '') {
_exception_failure($self, $method, $exception, $tests);
$skip_reason = "$method died";
$exception = '';
} else {
if ($self->fail_if_returned_early) {
my $class = ref $self;
$Builder->ok(0, "($class\::$method returned before plan complete)");
} else {
$Builder->skip( $skip_reason );
}
};
};
};
return(_all_ok_from($self, $num_start));
};
sub fail_if_returned_early { 0 }
sub _show_header {
my ($self, @tests) = @_;
return if $Builder->has_plan;
my $num_tests = Test::Class->expected_tests(@tests);
if ($num_tests eq NO_PLAN) {
$Builder->no_plan;
} else {
$Builder->expected_tests($num_tests);
};
};
my %SKIP_THIS_CLASS = ();
sub SKIP_CLASS {
my $class = shift;
$SKIP_THIS_CLASS{ $class } = shift if @_;
return $SKIP_THIS_CLASS{ $class };
};
sub _isa_class {
my ( $class, $object_or_class ) = @_;
return unless defined $object_or_class;
return if $object_or_class eq 'Contextual::Return::Value';
return eval {
$object_or_class->isa( $class ) and $object_or_class->can( 'runtests' )
};
}
sub _test_classes {
my $class = shift;
return( @{mro::get_isarev($class)}, $class );
};
sub runtests {
die "Test::Class was loaded too late (after the CHECK block was run). See 'A NOTE ON LOADING TEST CLASSES' in perldoc Test::Class for more details\n"
unless $Check_block_has_run;
my @tests = @_;
if (@tests == 1 && !ref($tests[0])) {
my $base_class = shift @tests;
@tests = _test_classes( $base_class );
};
my $all_passed = 1;
TEST_OBJECT: foreach my $t (@tests) {
# SHOULD ALSO ALLOW NO_PLAN
next if $t =~ m/^\d+$/;
croak "$t is not Test::Class or integer"
unless _isa_class( __PACKAGE__, $t );
if (my $reason = $t->SKIP_CLASS) {
_show_header($t, @tests);
$Builder->skip( $reason ) unless $reason eq "1";
} else {
$t = $t->new unless ref($t);
my @test_methods = _get_methods($t, TEST);
if ( @test_methods ) {
foreach my $method (_get_methods($t, STARTUP)) {
_show_header($t, @tests) unless _has_no_tests($t, $method);
my $method_passed = _run_method($t, $method, \@tests);
$all_passed = 0 unless $method_passed;
next TEST_OBJECT unless $method_passed;
};
my $class = ref($t);
my @setup = _get_methods($t, SETUP);
my @teardown = _get_methods($t, TEARDOWN);
foreach my $test ( @test_methods ) {
local $Current_method = $test;
$Builder->diag("\n$class->$test") if $ENV{TEST_VERBOSE};
my @methods_to_run = (@setup, $test, @teardown);
while ( my $method = shift @methods_to_run ) {
_show_header($t, @tests) unless _has_no_tests($t, $method);
$all_passed = 0 unless _run_method($t, $method, \@tests);
if ( _threw_exception( $t, $method ) ) {
my $num_to_skip = _total_num_tests($t, @methods_to_run);
$Builder->skip( "$method died" ) for ( 1 .. $num_to_skip );
last;
};
};
};
foreach my $method (_get_methods($t, SHUTDOWN)) {
_show_header($t, @tests) unless _has_no_tests($t, $method);
$all_passed = 0 unless _run_method($t, $method, \@tests);
}
}
}
}
return($all_passed);
};
sub _find_calling_test_class {
my $level = 0;
while (my $class = caller(++$level)) {
next if $class eq __PACKAGE__;
return $class if _isa_class( __PACKAGE__, $class );
};
return(undef);
};
sub num_method_tests {
my ($self, $method, $n) = @_;
my $class = _find_calling_test_class( $self )
or croak "not called in a Test::Class";
my $info = _method_info($self, $class, $method)
or croak "$method is not a test method of class $class";
$info->num_tests($n) if defined($n);
return( $info->num_tests );
};
sub num_tests {
my $self = shift;
croak "num_tests need to be called within a test method"
unless defined $Current_method;
return( $self->num_method_tests( $Current_method, @_ ) );
};
sub BAILOUT {
my ($self, $reason) = @_;
$Builder->BAILOUT($reason);
};
sub _last_test_if_exiting_immediately {
$Builder->expected_tests || $Builder->current_test+1
};
sub FAIL_ALL {
my ($self, $reason) = @_;
my $last_test = _last_test_if_exiting_immediately();
$Builder->expected_tests( $last_test ) unless $Builder->has_plan;
$Builder->ok(0, $reason) until $Builder->current_test >= $last_test;
my $num_failed = $Builder->can("history")
? $Builder->history->fail_count : grep( !$_, $Builder->summary );
exit( $num_failed < 254 ? $num_failed : 254 );
};
sub SKIP_ALL {
my ($self, $reason) = @_;
$Builder->skip_all( $reason ) unless $Builder->has_plan;
my $last_test = _last_test_if_exiting_immediately();
$Builder->skip( $reason )
until $Builder->current_test >= $last_test;
exit(0);
}
sub add_filter {
my ( $class, $cb ) = @_;
if ( not ref $cb eq 'CODE' ) {
croak "Filter isn't a code-ref"
}
push @Filters, $cb;
}
1;
__END__
=head1 NAME
Test::Class - Easily create test classes in an xUnit/JUnit style
=head1 SYNOPSIS
package Example::Test;
use base qw(Test::Class);
use Test::More;
# setup methods are run before every test method.
sub make_fixture : Test(setup) {
my $array = [1, 2];
shift->{test_array} = $array;
};
# a test method that runs 1 test
sub test_push : Test {
my $array = shift->{test_array};
push @$array, 3;
is_deeply($array, [1, 2, 3], 'push worked');
};
# a test method that runs 4 tests
sub test_pop : Test(4) {
my $array = shift->{test_array};
is(pop @$array, 2, 'pop = 2');
is(pop @$array, 1, 'pop = 1');
is_deeply($array, [], 'array empty');
is(pop @$array, undef, 'pop = undef');
};
# teardown methods are run after every test method.
sub teardown : Test(teardown) {
my $array = shift->{test_array};
diag("array = (@$array) after test(s)");
};
later in a nearby .t file
#! /usr/bin/perl
use Example::Test;
# run all the test methods in Example::Test
Test::Class->runtests;
Outputs:
1..5
ok 1 - pop = 2
ok 2 - pop = 1
ok 3 - array empty
ok 4 - pop = undef
# array = () after test(s)
ok 5 - push worked
# array = (1 2 3) after test(s)
=head1 DESCRIPTION
Test::Class provides a simple way of creating classes and objects to test your code in an xUnit style.
Built using L<Test::Builder>, it was designed to work with other Test::Builder based modules (L<Test::More>, L<Test::Differences>, L<Test::Exception>, etc.).
I<Note:> This module will make more sense, if you are already familiar with the "standard" mechanisms for testing perl code. Those unfamiliar with L<Test::Harness>, L<Test::Simple>, L<Test::More> and friends should go take a look at them now. L<Test::Tutorial> is a good starting point.
=head1 INTRODUCTION
=head2 A brief history lesson
In 1994 Kent Beck wrote a testing framework for Smalltalk called SUnit. It was popular. You can read a copy of his original paper at L<http://www.xprogramming.com/testfram.htm>.
Later Kent Beck and Erich Gamma created JUnit for testing Java L<http://www.junit.org/>. It was popular too.
Now there are xUnit frameworks for every language from Ada to XSLT. You can find a list at L<http://www.xprogramming.com/software.htm>.
While xUnit frameworks are traditionally associated with unit testing they are also useful in the creation of functional/acceptance tests.
Test::Class is (yet another) implementation of xUnit style testing in Perl.
=head2 Why you should use Test::Class
Test::Class attempts to provide simple xUnit testing that integrates simply with the standard perl *.t style of testing. In particular:
=over 4
=item *
All the advantages of xUnit testing. You can easily create test fixtures and isolate tests. It provides a framework that should be familiar to people who have used other xUnit style test systems.
=item *
It is built with L<Test::Builder> and should co-exist happily with all other Test::Builder based modules. This makes using test classes in *.t scripts, and refactoring normal tests into test classes, much simpler because:
=over 4
=item *
You do not have to learn a new set of new test APIs and can continue using ok(), like(), etc. from L<Test::More> and friends.
=item *
Skipping tests and todo tests are supported.
=item *
You can have normal tests and Test::Class classes co-existing in the same *.t script. You don't have to re-write an entire script, but can use test classes as and when it proves useful.
=back
=item *
You can easily package your tests as classes/modules, rather than *.t scripts. This simplifies reuse, documentation and distribution, encourages refactoring, and allows tests to be extended by inheritance.
=item *
You can have multiple setup/teardown methods. For example have one teardown method to clean up resources and another to check that class invariants still hold.
=item *
It can make running tests faster. Once you have refactored your *.t scripts into classes they can be easily run from a single script. This gains you the (often considerable) start up time that each separate *.t script takes.
=back
=head2 Why you should I<not> use Test::Class
=over 4
=item *
If your *.t scripts are working fine then don't bother with Test::Class. For simple test suites it is almost certainly overkill. Don't start thinking about using Test::Class until issues like duplicate code in your test scripts start to annoy.
=item *
If you are distributing your code it is yet another module that the user has to have to run your tests (unless you distribute it with your test suite of course).
=item *
If you are used to the TestCase/Suite/Runner class structure used by JUnit and similar testing frameworks you may find Test::Unit more familiar (but try reading L</"HELP FOR CONFUSED JUNIT USERS"> before you give up).
=back
=head1 TEST CLASSES
A test class is just a class that inherits from Test::Class. Defining a test class is as simple as doing:
package Example::Test;
use base qw(Test::Class);
Since Test::Class does not provide its own test functions, but uses those provided by L<Test::More> and friends, you will nearly always also want to have:
use Test::More;
to import the test functions into your test class.
=head1 METHOD TYPES
There are three different types of method you can define using Test::Class.
=head2 1) Test methods
You define test methods using the L<Test|/"Test"> attribute. For example:
package Example::Test;
use base qw(Test::Class);
use Test::More;
sub subtraction : Test {
is( 2-1, 1, 'subtraction works );
};
This declares the C<subtraction> method as a test method that runs one test.
If your test method runs more than one test, you should put the number of tests in brackets like this:
sub addition : Test(2) {
is(10 + 20, 30, 'addition works');
is(20 + 10, 30, ' both ways');
};
If you don't know the number of tests at compile time you can use C<no_plan> like this.
sub check_class : Test(no_plan) {
my $objects = shift->{objects};
isa_ok($_, "Object") foreach @$objects;
};
or use the :Tests attribute, which acts just like C<:Test> but defaults to C<no_plan> if no number is given:
sub check_class : Tests {
my $objects = shift->{objects};
isa_ok($_, "Object") foreach @$objects;
};
=head2 2) Setup and teardown methods
Setup and teardown methods are run before and after every test. For example:
sub before : Test(setup) { diag("running before test") };
sub after : Test(teardown) { diag("running after test") };
You can use setup and teardown methods to create common objects used by all of your test methods (a test I<fixture>) and store them in your Test::Class object, treating it as a hash. For example:
sub pig : Test(setup) {
my $self = shift;
$self->{test_pig} = Pig->new;
};
sub born_hungry : Test {
my $pig = shift->{test_pig};
is($pig->hungry, 'pigs are born hungry');
};
sub eats : Test(3) {
my $pig = shift->{test_pig};
ok( $pig->feed, 'pig fed okay');
ok(! $pig->hungry, 'fed pig not hungry');
ok(! $pig->feed, 'cannot feed full pig');
};
You can also declare setup and teardown methods as running tests. For example you could check that the test pig survives each test method by doing:
sub pig_alive : Test(teardown => 1) {
my $pig = shift->{test_pig};
ok($pig->alive, 'pig survived tests' );
};
=head2 3) Startup and shutdown methods
Startup and shutdown methods are like setup and teardown methods for the whole test class. All the startup methods are run once when you start running a test class. All the shutdown methods are run once just before a test class stops running.
You can use these to create and destroy expensive objects that you don't want to have to create and destroy for every test - a database connection for example:
sub db_connect : Test(startup) {
shift->{dbi} = DBI->connect;
};
sub db_disconnect : Test(shutdown) {
shift->{dbi}->disconnect;
};
Just like setup and teardown methods you can pass an optional number of tests to startup and shutdown methods. For example:
sub example : Test(startup => 1) {
ok(1, 'a startup method with one test');
};
If a startup method has a failing test or throws an exception then all other tests for the current test object are ignored.
=head1 RUNNING TESTS
You run test methods with L<runtests()|"runtests">. Doing:
Test::Class->runtests
runs all of the test methods in every loaded test class. This allows you to easily load multiple test classes in a *.t file and run them all.
#! /usr/bin/perl
# load all the test classes I want to run
use Foo::Test;
use Foo::Bar::Test;
use Foo::Fribble::Test;
use Foo::Ni::Test;
# and run them all
Test::Class->runtests;
You can use L<Test::Class::Load> to automatically load all the test classes in a given set of directories.
If you need finer control you can create individual test objects with L<new()|"new">. For example to just run the tests in the test class C<Foo::Bar::Test> you can do:
Example::Test->new->runtests
You can also pass L<runtests()|/"runtests"> a list of test objects to run. For example:
my $o1 = Example::Test->new;
my $o2 = Another::Test->new;
# runs all the tests in $o1 and $o2
$o1->runtests($o2);
Since, by definition, the base Test::Class has no tests you could also have written:
my $o1 = Example::Test->new;
my $o2 = Another::Test->new;
Test::Class->runtests($o1, $o2);
If you pass L<runtests()|/"runtests"> class names it will automatically create test objects for you, so the above can be written more compactly as:
Test::Class->runtests(qw( Example::Test Another::Test ))
In all of the above examples L<runtests()|/"runtests"> will look at the number of tests both test classes run and output an appropriate test header for L<Test::Harness> automatically.
What happens if you run test classes and normal tests in the same script? For example:
Test::Class->runtests;
ok(Example->new->foo, 'a test not in the test class');
ok(Example->new->bar, 'ditto');
L<Test::Harness> will complain that it saw more tests than it expected since the test header output by L<runtests()|/"runtests"> will not include the two normal tests.
To overcome this problem you can pass an integer value to L<runtests()|/"runtests">. This is added to the total number of tests in the test header. So the problematic example can be rewritten as follows:
Test::Class->runtests(+2);
ok(Example->new->foo, 'a test not in the test class');
ok(Example->new->bar, 'ditto');
If you prefer to write your test plan explicitly you can use L<expected_tests()|/"expected_tests"> to find out the number of tests a class/object is expected to run.
Since L<runtests()|/"runtests"> will not output a test plan if one has already been set the previous example can be written as:
plan tests => Test::Class->expected_tests(+2);
Test::Class->runtests;
ok(Example->new->foo, 'a test not in the test class');
ok(Example->new->bar, 'ditto');
I<Remember:> Test objects are just normal perl objects. Test classes are just normal perl classes. Setup, test and teardown methods are just normal methods. You are completely free to have other methods in your class that are called from your test methods, or have object specific C<new> and C<DESTROY> methods.
In particular you can override the new() method to pass parameters to your test object, or re-define the number of tests a method will run. See L<num_method_tests()|/"num_method_tests"> for an example.
=head1 TEST DESCRIPTIONS
The test functions you import from L<Test::More> and other L<Test::Builder> based modules usually take an optional third argument that specifies the test description, for example:
is $something, $something_else, 'a description of my test';
If you do not supply a test description, and the test function does not supply its own default, then Test::Class will use the name of the currently running test method, replacing all "_" characters with spaces so:
sub one_plus_one_is_two : Test {
is 1+1, 2;
}
will result in:
ok 1 - one plus one is two
=head1 RUNNING ORDER OF METHODS
Methods of each type are run in the following order:
=over 4
=item 1.
All of the startup methods in alphabetical order
=item 2.
For each test method, in alphabetical order:
=over 2
=item *
All of the setup methods in alphabetical order
=item *
The test method.
=item *
All of the teardown methods in alphabetical order
=back
=item 3.
All of the shutdown methods in alphabetical order.
=back
Most of the time you should not care what order tests are run in, but it can occasionally be useful to force some test methods to be run early. For example:
sub _check_new {
my $self = shift;
isa_ok(Object->new, "Object") or $self->BAILOUT('new fails!');
};
The leading C<_> will force the above method to run first - allowing the entire suite to be aborted before any other test methods run.
=head1 HANDLING EXCEPTIONS
If a startup, setup, test, teardown or shutdown method dies then L<runtests()|/"runtests"> will catch the exception and fail any remaining test. For example:
sub test_object : Test(2) {
my $object = Object->new;
isa_ok( $object, "Object" ) or die "could not create object\n";
ok( $object->open, "open worked" );
};
will produce the following if the first test failed:
not ok 1 - The object isa Object
# Failed test 'The object isa Object'
# at /Users/adrianh/Desktop/foo.pl line 14.
# (in MyTest->test_object)
# The object isn't defined
not ok 2 - test_object died (could not create object)
# Failed test 'test_object died (could not create object)'
# at /Users/adrianh/Desktop/foo.pl line 19.
# (in MyTest->test_object)
This can considerably simplify testing code that throws exceptions.
Rather than having to explicitly check that the code exited normally (e.g. with L<Test::Exception/"lives_ok">) the test will fail automatically - without aborting the other test methods. For example contrast:
use Test::Exception;
my $file;
lives_ok { $file = read_file('test.txt') } 'file read';
is($file, "content", 'test file read');
with:
sub read_file : Test {
is(read_file('test.txt'), "content", 'test file read');
};
If more than one test remains after an exception then the first one is failed, and the remaining ones are skipped.
If the setup method of a test method dies, then all of the remaining setup and shutdown methods are also skipped.
Since startup methods will usually be creating state needed by all the other test methods an exception within a startup method will prevent all other test methods of that class running.
=head1 RETURNING EARLY
If a test method returns before it has run all of its tests, by default the missing tests are deemed to have been skipped; see L<"Skipped Tests"> for more information.
However, if the class's C<fail_if_returned_early> method returns true, then the missing tests will be deemed to have failed. For example,
package MyClass;
use base 'Test::Class';
sub fail_if_returned_early { 1 }
sub oops : Tests(8) {
for (my $n=1; $n*$n<50; ++$n) {
ok 1, "$n squared is less than fifty";
}
}
=head1 SKIPPED TESTS
You can skip the rest of the tests in a method by returning from the method before all the test have finished running (but see L<"Returning Early"> for how to change this). The value returned is used as the reason for the tests being skipped.
This makes managing tests that can be skipped for multiple reasons very simple. For example:
sub flying_pigs : Test(5) {
my $pig = Pig->new;
isa_ok($pig, 'Pig') or return("cannot breed pigs")
can_ok($pig, 'takeoff') or return("pigs don't fly here");
ok($pig->takeoff, 'takeoff') or return("takeoff failed");
ok( $pig->altitude > 0, 'Pig is airborne' );
ok( $pig->airspeed > 0, ' and moving' );
};
If you run this test in an environment where C<Pig-E<gt>new> worked and the takeoff method existed, but failed when ran, you would get:
ok 1 - The object isa Pig
ok 2 - can takeoff
not ok 3 - takeoff
ok 4 # skip takeoff failed
ok 5 # skip takeoff failed
You can also skip tests just as you do in Test::More or Test::Builder - see L<Test::More/"Conditional tests"> for more information.
I<Note:> if you want to skip tests in a method with C<no_plan> tests then you have to explicitly skip the tests in the method - since Test::Class cannot determine how many tests (if any) should be skipped:
sub test_objects : Tests {
my $self = shift;
my $objects = $self->{objects};
if (@$objects) {
isa_ok($_, "Object") foreach (@$objects);
} else {
$self->builder->skip("no objects to test");
};
};
Another way of overcoming this problem is to explicitly set the number of tests for the method at run time using L<num_method_tests()|/"num_method_tests"> or L<"num_tests">.
You can make a test class skip all of its tests by setting L<SKIP_CLASS()|SKIP_CLASS> before L<runtests()|"runtests"> is called.
=head1 TO DO TESTS
You can create todo tests just as you do in L<Test::More> and L<Test::Builder> using the C<$TODO> variable. For example:
sub live_test : Test {
local $TODO = "live currently unimplemented";
ok(Object->live, "object live");
};
See L<Test::Harness/"Todo tests"> for more information.
=head1 EXTENDING TEST CLASSES BY INHERITANCE
You can extend test methods by inheritance in the usual way. For example consider the following test class for a C<Pig> object.
package Pig::Test;
use base qw(Test::Class);
use Test::More;
sub testing_class { "Pig" };
sub new_args { (-age => 3) };
sub setup : Test(setup) {
my $self = shift;
my $class = $self->testing_class;
my @args = $self->new_args;
$self->{pig} = $class->new( @args );