automateit 0.71221 → 0.71226

data/CHANGES.txt

@@ -1,3 +1,8 @@
+0.71226:
+    Date: Wed, 26 Dec 2007 11:41:03 -0800
+    Desc:
+    - (%) Fixed PackageManager::CPAN driver. It now provides a workaround to activate CPAN if it wasn't already configured, previously it'd hang as CPAN tried to get input. It now provides a workaround for rejecting all CPAN inputs because the CPAN default options are surprisingly dangerous. It now tries harder to execute the Perl helper files, previously these wouldn't be executed on some OSes. The helpers' core logic has been abstracted into a wrapper library.
+
 0.71221:
     Date: Sun, 23 Dec 2007 00:48:30 -0800
     Desc:

data/Rakefile

@@ -243,7 +243,7 @@ namespace :rdoc do
   desc "Generate documentation"
   task :make do
     # Uses Jamis Buck's RDoc template from http://weblog.jamisbuck.org/2005/4/8/rdoc-template
-    sh "rdoc --template=jamis --main README.txt --promiscuous --accessor class_inheritable_accessor=R --title 'AutomateIt: Open source server automation' lib docs/*.txt README.txt TUTORIAL.txt TESTING.txt"
+    sh "rdoc --template=jamis --main ./README.txt --promiscuous --accessor class_inheritable_accessor=R --title 'AutomateIt: Open source server automation' lib docs/*.txt README.txt TUTORIAL.txt TESTING.txt"
     # Create a tutorial index
     File.open("doc/tutorial.html", "w+") do |writer|
       writer.write(File.read("doc/index.html").sub(/README_txt.html/, 'TUTORIAL_txt.html'))

data/helpers/cpan_install.pl

@@ -2,6 +2,11 @@
 
 # Example: ./install.pl Acme::please
 
+use warnings "all";
+use File::Basename;
+my $wrapper = dirname($0)."/cpan_wrapper.pl";
+require $wrapper;
+
 sub usage {
   my($message) = @_;
   print <<EOB;
@@ -15,10 +20,7 @@ EOB
   }
 }
 
-use warnings "all";
-use CPAN;
 use Getopt::Long;
-
 our $quiet = 0;
 our $dryrun = 0;
 our $help = 0;
@@ -38,10 +40,18 @@ unless ($#modules >= 0) {
   usage "No modules specified";
 }
 
+$CpanWrapper::DRYRUN = $dryrun;
+if (0 && $CpanWrapper::DRYRUN) { die } # Squelch warnings
+
+# Uninstall modules
 foreach my $module (@modules) {
-  if (my $module_ref = CPAN::Shell->expand('Module', $module)) {
-    print "* Installing: $module\n" unless $quiet;
-    $module_ref->install unless $dryrun;
+  if (CpanWrapper->is_installed($module)) {
+    print "! Module already installed: $module\n";
+    next;
+  }
+
+  if (CpanWrapper->install($module)) {
+    print "* Installed: $module\n" unless $quiet;
   } else {
     print "! Can't find CPAN module: $module\n";
     exit 1

data/helpers/cpan_is_installed.pl

@@ -3,7 +3,9 @@
 # Example: ./is_available.pl Acme::please CPAN
 
 use warnings "all";
-use CPAN;
+use File::Basename;
+my $wrapper = dirname($0)."/cpan_wrapper.pl";
+require $wrapper;
 
 @modules = @ARGV;
 unless ($#modules >= 0) {
@@ -14,16 +16,9 @@ unless ($#modules >= 0) {
 my @available;
 my @unavailable;
 foreach my $module (@modules) {
-  if (my $module_ref = CPAN::Shell->expand('Module', $module)) {
-    my $path = $module_ref->inst_file;
-    if ($path && -e $path) {
-      #IK# print $module_ref->inst_file, "\n";
-      push(@available, $module);
-    } else {
-      push(@unavailable, $module);
-    }
+  if (CpanWrapper->is_installed($module)) {
+    push(@available, $module);
   } else {
-    #IK# die "Can't find module: $module";
     push(@unavailable, $module);
   }
 }

data/helpers/cpan_uninstall.pl

@@ -2,6 +2,11 @@
 
 # Example: ./uninstall.pl Acme::please
 
+use warnings "all";
+use File::Basename;
+my $wrapper = dirname($0)."/cpan_wrapper.pl";
+require $wrapper;
+
 sub usage {
   my($message) = @_;
   print <<EOB;
@@ -15,11 +20,7 @@ EOB
   }
 }
 
-use warnings "all";
-use ExtUtils::Packlist;
-use ExtUtils::Installed;
 use Getopt::Long;
-
 our $quiet = 0;
 our $dryrun = 0;
 our $help = 0;
@@ -39,25 +40,19 @@ unless ($#modules >= 0) {
   usage "No modules specified";
 }
 
-sub nuke {
-  my($target) = @_;
-  if ($dryrun == 0) {
-    unlink($target) || die "$! -- $target"
-  }
-}
-
-my $packlists = ExtUtils::Installed->new();
+$CpanWrapper::DRYRUN = $dryrun;
+if (0 && $CpanWrapper::DRYRUN) { die } # Squelch warnings
 
 foreach my $module (@modules) {
+  unless (CpanWrapper->is_installed($module)) {
+    print "! Module isn't installed: $module\n";
+    next;
+  }
+
   print "* Uninstalling module: $module\n" unless $quiet;
 
-  foreach my $item ($packlists->files($module)) {
-    print "- File: $item\n" unless $quiet;
-    nuke $item;
+  my(@files) = CpanWrapper->uninstall($module);
+  foreach my $file (@files) {
+    print "- File: $file\n" unless $quiet;
   }
-
-  my $packlist = $packlists->packlist($module)->packlist_file();
-  print "- List: $packlist\n" unless $quiet;
-  # NOTE: Leave packlist alone so it can be uninstalled if something goes catastrophically wrong with this uninstaller.
-  #IK# nuke $packlist;
 }

data/helpers/cpan_wrapper.pl

@@ -0,0 +1,98 @@
+package CpanWrapper;
+use CPAN;
+use ExtUtils::Packlist;
+use ExtUtils::Installed;
+
+=head1 NAME
+
+CpanWrapper - Provides a simpler wrapper for CPAN package methods.
+
+=head1 DESCRIPTION
+
+This module provides easy-to-use methods for performing typical tasks that the
+CPAN module makes difficult for some incomprehensible reason.
+
+=head1 CLASS VARIABLES
+
+=item $CpanWrapper::DRYRUN
+  
+Should actions really happen? E.g., in dry-run mode, the uninstall will only
+pretend to delete files.
+
+=cut
+
+our $DRYRUN = 0;
+
+=item CpanWrapper->is_installed($module_name)
+
+Returns 1 if the module is installed, else 0.
+
+Example:
+
+  CpanWrapper->is_installed('App::Ack')
+=cut
+sub is_installed {
+  my($class, $module) = @_;
+  return $CPAN::META->has_inst($module);
+}
+
+=item CpanWrapper->uninstall($module_name)
+
+Uninstall the module. Returns an array of files removed.
+=cut
+sub uninstall {
+  my($class, $module) = @_;
+  my $packlists = ExtUtils::Installed->new;
+  my @result;
+  foreach my $file ($packlists->files($module)) {
+    push(@result, $file);
+    unlink $file unless $DRYRUN;
+  }
+  return @result;
+}
+
+=item CpanWrapper->install($module_name)
+
+Install the module. Returns 0 if can't find module.
+=cut
+sub install {
+  my($class, $module) = @_;
+  tie *NO, 'NoHandle';
+  open(SAVEIN, ">&STDIN");
+  open(STDIN, ">&NO"); # TODO why isn't this enough?
+  *STDIN = *NO;
+  my $result;
+  if (my $module_ref = CPAN::Shell->expand('Module', $module)) {
+    $module_ref->install unless $DRYRUN;
+    $result = 1;
+  } else {
+    $result = 0;
+  }
+  open(STDIN, ">&SAVEIN");
+  close NO;
+  return $result;
+}
+
+=item NoHandle
+
+File handle that responds with "no" to all readline queries. This is used
+during the install process to reject CPAN's bad defaults.
+=cut
+require Tie::Handle;
+package NoHandle;
+sub TIEHANDLE { my $self; bless \$self, shift }
+sub WRITE { die }
+sub PRINT { die }
+sub PRINTF { die }
+sub READ { die }
+sub READLINE { print "no\n"; return "no\n" }
+sub GETC { die }
+sub CLOSE { }
+sub OPEN { }
+sub BINMODE { }
+sub EOF { 0 }
+sub TELL { }
+sub DESTROY { }
+package main;
+
+1;

data/lib/automateit/package_manager/cpan.rb

@@ -2,23 +2,60 @@
 #
 # A PackageManager driver for Perl CPAN (Comprehensive Perl Archive Network)
 # software packages.
+#
+# === No automatic dependency installation
+#
+# Unlike other AutomateIt PackageManager drivers, the CPAN driver will not install a package's dependencies automatically. This protects you because many CPAN packages require a specific version of Perl, often one which you don't have installed, and installing that dependency will destroy your Perl interpreter and everything that depends on it. Therefore, you must specify all package dependencies manually. If a package dependency isn't found, the install will fail.
+#
+# === Specifying Perl interpreter
+#
+# Use #setup to specify the Perl interpreter to use for all subsequent calls.
+#
+# Example:
+#
+#   package_manager[:cpan].setup(:perl => "/usr/local/bin/perl")
+#   package_manager.install %w(File::Next App::Ack), :with => :cpan
 class ::AutomateIt::PackageManager::CPAN < ::AutomateIt::PackageManager::BaseDriver
   CPAN_INSTALL = File.join(::AutomateIt::Constants::HELPERS_DIR, "cpan_install.pl")
   CPAN_UNINSTALL = File.join(::AutomateIt::Constants::HELPERS_DIR, "cpan_uninstall.pl")
   CPAN_IS_INSTALLED = File.join(::AutomateIt::Constants::HELPERS_DIR, "cpan_is_installed.pl")
 
+  # Path to Perl interpreter
+  attr_accessor :perl
+
+  # FIXME How to get #depends_on to use same Perl interpreter as #perl? The trouble is that Plugin::Driver#available? checks a class variable populated by #depends_on, so it can't see the instance's #perl variable that's been set by the user. A general solution would address this problem for all drivers that use commands with different names, e.g. "gem1.8", "python2.5.1", etc.
   depends_on :programs => %w(perl)
 
+  # Setup the PackageManager::CPAN driver.
+  #
+  # Options:
+  # * :perl -- The absolute, relative or unqualified path for the Perl interpreter to use. E.g., "perl" or "/usr/local/bin/perl".
+  def setup(*args)
+    super(*args)
+
+    args, opts = args_and_opts(*args)
+    if opts[:perl]
+      self.perl = opts[:perl]
+    else
+      self.perl ||= "perl"
+    end
+  end
+
   def suitability(method, *args) # :nodoc:
     # Never select as default driver
     return 0
   end
 
+  # Options:
+  # * :perl -- Command to use as the Perl interpreter, otherwise defaults to the one specified during #setup or to "perl"
+  #
   # See AutomateIt::PackageManager#installed?
   def installed?(*packages)
     return _installed_helper?(*packages) do |list, opts|
-      cmd = "#{CPAN_IS_INSTALLED} #{list.join(' ')}"
+      perl = opts[:perl] || self.perl
+      cmd = "#{perl} #{CPAN_IS_INSTALLED} #{list.join(' ')}"
 
+      # FIXME if CPAN isn't configured, this will hang because Perl will demand input
       log.debug(PEXEC+cmd)
       output = `#{cmd}`
       output.sub!(/.*---(\s[^\n]+)?\n/m, '')
@@ -30,19 +67,18 @@ class ::AutomateIt::PackageManager::CPAN < ::AutomateIt::PackageManager::BaseDri
 
   # See AutomateIt::PackageManager#not_installed?
   def not_installed?(*packages)
+    # TODO Move #not_installed? up to BaseDriver
     return _not_installed_helper?(*packages)
   end
 
-  # *IMPORTANT*: See documentation at the top of this file for how to correctly
-  # install packages from a specific channel.
-  #
   # Options:
-  # * :force -- Force installation, needed when installing unstable packages
+  # * :perl -- Command to use as the Perl interpreter, otherwise defaults to the one specified during #setup or to "perl"
   #
   # See AutomateIt::PackageManager#install
   def install(*packages)
     return _install_helper(*packages) do |list, opts|
-      cmd = "#{CPAN_INSTALL} #{list.join(' ')}"
+      perl = opts[:perl] || self.perl
+      cmd = "#{perl} #{CPAN_INSTALL} #{list.join(' ')}"
       cmd << " > /dev/null" if opts[:quiet]
       cmd << " 2>&1"
 
@@ -50,10 +86,14 @@ class ::AutomateIt::PackageManager::CPAN < ::AutomateIt::PackageManager::BaseDri
     end
   end
 
+  # Options:
+  # * :perl -- Command to use as the Perl interpreter, otherwise defaults to the one specified during #setup or to "perl"
+  #
   # See AutomateIt::PackageManager#uninstall
   def uninstall(*packages)
     return _uninstall_helper(*packages) do |list, opts|
-      cmd = "#{CPAN_UNINSTALL} #{list.join(' ')} < /dev/null"
+      perl = opts[:perl] || self.perl
+      cmd = "#{perl} #{CPAN_UNINSTALL} #{list.join(' ')} < /dev/null"
       cmd << " > /dev/null" if opts[:quiet]
       cmd << " 2>&1"
 

data/lib/automateit/root.rb

@@ -1,7 +1,7 @@
 # See AutomateIt::Interpreter for usage information.
 module AutomateIt # :nodoc:
   # AutomateIt version
-  VERSION=Gem::Version.new("0.71221")
+  VERSION=Gem::Version.new("0.71226")
 
   # Instantiates a new Interpreter. See documentation for
   # Interpreter#setup.

data/spec/integration/package_manager_spec.rb.orig

@@ -0,0 +1,123 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "/../spec_helper.rb")
+
+PACKAGE_FOUND_ERROR = %q{ERROR: Found the '%s' package installed for %s. You're probably not using this obscure package and should remove it so that this test can run. In the unlikely event that you actually rely on this package, change the spec to test with another unused package.}
+PACKAGE_DRIVER_MISSING_ERROR = "NOTE: Can't check %s on this platform, #{__FILE__}"
+
+if not INTERPRETER.euid?
+  puts "NOTE: Can't check 'euid' on this platform, #{__FILE__}"
+elsif not INTERPRETER.superuser?
+  puts "NOTE: Must be root to check #{__FILE__}"
+else
+  describe "AutomateIt::PackageManager", :shared => true do
+    before(:all) do
+      @level = Logger::WARN
+      @a = AutomateIt.new(:verbosity => @level)
+      @m = @a.package_manager
+      @fake_package = "not_a_real_package"
+    end
+
+    after(:all) do
+      @d.uninstall(@package, :quiet => true)
+    end
+
+    def uninstall_package(packages, opts={})
+      opts[:quiet] = true
+      return @d.uninstall(packages, opts)
+    end
+
+    def install_package(packages, opts={})
+      opts[:quiet] = true
+      opts[:force] = [:pecl, :pear].include?(@d.token)
+      return @d.install(packages, opts)
+    end
+
+    # Some specs below leave side-effects which others depend on, although
+    # these are clearly documented within the specs. This is necessary
+    # because doing proper setup/teardown for each test would make it run 5x
+    # slower and take over a minute. Although this approach is problematic,
+    # the performance boost is worth it.
+
+    it "should not install an invalid package" do
+      @d.log.silence(Logger::FATAL) do
+        lambda{ install_package(@fake_package) }.should raise_error(ArgumentError)
+      end
+    end
+
+    it "should install a package" do
+      install_package(@package).should be_true
+      # Leaves behind an installed package
+    end
+
+    it "should not re-install an installed package" do
+      # Expects package to be installed
+      install_package(@package).should be_false
+    end
+
+    it "should find an installed package" do
+      # Expects package to be installed
+      @d.installed?(@package).should be_true
+      @d.not_installed?(@package).should be_false
+    end
+
+    it "should not find a package that's not installed" do
+      @d.installed?(@fake_package).should be_false
+      @d.not_installed?(@fake_package).should be_true
+    end
+
+    it "should find group of packages" do
+      @d.installed?(@package, @fake_package, :details => true).should == [false, [@package]]
+      @d.not_installed?(@package, @fake_package, :details => true).should == [false, [@fake_package]]
+      # Leaves behind an installed package
+    end
+
+    it "should uninstall a package" do
+      # Expects package to be installed
+      uninstall_package(@package).should be_true
+    end
+
+    it "should not uninstall a package that's not installed" do
+      uninstall_package(@package).should be_false
+    end
+  end
+
+  #-----------------------------------------------------------------------
+
+  targets = {
+#    :apt => "nomarch", # Obscure package for extracting ARC files from the 80's
+#    :yum => "nomarch", # Obscure package for extracting ARC files from the 80's
+#    :portage => "arc", # Obscure package for extracting ARC files from the 80's
+#    :gem => "s33r", # Alpha-grade package its author deprecated in favor of another
+#    :egg => "_sre.py", # Slower reimplementation of ancient Python Regexps
+#    :pear => "File_DICOM", # Obscure package for DICOM X-rays, abandoned in 2003
+#    :pecl => "ecasound", # Obscure package for Ecasound libs, abandoned in 2003
+    :cpan => "Acme::please", # Insane gimmick port of intercal's please statements
+  }
+
+  if INTERPRETER.tagged?(:centos)
+    # CentOS lacks "nomarch", so use a less obscure archiver from the early 90's.
+    targets[:yum] = "arj"
+  end
+
+  targets.each_pair do |driver_token, package|
+    # Run the following from the shell to skip package tests:
+    #   export AUTOMATEIT_SPEC_SKIP_PACKAGES=1
+    # Or clear it out:
+    #   unset AUTOMATEIT_SPEC_SKIP_PACKAGES
+    next unless ENV["AUTOMATEIT_SPEC_SKIP_PACKAGES"].nil?
+
+    driver = INTERPRETER.package_manager[driver_token]
+    if driver.available?
+      describe driver.class.to_s do
+        it_should_behave_like "AutomateIt::PackageManager"
+
+        before(:all) do
+          @d = @m[driver_token]
+          @package = package
+          raise PACKAGE_FOUND_ERROR % [@package, @d.class] if @d.installed?(@package)
+        end
+      end
+    else
+      puts PACKAGE_DRIVER_MISSING_ERROR % driver.class
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: automateit
 version: !ruby/object:Gem::Version 
-  version: "0.71221"
+  version: "0.71226"
 platform: ruby
 authors: 
 - Igal Koshevoy
@@ -30,7 +30,7 @@ cert_chain:
   COR01yWDcVLdM89nNLk=
   -----END CERTIFICATE-----
 
-date: 2007-12-23 00:00:00 -08:00
+date: 2007-12-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,7 +67,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.0
+        version: 1.4.0
     version: 
 description: AutomateIt is an open source tool for automating the setup and maintenance of servers, applications and their dependencies.
 email: igal@pragmaticraft.com
@@ -118,6 +118,7 @@ files:
 - helpers/cpan_is_installed.pl
 - helpers/cpan_uninstall.pl
 - helpers/which.cmd
+- helpers/cpan_wrapper.pl
 - lib/hashcache.rb
 - lib/automateit.rb
 - lib/automateit/tag_manager.rb
@@ -232,6 +233,7 @@ files:
 - spec/integration/examples_spec_editor.rb
 - spec/integration/template_manager_erb_spec.rb
 - spec/integration/tempster_spec.rb
+- spec/integration/package_manager_spec.rb.orig
 - spec/breaker.rb
 - spec/extras/scratch.rb
 - spec/extras/automateit_service_sysv_test
@@ -302,6 +304,7 @@ test_files:
 - spec/integration/examples_spec_editor.rb
 - spec/integration/template_manager_erb_spec.rb
 - spec/integration/tempster_spec.rb
+- spec/integration/package_manager_spec.rb.orig
 - spec/breaker.rb
 - spec/extras
 - spec/extras/scratch.rb

metadata.gz.sig

@@ -1,2 +1 @@
-�Mlɏ�S�f]��m�H^`R����,L�ꧩ��2
-�;~'�=-iVȢ�]凿��Ը
+
�,s�͢#u���O�fg�z���G�o��z���x��&�	L�1R����l�S�[^���:����_p�Ku�V���a�qE���,��>�yp?O�h�JO��q��,zC	��,�����6ꓷ�?�4wOq,:�kƱe�� ���:{6��a7�m�WU��~�Ś����s�ɧ�HMK�������>؎u����W*�/ƛ��`��A,u��v#ݝ������6��,V�tM��#V���|