1 package VPIT::TestHelpers;
11 while (my ($name, $code) = each %$subs) {
13 *{$pkg.'::'.$name} = $code;
19 my %default_exports = (
20 load_or_skip => \&load_or_skip,
21 load_or_skip_all => \&load_or_skip_all,
22 skip_all => \&skip_all,
26 threads => \&init_threads,
27 usleep => \&init_usleep,
28 run_perl => \&init_run_perl,
29 capture => \&init_capture,
36 my %exports = %default_exports;
38 for (my $i = 0; $i <= $#opts; ++$i) {
39 my $feature = $opts[$i];
40 next unless defined $feature;
43 if ($i < $#opts and defined $opts[$i+1] and ref $opts[$i+1] eq 'ARRAY') {
50 my $handler = $features{$feature};
51 die "Unknown feature '$feature'" unless defined $handler;
53 my %syms = $handler->(@$args);
55 $exports{$_} = $syms{$_} for sort keys %syms;
58 export_to_pkg \%exports => scalar caller;
65 if ($INC{'Test/Leaner.pm'}) {
66 $stash = \%Test::Leaner::;
69 $stash = \%Test::More::;
72 my $glob = $stash->{$sub};
73 return $glob ? *$glob{CODE} : undef;
76 sub skip { $test_sub->('skip')->(@_) }
78 sub skip_all { $test_sub->('plan')->(skip_all => $_[0]) }
81 my $diag = $test_sub->('diag');
89 my ($pkg, $ver, $imports) = @_;
91 my $spec = $ver && $ver !~ /^[0._]*$/ ? "$pkg $ver" : $pkg;
95 if (eval "use $spec (); 1") {
96 $ver = do { no strict 'refs'; ${"${pkg}::VERSION"} };
97 $ver = 'undef' unless defined $ver;
100 my @imports = @$imports;
101 my $caller = (caller 1)[0];
103 my $res = eval <<"IMPORTER";
106 BEGIN { \$pkg->import(\@imports) }
109 $err = "Could not import '@imports' from $pkg $ver: $@" unless $res;
112 (my $file = "$pkg.pm") =~ s{::}{/}g;
114 $err = "Could not load $spec";
118 return wantarray ? (0, $err) : 0;
120 diag "Using $pkg $ver";
126 my ($pkg, $ver, $imports, $tests) = @_;
128 die 'You must specify how many tests to skip' unless defined $tests;
130 my ($loaded, $err) = load($pkg, $ver, $imports);
131 skip $err => $tests unless $loaded;
136 sub load_or_skip_all {
137 my ($pkg, $ver, $imports) = @_;
139 my ($loaded, $err) = load($pkg, $ver, $imports);
140 skip_all $err unless $loaded;
145 sub fresh_perl_env (&) {
148 my ($SystemRoot, $PATH) = @ENV{qw<SystemRoot PATH>};
149 my $ld_name = $Config::Config{ldlibpthname};
150 my $ldlibpth = $ENV{$ld_name};
153 $ENV{$ld_name} = $ldlibpth if defined $ldlibpth;
154 $ENV{SystemRoot} = $SystemRoot if $^O eq 'MSWin32' and defined $SystemRoot;
155 $ENV{PATH} = $PATH if $^O eq 'cygwin' and defined $PATH;
158 unless (-e $perl and -x $perl) {
159 $perl = $Config::Config{perlpath};
160 unless (-e $perl and -x $perl) {
165 return $handler->($perl, '-T', map("-I$_", @INC));
171 if (defined $prefix) {
172 if (length $prefix and $prefix !~ /_$/) {
182 run_perl => \&run_perl,
183 "${p}RUN_PERL_FAILED" => sub () { 'Could not execute perl subprocess' },
191 die 'Double quotes in evaluated code are not portable';
195 my ($perl, @perl_args) = @_;
196 system { $perl } $perl, @perl_args, '-e', $code;
201 skip_all 'Cannot capture output on VMS' if $^O eq 'VMS';
203 load_or_skip_all 'IO::Handle', '0', [ ];
204 load_or_skip_all 'IO::Select', '0', [ ];
205 load_or_skip_all 'IPC::Open3', '0', [ ];
206 if ($^O eq 'MSWin32') {
207 load_or_skip_all 'Socket', '0', [ ];
211 capture => \&capture,
212 capture_perl => \&capture_perl,
216 # Inspired from IPC::Cmd
221 my $want = wantarray;
225 my $ext_err = $^O eq 'MSWin32' ? $^E : undef;
228 my $args = join ', ', @_;
230 my $msg = "$syscall($args) failed: ";
233 no warnings 'numeric';
234 my ($err_code, $err_str) = (int $err, "$err");
235 $msg .= "$err_str ($err_code)";
238 if (defined $ext_err) {
239 no warnings 'numeric';
240 my ($ext_err_code, $ext_err_str) = (int $ext_err, "$ext_err");
241 $msg .= ", $ext_err_str ($ext_err_code)";
247 my ($status, $content_out, $content_err);
251 my ($pid, $out, $err);
253 if ($^O eq 'MSWin32') {
255 socketpair $_[0], $_[1],
256 &Socket::AF_UNIX, &Socket::SOCK_STREAM, &Socket::PF_UNSPEC
257 or $fail->(qw<socketpair reader writer>);
258 shutdown $_[0], 1 or $fail->(qw<shutdown reader>);
259 shutdown $_[1], 0 or $fail->(qw<shutdown writer>);
262 local (*IN_R, *IN_W);
263 local (*OUT_R, *OUT_W);
264 local (*ERR_R, *ERR_W);
265 $pipe->(*IN_R, *IN_W);
266 $pipe->(*OUT_R, *OUT_W);
267 $pipe->(*ERR_R, *ERR_W);
269 $pid = IPC::Open3::open3('>&IN_R', '<&OUT_W', '<&ERR_W', @cmd);
271 close *IN_W or $fail->(qw<close input>);
275 my $in = IO::Handle->new;
276 $out = IO::Handle->new;
278 $err = IO::Handle->new;
281 $pid = IPC::Open3::open3($in, $out, $err, @cmd);
286 # Forward signals to the child (except SIGKILL)
288 foreach my $s (keys %SIG) {
289 $sig_handlers{$s} = sub {
291 $SIG{$s} = $sig_handlers{$s};
294 local $SIG{$_} = $sig_handlers{$_} for keys %SIG;
297 close $out or $fail->(qw<close output>);
298 close $err or $fail->(qw<close error>);
304 my $sel = IO::Select->new();
305 $sel->add($out, $err);
307 my $fd_out = fileno $out;
308 my $fd_err = fileno $err;
311 $contents{$fd_out} = '';
312 $contents{$fd_err} = '';
314 while (my @ready = $sel->can_read) {
315 for my $fh (@ready) {
317 my $bytes_read = sysread $fh, $buf, 4096;
318 if (not defined $bytes_read) {
319 $fail->('sysread', 'fd(' . fileno($fh) . ')');
320 } elsif ($bytes_read) {
321 $contents{fileno($fh)} .= $buf;
324 close $fh or $fail->('close', 'fd(' . fileno($fh) . ')');
325 last unless $sel->count;
333 if ($^O eq 'MSWin32') {
334 # Manual CRLF translation that couldn't be done with sysread.
335 s/\x0D\x0A/\n/g for values %contents;
338 $content_out = $contents{$fd_out};
339 $content_err = $contents{$fd_err};
345 return ($status, $content_out, $content_err);
349 return (undef, $err);
357 die 'Double quotes in evaluated code are not portable';
362 capture @perl, '-e', $code;
367 my ($pkg, $threadsafe, $force_var) = @_;
369 skip_all 'This perl wasn\'t built to support threads'
370 unless $Config::Config{useithreads};
372 $pkg = 'package' unless defined $pkg;
373 skip_all "This $pkg isn't thread safe" if defined $threadsafe and !$threadsafe;
375 $force_var = 'PERL_FORCE_TEST_THREADS' unless defined $force_var;
376 my $force = $ENV{$force_var} ? 1 : !1;
377 skip_all 'perl 5.13.4 required to test thread safety'
378 unless $force or "$]" >= 5.013_004;
380 if (($INC{'Test/More.pm'} || $INC{'Test/Leaner.pm'}) && !$INC{'threads.pm'}) {
381 die 'Test::More/Test::Leaner was loaded too soon';
384 load_or_skip_all 'threads', $force ? '0' : '1.67', [ ];
385 load_or_skip_all 'threads::shared', $force ? '0' : '1.14', [ ];
387 require Test::Leaner;
389 diag "Threads testing forced by \$ENV{$force_var}" if $force;
391 return spawn => \&spawn;
397 if (do { local $@; eval { require Time::HiRes; 1 } }) {
398 defined and diag "Using usleep() from Time::HiRes $_"
399 for $Time::HiRes::VERSION;
400 $usleep = \&Time::HiRes::usleep;
402 diag 'Using fallback usleep()';
404 my $s = int($_[0] / 2.5e5);
409 return usleep => $usleep;
416 local $SIG{__WARN__} = sub { push @diag, "Thread creation warning: @_" };
419 push @diag, "Thread creation error: $@" if $@;
421 return $thread ? $thread : ();
424 package VPIT::TestHelpers::Guard;
427 my ($class, $code) = @_;
429 bless { code => $code }, $class;
432 sub DESTROY { $_[0]->{code}->() }