r10k 2.0.3 → 2.1.0

data/lib/r10k/environment/base.rb

@@ -67,6 +67,25 @@ class R10K::Environment::Base
     raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
   end
 
+  # Returns a unique identifier for the environment's current state.
+  #
+  # @api public
+  # @abstract
+  # @return [String]
+  def signature
+    raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
+  end
+
+  # Returns a hash describing the current state of the environment.
+  #
+  # @return [Hash]
+  def info
+    {
+      :name => self.name,
+      :signature => self.signature,
+    }
+  end
+
   # @return [Array<R10K::Module::Base>] All modules defined in the Puppetfile
   #   associated with this environment.
   def modules

data/lib/r10k/environment/git.rb

@@ -52,6 +52,15 @@ class R10K::Environment::Git < R10K::Environment::Base
     @synced = true
   end
 
+  # Return a sting which uniquely identifies (per source) the current state of the
+  # environment.
+  #
+  # @api public
+  # @return [String]
+  def signature
+    @repo.head
+  end
+
   extend Forwardable
 
   def_delegators :@repo, :status

data/lib/r10k/environment/svn.rb

@@ -64,6 +64,15 @@ class R10K::Environment::SVN < R10K::Environment::Base
     @synced = true
   end
 
+  # Return a sting which uniquely identifies (per source) the current state of the
+  # environment.
+  #
+  # @api public
+  # @return [String]
+  def signature
+    @working_dir.revision
+  end
+
   def status
     if !@path.exist?
       :absent

data/lib/r10k/forge/module_release.rb

@@ -1,10 +1,8 @@
-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'
+require 'puppet_forge'
 
 module R10K
   module Forge
@@ -14,6 +12,7 @@ module R10K
       include R10K::Settings::Mixin
 
       def_setting_attr :proxy
+      def_setting_attr :baseurl
 
       include R10K::Logging
 
@@ -24,10 +23,6 @@ module R10K
       #     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
@@ -42,11 +37,11 @@ module R10K
         @full_name = PuppetForge::V3.normalize_name(full_name)
         @version   = version
 
-        @forge_release = PuppetForge::V3::ModuleRelease.new(@full_name, @version)
-        @forge_release.conn.proxy(proxy)
+        PuppetForge::V3::Release.conn = conn
+        @forge_release = PuppetForge::V3::Release.new({ :name => @full_name, :version => @version, :slug => "#{@full_name}-#{@version}" })
 
-        @download_path = Pathname.new(Dir.mktmpdir) + (slug + '.tar.gz')
-        @unpack_path   = Pathname.new(Dir.mktmpdir) + slug
+        @download_path = Pathname.new(Dir.mktmpdir) + (@forge_release.slug + '.tar.gz')
+        @unpack_path   = Pathname.new(Dir.mktmpdir) + @forge_release.slug
       end
 
       # Download, unpack, and install this module release to the target directory.
@@ -71,19 +66,19 @@ module R10K
       #
       # @return [void]
       def download
-        logger.debug1 "Downloading #{@forge_release.slug} from #{@forge_release.conn.url_prefix} to #{@download_path}"
+        logger.debug1 "Downloading #{@forge_release.slug} from #{PuppetForge::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
+      # @raise [PuppetForge::V3::Release::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']}"
+        logger.debug1 "Verifying that #{download_path} matches checksum #{@forge_release.file_md5}"
         @forge_release.verify(download_path)
       end
 
@@ -128,6 +123,18 @@ module R10K
 
       private
 
+      def conn
+        if settings[:baseurl]
+          PuppetForge.host = settings[:baseurl]
+          conn = PuppetForge::Connection.make_connection(settings[:baseurl])
+        else
+          PuppetForge.host = "https://forgeapi.puppetlabs.com"
+          conn = PuppetForge::Connection.default_connection
+        end
+        conn.proxy(proxy)
+        conn
+      end
+
       def proxy
         [
           settings[:proxy],

data/lib/r10k/git.rb

@@ -68,6 +68,8 @@ module R10K
       name
     end
 
+    extend R10K::Logging
+
     # Manually set the Git provider by name.
     #
     # @param name [Symbol] The name of the Git provider to use.
@@ -87,7 +89,9 @@ module R10K
       if attrs[:on_set]
         attrs[:on_set].call
       end
+
       @provider = attrs[:module]
+      logger.debug1 { "Setting Git provider to #{@provider.name}" }
     end
 
     # @return [Module] The namespace of the first available Git implementation.
@@ -98,7 +102,9 @@ module R10K
         raise R10K::Error, "No Git provider set."
       when UNSET_PROVIDER
         self.provider = default_name
+        logger.debug1 { "Setting Git provider to default provider #{default_name}" }
       end
+
       @provider
     end
 

data/lib/r10k/git/alternates.rb

@@ -12,22 +12,35 @@ class R10K::Git::Alternates
   # @param git_dir [Pathname] The path to the git repository
   def initialize(git_dir)
     @file = git_dir + File.join('objects', 'info', 'alternates')
+    @entries = []
   end
 
-  def to_a
-    read()
+  def add(path)
+    write(to_a << path)
   end
+  alias << add
 
-  def <<(path)
-    write(to_a << path)
+  # Conditionally add path to the alternates file
+  #
+  # @param path [String] The file path to add to the file if not already present
+  # @return [true, false] If the entry was added.
+  def add?(path)
+    paths = read()
+
+    add_entry = !paths.include?(path)
+
+    if add_entry
+      paths << path
+      write(paths)
+    end
+
+    add_entry
   end
 
   def include?(path)
     to_a.include?(path)
   end
 
-  private
-
   def write(entries)
     if ! @file.parent.directory?
       raise R10K::Git::GitError, "Cannot write #{@file}; parent directory does not exist"
@@ -46,4 +59,5 @@ class R10K::Git::Alternates
     end
     entries
   end
+  alias to_a read
 end

data/lib/r10k/git/cache.rb

@@ -46,7 +46,7 @@ class R10K::Git::Cache
 
   extend Forwardable
 
-  def_delegators :@repo, :git_dir, :branches, :tags, :exist?, :resolve, :ref_type
+  def_delegators :@repo, :git_dir, :objects_dir, :branches, :tags, :exist?, :resolve, :ref_type
 
   # @!attribute [r] path
   #   @deprecated

data/lib/r10k/git/rugged/bare_repository.rb

@@ -19,6 +19,11 @@ class R10K::Git::Rugged::BareRepository < R10K::Git::Rugged::BaseRepository
     @path
   end
 
+  # @return [Pathname] The path to the objects directory in this Git repository
+  def objects_dir
+    @path + "objects"
+  end
+
   # Clone the given remote.
   #
   # This should only be called if the repository does not exist.

data/lib/r10k/git/rugged/base_repository.rb

@@ -1,10 +1,15 @@
 require 'r10k/git/rugged'
+require 'r10k/git/rugged/credentials'
 require 'r10k/logging'
 
 class R10K::Git::Rugged::BaseRepository
 
   include R10K::Logging
 
+  # @return [Pathname] The path to this repository.
+  # @note The `@path` instance variable must be set by inheriting classes on instantiation.
+  attr_reader :path
+
   def resolve(pattern)
     object = with_repo { |repo| repo.rev_parse(pattern) }
     case object
@@ -61,26 +66,7 @@ class R10K::Git::Rugged::BaseRepository
   #
   # @return [Proc]
   def credentials
-    Proc.new do |url, username_from_url, allowed_types|
-      private_key = R10K::Git.settings[:private_key]
-      git_user    = R10K::Git.settings[:username]
-
-      if private_key.nil?
-        raise R10K::Git::GitError.new("Git remote #{url.inspect} uses the SSH protocol but no private key was given", :git_dir => @path.to_s)
-      end
-
-      if !username_from_url.nil?
-        user = username_from_url
-      elsif git_user
-        user = git_user
-        logger.debug1 "URL #{url.inspect} did not specify an SSH user, using #{user.inspect} from configuration"
-      else
-        user = Etc.getlogin
-        logger.debug1 "URL #{url.inspect} did not specify an SSH user, using current user #{user.inspect}"
-      end
-
-      Rugged::Credentials::SshKey.new(:username => user, :privatekey => private_key)
-    end
+    R10K::Git::Rugged::Credentials.new(self)
   end
 
   def report_transfer(results, remote)

data/lib/r10k/git/rugged/credentials.rb

@@ -0,0 +1,66 @@
+require 'r10k/git/rugged'
+require 'r10k/git/errors'
+require 'r10k/logging'
+
+# Generate credentials for secured remote connections.
+#
+# @api private
+class R10K::Git::Rugged::Credentials
+
+  include R10K::Logging
+
+  # @param repository [R10K::Git::Rugged::BaseRepository]
+  def initialize(repository)
+    @repository = repository
+  end
+
+  def call(url, username_from_url, allowed_types)
+    if allowed_types.include?(:ssh_key)
+      get_ssh_key_credentials(url, username_from_url)
+    elsif allowed_types.include?(:plaintext)
+      get_plaintext_credentials(url, username_from_url)
+    else
+      get_default_credentials(url, username_from_url)
+    end
+  end
+
+  def get_ssh_key_credentials(url, username_from_url)
+    user = get_git_username(url, username_from_url)
+    private_key = R10K::Git.settings[:private_key]
+
+    if private_key.nil?
+      raise R10K::Git::GitError.new("Git remote #{url.inspect} uses the SSH protocol but no private key was given", :git_dir => @repository.path.to_s)
+    end
+
+    Rugged::Credentials::SshKey.new(:username => user, :privatekey => private_key)
+  end
+
+  def get_plaintext_credentials(url, username_from_url)
+    user = get_git_username(url, username_from_url)
+    password = URI.parse(url).password || ''
+    Rugged::Credentials::UserPassword.new(username: user, password: password)
+  end
+
+  def get_default_credentials(url, username_from_url)
+    Rugged::Credentials::Default.new
+  end
+
+  def get_git_username(url, username_from_url)
+    git_user = R10K::Git.settings[:username]
+
+    user = nil
+
+    if !username_from_url.nil?
+      user = username_from_url
+      logger.debug2 "URL #{url.inspect} includes the username #{username_from_url}, using that user for authentication."
+    elsif git_user
+      user = git_user
+      logger.debug2 "URL #{url.inspect} did not specify a user, using #{user.inspect} from configuration"
+    else
+      user = Etc.getlogin
+      logger.debug2 "URL #{url.inspect} did not specify a user, using current user #{user.inspect}"
+    end
+
+    user
+  end
+end

data/lib/r10k/git/rugged/thin_repository.rb

@@ -3,12 +3,10 @@ require 'r10k/git/rugged/working_repository'
 require 'r10k/git/rugged/cache'
 
 class R10K::Git::Rugged::ThinRepository < R10K::Git::Rugged::WorkingRepository
-  def initialize(basedir, dirname)
-    super
+  def initialize(basedir, dirname, cache_repo)
+    @cache_repo = cache_repo
 
-    if exist? && origin
-      set_cache(origin)
-    end
+    super(basedir, dirname)
   end
 
   # Clone this git repository
@@ -21,10 +19,9 @@ class R10K::Git::Rugged::ThinRepository < R10K::Git::Rugged::WorkingRepository
   # @return [void]
   def clone(remote, opts = {})
     logger.debug1 { "Cloning '#{remote}' into #{@path}" }
-    set_cache(remote)
     @cache_repo.sync
 
-    objectpath = (@cache_repo.git_dir + 'objects').to_s
+    cache_objects_dir = @cache_repo.objects_dir.to_s
 
     # {Rugged::Repository.clone_at} doesn't support :alternates, which
     # completely breaks how thin repositories need to work. To circumvent
@@ -33,8 +30,8 @@ class R10K::Git::Rugged::ThinRepository < R10K::Git::Rugged::WorkingRepository
     # fetch any objects because we don't need them, and we don't actually
     # use any refs in this repository so we skip all those steps.
     ::Rugged::Repository.init_at(@path.to_s, false)
-    @_rugged_repo = ::Rugged::Repository.new(@path.to_s, :alternates => [objectpath])
-    alternates << objectpath
+    @_rugged_repo = ::Rugged::Repository.new(@path.to_s, :alternates => [cache_objects_dir])
+    alternates << cache_objects_dir
 
     with_repo do |repo|
       config = repo.config
@@ -66,7 +63,15 @@ class R10K::Git::Rugged::ThinRepository < R10K::Git::Rugged::WorkingRepository
 
   private
 
-  def set_cache(remote)
-    @cache_repo = R10K::Git::Rugged::Cache.generate(remote)
+  # Override the parent class repo setup so that we can make sure the alternates file is up to date
+  # before we create the Rugged::Repository object, which reads from the alternates file.
+  def setup_rugged_repo
+    if git_dir.exist?
+      entry_added = alternates.add?(@cache_repo.objects_dir.to_s)
+      if entry_added
+        logger.debug2 { "Updated repo #{@path} to include alternate object db path #{@cache_repo.objects_dir}" }
+      end
+    end
+    super
   end
 end

data/lib/r10k/git/rugged/working_repository.rb

@@ -4,9 +4,6 @@ require 'r10k/git/errors'
 
 class R10K::Git::Rugged::WorkingRepository < R10K::Git::Rugged::BaseRepository
 
-  #  @return [Pathname] The path to this directory
-  attr_reader :path
-
   # @return [Pathname] The path to the Git repository inside of this directory
   def git_dir
     @path + '.git'
@@ -16,9 +13,7 @@ class R10K::Git::Rugged::WorkingRepository < R10K::Git::Rugged::BaseRepository
   # @param dirname [String] The directory name of the Git repository
   def initialize(basedir, dirname)
     @path = Pathname.new(File.join(basedir, dirname))
-    if exist? && git_dir.exist?
-      @_rugged_repo = ::Rugged::Repository.new(@path.to_s, :alternates => alternates.to_a)
-    end
+    setup_rugged_repo
   end
 
   # Clone this git repository
@@ -62,9 +57,14 @@ class R10K::Git::Rugged::WorkingRepository < R10K::Git::Rugged::BaseRepository
   # @param ref [String] The git reference to check out
   # @return [void]
   def checkout(ref)
-    logger.debug1 { "Checking out ref '#{ref}' at #{@path}" }
     sha = resolve(ref)
 
+    if sha
+      logger.debug2 { "Checking out ref '#{ref}' (resolved to SHA '#{sha}') in repository #{@path}" }
+    else
+      raise R10K::Git::GitError.new("Unable to check out unresolvable ref '#{ref}'", git_dir: git_dir)
+    end
+
     with_repo do |repo|
       repo.checkout(sha)
       repo.reset(sha, :hard)
@@ -96,4 +96,12 @@ class R10K::Git::Rugged::WorkingRepository < R10K::Git::Rugged::BaseRepository
   def origin
     with_repo { |repo| repo.config['remote.origin.url'] }
   end
+
+  private
+
+  def setup_rugged_repo
+    if exist? && git_dir.exist?
+      @_rugged_repo = ::Rugged::Repository.new(@path.to_s, :alternates => alternates.to_a)
+    end
+  end
 end