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;
32 my %default_exports = (
33 load_or_skip => \&load_or_skip,
34 load_or_skip_all => \&load_or_skip_all,
35 skip_all => \&skip_all,
39 threads => \&init_threads,
40 usleep => \&init_usleep,
41 run_perl => \&init_run_perl,
42 capture => \&init_capture,
49 my %exports = %default_exports;
51 for (my $i = 0; $i <= $#opts; ++$i) {
52 my $feature = $opts[$i];
53 next unless defined $feature;
56 if ($i < $#opts and defined $opts[$i+1] and ref $opts[$i+1] eq 'ARRAY') {
63 my $handler = $features{$feature};
64 die "Unknown feature '$feature'" unless defined $handler;
66 my %syms = $handler->(@$args);
68 $exports{$_} = $syms{$_} for sort keys %syms;
71 export_to_pkg \%exports => scalar caller;
78 if ($INC{'Test/Leaner.pm'}) {
79 $stash = \%Test::Leaner::;
82 $stash = \%Test::More::;
85 my $glob = $stash->{$sub};
86 return $glob ? *$glob{CODE} : undef;
89 sub skip { $test_sub->('skip')->(@_) }
91 sub skip_all { $test_sub->('plan')->(skip_all => $_[0]) }
94 my $diag = $test_sub->('diag');
102 my ($pkg, $ver, $imports) = @_;
104 my $spec = $ver && $ver !~ /^[0._]*$/ ? "$pkg $ver" : $pkg;
108 if (eval "use $spec (); 1") {
109 $ver = do { no strict 'refs'; ${"${pkg}::VERSION"} };
110 $ver = 'undef' unless defined $ver;
113 my @imports = @$imports;
114 my $caller = (caller 1)[0];
116 my $res = eval <<"IMPORTER";
119 BEGIN { \$pkg->import(\@imports) }
122 $err = "Could not import '@imports' from $pkg $ver: $@" unless $res;
125 (my $file = "$pkg.pm") =~ s{::}{/}g;
127 $err = "Could not load $spec";
131 return wantarray ? (0, $err) : 0;
133 diag "Using $pkg $ver";
139 my ($pkg, $ver, $imports, $tests) = @_;
141 die 'You must specify how many tests to skip' unless defined $tests;
143 my ($loaded, $err) = load($pkg, $ver, $imports);
144 skip $err => $tests unless $loaded;
149 sub load_or_skip_all {
150 my ($pkg, $ver, $imports) = @_;
152 my ($loaded, $err) = load($pkg, $ver, $imports);
153 skip_all $err unless $loaded;
168 use VPIT::TestHelpers run_perl => [ $p ]
176 C<$p> is prefixed to the constants exported by this feature (defaults to C<''>).
196 C<RUN_PERL_FAILED> (possibly prefixed by C<$p>)
204 sub fresh_perl_env (&) {
207 my ($SystemRoot, $PATH) = @ENV{qw<SystemRoot PATH>};
208 my $ld_name = $Config::Config{ldlibpthname};
209 my $ldlibpth = $ENV{$ld_name};
212 $ENV{$ld_name} = $ldlibpth if defined $ldlibpth;
213 $ENV{SystemRoot} = $SystemRoot if $^O eq 'MSWin32' and defined $SystemRoot;
214 $ENV{PATH} = $PATH if $^O eq 'cygwin' and defined $PATH;
217 unless (-e $perl and -x $perl) {
218 $perl = $Config::Config{perlpath};
219 unless (-e $perl and -x $perl) {
224 return $handler->($perl, '-T', map("-I$_", @INC));
230 if (defined $prefix) {
231 if (length $prefix and $prefix !~ /_$/) {
241 run_perl => \&run_perl,
242 "${p}RUN_PERL_FAILED" => sub () { 'Could not execute perl subprocess' },
250 die 'Double quotes in evaluated code are not portable';
254 my ($perl, @perl_args) = @_;
255 system { $perl } $perl, @perl_args, '-e', $code;
267 use VPIT::TestHelpers 'capture'
281 L<IO::Handle>, L<IO::Select>, L<IPC::Open3>
285 On MSWin32 : L<Socket>
301 C<capture_perl $code>
310 skip_all 'Cannot capture output on VMS' if $^O eq 'VMS';
312 load_or_skip_all 'IO::Handle', '0', [ ];
313 load_or_skip_all 'IO::Select', '0', [ ];
314 load_or_skip_all 'IPC::Open3', '0', [ ];
315 if ($^O eq 'MSWin32') {
316 load_or_skip_all 'Socket', '0', [ ];
320 capture => \&capture,
321 capture_perl => \&capture_perl,
325 # Inspired from IPC::Cmd
330 my $want = wantarray;
334 my $ext_err = $^O eq 'MSWin32' ? $^E : undef;
337 my $args = join ', ', @_;
339 my $msg = "$syscall($args) failed: ";
342 no warnings 'numeric';
343 my ($err_code, $err_str) = (int $err, "$err");
344 $msg .= "$err_str ($err_code)";
347 if (defined $ext_err) {
348 no warnings 'numeric';
349 my ($ext_err_code, $ext_err_str) = (int $ext_err, "$ext_err");
350 $msg .= ", $ext_err_str ($ext_err_code)";
356 my ($status, $content_out, $content_err);
360 my ($pid, $out, $err);
362 if ($^O eq 'MSWin32') {
364 socketpair $_[0], $_[1],
365 &Socket::AF_UNIX, &Socket::SOCK_STREAM, &Socket::PF_UNSPEC
366 or $fail->(qw<socketpair reader writer>);
367 shutdown $_[0], 1 or $fail->(qw<shutdown reader>);
368 shutdown $_[1], 0 or $fail->(qw<shutdown writer>);
371 local (*IN_R, *IN_W);
372 local (*OUT_R, *OUT_W);
373 local (*ERR_R, *ERR_W);
374 $pipe->(*IN_R, *IN_W);
375 $pipe->(*OUT_R, *OUT_W);
376 $pipe->(*ERR_R, *ERR_W);
378 $pid = IPC::Open3::open3('>&IN_R', '<&OUT_W', '<&ERR_W', @cmd);
380 close *IN_W or $fail->(qw<close input>);
384 my $in = IO::Handle->new;
385 $out = IO::Handle->new;
387 $err = IO::Handle->new;
390 $pid = IPC::Open3::open3($in, $out, $err, @cmd);
395 # Forward signals to the child (except SIGKILL)
397 foreach my $s (keys %SIG) {
398 $sig_handlers{$s} = sub {
400 $SIG{$s} = $sig_handlers{$s};
403 local $SIG{$_} = $sig_handlers{$_} for keys %SIG;
406 close $out or $fail->(qw<close output>);
407 close $err or $fail->(qw<close error>);
413 my $sel = IO::Select->new();
414 $sel->add($out, $err);
416 my $fd_out = fileno $out;
417 my $fd_err = fileno $err;
420 $contents{$fd_out} = '';
421 $contents{$fd_err} = '';
423 while (my @ready = $sel->can_read) {
424 for my $fh (@ready) {
426 my $bytes_read = sysread $fh, $buf, 4096;
427 if (not defined $bytes_read) {
428 $fail->('sysread', 'fd(' . fileno($fh) . ')');
429 } elsif ($bytes_read) {
430 $contents{fileno($fh)} .= $buf;
433 close $fh or $fail->('close', 'fd(' . fileno($fh) . ')');
434 last unless $sel->count;
442 if ($^O eq 'MSWin32') {
443 # Manual CRLF translation that couldn't be done with sysread.
444 s/\x0D\x0A/\n/g for values %contents;
447 $content_out = $contents{$fd_out};
448 $content_err = $contents{$fd_err};
454 return ($status, $content_out, $content_err);
458 return (undef, $err);
466 die 'Double quotes in evaluated code are not portable';
471 capture @perl, '-e', $code;
483 use VPIT::TestHelpers threads => [
484 $pkg, $is_threadsafe, $force_var
493 C<$pkg> is the target package name to be used in error messages (defaults to C<'package'>) ;
497 C<$is_threadsafe> is a boolean telling whether the target module is thread-safe (not tested if C<undef>) ;
501 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>).
521 L<threads::shared> 1.14
546 my ($pkg, $threadsafe, $force_var) = @_;
548 skip_all 'This perl wasn\'t built to support threads'
549 unless $Config::Config{useithreads};
551 $pkg = 'package' unless defined $pkg;
552 skip_all "This $pkg isn't thread safe" if defined $threadsafe and !$threadsafe;
554 $force_var = 'PERL_FORCE_TEST_THREADS' unless defined $force_var;
555 my $force = $ENV{$force_var} ? 1 : !1;
556 skip_all 'perl 5.13.4 required to test thread safety'
557 unless $force or "$]" >= 5.013_004;
559 if (($INC{'Test/More.pm'} || $INC{'Test/Leaner.pm'}) && !$INC{'threads.pm'}) {
560 die 'Test::More/Test::Leaner was loaded too soon';
563 load_or_skip_all 'threads', $force ? '0' : '1.67', [ ];
564 load_or_skip_all 'threads::shared', $force ? '0' : '1.14', [ ];
566 require Test::Leaner;
568 diag "Threads testing forced by \$ENV{$force_var}" if $force;
570 return spawn => \&spawn;
577 local $SIG{__WARN__} = sub { push @diag, "Thread creation warning: @_" };
580 push @diag, "Thread creation error: $@" if $@;
582 return $thread ? $thread : ();
593 use VPIT::TestHelpers 'usleep'
607 C<usleep $microseconds>
618 if (do { local $@; eval { require Time::HiRes; 1 } }) {
619 defined and diag "Using usleep() from Time::HiRes $_"
620 for $Time::HiRes::VERSION;
621 $usleep = \&Time::HiRes::usleep;
623 diag 'Using fallback usleep()';
625 my $s = int($_[0] / 2.5e5);
630 return usleep => $usleep;
635 =head2 C<VPIT::TestHelpers::Guard>
640 my $guard = VPIT::TestHelpers::Guard->new($coderef);
642 } # $codref called here
646 package VPIT::TestHelpers::Guard;
649 my ($class, $code) = @_;
651 bless { code => $code }, $class;
654 sub DESTROY { $_[0]->{code}->() }
658 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
660 =head1 COPYRIGHT & LICENSE
662 Copyright 2012,2013,2014,2015 Vincent Pit, all rights reserved.
664 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.