X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Fsbin%2Frt-test-dependencies.in;h=8fbce77c399d479a6d0236cb7cba8575021e640c;hp=ea6b9d15463d0be37cbb5bd4c1b632c47f09d070;hb=e9827319f740628016763ce99fc424df30369eea;hpb=c648976f0b7975f2328ebd7ba8c711fad0ca4195 diff --git a/rt/sbin/rt-test-dependencies.in b/rt/sbin/rt-test-dependencies.in index ea6b9d154..8fbce77c3 100644 --- a/rt/sbin/rt-test-dependencies.in +++ b/rt/sbin/rt-test-dependencies.in @@ -1,41 +1,41 @@ #!@PERL@ # BEGIN BPS TAGGED BLOCK {{{ -# +# # COPYRIGHT: -# -# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC -# -# +# +# 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. -# +# # 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/copyleft/gpl.html. -# -# +# 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 @@ -44,7 +44,7 @@ # 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 @@ -52,38 +52,63 @@ # 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-SPEEDYCGI', 'with-MODPERL1', - 'with-MODPERL2', 'with-DEV', - 'with-STANDALONE', - 'download=s', - 'repository=s' + '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', ); -unless (keys %args) { - help(); - exit(0); +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' => @RT_STANDALONE@, + '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 = ( @@ -94,70 +119,57 @@ $args{$_} = $default{$_} foreach grep !exists $args{$_}, keys %default; sub section { my $s = shift; $section = $s; - print "$s:\n"; + print "$s:\n" unless $args{'list-deps'}; } - my $any_missing = 0; - sub found { + sub print_found { my $msg = shift; my $test = shift; my $extra = shift; - - $any_missing = 1 unless $test; - 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 conclude { - if ($any_missing) { - print "\nSOMETHING WAS MISSING!\n"; - } else { - print "\nEverything was found.\n"; + 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 { +sub conclude { + my %missing_by_type = @_; - print <<'.'; - -By default, testdeps determine whether you have -installed all the perl modules RT needs to run. - - --install Install missing modules - -The following switches will tell the tool to check for specific dependencies + unless ( $args{'list-deps'} ) { + unless ( keys %missing_by_type ) { + print "\nAll dependencies have been found.\n"; + return; + } - --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 "\nSOME DEPENDENCIES WERE MISSING.\n"; - --with-standalone Libraries needed to support the standalone simple pure perl 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 + for my $type ( keys %missing_by_type ) { + my $missing = $missing_by_type{$type}; - --with-dev Tools needed for RT development + 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} ); + } + } -You can also specify -v or --verbose to list the status of all dependencies, -rather than just the missing ones. + print "\nPerl library path for @PERL@:\n"; + print " $_\n" for @INC; -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] ) { @@ -168,122 +180,156 @@ 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 -DBI 1.37 -Class::ReturnValue 0.40 -Date::Format -DBIx::SearchBuilder 1.50 -Text::Template +Digest::SHA +Email::Address 1.897 +Email::Address::List 0.02 +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 +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.108 +Log::Dispatch 2.30 +Mail::Header 2.12 Mail::Mailer 1.57 -Net::SMTP -Text::Wrapper -Time::ParseDate -Time::HiRes -File::Temp -Text::Autoformat -Text::Quoted 2.02 -Tree::Simple 1.04 +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 -Module::Versions::Report 1.03 -Cache::Simple::TimedExpiry -UNIVERSAL::require -Calendar::Simple -CSS::Squish 0.06 -. - -$deps{'MASON'} = [ text_to_hash( << '.') ]; -HTML::Mason 1.23 -Errno -Digest::MD5 2.27 -CGI::Cookie 1.20 Storable 2.08 -Apache::Session 1.53 -XML::RSS 1.05 -GD -GD::Graph -GD::Text +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 -. - -$deps{'STANDALONE'} = [ text_to_hash( << '.') ]; -HTTP::Server::Simple 0.07 -HTTP::Server::Simple::Mason 0.09 +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( << '.') ]; -Test::Inline -Apache::Test -HTML::Form -HTML::TokeParser -WWW::Mechanize -Test::WWW::Mechanize 1.04 -Module::Refresh 0.03 -Test::Expect 0.30 -XML::Simple +$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{'FASTCGI'} = [ text_to_hash( << '.') ]; -CGI 2.92 -FCGI -CGI::Fast -. - -$deps{'SPEEDYCGI'} = [ text_to_hash( << '.') ]; -CGI 2.92 -CGI::SpeedyCGI +FCGI 0.74 +FCGI::ProcManager . - $deps{'MODPERL1'} = [ text_to_hash( << '.') ]; -CGI 2.92 -Apache::Request Apache::DBI 0.92 +Apache::Request . $deps{'MODPERL2'} = [ text_to_hash( << '.') ]; -CGI 2.92 Apache::DBI -HTML::Mason 1.31 . $deps{'MYSQL'} = [ text_to_hash( << '.') ]; DBD::mysql 2.1018 . + $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 . @@ -291,8 +337,54 @@ $deps{'SQLITE'} = [ text_to_hash( << '.') ]; DBD::SQLite 1.00 . -if ($args{'download'}) { +$deps{'GPG'} = [ text_to_hash( << '.') ]; +File::Which +GnuPG::Interface +PerlIO::eol +. +$deps{'SMIME'} = [ text_to_hash( << '.') ]; +Crypt::X509 +File::Which +String::ShellQuote +. + +$deps{'ICAL'} = [ text_to_hash( << '.') ]; +Data::ICal +. + +$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{'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)], +); + +if ($args{'download'}) { download_mods(); } @@ -301,47 +393,96 @@ check_perl_version(); 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"); my @missing; my @deps = @{ $deps{$type} }; - while (@deps) { - my $module = shift @deps; - my $version = shift @deps; - my $ret = test_dep($module, $version); - push @missing, $module, $version unless $ret; - } + my %missing = test_deps(@deps); + if ( $args{'install'} ) { - while( @missing ) { - resolve_dep(shift @missing, shift @missing); + 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); -conclude(); + $missing{$module} = { version => $version, error => $error } unless $test; + } + + return %missing; +} sub test_dep { my $module = shift; my $version = shift; + my $avoid = shift; - eval "use $module $version ()"; - if ($@) { - my $error = $@; - $error =~ s/\n(.*)$//s; - undef $error unless $error =~ /this is only/; - found("$module $version", 0, $error); + 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 undef; - } else { - my $msg = "$module"; - $msg .= " >=$version" if $version; - found($msg, 1); return 1; } } @@ -350,9 +491,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; { @@ -364,11 +526,17 @@ sub resolve_dep { } 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 $@; @@ -412,68 +580,102 @@ 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 ($@) { - 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 { - found( ">=5.8.3($])", 1); + print_found( sprintf(">=5.10.1(%vd)", $^V), 1 ); } } sub check_users { section("users"); - found("rt group (@RTGROUP@)", defined getgrnam("@RTGROUP@")); - found("bin owner (@BIN_OWNER@)", defined getpwnam("@BIN_OWNER@")); - found("libs owner (@LIBS_OWNER@)", defined getpwnam("@LIBS_OWNER@")); - found("libs group (@LIBS_GROUP@)", defined getgrnam("@LIBS_GROUP@")); - found("web owner (@WEB_USER@)", defined getpwnam("@WEB_USER@")); - found("web group (@WEB_GROUP@)", defined getgrnam("@WEB_GROUP@")); + 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@")); } +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 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;