puppet_transplant 0.0.2 → 0.0.3

data/README.md

@@ -6,6 +6,14 @@ the puppet gem to relocate the default confdir and vardir.  This behaviors
 allows multiple versions of puppet to exist in different gemsets with distinct
 default base directories.
 
+The relocation directory is based on the Ruby PREFIX.  For example, if the
+puppet gem is installed using a ruby with a prefix of `/opt/operations` then
+`operations` will be used to construct a default system confdir of
+`/etc/operations/puppet` and a default system vardir of
+`/var/lib/operations/puppet`.  Similarly,
+`/opt/crossfader/versions/ruby/1.9.3-p448` will result in
+`/etc/crossfader/puppet` and `/var/lib/crossfader/puppet`.
+
 The design of modifying the default confdir and vardir has been chosen to
 support Puppet operating as a library in addition to Puppet operating as an
 application.  This approach has the goal of keeping behavior consistent between
@@ -15,26 +23,42 @@ inconsistency between application and library use cases.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install this gem before installing Puppet to ensure puppet will be relocated
+upon installation.
+
+    $ gem install puppet_transplant
 
-    gem 'puppet_transplant'
+If you do not have permission to write to `$GEM_HOME`, try preserving your
+environment in sudo:
 
-And then execute:
+    $ sudo -E gem install puppet_transplant
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+Simply install the gem into the current gemset then install a puppet gem
+afterwards.  For example:
 
-    $ gem install puppet_transplant
+    $ which gem
+    /opt/operations/bin/gem
 
-## Usage
+    $ sudo -E gem install puppet_transplant
+    Fetching: puppet_transplant-0.0.2.gem (100%)
+    Successfully installed puppet_transplant-0.0.2
+    1 gem installed
+    Installing ri documentation for puppet_transplant-0.0.2...
+    Installing RDoc documentation for puppet_transplant-0.0.2...
 
-Simply install the gem into the current gemset.  If Puppet already exists in
-this gemset then the default confdir and vardir will be modified to use
-`/etc/operations/puppet` and `/var/lib/operations/puppet` respectively.
+    $ sudo -E gem install puppet --no-ri --no-rdoc
+    Fetching: puppet-3.4.2.gem (100%)
+    Transplanted confdir: /etc/operations/puppet
+    Transplanted vardir:  /var/lib/operations/puppet
+    Successfully installed puppet-3.4.2
+    1 gem installed
 
-The relocation target directories are not currently configurable but this
-should be a future improvement.
+    $ sudo -E puppet agent --configprint confdir
+    /etc/operations/puppet
+    $ sudo -E puppet agent --configprint vardir
+    /var/lib/operations/puppet
 
 ## Contributing
 

data/lib/puppet_transplant/installer.rb

@@ -3,7 +3,24 @@ require 'rbconfig'
 require 'rubygems/installer'
 
 module PuppetTransplant
+  ##
+  # The Installer class contains all of the data and behavior required to
+  # relocate Puppet's default system confdir and vardir settings.  The behavior
+  # is intended to be implemented as a [rubygems
+  # plugin](http://rubygems.rubyforge.org/rubygems-update/Gem.html#method-c-post_install),
+  # called using something like the following example.
+  #
+  #     module Gem
+  #       post_install do |gem_installer|
+  #         PuppetTransplant::Installer.post_install(gem_installer)
+  #       end
+  #     end
+  #
+  # @author Jeff McCune <jeff@puppetlabs.com>
   class Installer
+    ##
+    # RelocationError instances are raised when modification of Puppet's
+    # behavior fails for some reason.  The message should indicate why.
     class RelocationError < Exception; end
 
     ##
@@ -14,31 +31,24 @@ module PuppetTransplant
     #
     # @param [Gem::Installer] gem_installer The gem installer instance of the
     #   gem just installed, passed from the Gem.post_install callback.
+    #
+    # @return [Boolean] true if relocation succeeded, false if it did not
+    #   succeed.
     def self.post_install(gem_installer)
       # Do nothing unless we're dealing with Puppet.
       return unless gem_installer.spec.name == 'puppet'
       # Perform the relocation
       installer = new(gem_installer)
-      installer.relocate_puppet!
+      begin
+        installer.relocate_puppet!
+      rescue RelocationError => detail
+        gem_installer.ui.alert_error "PuppetTransplant relocation failed: #{detail}"
+        return false
+      end
       # Let the user know what happened
       gem_installer.ui.debug "Transplanted confdir: #{installer.confdir}"
       gem_installer.ui.debug "Transplanted vardir:  #{installer.vardir}"
-    end
-
-    ##
-    # pre_install takes a {Gem::Installer} instance expected to be passed from
-    # a Gem.pre_install callback and overrides the
-    # {Gem::Installer#app_script_text} method if the puppet gem is about to be
-    # installed.
-    #
-    # @deprecated in favor of {.post_install}
-    #
-    # @param [Gem::Installer] gem_installer The gem installer instance of the
-    #   gem just installed, passed from the Gem.pre_install callback.
-    def self.pre_install(gem_installer)
-      return unless gem_installer.spec.name == 'puppet'
-      installer = new(gem_installer)
-      installer.modify_app_script_text!
+      return true
     end
 
     attr_reader :gem_installer
@@ -50,53 +60,6 @@ module PuppetTransplant
       @gem_installer = gem_installer
     end
 
-    ##
-    # modify_app_script_text! monkey patches the
-    # {Gem::Installer#app_script_text}
-    # method to implement the following behavior for the `puppet` binstub:
-    #
-    # 1. If `--confdir` or `--vardir` are specified via ARGV then use the
-    # provided values.
-    # 2. Otherwise modify ARGV to include `--confdir=/etc/#{org}/puppet` and
-    # `--vardir=/var/lib/#{org}/puppet`
-    #
-    # @deprecated in favor of overriding the default and confdir in a manner
-    #   that supports consistency between puppet as a library and puppet as an
-    #   application.  Implementing a wrapper script that sets --confdir and
-    #   --vardir creates inconsistent behavior between puppet as a library and
-    #   puppet as an application.
-    #
-    # @see {#relocate_puppet!}
-    #
-    # @see #org
-    #
-    # @api private
-    #
-    # @return [String] the text of the modified app script.
-    def modify_app_script_text!
-      custom_app_script_text = method(:app_script_text)
-      bindir  = bindir()
-      confdir = confdir()
-      vardir  = vardir()
-
-      gem_installer.instance_eval do
-        orig_app_script_text = method(:app_script_text)
-        define_singleton_method(:app_script_text) do |bin_file_name|
-          case bin_file_name
-          when 'puppet'
-            ui.say "***************************************************"
-            ui.say "* PuppetTransplant produced #{bindir}/puppet"
-            ui.say "*  confdir: #{confdir}"
-            ui.say "*  vardir:  #{vardir}"
-            ui.say "***************************************************"
-            custom_app_script_text.call(bin_file_name)
-          else
-            orig_app_script_text.call(bin_file_name)
-          end
-        end
-      end
-    end
-
     ##
     # relocate_puppet! overrides the default confdir and vardir using one of
     # two methods.  First, if the version of Puppet being relocated provides
@@ -115,12 +78,7 @@ module PuppetTransplant
       if puppet_override_api?
         rval = write_override_files
       else
-        begin
-          rval = modify_run_mode_in_place
-        rescue RelocationError => detail
-          gem_installer.ui.alert_error "Modification of run_mode.rb failed: #{detail}"
-          return false
-        end
+        rval = modify_run_mode_in_place
       end
       !!rval
     end
@@ -144,9 +102,9 @@ module PuppetTransplant
     def modify_run_mode_in_place
       # Locate the run_mode.rb file
       dir = gem_installer.dir
-      spec = gem_installer.spec
+      files = spec.files
 
-      if run_mode_file = spec.files.find() {|p| p.match(/\/run_mode.rb$/)}
+      if run_mode_file = files.find() {|p| p.match(/\/run_mode.rb$/)}
         run_mode_path = Pathname.new(File.join(dir, run_mode_file))
       else
         raise RelocationError, "Could not find run_mode.rb in the file list."
@@ -217,34 +175,6 @@ module PuppetTransplant
       Puppet::Util::RunMode.respond_to?(:override_path)
     end
 
-    ##
-    # @deprecated in favor of overriding the default and confdir in a manner
-    #   that supports consistency between puppet as a library and puppet as an
-    #   application.  Implementing a wrapper script that sets --confdir and
-    #   --vardir creates inconsistent behavior between puppet as a library and
-    #   puppet as an application.
-    #
-    # @see {#relocate_puppet!}
-    #
-    # @api private
-    #
-    # @return [String] the binstub contents
-    def app_script_text(bin_file_name)
-      return <<-TEXT
-#{shebang bin_file_name}
-#
-# This file was generated by PuppetTransplant in order to override the default
-# confdir and vardir in a generic way without patching.
-
-require 'rubygems'
-
-version = "#{Gem::Requirement.default}"
-
-gem '#{spec.name}', version
-load Gem.bin_path('#{spec.name}', '#{bin_file_name}', version)
-TEXT
-    end
-
     ##
     # org parses the filesystem path of the location of the ruby prefix path to
     # determine the organization name.  For example, if Ruby is installed with
@@ -285,11 +215,6 @@ TEXT
     end
     private :spec
 
-    def shebang(bin_file_name)
-      gem_installer.shebang(bin_file_name)
-    end
-    private :shebang
-
     ##
     # is_windows returns true if the ruby interpreter is currently running on a
     # windows platform.
@@ -323,17 +248,5 @@ TEXT
     def vardir
       @vardir ||= "/var/lib/#{org}/puppet"
     end
-
-    ##
-    # bindir returns the bin directory where binstub scripts will be written.
-    def bindir
-      bindir = gem_installer.bin_dir || Gem.bindir(gem_home)
-    end
-    private :bindir
-
-    def gem_home
-      gem_installer.gem_home
-    end
-    private :gem_home
   end
 end

data/lib/puppet_transplant/version.rb

@@ -1,3 +1,3 @@
 module PuppetTransplant
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/rubygems/puppet_transplant.rb

@@ -2,13 +2,6 @@
 require 'puppet_transplant/installer'
 
 module Gem
-  ## We're no longer going the route of patching the binstub.  Instead, we're
-  # going to override the default confdir and vardir in an effort to keep the
-  # behavior of puppet as a library and puppet as an application consistent.
-  # pre_install do |gem_installer|
-  #   PuppetTransplant::Installer.pre_install(gem_installer)
-  # end
-
   # Register a callback to override the default puppet confdir and vardir
   post_install do |gem_installer|
     PuppetTransplant::Installer.post_install(gem_installer)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet_transplant
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -134858611691268826
+      hash: 4590383034694438716
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -134858611691268826
+      hash: 4590383034694438716
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23