X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Fsbin%2Frt-test-dependencies.in;h=8fbce77c399d479a6d0236cb7cba8575021e640c;hp=6951290c4b7a6c92891b0c11b3f046738e79c7b0;hb=9aee669886202be7035e6c6049fc71bc99dd3013;hpb=0ebeec96313dd7edfca340f01f8fbbbac1f4aa1d diff --git a/rt/sbin/rt-test-dependencies.in b/rt/sbin/rt-test-dependencies.in index 6951290c4..8fbce77c3 100644 --- a/rt/sbin/rt-test-dependencies.in +++ b/rt/sbin/rt-test-dependencies.in @@ -1,246 +1,681 @@ #!@PERL@ -# BEGIN LICENSE BLOCK -# -# Copyright (c) 1996-2003 Jesse Vincent -# -# (Except where explictly superceded by other copyright notices) -# +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC +# +# +# (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; +use warnings; no warnings qw(numeric redefine); use Getopt::Long; -use CPAN; +use Cwd qw(abs_path); 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) { -help(); -exit(0); -} -$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; +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-PG', 'with-SQLITE', 'with-ORACLE', + 'with-FASTCGI', 'with-MODPERL1', 'with-MODPERL2', 'with-STANDALONE', + + 'with-DEVELOPER', + + 'with-GPG', + 'with-ICAL', + 'with-GRAPHVIZ', + 'with-GD', + 'with-DASHBOARDS', + 'with-USERLOGO', + 'with-HTML-DOC', + + 'list-deps', + 'siteinstall!', + 'help|h', +); + +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-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-USERLOGO' => 1, + 'with-HTML-DOC' => @RT_DEVELOPER@, +); +$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 help { - -print <<'.' +sub conclude { + my %missing_by_type = @_; -By default, testdeps determine whether you have -installed all the perl modules RT needs to run. + unless ( $args{'list-deps'} ) { + unless ( keys %missing_by_type ) { + print "\nAll dependencies have been found.\n"; + return; + } - --install Install missing modules + print "\nSOME DEPENDENCIES WERE MISSING.\n"; -The following switches will tell the tool to check for specific dependencies + for my $type ( keys %missing_by_type ) { + my $missing = $missing_by_type{$type}; - --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) + 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} ); + } + } - --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 + print "\nPerl library path for @PERL@:\n"; + print " $_\n" for @INC; - --with-dev Tools needed for RT development -. + exit 1; + } } +sub text_to_hash { + my %hash; + for my $line ( split /\n/, $_[0] ) { + my($key, $value) = $line =~ /(\S+)\s*(\S*)/; + $value ||= ''; + $hash{$key} = $value; + } -sub _ { - map { /(\S+)\s*(\S*)/; $1 => ($2 ? $2 :'') } split ( /\n/, $_[0] ); + return %hash; +} +sub set_dep { + my ($name, $module, $version) = @_; + my %list = @{$deps{$name}}; + $list{$module} = ($version || ''); + $deps{$name} = [ %list ]; } -$deps{'CORE'} = [ _( << '.') ]; -Digest::MD5 -DBI 1.18 -Test::Inline -Class::ReturnValue 0.40 -DBIx::SearchBuilder 0.86 -Text::Template +$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 +Email::Address 1.897 +Email::Address::List 0.02 +Encode +Errno +File::Glob +File::ShareDir File::Spec 0.8 -HTML::Entities -Net::Domain -Log::Dispatch 2.0 -Locale::Maketext 1.04 -Locale::Maketext::Lexicon 0.25 -Locale::Maketext::Fuzzy -MIME::Entity 5.108 +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 +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 +Log::Dispatch 2.30 +Mail::Header 2.12 Mail::Mailer 1.57 -Net::SMTP -Text::Wrapper +MIME::Entity 5.504 +Module::Refresh 0.03 +Module::Versions::Report 1.05 +Net::CIDR +Plack 1.0002 +Regexp::Common +Regexp::Common::net::CIDR +Regexp::IPv6 +Role::Basic 0.12 +Scalar::Util +Storable 2.08 +Symbol::Global::Name 0.04 +Sys::Syslog 0.16 +Text::Password::Pronounceable +Text::Quoted 2.07 +Text::Template 1.44 +Text::WikiFormat 0.76 +Text::Wrapper +Time::HiRes Time::ParseDate -File::Temp +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( << '.') ]; +Crypt::SSLeay +Getopt::Long +LWP::Protocol::https +LWP::UserAgent 6.0 +Net::SSL +Pod::Usage +. + +$deps{'CLI'} = [ text_to_hash( << '.') ]; +Getopt::Long 2.24 +HTTP::Request::Common +LWP Term::ReadKey -Text::Autoformat -Text::Quoted +Term::ReadLine +Text::ParseWords . -$deps{'MASON'} = [ _( << '.') ]; -Params::Validate 0.02 -Cache::Cache -Exception::Class -HTML::Mason 1.16 -MLDBM -Errno -FreezeThaw -Digest::MD5 -CGI::Cookie 1.20 -Storable -Apache::Session 1.53 +$deps{'DEVELOPER'} = [ text_to_hash( << '.') ]; +Email::Abstract +File::Find +File::Which +Locale::PO +Log::Dispatch::Perl +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 +Test::NoWarnings +Test::Pod +Test::Warn +Test::WWW::Mechanize 1.30 +Test::WWW::Mechanize::PSGI +WWW::Mechanize 1.52 +XML::Simple . -$deps{'MAILGATE'} = [ _( << '.') ]; -HTML::TreeBuilder -HTML::FormatText -Getopt::Long -LWP::UserAgent +$deps{'FASTCGI'} = [ text_to_hash( << '.') ]; +FCGI 0.74 +FCGI::ProcManager . -$deps{'CLI'} = [ _( << '.') ]; -Getopt::Long 2.24 +$deps{'MODPERL1'} = [ text_to_hash( << '.') ]; +Apache::DBI 0.92 +Apache::Request . -$deps{'DEV'} = [ _( << '.') ]; -Regexp::Common -Time::HiRes -Test::Inline -WWW::Mechanize +$deps{'MODPERL2'} = [ text_to_hash( << '.') ]; +Apache::DBI . -$deps{'FASTCGI'} = [ _( << '.') ]; -CGI -FCGI -CGI::Fast +$deps{'MYSQL'} = [ text_to_hash( << '.') ]; +DBD::mysql 2.1018 . -$deps{'SPEEDYCGI'} = [ _( << '.') ]; -CGI -CGI::SpeedyCGI +$deps{'ORACLE'} = [ text_to_hash( << '.') ]; +DBD::Oracle . +$deps{'PG'} = [ text_to_hash( << '.') ]; +DBIx::SearchBuilder 1.66 +DBD::Pg 1.43 +. -$deps{'MODPERL1'} = [ _( << '.') ]; -CGI -Apache::Request -Apache::DBI +$deps{'SQLITE'} = [ text_to_hash( << '.') ]; +DBD::SQLite 1.00 . -$deps{'MODPERL2'} = [ _( << '.') ]; -CGI 2.89 -Apache::DBI +$deps{'GPG'} = [ text_to_hash( << '.') ]; +File::Which +GnuPG::Interface +PerlIO::eol . -$deps{'I18N-COMPAT'} = [ _( << '.') ]; -Text::Iconv -Encode::compat 0.04 +$deps{'SMIME'} = [ text_to_hash( << '.') ]; +Crypt::X509 +File::Which +String::ShellQuote . -$deps{'MYSQL'} = [ _( << '.') ]; -DBD::mysql 2.1018 +$deps{'ICAL'} = [ text_to_hash( << '.') ]; +Data::ICal . -$deps{'ORACLE'} = [ _( << '.') ]; -DBD::Oracle + +$deps{'DASHBOARDS'} = [ text_to_hash( << '.') ]; +MIME::Types +URI 1.59 +URI::QueryParam +. + +$deps{'GRAPHVIZ'} = [ text_to_hash( << '.') ]; +GraphViz +IPC::Run 0.90 +. + +$deps{'GD'} = [ text_to_hash( << '.') ]; +GD +GD::Graph 1.47 +GD::Text . -$deps{'POSTGRESQL'} = [ _( << '.') ]; -DBD::Pg + +$deps{'USERLOGO'} = [ text_to_hash( << '.') ]; +Convert::Color . +$deps{'HTML-DOC'} = [ text_to_hash( <<'.') ]; +HTML::Entities +Pod::Simple 3.24 +. -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); +my %AVOID = ( + 'DBD::Oracle' => [qw(1.23)], + 'Devel::StackTrace' => [qw(1.28 1.29)], +); -if ($args{'install'} && !$ret) { - resolve_dep($module); +if ($args{'download'}) { + download_mods(); } + + +check_perl_version(); + +check_users(); + +my %Missing_By_Type = (); +foreach my $type (sort grep $args{$_}, keys %args) { + next unless ($type =~ /^with-(.*?)$/) and $deps{$1}; + + $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}); + 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}); + } + } + + $Missing_By_Type{$type} = \%missing if keys %missing; } + +if ( $args{'install'} && keys %Missing_By_Type ) { + exec($script_path, @orig_argv, '--no-install'); } +else { + conclude(%Missing_By_Type); +} + +sub test_deps { + my @deps = @_; + + 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; + } + + return %missing; +} + 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; - } + my $module = shift; + my $version = shift; + my $avoid = shift; + + if ( $args{'list-deps'} ) { + print $module, ': ', $version || 0, "\n"; + } + else { + no warnings 'deprecated'; + eval "{ local \$ENV{__WARN__}; 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/; + + my $path = $module; + $path =~ s{::}{/}g; + undef $error if defined $error and $error =~ /^Can't locate $path\.pm in \@INC/; + + 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; + } } sub resolve_dep { - my $module = shift; - use CPAN; - CPAN::Shell->install($module); - + 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'} || $ENV{'PERL_PREFER_CPAN_CLIENT'}; + 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 <{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 $@; + + print <&2`; +} + +sub check_perl_version { + section("perl"); + eval {require 5.010_001}; + if ($@) { + 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.10.1(%vd)", $^V), 1 ); + } } +sub check_users { + section("users"); + print_found("rt group (@RTGROUP@)", defined getgrnam("@RTGROUP@")); + print_found("bin owner (@BIN_OWNER@)", defined getpwnam("@BIN_OWNER@")); + print_found("libs owner (@LIBS_OWNER@)", defined getpwnam("@LIBS_OWNER@")); + print_found("libs group (@LIBS_GROUP@)", defined getgrnam("@LIBS_GROUP@")); + print_found("web owner (@WEB_USER@)", defined getpwnam("@WEB_USER@")); + print_found("web group (@WEB_GROUP@)", defined getgrnam("@WEB_GROUP@")); +} -sub print_help { - print << "EOF"; +1; -$0 FLAG DBTYPE +__END__ +=head1 NAME -$0 is a tool for RT that will tell you if you've got all -the modules RT depends on properly installed. +rt-test-dependencies - test rt's dependencies -Flags: (only one flag is valid for a given run) +=head1 SYNOPSIS --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. + rt-test-dependencies + rt-test-dependencies --install + rt-test-dependencies --with-mysql --with-fastcgi --warn will tell you what isn't properly installed +=head1 DESCRIPTION --fix will use CPANPLUS.pm or CPAN.pm to magically make everything better +by default, C determines whether you have installed all +the perl modules RT needs to run. -DBTYPE is one of: - oracle, pg, mysql +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. -EOF +=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 - exit(0); -}