utils/perlivp.PL

   1 #!/usr/local/bin/perl
   2
   3 use Config;
   4 use File::Basename;
   5 use Cwd;
   6
   7 # List explicitly here the variables you want Configure to
   8 # generate.  Metaconfig only looks for shell variables, so you
   9 # have to mention them as if they were shell variables, not
  10 # %Config entries:
  11 #  $startperl
  12 #  $perlpath
  13 #  $eunicefix
  14
  15 # This forces PL files to create target in same directory as PL file.
  16 # This is so that make depend always knows where to find PL derivatives.
  17 my $origdir = cwd;
  18 chdir dirname($0);
  19 my $file = basename($0, '.PL');
  20 $file .= '.com' if $^O eq 'VMS';
  21
  22 # Create output file.
  23 open OUT,">$file" or die "Can't create $file: $!";
  24
  25 print "Extracting $file (with variable substitutions)\n";
  26
  27 # In this section, perl variables will be expanded during extraction.
  28 # You can use $Config{...} to use Configure variables.
  29
  30 print OUT <<"!GROK!THIS!";
  31 $Config{'startperl'}
  32     eval 'exec $Config{'perlpath'} -S \$0 \${1+"\$@"}'
  33         if \$running_under_some_shell;
  34 !GROK!THIS!
  35
  36 print OUT "\n# perlivp $^V\n";
  37
  38 # In the following, perl variables are not expanded during extraction.
  39
  40 print OUT <<'!NO!SUBS!';
  41
  42 sub usage {
  43     warn "@_\n" if @_;
  44     print << "    EOUSAGE";
  45 Usage:
  46
  47     $0 [-a] [-p] [-v] | [-h]
  48
  49     -a Run all tests (default is to skip .ph tests)
  50     -p Print a preface before each test telling what it will test.
  51     -v Verbose mode in which extra information about test results
  52        is printed.  Test failures always print out some extra information
  53        regardless of whether or not this switch is set.
  54     -h Prints this help message.
  55     EOUSAGE
  56     exit;
  57 }
  58
  59 use vars qw(%opt); # allow testing with older versions (do not use our)
  60
  61 @opt{ qw/? H h P p V v/ } = qw(0 0 0 0 0 0 0);
  62
  63 while ($ARGV[0] =~ /^-/) {
  64     $ARGV[0] =~ s/^-//;
  65     for my $flag (split(//,$ARGV[0])) {
  66         usage() if '?' =~ /\Q$flag/;
  67         usage() if 'h' =~ /\Q$flag/;
  68         usage() if 'H' =~ /\Q$flag/;
  69         usage("unknown flag: `$flag'") unless 'HhPpVva' =~ /\Q$flag/;
  70         warn "$0: `$flag' flag already set\n" if $opt{$flag}++;
  71     }
  72     shift;
  73 }
  74
  75 $opt{p}++ if $opt{P};
  76 $opt{v}++ if $opt{V};
  77
  78 my $pass__total = 0;
  79 my $error_total = 0;
  80 my $tests_total = 0;
  81
  82 !NO!SUBS!
  83
  84 # We cannot merely check the variable `$^X' in general since on many
  85 # Unixes it is the basename rather than the full path to the perl binary.
  86 my $perlpath = '';
  87 if (defined($Config{'perlpath'})) { $perlpath = $Config{'perlpath'}; }
  88
  89 # The useithreads Config variable plays a role in whether or not
  90 # threads and threads/shared work when C<use>d.  They apparently always
  91 # get installed on systems that can run Configure.
  92 my $useithreads = '';
  93 if (defined($Config{'useithreads'})) { $useithreads = $Config{'useithreads'}; }
  94
  95 print OUT <<"!GROK!THIS!";
  96 my \$perlpath = '$perlpath';
  97 my \$useithreads = '$useithreads';
  98 !GROK!THIS!
  99
 100 print OUT <<'!NO!SUBS!';
 101
 102 print "## Checking Perl binary via variable `\$perlpath' = $perlpath.\n" if $opt{'p'};
 103
 104 if (-x $perlpath) {
 105     print "## Perl binary `$perlpath' appears executable.\n" if $opt{'v'};
 106     print "ok 1\n";
 107     $pass__total++;
 108 }
 109 else {
 110     print "# Perl binary `$perlpath' does not appear executable.\n";
 111     print "not ok 1\n";
 112     $error_total++;
 113 }
 114 $tests_total++;
 115
 116
 117 print "## Checking Perl version via variable `\$]'.\n" if $opt{'p'};
 118
 119 !NO!SUBS!
 120
 121 print OUT <<"!GROK!THIS!";
 122 my \$ivp_VERSION = $];
 123
 124 !GROK!THIS!
 125 print OUT <<'!NO!SUBS!';
 126 if ($ivp_VERSION eq $]) {
 127     print "## Perl version `$]' appears installed as expected.\n" if $opt{'v'};
 128     print "ok 2\n";
 129     $pass__total++;
 130 }
 131 else {
 132     print "# Perl version `$]' installed, expected $ivp_VERSION.\n";
 133     print "not ok 2\n";
 134     $error_total++;
 135 }
 136 $tests_total++;
 137
 138
 139 print "## Checking roots of the Perl library directory tree via variable `\@INC'.\n" if $opt{'p'};
 140
 141 my $INC_total = 0;
 142 my $INC_there = 0;
 143 foreach (@INC) {
 144     next if $_ eq '.'; # skip -d test here
 145     if ($^O eq 'MacOS') {
 146         next if $_ eq ':'; # skip -d test here
 147         next if $_ eq 'Dev:Pseudo:'; # why is this in @INC?
 148     }
 149     if (-d $_) {
 150         print "## Perl \@INC directory `$_' exists.\n" if $opt{'v'};
 151         $INC_there++;
 152     }
 153     else {
 154         print "# Perl \@INC directory `$_' does not appear to exist.\n";
 155     }
 156     $INC_total++;
 157 }
 158 if ($INC_total == $INC_there) {
 159     print "ok 3\n";
 160     $pass__total++;
 161 }
 162 else {
 163     print "not ok 3\n";
 164     $error_total++;
 165 }
 166 $tests_total++;
 167
 168
 169 print "## Checking installations of modules necessary for ivp.\n" if $opt{'p'};
 170
 171 my $needed_total = 0;
 172 my $needed_there = 0;
 173 foreach (qw(Config.pm ExtUtils/Installed.pm)) {
 174     $@ = undef;
 175     $needed_total++;
 176     eval "require \"$_\";";
 177     if (!$@) {
 178         print "## Module `$_' appears to be installed.\n" if $opt{'v'};
 179         $needed_there++;
 180     }
 181     else {
 182         print "# Needed module `$_' does not appear to be properly installed.\n";
 183     }
 184     $@ = undef;
 185 }
 186 if ($needed_total == $needed_there) {
 187     print "ok 4\n";
 188     $pass__total++;
 189 }
 190 else {
 191     print "not ok 4\n";
 192     $error_total++;
 193 }
 194 $tests_total++;
 195
 196
 197 print "## Checking installations of extensions built with perl.\n" if $opt{'p'};
 198
 199 use Config;
 200
 201 my $extensions_total = 0;
 202 my $extensions_there = 0;
 203 if (defined($Config{'extensions'})) {
 204     my @extensions = split(/\s+/,$Config{'extensions'});
 205     foreach (@extensions) {
 206         next if ($_ eq '');
 207         if ( $useithreads !~ /define/i ) {
 208             next if ($_ eq 'threads');
 209             next if ($_ eq 'threads/shared');
 210         }
 211         # that's a distribution name, not a module name
 212         next if $_ eq 'IO/Compress/Zlib';
 213         next if $_ eq 'Devel/DProf';
 214            # VMS$ perl  -e "eval ""require \""Devel/DProf.pm\"";"" print $@"
 215            # \NT> perl  -e "eval \"require 'Devel/DProf.pm'\"; print $@"
 216            # DProf: run perl with -d to use DProf.
 217            # Compilation failed in require at (eval 1) line 1.
 218         eval " require \"$_.pm\"; ";
 219         if (!$@) {
 220             print "## Module `$_' appears to be installed.\n" if $opt{'v'};
 221             $extensions_there++;
 222         }
 223         else {
 224             print "# Required module `$_' does not appear to be properly installed.\n";
 225             $@ = undef;
 226         }
 227         $extensions_total++;
 228     }
 229
 230     # A silly name for a module (that hopefully won't ever exist).
 231     # Note that this test serves more as a check of the validity of the
 232     # actuall required module tests above.
 233     my $unnecessary = 'bLuRfle';
 234
 235     if (!grep(/$unnecessary/, @extensions)) {
 236         $@ = undef;
 237         eval " require \"$unnecessary.pm\"; ";
 238         if ($@) {
 239             print "## Unnecessary module `$unnecessary' does not appear to be installed.\n" if $opt{'v'};
 240         }
 241         else {
 242             print "# Unnecessary module `$unnecessary' appears to be installed.\n";
 243             $extensions_there++;
 244         }
 245     }
 246     $@ = undef;
 247 }
 248 if ($extensions_total == $extensions_there) {
 249     print "ok 5\n";
 250     $pass__total++;
 251 }
 252 else {
 253     print "not ok 5\n";
 254     $error_total++;
 255 }
 256 $tests_total++;
 257
 258
 259 print "## Checking installations of later additional extensions.\n" if $opt{'p'};
 260
 261 use ExtUtils::Installed;
 262
 263 my $installed_total = 0;
 264 my $installed_there = 0;
 265 my $version_check = 0;
 266 my $installed = ExtUtils::Installed -> new();
 267 my @modules = $installed -> modules();
 268 my @missing = ();
 269 my $version = undef;
 270 for (@modules) {
 271     $installed_total++;
 272     # Consider it there if it contains one or more files,
 273     # and has zero missing files,
 274     # and has a defined version
 275     $version = undef;
 276     $version = $installed -> version($_);
 277     if ($version) {
 278         print "## $_; $version\n" if $opt{'v'};
 279         $version_check++;
 280     }
 281     else {
 282         print "# $_; NO VERSION\n" if $opt{'v'};
 283     }
 284     $version = undef;
 285     @missing = ();
 286     @missing = $installed -> validate($_);
 287     if ($#missing >= 0) {
 288         print "# file",+($#missing == 0) ? '' : 's'," missing from installation:\n";
 289         print '# ',join(' ',@missing),"\n";
 290     }
 291     elsif ($#missing == -1) {
 292         $installed_there++;
 293     }
 294     @missing = ();
 295 }
 296 if (($installed_total == $installed_there) &&
 297     ($installed_total == $version_check)) {
 298     print "ok 6\n";
 299     $pass__total++;
 300 }
 301 else {
 302     print "not ok 6\n";
 303     $error_total++;
 304 }
 305 $tests_total++;
 306
 307
 308 if ($opt{'a'}) {
 309 print "## Checking installations of *.h -> *.ph header files.\n" if $opt{'p'};
 310 my $ph_there = 0;
 311 my $var = undef;
 312 my $val = undef;
 313 my $h_file = undef;
 314 # Just about "any" C implementation ought to have a stdio.h (even if
 315 # Config.pm may not list a i_stdio var).
 316 my @ph_files = qw(stdio.ph);
 317 # Add the ones that we know that perl thinks are there:
 318 while (($var, $val) = each %Config) {
 319     if ($var =~ m/i_(.+)/ && $val eq 'define') {
 320         $h_file = $1;
 321         # Some header and symbol names don't match for hysterical raisins.
 322         $h_file = 'arpa/inet'    if $h_file eq 'arpainet';
 323         $h_file = 'netinet/in'   if $h_file eq 'niin';
 324         $h_file = 'netinet/tcp'  if $h_file eq 'netinettcp';
 325         $h_file = 'sys/resource' if $h_file eq 'sysresrc';
 326         $h_file = 'sys/select'   if $h_file eq 'sysselct';
 327         $h_file = 'sys/security' if $h_file eq 'syssecrt';
 328         $h_file = 'rpcsvc/dbm'   if $h_file eq 'rpcsvcdbm';
 329         # This ought to distinguish syslog from sys/syslog.
 330         # (NB syslog.ph is heavily used for the DBI pre-requisites).
 331         $h_file =~ s{^sys(\w.+)}{sys/$1} unless $h_file eq 'syslog';
 332         push(@ph_files, "$h_file.ph");
 333     }
 334 }
 335 #foreach (qw(stdio.ph syslog.ph)) {
 336 foreach (@ph_files) {
 337     $@ = undef;
 338     eval "require \"$_\";";
 339     if (!$@) {
 340         print "## Perl header `$_' appears to be installed.\n" if $opt{'v'};
 341         $ph_there++;
 342     }
 343     else {
 344         print "# Perl header `$_' does not appear to be properly installed.\n";
 345     }
 346     $@ = undef;
 347 }
 348
 349 if (scalar(@ph_files) == $ph_there) {
 350     print "ok 7\n";
 351     $pass__total++;
 352 }
 353 else {
 354     print "not ok 7\n";
 355     $error_total++;
 356 }
 357 $tests_total++;
 358 }
 359 else {
 360     print "##  Skip checking of *.ph header files.\n" if $opt{'p'};
 361 }
 362
 363 # Final report (rather than feed ousrselves to Test::Harness::runtests()
 364 # we simply format some output on our own to keep things simple and
 365 # easier to "fix" - at least for now.
 366
 367 if ($error_total == 0 && $tests_total) {
 368     print "All tests successful.\n";
 369 } elsif ($tests_total==0){
 370         die "FAILED--no tests were run for some reason.\n";
 371 } else {
 372     my $rate = 0.0;
 373     if ($tests_total > 0) { $rate = sprintf "%.2f", 100.0 * ($pass__total / $tests_total); }
 374     printf " %d/%d subtests failed, %.2f%% okay.\n",
 375                               $error_total, $tests_total, $rate;
 376 }
 377
 378 =head1 NAME
 379
 380 perlivp - Perl Installation Verification Procedure
 381
 382 =head1 SYNOPSIS
 383
 384 B<perlivp> [B<-a>] [B<-p>] [B<-v>] [B<-h>]
 385
 386 =head1 DESCRIPTION
 387
 388 The B<perlivp> program is set up at Perl source code build time to test the
 389 Perl version it was built under.  It can be used after running:
 390
 391     make install
 392
 393 (or your platform's equivalent procedure) to verify that B<perl> and its
 394 libraries have been installed correctly.  A correct installation is verified
 395 by output that looks like:
 396
 397     ok 1
 398     ok 2
 399
 400 etc.
 401
 402 =head1 OPTIONS
 403
 404 =over 5
 405
 406 =item B<-h> help
 407
 408 Prints out a brief help message.
 409
 410 =item B<-a> run all tests
 411
 412 Normally tests for optional features are skipped.  With -a all tests
 413 are executed.
 414
 415 =item B<-p> print preface
 416
 417 Gives a description of each test prior to performing it.
 418
 419 =item B<-v> verbose
 420
 421 Gives more detailed information about each test, after it has been performed.
 422 Note that any failed tests ought to print out some extra information whether
 423 or not -v is thrown.
 424
 425 =back
 426
 427 =head1 DIAGNOSTICS
 428
 429 =over 4
 430
 431 =item * print "# Perl binary `$perlpath' does not appear executable.\n";
 432
 433 Likely to occur for a perl binary that was not properly installed.
 434 Correct by conducting a proper installation.
 435
 436 =item * print "# Perl version `$]' installed, expected $ivp_VERSION.\n";
 437
 438 Likely to occur for a perl that was not properly installed.
 439 Correct by conducting a proper installation.
 440
 441 =item * print "# Perl \@INC directory `$_' does not appear to exist.\n";
 442
 443 Likely to occur for a perl library tree that was not properly installed.
 444 Correct by conducting a proper installation.
 445
 446 =item * print "# Needed module `$_' does not appear to be properly installed.\n";
 447
 448 One of the two modules that is used by perlivp was not present in the
 449 installation.  This is a serious error since it adversely affects perlivp's
 450 ability to function.  You may be able to correct this by performing a
 451 proper perl installation.
 452
 453 =item * print "# Required module `$_' does not appear to be properly installed.\n";
 454
 455 An attempt to C<eval "require $module"> failed, even though the list of
 456 extensions indicated that it should succeed.  Correct by conducting a proper
 457 installation.
 458
 459 =item * print "# Unnecessary module `bLuRfle' appears to be installed.\n";
 460
 461 This test not coming out ok could indicate that you have in fact installed
 462 a bLuRfle.pm module or that the C<eval " require \"$module_name.pm\"; ">
 463 test may give misleading results with your installation of perl.  If yours
 464 is the latter case then please let the author know.
 465
 466 =item * print "# file",+($#missing == 0) ? '' : 's'," missing from installation:\n";
 467
 468 One or more files turned up missing according to a run of
 469 C<ExtUtils::Installed -E<gt> validate()> over your installation.
 470 Correct by conducting a proper installation.
 471
 472 =item * print "# Perl header `$_' does not appear to be properly installed.\n";
 473
 474 Correct by running B<h2ph> over your system's C header files.  If necessary,
 475 edit the resulting *.ph files to eliminate perl syntax errors.
 476
 477 =back
 478
 479 For further information on how to conduct a proper installation consult the
 480 INSTALL file that comes with the perl source and the README file for your
 481 platform.
 482
 483 =head1 AUTHOR
 484
 485 Peter Prymmer
 486
 487 =cut
 488
 489 !NO!SUBS!
 490
 491 close OUT or die "Can't close $file: $!";
 492 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
 493 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';
 494 chdir $origdir;
 495