puppet_transplant 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--markup-provider redcarpet
+--readme README.md
+lib/**/*.rb
+-
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puppet_wrapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,45 @@
+# PuppetTransplant
+
+This gem is a [rubygems plugin](http://guides.rubygems.org/plugins/) that is
+expected to be installed in the same gemset as Puppet.  The intent is to modify
+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 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
+library based use cases and application based use cases as compared to a
+wrapper script which sets --confdir and --vardir which introduces an
+inconsistency between application and library use cases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'puppet_transplant'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puppet_transplant
+
+## Usage
+
+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.
+
+The relocation target directories are not currently configurable but this
+should be a future improvement.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "yard"
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end

data/lib/puppet_transplant/installer.rb

@@ -0,0 +1,254 @@
+require 'pathname'
+require 'rbconfig'
+require 'rubygems/installer'
+
+module PuppetTransplant
+  class Installer
+    ##
+    # post_install takes a {Gem::Installer} instance expected to be passed from
+    # a {Gem.post_install} callback and modifies an installed `puppet` gem to
+    # use a relocated confdir and vardir.  This method does nothing if the
+    # gem_installer instance is not processing puppet.
+    #
+    # @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)
+      return unless gem_installer.spec.name == 'puppet'
+      installer = new(gem_installer)
+      installer.relocate_puppet!
+    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!
+    end
+
+    attr_reader :gem_installer
+
+    ##
+    # @param [Gem::Installer] gem_installer The gem installer instance
+    #   typically passed from the plugin hook.
+    def initialize(gem_installer)
+      @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
+    # the Puppet::Util::RunMode.override_path method then the default path will
+    # be overriden using this method.
+    #
+    # If the override_path API is not implemented in the version of Puppet
+    # installed then the run_mode.rb file will be modified directly after
+    # creating a backup at run_mode.rb.orig
+    #
+    # @api private
+    def relocate_puppet!
+      if puppet_override_api?
+        write_override_files
+      else
+        modify_run_mode_in_place
+      end
+    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
+    # 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')
+      msg = "# Automatically overriden by the puppet_transplant gem"
+      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|
+        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}'"
+    end
+
+    ##
+    # puppet_override_api? determines if the version of Puppet being processed
+    # supports the {Puppet::Util::RunMode.override_path} API which makes it
+    # easier to override the default confdir and vardir.
+    #
+    # @return [Boolean] if puppet supports the override_path API return true.
+    #   if not return false.
+    def puppet_override_api?
+      require 'puppet/util/run_mode'
+      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
+    # a prefix of `/opt/operations` then this method will return `operations`.
+    # With a Unix style path the second element from the root will be used.
+    # With a Windows style path, the first directory following the drive
+    # component will be used.  On windows `C:/operations` will return
+    # `operations`.
+    #
+    # @api public
+    #
+    # @return [String] The org name parsed from the ruby prefix path or
+    #   "unknown" if the parsing of the path did not succeed.
+    def org
+      return @org if @org
+      path = Pathname.new(prefix)
+      idx = is_windows ? 1 : 2
+      @org = path.expand_path.to_s.split('/')[idx] || 'unknown'
+    end
+
+    ##
+    # prefix returns the ruby prefix path of the currently running interpreter
+    #
+    # @api private
+    #
+    # @return [String] The prefix path of the ruby interpreter
+    def prefix
+      RbConfig::CONFIG['prefix']
+    end
+
+    ##
+    # spec returns the {Gem::Specification} instance for the gem being
+    # processed.
+    #
+    # @return [Gem::Specification] gem specification of the gem being installed.
+    def spec
+      gem_installer.spec
+    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.
+    def is_windows
+      !!(RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+    end
+    private :is_windows
+
+    def confdir
+      @confdir ||= "/etc/#{org}/puppet"
+    end
+    private :confdir
+
+    def vardir
+      @vardir ||= "/var/lib/#{org}/puppet"
+    end
+    private :vardir
+
+    ##
+    # 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

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

data/lib/puppet_transplant.rb

@@ -0,0 +1,5 @@
+require "puppet_transplant/version"
+
+module PuppetTransplant
+  # Your code goes here...
+end

data/lib/rubygems/puppet_transplant.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+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)
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,2 @@
+# encoding: UTF-8
+require 'rubygems/puppet_transplant'

data/puppet_transplant.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppet_transplant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puppet_transplant"
+  spec.version       = PuppetTransplant::VERSION
+  spec.authors       = ["Jeff McCune"]
+  spec.email         = ["jeff@puppetlabs.com"]
+  spec.description   = %q{Relocate puppet to use a different default confdir and vardir}
+  spec.summary       = %q{Relocate puppet to use a different default confdir and vardir}
+  spec.homepage      = ""
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+end