-
Notifications
You must be signed in to change notification settings - Fork 528
/
test.pl
2025 lines (1776 loc) · 59.3 KB
/
test.pl
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
#
# t/test.pl - most of Test::More functionality without the fuss
# NOTE:
#
# Do not rely on features found only in more modern Perls here, as some CPAN
# distributions copy this file and must operate on older Perls. Similarly, keep
# things, simple as this may be run under fairly broken circumstances. For
# example, increment ($x++) has a certain amount of cleverness for things like
#
# $x = 'zz';
# $x++; # $x eq 'aaa';
#
# This stands more chance of breaking than just a simple
#
# $x = $x + 1
#
# In this file, we use the latter "Baby Perl" approach, and increment
# will be worked over by t/op/inc.t
$| = 1;
our $Level = 1;
my $test = 1;
my $planned;
my $noplan;
my $Perl; # Safer version of $^X set by which_perl()
# This defines ASCII/UTF-8 vs EBCDIC/UTF-EBCDIC
$::IS_ASCII = ord 'A' == 65;
$::IS_EBCDIC = ord 'A' == 193;
# This is 'our' to enable harness to account for TODO-ed tests in
# overall grade of PASS or FAIL
our $TODO = 0;
our $NO_ENDING = 0;
our $Tests_Are_Passing = 1;
# Use this instead of print to avoid interference while testing globals.
sub _print {
local($\, $", $,) = (undef, ' ', '');
print STDOUT @_;
}
sub _print_stderr {
local($\, $", $,) = (undef, ' ', '');
print STDERR @_;
}
sub plan {
my $n;
if (@_ == 1) {
$n = shift;
if ($n eq 'no_plan') {
undef $n;
$noplan = 1;
}
} else {
my %plan = @_;
$plan{skip_all} and skip_all($plan{skip_all});
$n = $plan{tests};
}
_print "1..$n\n" unless $noplan;
$planned = $n;
}
# Set the plan at the end. See Test::More::done_testing.
sub done_testing {
my $n = $test - 1;
$n = shift if @_;
_print "1..$n\n";
$planned = $n;
}
END {
my $ran = $test - 1;
if (!$NO_ENDING) {
if (defined $planned && $planned != $ran) {
_print_stderr
"# Looks like you planned $planned tests but ran $ran.\n";
} elsif ($noplan) {
_print "1..$ran\n";
}
}
}
sub _diag {
return unless @_;
my @mess = _comment(@_);
$TODO ? _print(@mess) : _print_stderr(@mess);
}
# Use this instead of "print STDERR" when outputting failure diagnostic
# messages
sub diag {
_diag(@_);
}
# Use this instead of "print" when outputting informational messages
sub note {
return unless @_;
_print( _comment(@_) );
}
sub is_miniperl {
return !defined &DynaLoader::boot_DynaLoader;
}
sub set_up_inc {
# Don’t clobber @INC under miniperl
@INC = () unless is_miniperl;
unshift @INC, @_;
}
sub _comment {
return map { /^#/ ? "$_\n" : "# $_\n" }
map { split /\n/ } @_;
}
sub _have_dynamic_extension {
my $extension = shift;
unless (eval {require Config; 1}) {
warn "test.pl had problems loading Config: $@";
return 1;
}
$extension =~ s!::!/!g;
return 1 if ($Config::Config{extensions} =~ /\b$extension\b/);
}
sub skip_all {
if (@_) {
_print "1..0 # Skip @_\n";
} else {
_print "1..0\n";
}
exit(0);
}
sub skip_all_if_miniperl {
skip_all(@_) if is_miniperl();
}
sub skip_all_without_dynamic_extension {
my ($extension) = @_;
skip_all("no dynamic loading on miniperl, no $extension") if is_miniperl();
return if &_have_dynamic_extension;
skip_all("$extension was not built");
}
sub skip_all_without_perlio {
skip_all('no PerlIO') unless PerlIO::Layer->find('perlio');
}
sub skip_all_without_config {
unless (eval {require Config; 1}) {
warn "test.pl had problems loading Config: $@";
return;
}
foreach (@_) {
next if $Config::Config{$_};
my $key = $_; # Need to copy, before trying to modify.
$key =~ s/^use//;
$key =~ s/^d_//;
skip_all("no $key");
}
}
sub skip_all_without_unicode_tables { # (but only under miniperl)
if (is_miniperl()) {
skip_all_if_miniperl("Unicode tables not built yet")
unless eval 'require "unicore/UCD.pl"';
}
}
sub find_git_or_skip {
my ($source_dir, $reason);
if ( $ENV{CONTINUOUS_INTEGRATION} && $ENV{WORKSPACE} ) {
$source_dir = $ENV{WORKSPACE};
if ( -d "${source_dir}/.git" ) {
$ENV{GIT_DIR} = "${source_dir}/.git";
return $source_dir;
}
}
if (-d '.git') {
$source_dir = '.';
} elsif (-l 'MANIFEST' && -l 'AUTHORS') {
my $where = readlink 'MANIFEST';
die "Can't readlink MANIFEST: $!" unless defined $where;
die "Confusing symlink target for MANIFEST, '$where'"
unless $where =~ s!/MANIFEST\z!!;
if (-d "$where/.git") {
# Looks like we are in a symlink tree
if (exists $ENV{GIT_DIR}) {
diag("Found source tree at $where, but \$ENV{GIT_DIR} is $ENV{GIT_DIR}. Not changing it");
} else {
note("Found source tree at $where, setting \$ENV{GIT_DIR}");
$ENV{GIT_DIR} = "$where/.git";
}
$source_dir = $where;
}
} elsif (exists $ENV{GIT_DIR} || -f '.git') {
my $commit = '8d063cd8450e59ea1c611a2f4f5a21059a2804f1';
my $out = `git rev-parse --verify --quiet '$commit^{commit}'`;
chomp $out;
if($out eq $commit) {
$source_dir = '.'
}
}
if ($ENV{'PERL_BUILD_PACKAGING'}) {
$reason = 'PERL_BUILD_PACKAGING is set';
} elsif ($source_dir) {
my $version_string = `git --version`;
if (defined $version_string
&& $version_string =~ /\Agit version (\d+\.\d+\.\d+)(.*)/) {
return $source_dir if eval "v$1 ge v1.5.0";
# If you have earlier than 1.5.0 and it works, change this test
$reason = "in git checkout, but git version '$1$2' too old";
} else {
$reason = "in git checkout, but cannot run git";
}
} else {
$reason = 'not being run from a git checkout';
}
skip_all($reason) if $_[0] && $_[0] eq 'all';
skip($reason, @_);
}
sub BAIL_OUT {
my ($reason) = @_;
_print("Bail out! $reason\n");
exit 255;
}
sub _ok {
my ($pass, $where, $name, @mess) = @_;
# Do not try to microoptimize by factoring out the "not ".
# VMS will avenge.
my $out;
if ($name) {
# escape out '#' or it will interfere with '# skip' and such
$name =~ s/#/\\#/g;
$out = $pass ? "ok $test - $name" : "not ok $test - $name";
} else {
$out = $pass ? "ok $test - [$where]" : "not ok $test - [$where]";
}
if ($TODO) {
$out = $out . " # TODO $TODO";
} else {
$Tests_Are_Passing = 0 unless $pass;
}
_print "$out\n";
if ($pass) {
note @mess; # Ensure that the message is properly escaped.
}
else {
my $msg = "# Failed test $test - ";
$msg.= "$name " if $name;
$msg .= "$where\n";
_diag $msg;
_diag @mess;
}
$test = $test + 1; # don't use ++
return $pass;
}
sub _where {
my (undef, $filename, $lineno) = caller($Level);
return "at $filename line $lineno";
}
# DON'T use this for matches. Use like() instead.
sub ok ($@) {
my ($pass, $name, @mess) = @_;
_ok($pass, _where(), $name, @mess);
}
sub _q {
my $x = shift;
return 'undef' unless defined $x;
my $q = $x;
$q =~ s/\\/\\\\/g;
$q =~ s/'/\\'/g;
return "'$q'";
}
sub _qq {
my $x = shift;
return defined $x ? '"' . display ($x) . '"' : 'undef';
};
# Support pre-5.10 Perls, for the benefit of CPAN dists that copy this file.
# Note that chr(90) exists in both ASCII ("Z") and EBCDIC ("!").
my $chars_template = defined(eval { pack "W*", 90 }) ? "W*" : "U*";
eval 'sub re::is_regexp { ref($_[0]) eq "Regexp" }'
if !defined &re::is_regexp;
# keys are the codes \n etc map to, values are 2 char strings such as \n
my %backslash_escape;
foreach my $x (split //, 'enrtfa\\\'"') {
$backslash_escape{ord eval "\"\\$x\""} = "\\$x";
}
# A way to display scalars containing control characters and Unicode.
# Trying to avoid setting $_, or relying on local $_ to work.
sub display {
my @result;
foreach my $x (@_) {
if (defined $x and not ref $x) {
my $y = '';
foreach my $c (unpack($chars_template, $x)) {
if ($c > 255) {
$y = $y . sprintf "\\x{%x}", $c;
} elsif ($backslash_escape{$c}) {
$y = $y . $backslash_escape{$c};
} elsif ($c < ord " ") {
# Use octal for characters with small ordinals that are
# traditionally expressed as octal: the controls below
# space, which on EBCDIC are almost all the controls, but
# on ASCII don't include DEL nor the C1 controls.
$y = $y . sprintf "\\%03o", $c;
} elsif (chr $c =~ /[[:print:]]/a) {
$y = $y . chr $c;
}
else {
$y = $y . sprintf "\\x%02X", $c;
}
}
$x = $y;
}
return $x unless wantarray;
push @result, $x;
}
return @result;
}
sub is ($$@) {
my ($got, $expected, $name, @mess) = @_;
my $pass;
if( !defined $got || !defined $expected ) {
# undef only matches undef
$pass = !defined $got && !defined $expected;
}
else {
$pass = $got eq $expected;
}
unless ($pass) {
unshift(@mess, "# got "._qq($got)."\n",
"# expected "._qq($expected)."\n");
if (defined $got and defined $expected and
(length($got)>20 or length($expected)>20))
{
my $p = 0;
$p++ while substr($got,$p,1) eq substr($expected,$p,1);
push @mess,"# diff at $p\n";
push @mess,"# after "._qq(substr($got,$p < 40 ? 0 : $p - 40,
$p < 40 ? $p : 40)) . "\n";
push @mess,"# have "._qq(substr($got,$p,40))."\n";
push @mess,"# want "._qq(substr($expected,$p,40))."\n";
}
}
_ok($pass, _where(), $name, @mess);
}
sub isnt ($$@) {
my ($got, $isnt, $name, @mess) = @_;
my $pass;
if( !defined $got || !defined $isnt ) {
# undef only matches undef
$pass = defined $got || defined $isnt;
}
else {
$pass = $got ne $isnt;
}
unless( $pass ) {
unshift(@mess, "# it should not be "._qq($got)."\n",
"# but it is.\n");
}
_ok($pass, _where(), $name, @mess);
}
sub cmp_ok ($$$@) {
my($got, $type, $expected, $name, @mess) = @_;
my $pass;
{
local $^W = 0;
local($@,$!); # don't interfere with $@
# eval() sometimes resets $!
$pass = eval "\$got $type \$expected";
}
unless ($pass) {
# It seems Irix long doubles can have 2147483648 and 2147483648
# that stringify to the same thing but are actually numerically
# different. Display the numbers if $type isn't a string operator,
# and the numbers are stringwise the same.
# (all string operators have alphabetic names, so tr/a-z// is true)
# This will also show numbers for some unneeded cases, but will
# definitely be helpful for things such as == and <= that fail
if ($got eq $expected and $type !~ tr/a-z//) {
unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
}
unshift(@mess, "# got "._qq($got)."\n",
"# expected $type "._qq($expected)."\n");
}
_ok($pass, _where(), $name, @mess);
}
# Check that $got is within $range of $expected
# if $range is 0, then check it's exact
# else if $expected is 0, then $range is an absolute value
# otherwise $range is a fractional error.
# Here $range must be numeric, >= 0
# Non numeric ranges might be a useful future extension. (eg %)
sub within ($$$@) {
my ($got, $expected, $range, $name, @mess) = @_;
my $pass;
if (!defined $got or !defined $expected or !defined $range) {
# This is a fail, but doesn't need extra diagnostics
} elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
# This is a fail
unshift @mess, "# got, expected and range must be numeric\n";
} elsif ($range < 0) {
# This is also a fail
unshift @mess, "# range must not be negative\n";
} elsif ($range == 0) {
# Within 0 is ==
$pass = $got == $expected;
} elsif ($expected == 0) {
# If expected is 0, treat range as absolute
$pass = ($got <= $range) && ($got >= - $range);
} else {
my $diff = $got - $expected;
$pass = abs ($diff / $expected) < $range;
}
unless ($pass) {
if ($got eq $expected) {
unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
}
unshift@mess, "# got "._qq($got)."\n",
"# expected "._qq($expected)." (within "._qq($range).")\n";
}
_ok($pass, _where(), $name, @mess);
}
# Note: this isn't quite as fancy as Test::More::like().
sub like ($$@) { like_yn (0,@_) }; # 0 for -
sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
sub like_yn ($$$@) {
my ($flip, undef, $expected, $name, @mess) = @_;
# We just accept like(..., qr/.../), not like(..., '...'), and
# definitely not like(..., '/.../') like
# Test::Builder::maybe_regex() does.
unless (re::is_regexp($expected)) {
die "PANIC: The value '$expected' isn't a regexp. The like() function needs a qr// pattern, not a string";
}
my $pass = ($flip) ? $_[1] !~ /$expected/ : $_[1] =~ /$expected/;
unless ($pass) {
my $display_got = display($_[1]);
my $display_expected = display($expected);
unshift(@mess, "# got '$display_got'\n",
$flip
? "# expected !~ /$display_expected/\n"
: "# expected /$display_expected/\n");
}
local $Level = $Level + 1;
_ok($pass, _where(), $name, @mess);
}
sub refcount_is {
# Don't unpack first arg; access it directly via $_[0] to avoid creating
# another reference and upsetting the refcount
my (undef, $expected, $name, @mess) = @_;
my $got = &Internals::SvREFCNT($_[0]) + 1; # +1 to account for the & calling style
my $pass = $got == $expected;
unless ($pass) {
unshift @mess, "# got $got references\n" .
"# expected $expected\n";
}
_ok($pass, _where(), $name, @mess);
}
sub pass {
_ok(1, '', @_);
}
sub fail {
_ok(0, _where(), @_);
}
sub curr_test {
$test = shift if @_;
return $test;
}
sub next_test {
my $retval = $test;
$test = $test + 1; # don't use ++
$retval;
}
# Note: can't pass multipart messages since we try to
# be compatible with Test::More::skip().
sub skip {
my $why = shift;
my $n = @_ ? shift : 1;
my $bad_swap;
my $both_zero;
{
local $^W = 0;
$bad_swap = $why > 0 && $n == 0;
$both_zero = $why == 0 && $n == 0;
}
if ($bad_swap || $both_zero || @_) {
my $arg = "'$why', '$n'";
if (@_) {
$arg .= join(", ", '', map { qq['$_'] } @_);
}
die qq[$0: expected skip(why, count), got skip($arg)\n];
}
for (1..$n) {
_print "ok $test # skip $why\n";
$test = $test + 1;
}
local $^W = 0;
last SKIP;
}
sub skip_if_miniperl {
skip(@_) if is_miniperl();
}
sub skip_without_dynamic_extension {
my $extension = shift;
skip("no dynamic loading on miniperl, no extension $extension", @_)
if is_miniperl();
return if &_have_dynamic_extension($extension);
skip("extension $extension was not built", @_);
}
sub todo_skip {
my $why = shift;
my $n = @_ ? shift : 1;
for (1..$n) {
_print "not ok $test # TODO & SKIP $why\n";
$test = $test + 1;
}
local $^W = 0;
last TODO;
}
sub eq_array {
my ($ra, $rb) = @_;
return 0 unless $#$ra == $#$rb;
for my $i (0..$#$ra) {
next if !defined $ra->[$i] && !defined $rb->[$i];
return 0 if !defined $ra->[$i];
return 0 if !defined $rb->[$i];
return 0 unless $ra->[$i] eq $rb->[$i];
}
return 1;
}
sub eq_hash {
my ($orig, $suspect) = @_;
my $fail;
while (my ($key, $value) = each %$suspect) {
# Force a hash recompute if this perl's internals can cache the hash key.
$key = "" . $key;
if (exists $orig->{$key}) {
if (
defined $orig->{$key} != defined $value
|| (defined $value && $orig->{$key} ne $value)
) {
_print "# key ", _qq($key), " was ", _qq($orig->{$key}),
" now ", _qq($value), "\n";
$fail = 1;
}
} else {
_print "# key ", _qq($key), " is ", _qq($value),
", not in original.\n";
$fail = 1;
}
}
foreach (keys %$orig) {
# Force a hash recompute if this perl's internals can cache the hash key.
$_ = "" . $_;
next if (exists $suspect->{$_});
_print "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
$fail = 1;
}
!$fail;
}
# We only provide a subset of the Test::More functionality.
sub require_ok ($) {
my ($require) = @_;
if ($require =~ tr/[A-Za-z0-9:.]//c) {
fail("Invalid character in \"$require\", passed to require_ok");
} else {
eval <<REQUIRE_OK;
require $require;
REQUIRE_OK
is($@, '', _where(), "require $require");
}
}
sub use_ok ($) {
my ($use) = @_;
if ($use =~ tr/[A-Za-z0-9:.]//c) {
fail("Invalid character in \"$use\", passed to use");
} else {
eval <<USE_OK;
use $use;
USE_OK
is($@, '', _where(), "use $use");
}
}
# runperl, run_perl - Runs a separate perl interpreter and returns its output.
# Arguments :
# switches => [ command-line switches ]
# nolib => 1 # don't use -I../lib (included by default)
# non_portable => Don't warn if a one liner contains quotes
# prog => one-liner (avoid quotes)
# progs => [ multi-liner (avoid quotes) ]
# progfile => perl script
# stdin => string to feed the stdin (or undef to redirect from /dev/null)
# stderr => If 'devnull' suppresses stderr, if other TRUE value redirect
# stderr to stdout
# args => [ command-line arguments to the perl program ]
# verbose => print the command line
my $is_mswin = $^O eq 'MSWin32';
my $is_vms = $^O eq 'VMS';
my $is_cygwin = $^O eq 'cygwin';
sub _quote_args {
my ($runperl, $args) = @_;
foreach (@$args) {
# In VMS protect with doublequotes because otherwise
# DCL will lowercase -- unless already doublequoted.
$_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
$runperl = $runperl . ' ' . $_;
}
return $runperl;
}
sub _create_runperl { # Create the string to qx in runperl().
my %args = @_;
my $runperl = which_perl();
if ($runperl =~ m/\s/) {
$runperl = qq{"$runperl"};
}
#- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind
if ($ENV{PERL_RUNPERL_DEBUG}) {
$runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl";
}
unless ($args{nolib}) {
$runperl = $runperl . ' "-I../lib" "-I." '; # doublequotes because of VMS
}
if ($args{switches}) {
local $Level = 2;
die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
unless ref $args{switches} eq "ARRAY";
$runperl = _quote_args($runperl, $args{switches});
}
if (defined $args{prog}) {
die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
if defined $args{progs};
$args{progs} = [split /\n/, $args{prog}, -1]
}
if (defined $args{progs}) {
die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
unless ref $args{progs} eq "ARRAY";
foreach my $prog (@{$args{progs}}) {
if (!$args{non_portable}) {
if ($prog =~ tr/'"//) {
warn "quotes in prog >>$prog<< are not portable";
}
if ($prog =~ /^([<>|]|2>)/) {
warn "Initial $1 in prog >>$prog<< is not portable";
}
if ($prog =~ /&\z/) {
warn "Trailing & in prog >>$prog<< is not portable";
}
}
if ($is_mswin || $is_vms) {
$runperl = $runperl . qq ( -e "$prog" );
}
else {
$runperl = $runperl . qq ( -e '$prog' );
}
}
} elsif (defined $args{progfile}) {
$runperl = $runperl . qq( "$args{progfile}");
} else {
# You probably didn't want to be sucking in from the upstream stdin
die "test.pl:runperl(): none of prog, progs, progfile, args, "
. " switches or stdin specified"
unless defined $args{args} or defined $args{switches}
or defined $args{stdin};
}
if (defined $args{stdin}) {
# so we don't try to put literal newlines and crs onto the
# command line.
$args{stdin} =~ s/\n/\\n/g;
$args{stdin} =~ s/\r/\\r/g;
if ($is_mswin || $is_vms) {
$runperl = qq{$Perl -e "print qq(} .
$args{stdin} . q{)" | } . $runperl;
}
else {
$runperl = qq{$Perl -e 'print qq(} .
$args{stdin} . q{)' | } . $runperl;
}
} elsif (exists $args{stdin}) {
# Using the pipe construction above can cause fun on systems which use
# ksh as /bin/sh, as ksh does pipes differently (with one less process)
# With sh, for the command line 'perl -e 'print qq()' | perl -e ...'
# the sh process forks two children, which use exec to start the two
# perl processes. The parent shell process persists for the duration of
# the pipeline, and the second perl process starts with no children.
# With ksh (and zsh), the shell saves a process by forking a child for
# just the first perl process, and execing itself to start the second.
# This means that the second perl process starts with one child which
# it didn't create. This causes "fun" when if the tests assume that
# wait (or waitpid) will only return information about processes
# started within the test.
# They also cause fun on VMS, where the pipe implementation returns
# the exit code of the process at the front of the pipeline, not the
# end. This messes up any test using OPTION FATAL.
# Hence it's useful to have a way to make STDIN be at eof without
# needing a pipeline, so that the fork tests have a sane environment
# without these surprises.
# /dev/null appears to be surprisingly portable.
$runperl = $runperl . ($is_mswin ? ' <nul' : ' </dev/null');
}
if (defined $args{args}) {
$runperl = _quote_args($runperl, $args{args});
}
if (exists $args{stderr} && $args{stderr} eq 'devnull') {
$runperl = $runperl . ($is_mswin ? ' 2>nul' : ' 2>/dev/null');
}
elsif ($args{stderr}) {
$runperl = $runperl . ' 2>&1';
}
if ($args{verbose}) {
my $runperldisplay = $runperl;
$runperldisplay =~ s/\n/\n\#/g;
_print_stderr "# $runperldisplay\n";
}
return $runperl;
}
# usage:
# $ENV{PATH} =~ /(.*)/s;
# local $ENV{PATH} = untaint_path($1);
sub untaint_path {
my $path = shift;
my $sep;
if (! eval {require Config; 1}) {
warn "test.pl had problems loading Config: $@";
$sep = ':';
} else {
$sep = $Config::Config{path_sep};
}
$path =
join $sep, grep { $_ ne "" and $_ ne "." and -d $_ and
($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) }
split quotemeta ($sep), $1;
if ($is_cygwin) { # Must have /bin under Cygwin
if (length $path) {
$path = $path . $sep;
}
$path = $path . '/bin';
} elsif (!$is_vms and !length $path) {
# empty PATH is the same as a path of "." on *nix so to prevent
# tests from dieing under taint we need to return something
# absolute. Perhaps "/" would be better? Anything absolute will do.
$path = "/usr/bin";
}
$path;
}
# sub run_perl {} is alias to below
# Since this uses backticks to run, it is subject to the rules of the shell.
# Locale settings may pose a problem, depending on the program being run.
sub runperl {
die "test.pl:runperl() does not take a hashref"
if ref $_[0] and ref $_[0] eq 'HASH';
my $runperl = &_create_runperl;
my $result;
my $tainted = ${^TAINT};
my %args = @_;
exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1;
if ($tainted) {
# We will assume that if you're running under -T, you really mean to
# run a fresh perl, so we'll brute force launder everything for you
my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV);
local @ENV{@keys} = ();
# Untaint, plus take out . and empty string:
local $ENV{'DCL$PATH'} = $1 if $is_vms && exists($ENV{'DCL$PATH'}) && ($ENV{'DCL$PATH'} =~ /(.*)/s);
$ENV{PATH} =~ /(.*)/s;
local $ENV{PATH} = untaint_path($1);
$runperl =~ /(.*)/s;
$runperl = $1;
$result = `$runperl`;
} else {
$result = `$runperl`;
}
$result =~ s/\n\n/\n/g if $is_vms; # XXX pipes sometimes double these
return $result;
}
# Nice alias
*run_perl = *run_perl = \&runperl; # shut up "used only once" warning
# Run perl with specified environment and arguments, return (STDOUT, STDERR)
# set DEBUG_RUNENV=1 in the environment to debug.
sub runperl_and_capture {
my ($env, $args) = @_;
my $STDOUT = tempfile();
my $STDERR = tempfile();
my $PERL = $^X;
my $FAILURE_CODE = 119;
local %ENV = %ENV;
delete $ENV{PERLLIB};
delete $ENV{PERL5LIB};
delete $ENV{PERL5OPT};
delete $ENV{PERL_USE_UNSAFE_INC};
my $pid = fork;
return (0, "Couldn't fork: $!") unless defined $pid; # failure
if ($pid) { # parent
waitpid $pid,0;
my $exit_code = $? ? $? >> 8 : 0;
my ($out, $err)= ("", "");
local $/;
if (open my $stdout, '<', $STDOUT) {
$out .= <$stdout>;
} else {
$err .= "Could not read STDOUT '$STDOUT' file: $!\n";
}
if (open my $stderr, '<', $STDERR) {
$err .= <$stderr>;
} else {
$err .= "Could not read STDERR '$STDERR' file: $!\n";
}
if ($exit_code == $FAILURE_CODE) {
$err .= "Something went wrong. Received FAILURE_CODE as exit code.\n";
}
if ($ENV{DEBUG_RUNENV}) {
print "OUT: $out\n";
print "ERR: $err\n";
}
return ($out, $err);
} elsif (defined $pid) { # child
# Just in case the order we update the environment changes how
# the environment is set up we sort the keys here for consistency.
for my $k (sort keys %$env) {
$ENV{$k} = $env->{$k};
}
if ($ENV{DEBUG_RUNENV}) {
print "Child Process $$ Executing:\n$PERL @$args\n";
}
open STDOUT, '>', $STDOUT
or do {
print "Failed to dup STDOUT to '$STDOUT': $!";
exit $FAILURE_CODE;
};
open STDERR, '>', $STDERR
or do {
print "Failed to dup STDERR to '$STDERR': $!";
exit $FAILURE_CODE;
};
exec $PERL, @$args
or print STDERR "Failed to exec: ",
join(" ",map { "'$_'" } $^X, @$args),
": $!\n";
exit $FAILURE_CODE;
}
}
sub DIE {
_print_stderr "# @_\n";
exit 1;
}
# A somewhat safer version of the sometimes wrong $^X.
sub which_perl {
unless (defined $Perl) {
$Perl = $^X;
# VMS should have 'perl' aliased properly
return $Perl if $is_vms;
my $exe;
if (! eval {require Config; 1}) {
warn "test.pl had problems loading Config: $@";
$exe = '';
} else {
$exe = $Config::Config{_exe};
}
$exe = '' unless defined $exe;
# This doesn't absolutize the path: beware of future chdirs().
# We could do File::Spec->abs2rel() but that does getcwd()s,
# which is a bit heavyweight to do here.
if ($Perl =~ /^perl\Q$exe\E$/i) {
my $perl = "perl$exe";
if (! eval {require File::Spec; 1}) {
warn "test.pl had problems loading File::Spec: $@";
$Perl = "./$perl";
} else {
$Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
}
}
# Build up the name of the executable file from the name of
# the command.
if ($Perl !~ /\Q$exe\E$/i) {
$Perl = $Perl . $exe;
}
warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
# For subcommands to use.
$ENV{PERLEXE} = $Perl;
}
return $Perl;
}
sub unlink_all {
my $count = 0;
foreach my $file (@_) {
1 while unlink $file;
if( -f $file ){
_print_stderr "# Couldn't unlink '$file': $!\n";
}else{
$count = $count + 1; # don't use ++
}
}
$count;
}
# _num_to_alpha - Returns a string of letters representing a positive integer.
# Arguments :
# number to convert
# maximum number of letters
# returns undef if the number is negative
# returns undef if the number of letters is greater than the maximum wanted
# _num_to_alpha( 0) eq 'A';
# _num_to_alpha( 1) eq 'B';
# _num_to_alpha(25) eq 'Z';
# _num_to_alpha(26) eq 'AA';
# _num_to_alpha(27) eq 'AB';
my @letters = qw(A B C D E F G H I J K L M N O P Q R S T U V W X Y Z);
# Avoid ++ -- ranges split negative numbers
sub _num_to_alpha {
my($num,$max_char) = @_;
return unless $num >= 0;
my $alpha = '';
my $char_count = 0;
$max_char = 0 if !defined($max_char) or $max_char < 0;
while( 1 ){