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 run_perl => \&run_perl,
23 skip_all => \&skip_all,
27 threads => \&init_threads,
28 usleep => \&init_usleep,
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));
172 die 'Double quotes in evaluated code are not portable';
176 my ($perl, @perl_args) = @_;
177 system { $perl } $perl, @perl_args, '-e', $code;
182 skip_all 'Cannot capture output on VMS' if $^O eq 'VMS';
184 load_or_skip_all 'IO::Handle', '0', [ ];
185 load_or_skip_all 'IO::Select', '0', [ ];
186 load_or_skip_all 'IPC::Open3', '0', [ ];
187 if ($^O eq 'MSWin32') {
188 load_or_skip_all 'Socket', '0', [ ];
191 return capture => \&capture;
194 # Inspired from IPC::Cmd
199 my $want = wantarray;
203 my $ext_err = $^O eq 'MSWin32' ? $^E : undef;
206 my $args = join ', ', @_;
208 my $msg = "$syscall($args) failed: ";
211 no warnings 'numeric';
212 my ($err_code, $err_str) = (int $err, "$err");
213 $msg .= "$err_str ($err_code)";
216 if (defined $ext_err) {
217 no warnings 'numeric';
218 my ($ext_err_code, $ext_err_str) = (int $ext_err, "$ext_err");
219 $msg .= ", $ext_err_str ($ext_err_code)";
225 my ($status, $content_out, $content_err);
229 my ($pid, $out, $err);
231 if ($^O eq 'MSWin32') {
233 socketpair $_[0], $_[1],
234 &Socket::AF_UNIX, &Socket::SOCK_STREAM, &Socket::PF_UNSPEC
235 or $fail->(qw<socketpair reader writer>);
236 shutdown $_[0], 1 or $fail->(qw<shutdown reader>);
237 shutdown $_[1], 0 or $fail->(qw<shutdown writer>);
240 local (*IN_R, *IN_W);
241 local (*OUT_R, *OUT_W);
242 local (*ERR_R, *ERR_W);
243 $pipe->(*IN_R, *IN_W);
244 $pipe->(*OUT_R, *OUT_W);
245 $pipe->(*ERR_R, *ERR_W);
247 $pid = IPC::Open3::open3('>&IN_R', '<&OUT_W', '<&ERR_W', @cmd);
249 close *IN_W or $fail->(qw<close input>);
253 my $in = IO::Handle->new;
254 $out = IO::Handle->new;
256 $err = IO::Handle->new;
259 $pid = IPC::Open3::open3($in, $out, $err, @cmd);
264 # Forward signals to the child (except SIGKILL)
266 foreach my $s (keys %SIG) {
267 $sig_handlers{$s} = sub {
269 $SIG{$s} = $sig_handlers{$s};
272 local $SIG{$_} = $sig_handlers{$_} for keys %SIG;
275 close $out or $fail->(qw<close output>);
276 close $err or $fail->(qw<close error>);
282 my $sel = IO::Select->new();
283 $sel->add($out, $err);
285 my $fd_out = fileno $out;
286 my $fd_err = fileno $err;
289 $contents{$fd_out} = '';
290 $contents{$fd_err} = '';
292 while (my @ready = $sel->can_read) {
293 for my $fh (@ready) {
295 my $bytes_read = sysread $fh, $buf, 4096;
296 if (not defined $bytes_read) {
297 $fail->('sysread', 'fd(' . fileno($fh) . ')');
298 } elsif ($bytes_read) {
299 $contents{fileno($fh)} .= $buf;
302 close $fh or $fail->('close', 'fd(' . fileno($fh) . ')');
303 last unless $sel->count;
311 if ($^O eq 'MSWin32') {
312 # Manual CRLF translation that couldn't be done with sysread.
313 s/\x0D\x0A/\n/g for values %contents;
316 $content_out = $contents{$fd_out};
317 $content_err = $contents{$fd_err};
323 return ($status, $content_out, $content_err);
327 return (undef, $err);
332 my ($pkg, $threadsafe, $force_var) = @_;
334 skip_all 'This perl wasn\'t built to support threads'
335 unless $Config::Config{useithreads};
337 $pkg = 'package' unless defined $pkg;
338 skip_all "This $pkg isn't thread safe" if defined $threadsafe and !$threadsafe;
340 $force_var = 'PERL_FORCE_TEST_THREADS' unless defined $force_var;
341 my $force = $ENV{$force_var} ? 1 : !1;
342 skip_all 'perl 5.13.4 required to test thread safety'
343 unless $force or "$]" >= 5.013_004;
345 if (($INC{'Test/More.pm'} || $INC{'Test/Leaner.pm'}) && !$INC{'threads.pm'}) {
346 die 'Test::More/Test::Leaner was loaded too soon';
349 load_or_skip_all 'threads', $force ? '0' : '1.67', [ ];
350 load_or_skip_all 'threads::shared', $force ? '0' : '1.14', [ ];
352 require Test::Leaner;
354 diag "Threads testing forced by \$ENV{$force_var}" if $force;
356 return spawn => \&spawn;
362 if (do { local $@; eval { require Time::HiRes; 1 } }) {
363 defined and diag "Using usleep() from Time::HiRes $_"
364 for $Time::HiRes::VERSION;
365 $usleep = \&Time::HiRes::usleep;
367 diag 'Using fallback usleep()';
369 my $s = int($_[0] / 2.5e5);
374 return usleep => $usleep;
381 local $SIG{__WARN__} = sub { push @diag, "Thread creation warning: @_" };
384 push @diag, "Thread creation error: $@" if $@;
386 return $thread ? $thread : ();
389 package VPIT::TestHelpers::Guard;
392 my ($class, $code) = @_;
394 bless { code => $code }, $class;
397 sub DESTROY { $_[0]->{code}->() }