r10k 1.5.1 → 2.0.0

data/lib/r10k/deployment/config.rb

@@ -8,6 +8,8 @@ module R10K
 class Deployment
 class Config
 
+  include R10K::Logging
+
   attr_accessor :configfile
 
   def initialize(configfile)
@@ -41,7 +43,7 @@ class Config
       loader = R10K::Deployment::Config::Loader.new
       @configfile = loader.search
       if @configfile.nil?
-        raise ConfigError, "No configuration file given, no config file found in parent directory, and no global config present"
+        raise ConfigError, "No configuration file given, no config file found in current directory, and no global config present"
       end
     end
     begin
@@ -61,10 +63,22 @@ class Config
 
   # Apply global configuration settings.
   def apply_config_settings
+    with_setting(:purgedirs) do |purgedirs|
+      logger.warn("The purgedirs key in r10k.yaml is deprecated. It is currently ignored.")
+    end
+
     with_setting(:cachedir) do |cachedir|
       R10K::Git::Cache.settings[:cache_root] = cachedir
     end
 
+    with_setting(:forge) do |forge_settings|
+      R10K::Util::SymbolizeKeys.symbolize_keys!(forge_settings)
+      proxy = forge_settings[:proxy]
+      if proxy
+        R10K::Forge::ModuleRelease.settings[:proxy] = proxy
+      end
+    end
+
     with_setting(:git) do |git_settings|
       R10K::Util::SymbolizeKeys.symbolize_keys!(git_settings)
       provider = git_settings[:provider]

data/lib/r10k/deployment/config/loader.rb

@@ -11,7 +11,6 @@ module R10K
 
         CONFIG_FILE = 'r10k.yaml'
         DEFAULT_LOCATION = File.join('/etc/puppetlabs/r10k', CONFIG_FILE)
-        OLD_DEFAULT_LOCATION = File.join('/etc', CONFIG_FILE)
 
         # Search for a deployment configuration file (r10k.yaml) in several locations
         def initialize
@@ -21,13 +20,6 @@ module R10K
 
         # @return [String] The path to the first valid configfile
         def search
-
-          # If both default files are present, issue a warning.
-          if (File.file? DEFAULT_LOCATION) && (File.file? OLD_DEFAULT_LOCATION)
-            logger.warn "Both #{DEFAULT_LOCATION} and #{OLD_DEFAULT_LOCATION} configuration files exist."
-            logger.warn "#{DEFAULT_LOCATION} will be used."
-          end
-
           first = @loadpath.find {|filename| File.file? filename}
         end
 
@@ -41,9 +33,6 @@ module R10K
           # Add the AIO location for of r10k.yaml
           @loadpath << DEFAULT_LOCATION
 
-          # Add the old default location last.
-          @loadpath << OLD_DEFAULT_LOCATION
-
           @loadpath
         end
       end

data/lib/r10k/environment/git.rb

@@ -55,13 +55,4 @@ class R10K::Environment::Git < R10K::Environment::Base
   extend Forwardable
 
   def_delegators :@repo, :status
-
-  # @deprecated
-  # @api private
-  def sync_modules
-    modules.each do |mod|
-      logger.debug "Deploying module #{mod.name}"
-      mod.sync
-    end
-  end
 end

data/lib/r10k/environment/svn.rb

@@ -77,13 +77,4 @@ class R10K::Environment::SVN < R10K::Environment::Base
       :insync
     end
   end
-
-  # @deprecated
-  # @api private
-  def sync_modules
-    modules.each do |mod|
-      logger.debug "Deploying module #{mod.name}"
-      mod.sync
-    end
-  end
 end

data/lib/r10k/errors.rb

@@ -40,7 +40,4 @@ module R10K
       @options = options
     end
   end
-
-  # @deprecated
-  R10KError = Error
 end

data/lib/r10k/feature.rb

@@ -1,7 +1,11 @@
+require 'r10k/logging'
+
 module R10K
   # Detect whether a given feature is present or absent
   class Feature
 
+    include R10K::Logging
+
     # @attribute [r] name
     #   @return [Symbol] The name of this feature
     attr_reader :name
@@ -15,21 +19,38 @@ module R10K
     def initialize(name, opts = {}, &block)
       @name      = name
       @libraries = Array(opts.delete(:libraries))
-      @block     = block || lambda { true }
+      @block     = block
     end
 
     # @return [true, false] Is this feature available?
     def available?
-      @libraries.all? { |lib| library_available?(lib) } && !!@block.call
+      logger.debug1 { "Testing to see if feature #{@name} is available." }
+      rv = @libraries.all? { |lib| library_available?(lib) } && proc_available?
+      msg = rv ? "is" : "is not"
+      logger.debug1 { "Feature #{@name} #{msg} available." }
+      rv
     end
 
     private
 
     def library_available?(lib)
+      logger.debug2 { "Attempting to load library '#{lib}' for feature #{@name}" }
       require lib
       true
-    rescue ScriptError
+    rescue ScriptError => e
+      logger.debug2 { "Error while loading library #{lib} for feature #{@name}: #{e.message}" }
       false
     end
+
+    def proc_available?
+      if @block
+        logger.debug2 { "Evaluating proc #{@block.inspect} to test for feature #{@name}" }
+        output = @block.call
+        logger.debug2 { "Proc #{@block.inspect} for feature #{@name} returned #{output.inspect}" }
+        !!output
+      else
+        true
+      end
+    end
   end
 end

data/lib/r10k/forge/module_release.rb

@@ -0,0 +1,142 @@
+require 'shared/puppet_forge/v3/module_release'
+require 'shared/puppet_forge/unpacker'
+require 'r10k/logging'
+require 'r10k/settings/mixin'
+require 'fileutils'
+require 'forwardable'
+require 'tmpdir'
+
+module R10K
+  module Forge
+    # Download, unpack, and install modules from the Puppet Forge
+    class ModuleRelease
+
+      include R10K::Settings::Mixin
+
+      def_setting_attr :proxy
+
+      include R10K::Logging
+
+      # @!attribute [r] forge_release
+      #   @api private
+      #   @return [PuppetForge::V3::ModuleRelease] The Forge V3 API module
+      #     release object used for downloading and verifying the module
+      #     release.
+      attr_reader :forge_release
+
+      extend Forwardable
+
+      def_delegators :@forge_release, :slug, :data
+
+      # @!attribute [rw] download_path
+      #   @return [Pathname] Where the module tarball will be downloaded to.
+      attr_accessor :download_path
+
+      # @!attribute [rw] unpack_path
+      #   @return [Pathname] Where the module will be unpacked to.
+      attr_accessor :unpack_path
+
+      # @param full_name [String] The hyphen separated name of the module
+      # @param version [String] The version of the module
+      def initialize(full_name, version)
+        @full_name = PuppetForge::V3.normalize_name(full_name)
+        @version   = version
+
+        @forge_release = PuppetForge::V3::ModuleRelease.new(@full_name, @version)
+        @forge_release.conn.proxy(proxy)
+
+        @download_path = Pathname.new(Dir.mktmpdir) + (slug + '.tar.gz')
+        @unpack_path   = Pathname.new(Dir.mktmpdir) + slug
+      end
+
+      # Download, unpack, and install this module release to the target directory.
+      #
+      # @example
+      #   environment_path = Pathname.new('/etc/puppetlabs/puppet/environments/production')
+      #   target_dir = environment_path + 'eight_hundred'
+      #   mod = R10K::Forge::ModuleRelease.new('branan-eight_hundred', '8.0.0')
+      #   mod.install(target_dir)
+      #
+      # @param target_dir [Pathname] The full path to where the module should be installed.
+      # @return [void]
+      def install(target_dir)
+        download
+        verify
+        unpack(target_dir)
+      ensure
+        cleanup
+      end
+
+      # Download the module release to {#download_path}
+      #
+      # @return [void]
+      def download
+        logger.debug1 "Downloading #{@forge_release.slug} from #{@forge_release.conn.url_prefix} to #{@download_path}"
+        @forge_release.download(download_path)
+      end
+
+      # Verify the module release downloaded to {#download_path} against the
+      # module release checksum given by the Puppet Forge
+      #
+      # @raise [PuppetForge::V3::ModuleRelease::ChecksumMismatch] The
+      #   downloaded module release checksum doesn't match the expected Forge
+      #   module release checksum.
+      # @return [void]
+      def verify
+        logger.debug1 "Verifying that #{download_path} matches checksum #{data['file_md5']}"
+        @forge_release.verify(download_path)
+      end
+
+      # Unpack the module release at {#download_path} into the given target_dir
+      #
+      # @param target_dir [Pathname] The final path where the module release
+      #   should be unpacked/installed into.
+      # @return [void]
+      def unpack(target_dir)
+        logger.debug1 "Unpacking #{download_path} to #{target_dir} (with tmpdir #{unpack_path})"
+        file_lists = PuppetForge::Unpacker.unpack(download_path.to_s, target_dir.to_s, unpack_path.to_s)
+        logger.debug2 "Valid files unpacked: #{file_lists[:valid]}"
+        if !file_lists[:invalid].empty?
+          logger.warn "These files existed in the module's tar file, but are invalid filetypes and were not " +
+                      "unpacked: #{file_lists[:invalid]}"
+        end
+        if !file_lists[:symlinks].empty?
+          raise R10K::Error, "Symlinks are unsupported and were not unpacked from the module tarball. " + 
+                             "#{@forge_release.slug} contained these ignored symlinks: #{file_lists[:symlinks]}"
+        end
+      end
+
+      # Remove all files created while downloading and unpacking the module.
+      def cleanup
+        cleanup_unpack_path
+        cleanup_download_path
+      end
+
+      # Remove the temporary directory used for unpacking the module.
+      def cleanup_unpack_path
+        if unpack_path.exist?
+          unpack_path.rmtree
+        end
+      end
+
+      # Remove the downloaded module release.
+      def cleanup_download_path
+        if download_path.exist?
+          download_path.delete
+        end
+      end
+
+      private
+
+      def proxy
+        [
+          settings[:proxy],
+          ENV['HTTPS_PROXY'],
+          ENV['https_proxy'],
+          ENV['HTTP_PROXY'],
+          ENV['http_proxy']
+        ].find { |value| value }
+      end
+    end
+  end
+end

data/lib/r10k/git.rb

@@ -1,18 +1,38 @@
 require 'r10k/features'
 require 'r10k/errors'
 require 'r10k/settings'
+require 'r10k/logging'
 
 module R10K
   module Git
     require 'r10k/git/shellgit'
     require 'r10k/git/rugged'
 
+    extend R10K::Logging
+
     # A list of Git providers, sorted by priority. Providers have features that
     # must be available for them to be used, and a module which is the namespace
     # containing the implementation.
     @providers = [
-      [:shellgit, {:feature => :shellgit, :module => R10K::Git::ShellGit}],
-      [:rugged,   {:feature => :rugged,   :module => R10K::Git::Rugged}],
+      [ :shellgit,
+        {
+          :feature => :shellgit,
+          :module  => R10K::Git::ShellGit,
+        }
+      ],
+      [ :rugged,
+        {
+          :feature => :rugged,
+          :module  => R10K::Git::Rugged,
+          :on_set  => proc do
+            [:ssh, :https].each do |transport|
+              if !::Rugged.features.include?(transport)
+                logger.warn "Rugged has been compiled without support for #{transport}; Git repositories will not be reachable via #{transport}."
+              end
+            end
+          end
+        }
+      ],
     ]
 
     # Mark the current provider as invalid.
@@ -39,14 +59,13 @@ module R10K
     # Return the first available Git provider.
     #
     # @raise [R10K::Error] if no Git providers are functional.
-    # @return [Module] The namespace of the first available Git implementation.
-    #   Implementation classes should be looked up against this returned Module.
-    def self.default
-      _, attrs = @providers.find { |(_, hash)| R10K::Features.available?(hash[:feature]) }
-      if attrs.nil?
+    # @return [String] The name of the first available Git implementation.
+    def self.default_name
+      name, _ = @providers.find { |(_, hash)| R10K::Features.available?(hash[:feature]) }
+      if name.nil?
         raise R10K::Error, "No Git providers are functional."
       end
-      attrs[:module]
+      name
     end
 
     # Manually set the Git provider by name.
@@ -65,6 +84,9 @@ module R10K
         @provider = NULL_PROVIDER
         raise R10K::Error, "Git provider '#{name}' is not functional."
       end
+      if attrs[:on_set]
+        attrs[:on_set].call
+      end
       @provider = attrs[:module]
     end
 
@@ -75,10 +97,9 @@ module R10K
       when NULL_PROVIDER
         raise R10K::Error, "No Git provider set."
       when UNSET_PROVIDER
-        @provider = default
-      else
-        @provider
+        self.provider = default_name
       end
+      @provider
     end
 
     def self.cache

data/lib/r10k/module/forge.rb

@@ -2,19 +2,19 @@ require 'r10k/module'
 require 'r10k/errors'
 require 'shared/puppet/module_tool/metadata'
 require 'r10k/module/metadata_file'
-require 'r10k/util/subprocess'
-require 'r10k/module_repository/forge'
+
+require 'r10k/forge/module_release'
+require 'shared/puppet_forge/v3/module'
 
 require 'pathname'
 require 'fileutils'
-require 'r10k/semver'
 
 class R10K::Module::Forge < R10K::Module::Base
 
   R10K::Module.register(self)
 
   def self.implement?(name, args)
-    !!(name.match %r[\w+/\w+])
+    !!(name.match %r[\w+[/-]\w+])
   end
 
   # @!attribute [r] metadata
@@ -22,18 +22,20 @@ class R10K::Module::Forge < R10K::Module::Base
   #   @return [Puppet::ModuleTool::Metadata]
   attr_reader :metadata
 
+  # @!attribute [r] v3_module
+  #   @api private
+  #   @return [PuppetForge::V3::Module] The Puppet Forge module metadata
+  attr_reader :v3_module
+
   include R10K::Logging
 
-  def initialize(title, dirname, args)
+  def initialize(title, dirname, expected_version)
     super
     @metadata_file = R10K::Module::MetadataFile.new(path + 'metadata.json')
     @metadata = @metadata_file.read
 
-    if args.is_a? String
-      @expected_version = R10K::SemVer.new(args)
-    elsif args.is_a? Symbol and args == :latest
-      @expected_version = args
-    end
+    @expected_version = expected_version || current_version || :latest
+    @v3_module = PuppetForge::V3::Module.new(@title)
   end
 
   def sync(options = {})
@@ -55,17 +57,17 @@ class R10K::Module::Forge < R10K::Module::Base
     }
   end
 
-  # @return [R10K::SemVer] The expected version that the module
+  # @return [String] The expected version that the module
   def expected_version
-    if @expected_version.is_a?(Symbol) && @expected_version == :latest
-      set_version_from_forge
+    if @expected_version == :latest
+      @expected_version = @v3_module.latest_version
     end
     @expected_version
   end
 
-  # @return [R10K::SemVer] The version of the currently installed module
+  # @return [String] The version of the currently installed module
   def current_version
-    @metadata.version
+    @metadata ? @metadata.version : nil
   end
 
   alias version current_version
@@ -113,26 +115,16 @@ class R10K::Module::Forge < R10K::Module::Base
     return :insync
   end
 
-  private
-
   def install
-    FileUtils.mkdir @dirname unless File.directory? @dirname
-    cmd = []
-    cmd << 'install'
-    cmd << "--version=#{expected_version}" if expected_version
-    cmd << "--force"
-    cmd << title
-    pmt cmd
+    parent_path = @path.parent
+    if !parent_path.exist?
+      parent_path.mkpath
+    end
+    module_release = R10K::Forge::ModuleRelease.new(@title, expected_version)
+    module_release.install(@path)
   end
 
-  def upgrade
-    cmd = []
-    cmd << 'upgrade'
-    cmd << "--version=#{expected_version}" if expected_version
-    cmd << "--force"
-    cmd << title
-    pmt cmd
-  end
+  alias upgrade install
 
   def uninstall
     FileUtils.rm_rf full_path
@@ -143,28 +135,7 @@ class R10K::Module::Forge < R10K::Module::Base
     install
   end
 
-  # Wrap puppet module commands
-  #
-  # @param argv [Array<String>]
-  #
-  # @return [String] The stdout from the executed command
-  def pmt(argv)
-    argv = ['puppet', 'module', '--modulepath', @dirname, '--color', 'false'] + argv
-
-    subproc = R10K::Util::Subprocess.new(argv)
-    subproc.raise_on_fail = true
-    subproc.logger = self.logger
-
-    result = subproc.execute
-
-    result.stdout
-  end
-
-  def set_version_from_forge
-    repo = R10K::ModuleRepository::Forge.new
-    expected = repo.latest_version(title)
-    @expected_version = R10K::SemVer.new(expected)
-  end
+  private
 
   # Override the base #parse_title to ensure we have a fully qualified name
   def parse_title(title)