puppet_transplant 0.0.1 → 0.0.2

data/lib/puppet_transplant/installer.rb

@@ -4,6 +4,8 @@ require 'rubygems/installer'
 
 module PuppetTransplant
   class Installer
+    class RelocationError < Exception; end
+
     ##
     # post_install takes a {Gem::Installer} instance expected to be passed from
     # a {Gem.post_install} callback and modifies an installed `puppet` gem to
@@ -13,9 +15,14 @@ module PuppetTransplant
     # @param [Gem::Installer] gem_installer The gem installer instance of the
     #   gem just installed, passed from the Gem.post_install callback.
     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!
+      # Let the user know what happened
+      gem_installer.ui.debug "Transplanted confdir: #{installer.confdir}"
+      gem_installer.ui.debug "Transplanted vardir:  #{installer.vardir}"
     end
 
     ##
@@ -100,40 +107,102 @@ module PuppetTransplant
     # installed then the run_mode.rb file will be modified directly after
     # creating a backup at run_mode.rb.orig
     #
-    # @api private
+    # @return [Boolean] true if Puppet has been successfully relocated, false
+    #   otherwise
+    #
+    # @api public
     def relocate_puppet!
       if puppet_override_api?
-        write_override_files
+        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
+      end
+      !!rval
+    end
+
+    ##
+    # modify_run_mode_in_place directly modifies Puppet's `run_mode.rb` file to
+    # change the default system confdir and vardir.  This behavior is a
+    # fallback mechanism in the event Puppet does not support the so-called
+    # relocation API submitted at
+    # https://github.com/puppetlabs/puppet/pull/2236
+    #
+    # @api private
+    #
+    # @raise [RelocationError] if the method could not perform the relocation.
+    #   The reason will be included in the exception message.
+    #
+    # @see #relocate_puppet!
+    # @see #puppet_override_api?
+    #
+    # @return [Boolean] true if `run_mode.rb` was successfully modified.
+    def modify_run_mode_in_place
+      # Locate the run_mode.rb file
+      dir = gem_installer.dir
+      spec = gem_installer.spec
+
+      if run_mode_file = spec.files.find() {|p| p.match(/\/run_mode.rb$/)}
+        run_mode_path = Pathname.new(File.join(dir, run_mode_file))
       else
-        modify_run_mode_in_place
+        raise RelocationError, "Could not find run_mode.rb in the file list."
+      end
+
+      if not run_mode_path.readable?
+        raise RelocationError, "#{run_mode_path} is not readable."
+      end
+
+      if not run_mode_path.writable?
+        raise RelocationError, "#{run_mode_path} is not writable."
       end
+
+      # This file is small enough to fit into memory.
+      data = File.read(run_mode_path)
+
+      # Modify the file in place for confdir
+      if not data.gsub!(/\/etc\/puppet\b/, confdir)
+        raise RelocationError, "Found no occurrences of /etc/puppet to replace."
+      end
+      # Modify the file in place for vardir
+      if not data.gsub!(/\/var\/lib\/puppet\b/, vardir)
+        raise RelocationError, "Found no occurrences of /var/lib/puppet to replace."
+      end
+
+      # Write the file back out to the system.
+      File.open(run_mode_path, 'w') do |file|
+        file.write(data)
+      end
+      return true
     end
 
     ##
     # write_override_files writes files to the filesystem using the
     # {Puppet::Util::RunMode.override_path) public API method to determine
-    # which files to write.  These files are intended to override the default
+    # whch files to write.  These files are intended to override the default
     # confdir and vardir for Puppet both as an application and as a library.
     # See {https://tickets.puppetlabs.com/browse/PUP-1406}
     #
     # @api private
     def write_override_files
       confdir_path = Puppet::Util::RunMode.override_path('confdir')
+      vardir_path = Puppet::Util::RunMode.override_path('vardir')
       msg = "# Automatically overriden by the puppet_transplant gem"
-      File.open(confdir_path, "w+") do |f|
+
+      File.open(confdir_path, "w") do |f|
         f.puts(confdir)
         f.puts(msg)
       end
 
-      vardir_path = Puppet::Util::RunMode.override_path('vardir')
-      File.open(vardir_path, "w+") do |f|
+      File.open(vardir_path, "w") do |f|
         f.puts(vardir)
         f.puts(msg)
       end
-    
-      gem_installer.ui.alert "PuppetTransplant modified the system confdir and vardir defaults:"
-      gem_installer.ui.alert "confdir='#{confdir}'"
-      gem_installer.ui.alert "vardir='#{vardir}'"
+
+      return true
     end
 
     ##
@@ -229,15 +298,31 @@ TEXT
     end
     private :is_windows
 
+    ##
+    # confdir returns the path of the relocated default system confdir
+    #
+    # @api public
+    #
+    # @see #vardir
+    #
+    # @return [String] The fully qualified path of the relocated default system
+    #   confdir.
     def confdir
       @confdir ||= "/etc/#{org}/puppet"
     end
-    private :confdir
 
+    ##
+    # vardir returns the path of the relocated default system vardir
+    #
+    # @api public
+    #
+    # @see #confdir
+    #
+    # @return [String] The fully qualified path of the relocated default system
+    #   vardir.
     def vardir
       @vardir ||= "/var/lib/#{org}/puppet"
     end
-    private :vardir
 
     ##
     # bindir returns the bin directory where binstub scripts will be written.

data/lib/puppet_transplant/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet_transplant
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-01-21 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: -1993839482699150890
+      hash: -134858611691268826
 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: -1993839482699150890
+      hash: -134858611691268826
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23