rt 4.2.16
[freeside.git] / rt / sbin / rt-test-dependencies.in
index 1ce118f..7b7d231 100644 (file)
@@ -3,7 +3,7 @@
 #
 # COPYRIGHT:
 #
-# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2019 Best Practical Solutions, LLC
 #                                          <sales@bestpractical.com>
 #
 # (Except where explicitly superseded by other copyright notices)
 #
 
 use strict;
+use warnings;
 no warnings qw(numeric redefine);
 use Getopt::Long;
+use Cwd qw(abs_path);
 my %args;
 my %deps;
+my @orig_argv = @ARGV;
+# Save our path because installers or tests can change cwd
+my $script_path = abs_path($0);
+
 GetOptions(
     \%args,                               'v|verbose',
-    'install',                            'with-MYSQL',
-    'with-POSTGRESQL|with-pg|with-pgsql', 'with-SQLITE',
-    'with-ORACLE',                        'with-FASTCGI', 'with-FASTCGI-SERVER',
-    'with-SPEEDYCGI',                     'with-MODPERL1',
-    'with-MODPERL2',                      'with-DEV',
-    'with-STANDALONE',
+    'install!',
+    'with-MYSQL', 'with-PG', 'with-SQLITE', 'with-ORACLE',
+    'with-FASTCGI', 'with-MODPERL1', 'with-MODPERL2', 'with-STANDALONE',
+
+    'with-DEVELOPER',
 
     'with-GPG',
     'with-ICAL',
-    'with-SMTP',
     'with-GRAPHVIZ',
     'with-GD',
     'with-DASHBOARDS',
+    'with-USERLOGO',
+    'with-HTML-DOC',
 
-    'download=s',
-    'repository=s',
-    'list-deps'
+    'list-deps',
+    'siteinstall!',
+    'help|h',
 );
 
-unless (keys %args) {
-    help();
-    exit(1);
+if ( $args{help} ) {
+    require Pod::Usage;
+    Pod::Usage::pod2usage( { verbose => 2 } );
+    exit;
 }
 
 # Set up defaults
 my %default = (
     'with-MASON' => 1,
+    'with-PSGI' => 0,
     'with-CORE' => 1,
     'with-CLI' => 1,
     'with-MAILGATE' => 1, 
-    'with-DEV' => @RT_DEVEL_MODE@, 
-    'with-STANDALONE' => 1,
-    'with-GPG' => @RT_GPG@,
+    'with-DEVELOPER' => @RT_DEVELOPER@,
+    'with-GPG' => @RT_GPG_DEPS@,
+    'with-SMIME' => @RT_SMIME_DEPS@,
     'with-ICAL' => 1,
     'with-SMTP' => 1,
     'with-GRAPHVIZ' => @RT_GRAPHVIZ@,
     'with-GD' => @RT_GD@,
-    'with-DASHBOARDS' => 1
+    'with-DASHBOARDS' => 1,
+    'with-USERLOGO' => 1,
+    'with-HTML-DOC' => @RT_DEVELOPER@,
 );
 $args{$_} = $default{$_} foreach grep !exists $args{$_}, keys %default;
 
@@ -152,48 +162,14 @@ sub conclude {
                     0, $module->{error} );
             }
         }
-        exit 1;
-    }
-}
-
-
-sub help {
-
-    print <<'.';
-
-By default, testdeps determine whether you have 
-installed all the perl modules RT needs to run.
 
-    --install           Install missing modules
+        print "\nPerl library path for @PERL@:\n";
+        print "    $_\n" for @INC;
 
-The following switches will tell the tool to check for specific dependencies
-
-    --with-mysql        Database interface for MySQL
-    --with-postgresql   Database interface for PostgreSQL 
-    --with-oracle       Database interface for Oracle
-    --with-sqlite       Database interface and driver for SQLite (unsupported)
-
-    --with-standalone     Libraries needed to support the standalone simple pure perl server
-    --with-fastcgi-server Libraries needed to support the external fastcgi server
-    --with-fastcgi        Libraries needed to support the fastcgi handler
-    --with-speedycgi      Libraries needed to support the speedycgi handler
-    --with-modperl1       Libraries needed to support the modperl 1 handler
-    --with-modperl2       Libraries needed to support the modperl 2 handler
-
-    --with-dev          Tools needed for RT development
-
-You can also specify -v or --verbose to list the status of all dependencies,
-rather than just the missing ones.
-
-The "RT_FIX_DEPS_CMD" environment variable, if set, will be used
-instead of the standard CPAN shell by --install to install any
-required modules.  It will be called with the module name, or, if
-"RT_FIX_DEPS_CMD" contains a "%s", will replace the "%s" with the
-module name before calling the program.
-.
+        exit 1;
+    }
 }
 
-
 sub text_to_hash {
     my %hash;
     for my $line ( split /\n/, $_[0] ) {
@@ -204,135 +180,140 @@ sub text_to_hash {
 
     return %hash;
 }
+sub set_dep {
+    my ($name, $module, $version) = @_;
+    my %list = @{$deps{$name}};
+    $list{$module} = ($version || '');
+    $deps{$name} = [ %list ];
+}
 
 $deps{'CORE'} = [ text_to_hash( << '.') ];
+Apache::Session 1.53
+CGI 3.38
+CGI::Cookie 1.20
+CGI::Emulate::PSGI
+CGI::PSGI 0.12
+Class::Accessor::Fast
+Crypt::Eksblowfish
+CSS::Squish 0.06
+Data::GUID
+Date::Extract 0.02
+Date::Manip
+DateTime 0.44
+DateTime::Format::Natural 0.67
+DateTime::Locale 0.40
+DBI 1.37
+DBIx::SearchBuilder 1.65
+Devel::GlobalDestruction
+Devel::StackTrace 1.19
 Digest::base
 Digest::MD5 2.27
 Digest::SHA
-DBI 1.37
-Class::ReturnValue 0.40
-DBIx::SearchBuilder 1.54
-Text::Template 1.44
+Email::Address 1.908
+Email::Address::List 0.05
+Encode
+Errno
+File::Glob
 File::ShareDir
 File::Spec 0.8
-HTML::Entities 
+File::Temp 0.19
+HTML::Entities
+HTML::FormatText::WithLinks 0.14
+HTML::FormatText::WithLinks::AndTables
+HTML::Mason 1.43
+HTML::Mason::PSGIHandler 0.52
+HTML::Quoted
+HTML::RewriteAttributes 0.05
 HTML::Scrubber 0.08
-Log::Dispatch 2.0
-Sys::Syslog 0.16
+HTTP::Message 6.0
+IPC::Run3
+JSON
+LWP::Simple
+List::MoreUtils
 Locale::Maketext 1.06
+Locale::Maketext::Fuzzy 0.11
 Locale::Maketext::Lexicon 0.32
-Locale::Maketext::Fuzzy
-MIME::Entity 5.425
+Log::Dispatch 2.30
+Mail::Header 2.12
 Mail::Mailer 1.57
-Email::Address
-Text::Wrapper 
-Time::ParseDate
-Time::HiRes 
-File::Temp 0.19
-Text::Quoted 2.02
-Tree::Simple 1.04
-UNIVERSAL::require
+MIME::Entity 5.504
+Module::Refresh 0.03
+Module::Versions::Report 1.05
+Encode 2.64
+Net::CIDR
+Plack 1.0002
 Regexp::Common
+Regexp::Common::net::CIDR
+Regexp::IPv6
+Role::Basic 0.12
 Scalar::Util
-Module::Versions::Report 1.05
-Cache::Simple::TimedExpiry
-Calendar::Simple
-Encode 2.21
-CSS::Squish 0.06
-File::Glob
-Devel::StackTrace 1.19
-.
-
-$deps{'MASON'} = [ text_to_hash( << '.') ];
-HTML::Mason 1.36
-Errno
-Digest::MD5 2.27
-CGI::Cookie 1.20
 Storable 2.08
-Apache::Session 1.53
-XML::RSS 1.05
+Symbol::Global::Name 0.04
+Sys::Syslog 0.16
+Text::Password::Pronounceable
+Text::Quoted 2.07
+Text::Template 1.44
 Text::WikiFormat 0.76
-CSS::Squish 0.06
-Devel::StackTrace 1.19
-.
-
-$deps{'STANDALONE'} = [ text_to_hash( << '.') ];
-HTTP::Server::Simple 0.34
-HTTP::Server::Simple::Mason 0.14
-Net::Server
+Text::Wrapper
+Time::HiRes
+Time::ParseDate
+Tree::Simple 1.04
+UNIVERSAL::require
+XML::RSS 1.05
 .
+set_dep( CORE => 'Symbol::Global::Name' => 0.05 ) if $] >= 5.019003;
+set_dep( CORE => CGI => 4.00 )                    if $] > 5.019003;
 
 $deps{'MAILGATE'} = [ text_to_hash( << '.') ];
-HTML::TreeBuilder
-HTML::FormatText
+Crypt::SSLeay
 Getopt::Long
-LWP::UserAgent
+LWP::Protocol::https
+LWP::UserAgent 6.0
+Net::SSL
 Pod::Usage
 .
 
 $deps{'CLI'} = [ text_to_hash( << '.') ];
 Getopt::Long 2.24
-LWP
 HTTP::Request::Common
-Text::ParseWords
-Term::ReadLine
+LWP
 Term::ReadKey
+Term::ReadLine
+Text::ParseWords
 .
 
-$deps{'DEV'} = [ text_to_hash( << '.') ];
-HTML::Form
-HTML::TokeParser
-WWW::Mechanize
-Test::WWW::Mechanize 1.04
-Module::Refresh 0.03
-Test::Expect 0.31
-XML::Simple
+$deps{'DEVELOPER'} = [ text_to_hash( << '.') ];
+Email::Abstract
 File::Find
-Test::Deep 0 # needed for shredder tests
-String::ShellQuote 0 # needed for gnupg-incoming.t
-Test::HTTP::Server::Simple 0.09
-Test::HTTP::Server::Simple::StashWarnings 0.02
+File::Which
+Locale::PO
 Log::Dispatch::Perl
-Test::Warn
-Test::Builder 0.77 # needed to fix TODO test
-IPC::Run3
+Mojo::DOM
+Plack::Middleware::Test::StashWarnings 0.08
+Set::Tiny
+String::ShellQuote 0 # needed for gnupg-incoming.t
+Test::Builder 0.90 # needed for is_passing
+Test::Deep 0 # needed for shredder tests
+Test::Email
+Test::Expect 0.31
+Test::LongString
 Test::MockTime
-HTTP::Server::Simple::Mason 0.13
-Log::Dispatch::Perl
+Test::NoWarnings
+Test::Pod
+Test::Warn
+Test::WWW::Mechanize 1.30
+Test::WWW::Mechanize::PSGI
+WWW::Mechanize 1.52
+XML::Simple
 .
 
 $deps{'FASTCGI'} = [ text_to_hash( << '.') ];
-CGI 3.38
-FCGI
-CGI::Fast 
-.
-
-$deps{'FASTCGI-SERVER'} = [ text_to_hash( << '.') ];
-CGI 3.38
-CGI::Fast
+FCGI 0.74
 FCGI::ProcManager
-File::Basename
-File::Spec
-Getopt::Long
-Pod::Usage
 .
 
-$deps{'SPEEDYCGI'} = [ text_to_hash( << '.') ];
-CGI 3.38
-CGI::SpeedyCGI
-.
-
-
 $deps{'MODPERL1'} = [ text_to_hash( << '.') ];
-CGI 3.38
 Apache::Request
-Apache::DBI 0.92
-.
-
-$deps{'MODPERL2'} = [ text_to_hash( << '.') ];
-CGI 3.38
-Apache::DBI
-HTML::Mason 1.36
 .
 
 $deps{'MYSQL'} = [ text_to_hash( << '.') ];
@@ -343,7 +324,8 @@ $deps{'ORACLE'} = [ text_to_hash( << '.') ];
 DBD::Oracle
 .
 
-$deps{'POSTGRESQL'} = [ text_to_hash( << '.') ];
+$deps{'PG'} = [ text_to_hash( << '.') ];
+DBIx::SearchBuilder 1.66
 DBD::Pg 1.43
 .
 
@@ -352,37 +334,52 @@ DBD::SQLite 1.00
 .
 
 $deps{'GPG'} = [ text_to_hash( << '.') ];
+File::Which
 GnuPG::Interface
 PerlIO::eol
 .
 
-$deps{'ICAL'} = [ text_to_hash( << '.') ];
-Data::ICal
+$deps{'SMIME'} = [ text_to_hash( << '.') ];
+Crypt::X509
+File::Which
+String::ShellQuote
 .
 
-$deps{'SMTP'} = [ text_to_hash( << '.') ];
-Net::SMTP
+$deps{'ICAL'} = [ text_to_hash( << '.') ];
+Data::ICal
 .
 
 $deps{'DASHBOARDS'} = [ text_to_hash( << '.') ];
-HTML::RewriteAttributes 0.02
 MIME::Types
+URI 1.59
+URI::QueryParam
 .
 
 $deps{'GRAPHVIZ'} = [ text_to_hash( << '.') ];
 GraphViz
-IPC::Run
-IPC::Run::SafeHandles
+IPC::Run 0.90
 .
 
 $deps{'GD'} = [ text_to_hash( << '.') ];
 GD
-GD::Graph
+GD::Graph 1.47
 GD::Text
 .
 
+$deps{'USERLOGO'} = [ text_to_hash( << '.') ];
+Convert::Color
+.
+
+$deps{'HTML-DOC'} = [ text_to_hash( <<'.') ];
+HTML::Entities
+Pod::Simple 3.24
+.
+
 my %AVOID = (
     'DBD::Oracle' => [qw(1.23)],
+    'Devel::StackTrace' => [qw(1.28 1.29)],
+    'DateTime::Locale'  => [qw(1.00 1.01)],
+    'DBD::mysql'        => [qw(4.042)],
 );
 
 if ($args{'download'}) {
@@ -396,7 +393,7 @@ check_users();
 
 my %Missing_By_Type = ();
 foreach my $type (sort grep $args{$_}, keys %args) {
-    next unless ($type =~ /^with-(.*?)$/);
+    next unless ($type =~ /^with-(.*?)$/) and $deps{$1};
 
     $type = $1;
     section("$type dependencies");
@@ -409,6 +406,16 @@ foreach my $type (sort grep $args{$_}, keys %args) {
     if ( $args{'install'} ) {
         for my $module (keys %missing) {
             resolve_dep($module, $missing{$module}{version});
+            my $m = $module . '.pm';
+            $m =~ s!::!/!g;
+            if ( delete $INC{$m} ) {
+                my $symtab = $module . '::';
+                no strict 'refs';
+                for my $symbol ( keys %{$symtab} ) {
+                    next if substr( $symbol, -2, 2 ) eq '::';
+                    delete $symtab->{$symbol};
+                }
+            }
             delete $missing{$module}
                 if test_dep($module, $missing{$module}{version}, $AVOID{$module});
         }
@@ -417,7 +424,12 @@ foreach my $type (sort grep $args{$_}, keys %args) {
     $Missing_By_Type{$type} = \%missing if keys %missing;
 }
 
-conclude(%Missing_By_Type);
+if ( $args{'install'} && keys %Missing_By_Type ) {
+    exec($script_path, @orig_argv, '--no-install');
+}
+else {
+    conclude(%Missing_By_Type);
+}
 
 sub test_deps {
     my @deps = @_;
@@ -445,7 +457,8 @@ sub test_dep {
         print $module, ': ', $version || 0, "\n"; 
     }
     else {
-        eval "use $module $version ()";
+        no warnings 'deprecated';
+        eval "{ local \$ENV{__WARN__}; use $module $version () }";
         if ( my $error = $@ ) {
             return 0 unless wantarray;
 
@@ -453,6 +466,10 @@ sub test_dep {
             $error =~ s/at \(eval \d+\) line \d+\.$//;
             undef $error if $error =~ /this is only/;
 
+            my $path = $module;
+            $path =~ s{::}{/}g;
+            undef $error if defined $error and $error =~ /^Can't locate $path\.pm in \@INC/;
+
             return ( 0, $error );
         }
         
@@ -472,9 +489,30 @@ sub resolve_dep {
     my $module = shift;
     my $version = shift;
 
+    unless (defined $args{siteinstall}) {
+        require Config;
+        my %uniq;
+        my @order = grep {($_ eq $Config::Config{sitelibexp}
+                        or $_ eq $Config::Config{privlibexp})
+                        and not $uniq{$_}++} @INC;
+        if ($] < 5.011 and @order == 2
+                and $order[0] eq $Config::Config{sitelibexp}
+                and $order[1] eq $Config::Config{privlibexp}) {
+
+            print "\n";
+            print "Patched perl, with site_perl before core in \@INC, detected.\n";
+            print "Installing dual-life modules into site_perl so they are not\n";
+            print "later overridden by the distribution's package.\n";
+
+            $args{siteinstall} = 1;
+        } else {
+            $args{siteinstall} = 0;
+        }
+    }
+
     print "\nInstall module $module\n";
 
-    my $ext = $ENV{'RT_FIX_DEPS_CMD'};
+    my $ext = $ENV{'RT_FIX_DEPS_CMD'} || $ENV{'PERL_PREFER_CPAN_CLIENT'};
     unless( $ext ) {
         my $configured = 1;
         {
@@ -491,6 +529,12 @@ Please run `@PERL@ -MCPAN -e shell` to configure it.
 END
             exit(1);
         }
+
+        my $installdirs = $CPAN::Config->{makepl_arg} ||= "";
+        $installdirs =~ s/(\bINSTALLDIRS=\S+|$)/ INSTALLDIRS=site/
+            if $args{siteinstall};
+        local $CPAN::Config->{makepl_arg} = $installdirs;
+
         my $rv = eval { require CPAN; CPAN::Shell->install($module) };
         return $rv unless $@;
 
@@ -534,55 +578,14 @@ END
     return scalar `$ext 1>&2`;
 }
 
-sub download_mods {
-    my %modules;
-    use CPAN;
-    
-    foreach my $key (keys %deps) {
-        my @deps = (@{$deps{$key}});
-        while (@deps) {
-            my $mod = shift @deps;
-            my $ver = shift @deps;
-            next if ($mod =~ /^(DBD-|Apache-Request)/);
-            $modules{$mod} = $ver;
-        }
-    }
-    my @mods = keys %modules;
-    CPAN::get();
-    my $moddir = $args{'download'};
-    foreach my $mod (@mods) {
-        $CPAN::Config->{'build_dir'} = $moddir;
-        CPAN::get($mod);
-    }
-
-    opendir(DIR, $moddir);
-    while ( my $dir = readdir(DIR)) {
-        print "Dir is $dir\n";
-        next if ( $dir =~ /^\.\.?$/);
-
-        # Skip things we've previously tagged
-        my $out = `svn ls $args{'repository'}/tags/$dir`;
-        next if ($out);
-
-        if ($dir =~ /^(.*)-(.*?)$/) {
-            `svn_load_dirs -no_user_input -t tags/$dir -v $args{'repository'} dists/$1 $moddir/$dir`;
-            `rm -rf $moddir/$dir`;
-
-        }
-
-    }
-    closedir(DIR);
-    exit;
-}
-
 sub check_perl_version {
   section("perl");
-  eval {require 5.008003};
+  eval {require 5.010_001};
   if ($@) {
-    print_found("5.8.3", 0,"RT is known to be non-functional on versions of perl older than 5.8.3. Please upgrade to 5.8.3 or newer.");
+    print_found("5.10.1", 0, sprintf("RT requires Perl v5.10.1 or newer. Your current Perl is v%vd", $^V));
     exit(1);
   } else {
-    print_found( sprintf(">=5.8.3(%vd)", $^V), 1 );
+    print_found( sprintf(">=5.10.1(%vd)", $^V), 1 );
   }
 }
 
@@ -596,6 +599,81 @@ sub check_users {
   print_found("web group (@WEB_GROUP@)",   defined getgrnam("@WEB_GROUP@"));
 }
 
+1;
+
+__END__
 
+=head1 NAME
+
+rt-test-dependencies - test rt's dependencies
+
+=head1 SYNOPSIS
+
+    rt-test-dependencies
+    rt-test-dependencies --install
+    rt-test-dependencies --with-mysql --with-fastcgi
+
+=head1 DESCRIPTION
+
+by default, C<rt-test-dependencies> determines whether you have installed all
+the perl modules RT needs to run.
+
+the "RT_FIX_DEPS_CMD" environment variable, if set, will be used instead of
+the standard CPAN shell by --install to install any required modules.  it will
+be called with the module name, or, if "RT_FIX_DEPS_CMD" contains a "%s", will
+replace the "%s" with the module name before calling the program.
+
+=head1 OPTIONS
+
+=over
+
+=item install
+
+    install missing modules
+
+=item verbose
+
+list the status of all dependencies, rather than just the missing ones.
+
+-v is equal to --verbose
+
+=item specify dependencies
+
+=over
+
+=item --with-mysql
+
+database interface for mysql
+
+=item --with-pg
+
+database interface for postgresql
+
+=item --with-oracle
+
+database interface for oracle
+
+=item --with-sqlite
+
+database interface and driver for sqlite (unsupported)
+
+=item --with-fastcgi
+
+libraries needed to support the fastcgi handler
+
+=item --with-modperl1
+
+libraries needed to support the modperl 1 handler
+
+=item --with-modperl2
+
+libraries needed to support the modperl 2 handler
+
+=item --with-developer
+
+tools needed for RT development
+
+=back
+
+=back
 
-1;