import rt 3.8.10
[freeside.git] / rt / sbin / rt-test-dependencies
index c1591b1..18e7c06 100644 (file)
@@ -1,28 +1,51 @@
 #!/usr/bin/perl
-# BEGIN LICENSE BLOCK
-# 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
-# 
-# (Except where explictly superceded by other copyright notices)
-# 
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (Except where explicitly superseded by other copyright notices)
+#
+#
+# LICENSE:
+#
 # This work is made available to you under the terms of Version 2 of
 # the GNU General Public License. A copy of that license should have
 # been provided with this software, but in any event can be snarfed
 # from www.gnu.org.
-# 
+#
 # This work is distributed in the hope that it will be useful, but
 # WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 # General Public License for more details.
-# 
-# Unless otherwise specified, all modifications, corrections or
-# extensions to this work which alter its source code become the
-# property of Best Practical Solutions, LLC when submitted for
-# inclusion in the work.
-# 
-# 
-# END LICENSE BLOCK
-
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+#
+#
+# CONTRIBUTION SUBMISSION POLICY:
+#
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+#
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+#
+# END BPS TAGGED BLOCK }}}
 #
 # This is just a basic script that checks to make sure that all
 # the modules needed by RT before you can install it.
 use strict;
 no warnings qw(numeric redefine);
 use Getopt::Long;
-use CPAN;
 my %args;
 my %deps;
-GetOptions(\%args,'install', 'with-MYSQL', 'with-POSTGRESQL|with-pg|with-pgsql', 'with-SQLITE', 'with-ORACLE', 'with-FASTCGI', 'with-SPEEDYCGI', 'with-MODPERL1', 'with-MODPERL2' ,'with-DEV');
-
-if (!keys %args) {
+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',
+
+    'with-GPG',
+    'with-ICAL',
+    'with-SMTP',
+    'with-GRAPHVIZ',
+    'with-GD',
+    'with-DASHBOARDS',
+
+    'download=s',
+    'repository=s',
+    'list-deps'
+);
+
+unless (keys %args) {
     help();
-    exit(0);
-}
-if ($args{'with-MODPERL2'}) {
-    warn_modperl2();
+    exit(1);
 }
 
-$args{'with-MASON'} = 1;
-$args{'with-CORE'} = 1;
-$args{'with-DEV'} =1; 
-$args{'with-CLI'} =1; 
-$args{'with-MAILGATE'} =1; 
-if ($] < 5.007) {
-$args{'with-I18N-COMPAT'} = 1;
+# Set up defaults
+my %default = (
+    'with-MASON' => 1,
+    'with-CORE' => 1,
+    'with-CLI' => 1,
+    'with-MAILGATE' => 1, 
+    'with-DEV' => 0, 
+    'with-STANDALONE' => 1,
+    'with-GPG' => 1,
+    'with-ICAL' => 1,
+    'with-SMTP' => 1,
+    'with-GRAPHVIZ' => 0,
+    'with-GD' => 1,
+    'with-DASHBOARDS' => 1
+);
+$args{$_} = $default{$_} foreach grep !exists $args{$_}, keys %default;
+
+{
+  my $section;
+  my %always_show_sections = (
+    perl => 1,
+    users => 1,
+  );
+
+  sub section {
+    my $s = shift;
+    $section = $s;
+    print "$s:\n" unless $args{'list-deps'};
+  }
+
+  sub print_found {
+    my $msg = shift;
+    my $test = shift;
+    my $extra = shift;
+
+    unless ( $args{'list-deps'} ) {
+        if ( $args{'v'} or not $test or $always_show_sections{$section} ) {
+            print "\t$msg ...";
+            print $test ? "found" : "MISSING";
+            print "\n";
+        }
+
+        print "\t\t$extra\n" if defined $extra;
+    }
+  }
 }
 
-sub warn_modperl2 {
-    print <<'.';
-        NOTE: mod_perl 2.0 isn't quite ready for prime_time just yet;
-        Best Practical Solutions strongly recommends that sites use
-        Apache 1.3 or FastCGI. If you MUST use mod_perl 2.0 (or 1.99),
-        please read the mailing list archives before asking for help.
-.
-    sleep 5;
+sub conclude {
+    my %missing_by_type = @_;
+
+    unless ( $args{'list-deps'} ) {
+        unless ( keys %missing_by_type ) {
+            print "\nAll dependencies have been found.\n";
+            return;
+        }
+
+        print "\nSOME DEPENDENCIES WERE MISSING.\n";
+
+        for my $type ( keys %missing_by_type ) {
+            my $missing = $missing_by_type{$type};
+
+            print "$type missing dependencies:\n";
+            for my $name ( keys %$missing ) {
+                my $module  = $missing->{$name};
+                my $version = $module->{version};
+                my $error = $module->{error};
+                print_found( $name . ( $version && !$error ? " >= $version" : "" ),
+                    0, $module->{error} );
+            }
+        }
+        exit 1;
+    }
 }
 
 
@@ -71,208 +164,438 @@ sub help {
 By default, testdeps determine whether you have 
 installed all the perl modules RT needs to run.
 
-       --install               Install missing modules
+    --install           Install missing modules
 
 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-sqlite           Database interface and driver for SQLite (unsupported)
-       --with-oracle           Database interface for oracle (unsupported)
+    --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-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-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
+    --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.
 .
 }
 
 
-sub _ {
-    map { /(\S+)\s*(\S*)/; $1 => ($2 ? $2 :'') } split ( /\n/, $_[0] );
+sub text_to_hash {
+    my %hash;
+    for my $line ( split /\n/, $_[0] ) {
+        my($key, $value) = $line =~ /(\S+)\s*(\S*)/;
+        $value ||= '';
+        $hash{$key} = $value;
+    }
+
+    return %hash;
 }
 
-$deps{'CORE'} = [ _( << '.') ];
+$deps{'CORE'} = [ text_to_hash( << '.') ];
+Digest::base
 Digest::MD5 2.27
+Digest::SHA
 DBI 1.37
-Test::Inline
 Class::ReturnValue 0.40
-DBIx::SearchBuilder 0.97
-Text::Template
+DBIx::SearchBuilder 1.54
+Text::Template 1.44
+File::ShareDir
 File::Spec 0.8
 HTML::Entities 
-Net::Domain
+HTML::Scrubber 0.08
 Log::Dispatch 2.0
+Sys::Syslog 0.16
 Locale::Maketext 1.06
 Locale::Maketext::Lexicon 0.32
 Locale::Maketext::Fuzzy
-MIME::Entity 5.108
+MIME::Entity 5.425
 Mail::Mailer 1.57
-Net::SMTP
+Email::Address
 Text::Wrapper 
 Time::ParseDate
-File::Temp
-Term::ReadKey
-Text::Autoformat
-Text::Quoted 1.3
+Time::HiRes 
+File::Temp 0.19
+Text::Quoted 2.02
+Tree::Simple 1.04
+UNIVERSAL::require
+Regexp::Common
 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'} = [ _( << '.') ];
-Params::Validate 0.02
-Cache::Cache
-Exception::Class
-HTML::Mason 1.16
-MLDBM
+$deps{'MASON'} = [ text_to_hash( << '.') ];
+HTML::Mason 1.36
 Errno
-FreezeThaw
 Digest::MD5 2.27
 CGI::Cookie 1.20
 Storable 2.08
 Apache::Session 1.53
+XML::RSS 1.05
+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
 .
 
-$deps{'MAILGATE'} = [ _( << '.') ];
+$deps{'MAILGATE'} = [ text_to_hash( << '.') ];
 HTML::TreeBuilder
 HTML::FormatText
 Getopt::Long
 LWP::UserAgent
+Pod::Usage
 .
 
-$deps{'CLI'} = [ _( << '.') ];
+$deps{'CLI'} = [ text_to_hash( << '.') ];
 Getopt::Long 2.24
+LWP
+HTTP::Request::Common
+Text::ParseWords
+Term::ReadLine
+Term::ReadKey
 .
 
-$deps{'DEV'} = [ _( << '.') ];
-Regexp::Common
-Time::HiRes 
-Test::Inline 
+$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
+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
+Log::Dispatch::Perl
+Test::Warn
+Test::Builder 0.77 # needed to fix TODO test
+IPC::Run3
+Test::MockTime
+HTTP::Server::Simple::Mason 0.13
+Log::Dispatch::Perl
 .
 
-$deps{'FASTCGI'} = [ _( << '.') ];
-CGI 2.92
+$deps{'FASTCGI'} = [ text_to_hash( << '.') ];
+CGI 3.38
 FCGI
 CGI::Fast 
 .
 
-$deps{'SPEEDYCGI'} = [ _( << '.') ];
-CGI 2.92
+$deps{'FASTCGI-SERVER'} = [ text_to_hash( << '.') ];
+CGI 3.38
+CGI::Fast
+FCGI::ProcManager
+File::Basename
+File::Spec
+Getopt::Long
+Pod::Usage
+.
+
+$deps{'SPEEDYCGI'} = [ text_to_hash( << '.') ];
+CGI 3.38
 CGI::SpeedyCGI
 .
 
 
-$deps{'MODPERL1'} = [ _( << '.') ];
-CGI 2.92
+$deps{'MODPERL1'} = [ text_to_hash( << '.') ];
+CGI 3.38
 Apache::Request
 Apache::DBI 0.92
 .
 
-$deps{'MODPERL2'} = [ _( << '.') ];
-CGI 2.92
+$deps{'MODPERL2'} = [ text_to_hash( << '.') ];
+CGI 3.38
 Apache::DBI
+HTML::Mason 1.36
 .
 
-$deps{'I18N-COMPAT'} = [ _( << '.') ];
-Text::Iconv
-Encode::compat 0.04
-.
-
-$deps{'MYSQL'} = [ _( << '.') ];
+$deps{'MYSQL'} = [ text_to_hash( << '.') ];
 DBD::mysql 2.1018
 .
-$deps{'ORACLE'} = [ _( << '.') ];
+
+$deps{'ORACLE'} = [ text_to_hash( << '.') ];
 DBD::Oracle
 .
-$deps{'POSTGRESQL'} = [ _( << '.') ];
-DBD::Pg
+
+$deps{'POSTGRESQL'} = [ text_to_hash( << '.') ];
+DBD::Pg 1.43
+.
+
+$deps{'SQLITE'} = [ text_to_hash( << '.') ];
+DBD::SQLite 1.00
 .
 
-print "perl:\n";
-print "\t5.8.0";
-eval {require 5.008};
-if ($@) {
-print "...missing.\n";
-        eval {require 5.006001};
-        if ($@) {
-            print " RT is known to be non-functional on versions of perl older than 5.6.1. Please upgrade to 5.8.0 or newer";
-            die;
-        } else {
-            print " RT is not supported on perl 5.6.1\n";
-        }
-} else {
-        print "...found\n";
+$deps{'GPG'} = [ text_to_hash( << '.') ];
+GnuPG::Interface
+PerlIO::eol
+.
 
-}
+$deps{'ICAL'} = [ text_to_hash( << '.') ];
+Data::ICal
+.
 
+$deps{'SMTP'} = [ text_to_hash( << '.') ];
+Net::SMTP
+.
 
-foreach my $type (keys %args)  {
-next unless ($type =~ /^with-(.*?)$/);
-my $type = $1;
-print "$type dependencies:\n";
-       my @deps = (@{$deps{$type}});
-       while (@deps) {
-               my $module = shift @deps;
-               my $version = shift @deps;
-my $ret;
-       $ret =test_dep($module, $version);      
+$deps{'DASHBOARDS'} = [ text_to_hash( << '.') ];
+HTML::RewriteAttributes 0.02
+MIME::Types
+.
 
-if ($args{'install'} && !$ret) {
-       resolve_dep($module);           
-}
-}
-}
-sub test_dep {
-       my $module = shift;
-       my $version = shift;
-
-       print "\t$module $version";
-       eval "use $module $version" ;
-       if ($@) {
-               my $error = $@;
-               $error =~ s/\n(.*)$//s;
-               print "...MISSING\n";
-                       print "\t\t$error\n" if $error =~ /this is only/;
-
-               return undef;
-       } else {
-               print "...found\n";
-return 1;
-       }
+$deps{'GRAPHVIZ'} = [ text_to_hash( << '.') ];
+GraphViz
+IPC::Run
+IPC::Run::SafeHandles
+.
+
+$deps{'GD'} = [ text_to_hash( << '.') ];
+GD
+GD::Graph
+GD::Text
+.
+
+my %AVOID = (
+    'DBD::Oracle' => [qw(1.23)],
+);
+
+if ($args{'download'}) {
+    download_mods();
 }
 
-sub resolve_dep {
-       my $module = shift;
-       use CPAN;
-       CPAN::Shell->install($module);          
-       
+
+check_perl_version();
+
+check_users();
+
+my %Missing_By_Type = ();
+foreach my $type (sort grep $args{$_}, keys %args) {
+    next unless ($type =~ /^with-(.*?)$/);
+
+    $type = $1;
+    section("$type dependencies");
+
+    my @missing;
+    my @deps = @{ $deps{$type} };
+
+    my %missing = test_deps(@deps);
+
+    if ( $args{'install'} ) {
+        for my $module (keys %missing) {
+            resolve_dep($module, $missing{$module}{version});
+            delete $missing{$module}
+                if test_dep($module, $missing{$module}{version}, $AVOID{$module});
+        }
+    }
+
+    $Missing_By_Type{$type} = \%missing if keys %missing;
 }
 
+conclude(%Missing_By_Type);
 
-sub print_help {
-    print << "EOF";
+sub test_deps {
+    my @deps = @_;
 
-$0 FLAG DBTYPE
+    my %missing;
+    while(@deps) {
+        my $module = shift @deps;
+        my $version = shift @deps;
+        my($test, $error) = test_dep($module, $version, $AVOID{$module});
+        my $msg = $module . ($version && !$error ? " >= $version" : '');
+        print_found($msg, $test, $error);
 
+        $missing{$module} = { version => $version, error => $error } unless $test;
+    }
 
-$0 is a tool for RT that will tell you if you've got all
-the modules RT depends on properly installed.
+    return %missing;
+}
 
-Flags: (only one flag is valid for a given run)
+sub test_dep {
+    my $module = shift;
+    my $version = shift;
+    my $avoid = shift;
+
+    if ( $args{'list-deps'} ) {
+        print $module, ': ', $version || 0, "\n"; 
+    }
+    else {
+        eval "use $module $version ()";
+        if ( my $error = $@ ) {
+            return 0 unless wantarray;
+
+            $error =~ s/\n(.*)$//s;
+            $error =~ s/at \(eval \d+\) line \d+\.$//;
+            undef $error if $error =~ /this is only/;
+
+            return ( 0, $error );
+        }
+        
+        if ( $avoid ) {
+            my $version = $module->VERSION;
+            if ( grep $version eq $_, @$avoid ) {
+                return 0 unless wantarray;
+                return (0, "It's known that there are problems with RT and version '$version' of '$module' module. If it's the latest available version of the module then you have to downgrade manually.");
+            }
+        }
+
+        return 1;
+    }
+}
 
--quiet will check to see if we've got everything we need
-       and will exit with a return code of (1) if we don't.
+sub resolve_dep {
+    my $module = shift;
+    my $version = shift;
+
+    print "\nInstall module $module\n";
+
+    my $ext = $ENV{'RT_FIX_DEPS_CMD'};
+    unless( $ext ) {
+        my $configured = 1;
+        {
+            local @INC = @INC;
+            if ( $ENV{'HOME'} ) {
+                unshift @INC, "$ENV{'HOME'}/.cpan";
+            }
+            $configured = eval { require CPAN::MyConfig } || eval { require CPAN::Config };
+        }
+        unless ( $configured ) {
+            print <<END;
+You haven't configured the CPAN shell yet.
+Please run `/usr/bin/perl -MCPAN -e shell` to configure it.
+END
+            exit(1);
+        }
+        my $rv = eval { require CPAN; CPAN::Shell->install($module) };
+        return $rv unless $@;
+
+        print <<END;
+Failed to load module CPAN.
+
+-------- Error ---------
+$@
+------------------------
+
+When we tried to start installing RT's perl dependencies, 
+we were unable to load the CPAN client. This module is usually distributed
+with Perl. This usually indicates that your vendor has shipped an unconfigured
+or incorrectly configured CPAN client.
+The error above may (or may not) give you a hint about what went wrong
+
+You have several choices about how to install dependencies in 
+this situatation:
+
+1) use a different tool to install dependencies by running setting the following
+   shell environment variable and rerunning this tool:
+    RT_FIX_DEPS_CMD='/usr/bin/perl -MCPAN -e"install %s"'
+2) Attempt to configure CPAN by running:
+   `/usr/bin/perl -MCPAN -e shell` program from shell.
+   If this fails, you may have to manually upgrade CPAN (see below)
+3) Try to update the CPAN client. Download it from:
+   http://search.cpan.org/dist/CPAN and try again
+4) Install each dependency manually by downloading them one by one from
+   http://search.cpan.org
+
+END
+        exit(1);
+    }
+
+    if( $ext =~ /\%s/) {
+        $ext =~ s/\%s/$module/g; # sprintf( $ext, $module );
+    } else {
+        $ext .= " $module";
+    }
+    print "\t\tcommand: '$ext'\n";
+    return scalar `$ext 1>&2`;
+}
 
--warn will tell you what isn't properly installed
+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`;
 
--fix will use CPANPLUS.pm or CPAN.pm to magically make everything better
+        }
 
-DBTYPE is one of:
-       oracle, pg, mysql
+    }
+    closedir(DIR);
+    exit;
+}
 
-EOF
+sub check_perl_version {
+  section("perl");
+  eval {require 5.008003};
+  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.");
+    exit(1);
+  } else {
+    print_found( sprintf(">=5.8.3(%vd)", $^V), 1 );
+  }
+}
 
-    exit(0);
+sub check_users {
+  section("users");
+  print_found("rt group (www)",      defined getgrnam("www"));
+  print_found("bin owner (root)",   defined getpwnam("root"));
+  print_found("libs owner (root)", defined getpwnam("root"));
+  print_found("libs group (bin)", defined getgrnam("bin"));
+  print_found("web owner (www)",    defined getpwnam("www"));
+  print_found("web group (www)",   defined getgrnam("www"));
 }
+
+
+
+1;