1 package VPIT::TestHelpers;
14 use VPIT::TestHelpers (
15 feature1 => \@feature1_args,
16 feature2 => \@feature2_args,
22 my ($subs, $pkg) = @_;
24 while (my ($name, $code) = each %$subs) {
26 *{$pkg.'::'.$name} = $code;
35 if (defined $prefix) {
36 if (length $prefix and $prefix !~ /_$/) {
46 my %default_exports = (
47 load_or_skip => \&load_or_skip,
48 load_or_skip_all => \&load_or_skip_all,
49 skip_all => \&skip_all,
53 threads => \&init_threads,
54 usleep => \&init_usleep,
55 run_perl => \&init_run_perl,
56 capture => \&init_capture,
63 my %exports = %default_exports;
65 for (my $i = 0; $i <= $#opts; ++$i) {
66 my $feature = $opts[$i];
67 next unless defined $feature;
70 if ($i < $#opts and defined $opts[$i+1] and ref $opts[$i+1] eq 'ARRAY') {
77 my $handler = $features{$feature};
78 die "Unknown feature '$feature'" unless defined $handler;
80 my %syms = $handler->(@$args);
82 $exports{$_} = $syms{$_} for sort keys %syms;
85 export_to_pkg \%exports => scalar caller;
92 if ($INC{'Test/Leaner.pm'}) {
93 $stash = \%Test::Leaner::;
96 $stash = \%Test::More::;
99 my $glob = $stash->{$sub};
100 return $glob ? *$glob{CODE} : undef;
103 sub skip { $test_sub->('skip')->(@_) }
105 sub skip_all { $test_sub->('plan')->(skip_all => $_[0]) }
108 my $diag = $test_sub->('diag');
116 my ($pkg, $ver, $imports) = @_;
118 my $spec = $ver && $ver !~ /^[0._]*$/ ? "$pkg $ver" : $pkg;
122 if (eval "use $spec (); 1") {
123 $ver = do { no strict 'refs'; ${"${pkg}::VERSION"} };
124 $ver = 'undef' unless defined $ver;
127 my @imports = @$imports;
128 my $caller = (caller 1)[0];
130 my $res = eval <<"IMPORTER";
133 BEGIN { \$pkg->import(\@imports) }
136 $err = "Could not import '@imports' from $pkg $ver: $@" unless $res;
139 (my $file = "$pkg.pm") =~ s{::}{/}g;
141 $err = "Could not load $spec";
145 return wantarray ? (0, $err) : 0;
147 diag "Using $pkg $ver";
153 my ($pkg, $ver, $imports, $tests) = @_;
155 die 'You must specify how many tests to skip' unless defined $tests;
157 my ($loaded, $err) = load($pkg, $ver, $imports);
158 skip $err => $tests unless $loaded;
163 sub load_or_skip_all {
164 my ($pkg, $ver, $imports) = @_;
166 my ($loaded, $err) = load($pkg, $ver, $imports);
167 skip_all $err unless $loaded;
182 use VPIT::TestHelpers run_perl => [ $p ]
190 C<$p> is prefixed to the constants exported by this feature (defaults to C<''>).
218 C<run_perl_file $file>
222 C<RUN_PERL_FAILED> (possibly prefixed by C<$p>)
230 sub fresh_perl_env (&) {
233 my ($SystemRoot, $PATH) = @ENV{qw<SystemRoot PATH>};
234 my $ld_name = $Config::Config{ldlibpthname};
235 my $ldlibpth = $ENV{$ld_name};
238 $ENV{$ld_name} = $ldlibpth if defined $ldlibpth;
239 $ENV{SystemRoot} = $SystemRoot if $^O eq 'MSWin32' and defined $SystemRoot;
240 $ENV{PATH} = $PATH if $^O eq 'cygwin' and defined $PATH;
243 unless (-e $perl and -x $perl) {
244 $perl = $Config::Config{perlpath};
245 unless (-e $perl and -x $perl) {
250 return $handler->($perl, '-T', map("-I$_", @INC));
254 my $p = sanitize_prefix(shift);
256 # This is only required for run_perl_file(), so it is not needed for the
257 # threads feature which only calls run_perl() - don't forget to update its
258 # requirements if this ever changes.
262 run_perl => \&run_perl,
263 run_perl_file => \&run_perl_file,
264 "${p}RUN_PERL_FAILED" => sub () { 'Could not execute perl subprocess' },
272 die 'Double quotes in evaluated code are not portable';
276 my ($perl, @perl_args) = @_;
277 system { $perl } $perl, @perl_args, '-e', $code;
284 $file = File::Spec->rel2abs($file);
285 unless (-e $file and -r _) {
286 die 'Could not run perl file';
290 my ($perl, @perl_args) = @_;
291 system { $perl } $perl, @perl_args, $file;
303 use VPIT::TestHelpers capture => [ $p ];
311 C<$p> is prefixed to the constants exported by this feature (defaults to C<''>).
339 On MSWin32 : L<Socket>
355 C<CAPTURE_FAILED $details> (possibly prefixed by C<$p>)
359 C<capture_perl $code>
363 C<CAPTURE_PERL_FAILED $details> (possibly prefixed by C<$p>)
372 my $p = sanitize_prefix(shift);
374 skip_all 'Cannot capture output on VMS' if $^O eq 'VMS';
375 skip_all 'Cannot capture output on OS/2' if $^O eq 'os2';
377 load_or_skip_all 'IO::Handle', '0', [ ];
378 load_or_skip_all 'IO::Select', '0', [ ];
379 load_or_skip_all 'IPC::Open3', '0', [ ];
380 if ($^O eq 'MSWin32') {
381 load_or_skip_all 'Socket', '0', [ ];
385 capture => \&capture,
386 "${p}CAPTURE_FAILED" => \&capture_failed_msg,
387 capture_perl => \&capture_perl,
388 "${p}CAPTURE_PERL_FAILED" => \&capture_perl_failed_msg,
392 # Inspired from IPC::Cmd
397 my $want = wantarray;
401 my $ext_err = $^O eq 'MSWin32' ? $^E : undef;
404 my $args = join ', ', @_;
406 my $msg = "$syscall($args) failed: ";
409 no warnings 'numeric';
410 my ($err_code, $err_str) = (int $err, "$err");
411 $msg .= "$err_str ($err_code)";
414 if (defined $ext_err) {
415 no warnings 'numeric';
416 my ($ext_err_code, $ext_err_str) = (int $ext_err, "$ext_err");
417 $msg .= ", $ext_err_str ($ext_err_code)";
423 my ($status, $content_out, $content_err);
427 my ($pid, $out, $err);
429 if ($^O eq 'MSWin32') {
431 socketpair $_[0], $_[1],
432 &Socket::AF_UNIX, &Socket::SOCK_STREAM, &Socket::PF_UNSPEC
433 or $fail->(qw<socketpair reader writer>);
434 shutdown $_[0], 1 or $fail->(qw<shutdown reader>);
435 shutdown $_[1], 0 or $fail->(qw<shutdown writer>);
438 local (*IN_R, *IN_W);
439 local (*OUT_R, *OUT_W);
440 local (*ERR_R, *ERR_W);
441 $pipe->(*IN_R, *IN_W);
442 $pipe->(*OUT_R, *OUT_W);
443 $pipe->(*ERR_R, *ERR_W);
445 $pid = IPC::Open3::open3('>&IN_R', '<&OUT_W', '<&ERR_W', @cmd);
447 close *IN_W or $fail->(qw<close input>);
451 my $in = IO::Handle->new;
452 $out = IO::Handle->new;
454 $err = IO::Handle->new;
457 $pid = IPC::Open3::open3($in, $out, $err, @cmd);
462 # Forward signals to the child (except SIGKILL)
464 foreach my $s (keys %SIG) {
465 $sig_handlers{$s} = sub {
467 $SIG{$s} = $sig_handlers{$s};
470 local $SIG{$_} = $sig_handlers{$_} for keys %SIG;
473 close $out or $fail->(qw<close output>);
474 close $err or $fail->(qw<close error>);
480 my $sel = IO::Select->new();
481 $sel->add($out, $err);
483 my $fd_out = fileno $out;
484 my $fd_err = fileno $err;
487 $contents{$fd_out} = '';
488 $contents{$fd_err} = '';
490 while (my @ready = $sel->can_read) {
491 for my $fh (@ready) {
493 my $bytes_read = sysread $fh, $buf, 4096;
494 if (not defined $bytes_read) {
495 $fail->('sysread', 'fd(' . fileno($fh) . ')');
496 } elsif ($bytes_read) {
497 $contents{fileno($fh)} .= $buf;
500 close $fh or $fail->('close', 'fd(' . fileno($fh) . ')');
501 last unless $sel->count;
509 if ($^O eq 'MSWin32') {
510 # Manual CRLF translation that couldn't be done with sysread.
511 s/\x0D\x0A/\n/g for values %contents;
514 $content_out = $contents{$fd_out};
515 $content_err = $contents{$fd_err};
520 if ("$]" < 5.014 and $ok and ($status >> 8) == 255 and defined $content_err
521 and $content_err =~ /^open3/) {
522 # Before perl commit 8960aa87 (between 5.12 and 5.14), exceptions in open3
523 # could be reported to STDERR instead of being propagated, so work around
530 return ($status, $content_out, $content_err);
534 return (undef, $err);
538 sub capture_failed_msg {
541 my $msg = 'Could not capture command output';
542 $msg .= " ($details)" if defined $details;
551 die 'Double quotes in evaluated code are not portable';
556 capture @perl, '-e', $code;
560 sub capture_perl_failed_msg {
563 my $msg = 'Could not capture perl output';
564 $msg .= " ($details)" if defined $details;
577 use VPIT::TestHelpers threads => [
578 $pkg, $threadsafe_var, $force_var
587 C<$pkg> is the target package name that will be exercised by this test ;
591 C<$threadsafe_var> is the name of an optional variable in C<$pkg> that evaluates to true if and only if the module claims to be thread safe (not checked if either C<$threadsafe_var> or C<$pkg> is C<undef>) ;
595 C<$force_var> is the name of the environment variable that can be used to force the thread tests (defaults to C<PERL_FORCE_TEST_THREADS>).
619 L<threads::shared> 1.14
643 C<< exit => 'threads_only' >> is passed to C<< threads->import >>.
652 my ($pkg, $threadsafe_var, $force_var) = @_;
654 skip_all 'This perl wasn\'t built to support threads'
655 unless $Config::Config{useithreads};
657 if (defined $pkg and defined $threadsafe_var) {
659 # run_perl() doesn't actually require anything
660 my $stat = run_perl("require POSIX; require $pkg; exit($threadsafe_var ? POSIX::EXIT_SUCCESS() : POSIX::EXIT_FAILURE())");
663 my $res = $stat >> 8;
664 if ($res == POSIX::EXIT_SUCCESS()) {
666 } elsif ($res == POSIX::EXIT_FAILURE()) {
670 if (not defined $threadsafe) {
671 skip_all "Could not detect if $pkg is thread safe or not";
672 } elsif (not $threadsafe) {
673 skip_all "This $pkg is not thread safe";
677 $force_var = 'PERL_FORCE_TEST_THREADS' unless defined $force_var;
678 my $force = $ENV{$force_var} ? 1 : !1;
679 skip_all 'perl 5.13.4 required to test thread safety'
680 unless $force or "$]" >= 5.013_004;
682 unless ($INC{'threads.pm'}) {
684 if ($INC{'Test/Leaner.pm'}) {
685 $test_module = 'Test::Leaner';
686 } elsif ($INC{'Test/More.pm'}) {
687 $test_module = 'Test::More';
689 die "$test_module was loaded too soon" if defined $test_module;
692 load_or_skip_all 'threads', $force ? '0' : '1.67', [
693 exit => 'threads_only',
695 load_or_skip_all 'threads::shared', $force ? '0' : '1.14', [ ];
697 diag "Threads testing forced by \$ENV{$force_var}" if $force;
699 return spawn => \&spawn;
706 local $SIG{__WARN__} = sub { push @diag, "Thread creation warning: @_" };
709 push @diag, "Thread creation error: $@" if $@;
711 return $thread ? $thread : ();
722 use VPIT::TestHelpers 'usleep' => [ @impls ];
730 C<@impls> is the list of desired implementations (which may be C<'Time::HiRes'>, C<'select'> or C<'sleep'>), in the order they should be checked.
731 When the list is empty, it defaults to all of them.
747 C<usleep $microseconds>
759 'Time::HiRes' => sub {
760 if (do { local $@; eval { require Time::HiRes; 1 } }) {
761 defined and diag "Using usleep() from Time::HiRes $_"
762 for $Time::HiRes::VERSION;
763 return \&Time::HiRes::usleep;
769 if ($Config::Config{d_select}) {
770 diag 'Using select()-based fallback usleep()';
775 my ($found, $t) = select(undef, undef, undef, $s / 1e6);
776 last unless defined $t;
788 diag 'Using sleep()-based fallback usleep()';
791 my $s = int($ms / 1e6) + ($ms % 1e6 == 0 ? 0 : 1);
798 @impls = qw<Time::HiRes select sleep> unless @impls;
801 for my $impl (@impls) {
802 next unless defined $impl and $impls{$impl};
803 $usleep = $impls{$impl}->();
804 last if defined $usleep;
807 skip_all "Could not find a suitable usleep() implementation among: @impls"
810 return usleep => $usleep;
815 =head2 C<VPIT::TestHelpers::Guard>
820 my $guard = VPIT::TestHelpers::Guard->new($coderef);
822 } # $codref called here
826 package VPIT::TestHelpers::Guard;
829 my ($class, $code) = @_;
831 bless { code => $code }, $class;
834 sub DESTROY { $_[0]->{code}->() }
838 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
840 =head1 COPYRIGHT & LICENSE
842 Copyright 2012,2013,2014,2015 Vincent Pit, all rights reserved.
844 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.