r10k 1.4.2 → 1.5.1

data/lib/r10k/errors.rb

@@ -2,11 +2,6 @@ require 'r10k'
 
 module R10K
 
-  # @deprecated
-  class ExecutionFailure < StandardError
-    attr_accessor :exit_code, :stdout, :stderr
-  end
-
   # An error class that accepts an optional hash and wrapped error message
   #
   class Error < StandardError
@@ -32,8 +27,16 @@ module R10K
     # @overload initialize(mesg, options)
     #   @param mesg [String] The exception mesg
     #   @param options [Hash] A set of options to store on the exception
+    #
+    # @options options [Array<String>] :backtrace
     def initialize(mesg, options = {})
       super(mesg)
+
+      bt = options.delete(:backtrace)
+      if bt
+        set_backtrace(bt)
+      end
+
       @options = options
     end
   end

data/lib/r10k/feature.rb

@@ -0,0 +1,35 @@
+module R10K
+  # Detect whether a given feature is present or absent
+  class Feature
+
+    # @attribute [r] name
+    #   @return [Symbol] The name of this feature
+    attr_reader :name
+
+    # @param name [Symbol] The name of this feature
+    # @param opts [Hash]
+    # @param block [Proc] An optional block to detect if this feature is available
+    #
+    # @option opts [String, Array<String>] :libraries One or more libraries to
+    #   require to make sure this feature is present.
+    def initialize(name, opts = {}, &block)
+      @name      = name
+      @libraries = Array(opts.delete(:libraries))
+      @block     = block || lambda { true }
+    end
+
+    # @return [true, false] Is this feature available?
+    def available?
+      @libraries.all? { |lib| library_available?(lib) } && !!@block.call
+    end
+
+    private
+
+    def library_available?(lib)
+      require lib
+      true
+    rescue ScriptError
+      false
+    end
+  end
+end

data/lib/r10k/feature/collection.rb

@@ -0,0 +1,23 @@
+require 'r10k/feature'
+
+# Store all features and indicate if they're available.
+class R10K::Feature::Collection
+  def initialize
+    @features = {}
+  end
+
+  # @param name [Symbol] The feature to add
+  # @param opts [Hash] Additional options for the feature, see {R10K::Feature}
+  # @param block [Proc] An optional block to detect if this feature is present
+  # @return [void]
+  def add(name, opts = {}, &block)
+    @features[name] = R10K::Feature.new(name, opts, &block)
+  end
+
+  # @return [true, false] Does a feature by this name exist and is it available?
+  def available?(name)
+    if @features.key?(name)
+      @features[name].available?
+    end
+  end
+end

data/lib/r10k/features.rb

@@ -0,0 +1,18 @@
+require 'r10k/feature/collection'
+require 'forwardable'
+require 'r10k/util/commands'
+
+module R10K
+  module Features
+    @features = R10K::Feature::Collection.new
+
+    class << self
+      extend Forwardable
+      def_delegators :@features, :add, :available?
+    end
+  end
+end
+
+R10K::Features.add(:shellgit) { R10K::Util::Commands.which('git') }
+
+R10K::Features.add(:rugged, :libraries => 'rugged')

data/lib/r10k/git.rb

@@ -1,16 +1,110 @@
+require 'r10k/features'
+require 'r10k/errors'
+require 'r10k/settings'
+
 module R10K
   module Git
-    require 'r10k/git/errors'
-
-    require 'r10k/git/ref'
-    require 'r10k/git/tag'
-    require 'r10k/git/head'
-    require 'r10k/git/remote_head'
-    require 'r10k/git/commit'
-
-    require 'r10k/git/repository'
-    require 'r10k/git/cache'
-    require 'r10k/git/alternates'
-    require 'r10k/git/working_dir'
+    require 'r10k/git/shellgit'
+    require 'r10k/git/rugged'
+
+    # 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}],
+    ]
+
+    # Mark the current provider as invalid.
+    #
+    # If a provider is set to an invalid provider, we need to make sure that
+    # the provider doesn't fall back to the default value, thereby ignoring the
+    # explicit value and silently continuing. If the current provider is
+    # assigned to this value, no provider will be used until the provider is
+    # either reset or assigned a valid provider.
+    #
+    # @api private
+    NULL_PROVIDER = Object.new
+
+    # Mark the current provider as unset.
+    #
+    # If the provider has never been set we need to indicate that there is no
+    # current value but the default value can be used. If the current provider
+    # is assigned to this value and the provider is looked up, the default
+    # provider will be looked up and used.
+    #
+    # @api private
+    UNSET_PROVIDER = Object.new
+
+    # 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?
+        raise R10K::Error, "No Git providers are functional."
+      end
+      attrs[:module]
+    end
+
+    # Manually set the Git provider by name.
+    #
+    # @param name [Symbol] The name of the Git provider to use.
+    # @raise [R10K::Error] if the requested Git provider doesn't exist.
+    # @raise [R10K::Error] if the requested Git provider isn't functional.
+    # @return [void]
+    def self.provider=(name)
+      _, attrs = @providers.find { |(providername, _)| name == providername }
+      if attrs.nil?
+        @provider = NULL_PROVIDER
+        raise R10K::Error, "No Git provider named '#{name}'."
+      end
+      if !R10K::Features.available?(attrs[:feature])
+        @provider = NULL_PROVIDER
+        raise R10K::Error, "Git provider '#{name}' is not functional."
+      end
+      @provider = attrs[:module]
+    end
+
+    # @return [Module] The namespace of the first available Git implementation.
+    #   Implementation classes should be looked up against this returned Module.
+    def self.provider
+      case @provider
+      when NULL_PROVIDER
+        raise R10K::Error, "No Git provider set."
+      when UNSET_PROVIDER
+        @provider = default
+      else
+        @provider
+      end
+    end
+
+    def self.cache
+      provider::Cache
+    end
+
+    def self.bare_repository
+      provider::BareRepository
+    end
+
+    def self.thin_repository
+      provider::ThinRepository
+    end
+
+    # Clear the currently set provider.
+    #
+    # @api private
+    def self.reset!
+      @provider = UNSET_PROVIDER
+    end
+
+    @provider = UNSET_PROVIDER
+
+    extend R10K::Settings::Mixin::ClassMethods
+
+    def_setting_attr :private_key
+    def_setting_attr :username
   end
 end

data/lib/r10k/git/alternates.rb

@@ -9,9 +9,9 @@ class R10K::Git::Alternates
   #   @return [Pathname] The alternates file
   attr_reader :file
 
-  # @param git_dir [String] The path to the git repository
+  # @param git_dir [Pathname] The path to the git repository
   def initialize(git_dir)
-    @file = Pathname.new(File.join(git_dir, 'objects', 'info', 'alternates'))
+    @file = git_dir + File.join('objects', 'info', 'alternates')
   end
 
   def to_a

data/lib/r10k/git/cache.rb

@@ -1,22 +1,28 @@
 require 'r10k/git'
-require 'r10k/git/repository'
 
 require 'r10k/settings'
-require 'r10k/registry'
+require 'r10k/instance_cache'
+require 'forwardable'
 
-# Mirror a git repository for use shared git object repositories
+# Cache Git repository mirrors for object database reuse.
 #
+# This implements most of the behavior needed for Git repo caching, but needs
+# to have a specific Git bare repository provided. Subclasses should implement
+# the {bare_repository} method.
+#
+# @abstract
 # @see man git-clone(1)
-class R10K::Git::Cache < R10K::Git::Repository
+class R10K::Git::Cache
 
   include R10K::Settings::Mixin
 
   def_setting_attr :cache_root, File.expand_path(ENV['HOME'] ? '~/.r10k/git': '/root/.r10k/git')
 
-  # Lazily construct an instance cache for R10K::Git::Cache objects
+  @instance_cache = R10K::InstanceCache.new(self)
+
   # @api private
   def self.instance_cache
-    @instance_cache ||= R10K::InstanceCache.new(self)
+    @instance_cache
   end
 
   # Generate a new instance with the given remote or return an existing object
@@ -29,58 +35,69 @@ class R10K::Git::Cache < R10K::Git::Repository
     instance_cache.generate(remote)
   end
 
+  # @abstract
+  # @return [Object] The concrete bare repository implementation to use for
+  #   interacting with the cached Git repository.
+  def self.bare_repository
+    raise NotImplementedError
+  end
+
   include R10K::Logging
 
+  extend Forwardable
+
+  def_delegators :@repo, :git_dir, :branches, :tags, :exist?, :resolve, :ref_type
+
   # @!attribute [r] path
   #   @deprecated
   #   @return [String] The path to the git cache repository
   def path
     logger.warn "#{self.class}#path is deprecated; use #git_dir"
-    @git_dir
+    git_dir
   end
 
-  # @param [String] remote
-  # @param [String] cache_root
+  # @!attribute [r] repo
+  #   @api private
+  attr_reader :repo
+
+  # @param remote [String] The URL of the Git remote URL to cache.
   def initialize(remote)
     @remote = remote
-
-    @git_dir = File.join(settings[:cache_root], sanitized_dirname)
+    @repo = self.class.bare_repository.new(settings[:cache_root], sanitized_dirname)
   end
 
   def sync
-    if not @synced
+    if !@synced
       sync!
       @synced = true
     end
   end
 
+  def synced?
+    @synced
+  end
+
   def sync!
     if cached?
-      fetch
+      @repo.fetch
     else
-      logger.debug "Creating new git cache for #{@remote.inspect}"
+      logger.debug1 "Creating new git cache for #{@remote.inspect}"
 
       # TODO extract this to an initialization step
-      unless File.exist? settings[:cache_root]
+      if !File.exist?(settings[:cache_root])
         FileUtils.mkdir_p settings[:cache_root]
       end
 
-      git ['clone', '--mirror', @remote, git_dir]
+      @repo.clone(@remote)
     end
-  rescue R10K::Util::Subprocess::SubprocessError => e
-    raise R10K::Git::GitError.wrap(e, "Couldn't update git cache for #{@remote}")
   end
 
-  # @return [Array<String>] A list the branches for the git repository
-  def branches
-    output = git %w[for-each-ref refs/heads --format %(refname)], :git_dir => git_dir
-    output.stdout.scan(%r[refs/heads/(.*)$]).flatten
+  # @api private
+  def reset!
+    @synced = false
   end
 
-  # @return [true, false] If the repository has been locally cached
-  def cached?
-    File.exist? git_dir
-  end
+  alias cached? exist?
 
   private
 

data/lib/r10k/git/errors.rb

@@ -3,16 +3,11 @@ require 'r10k/errors'
 module R10K
   module Git
 
-    class GitError < R10K::Error; end
-
-    class UnresolvableRefError < GitError
-
-      attr_reader :ref
+    class GitError < R10K::Error
       attr_reader :git_dir
 
       def initialize(mesg, options = {})
         super
-        @ref     = @options[:ref]
         @git_dir = @options[:git_dir]
       end
 
@@ -24,5 +19,16 @@ module R10K
         msg
       end
     end
+
+
+    class UnresolvableRefError < GitError
+
+      attr_reader :ref
+
+      def initialize(mesg, options = {})
+        super
+        @ref = @options[:ref]
+      end
+    end
   end
 end

data/lib/r10k/git/head.rb

@@ -6,6 +6,9 @@ require 'r10k/git/repository'
 # head: A named reference to the commit at the tip of a branch. Heads are
 # stored in a file in $GIT_DIR/refs/heads/ directory. except when using packed
 #
+# @deprecated This has been replaced by the ShellGit provider and the
+#   StatefulRepository class and will be removed in 2.0.0
+#
 # @see https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html
 # @api private
 class R10K::Git::Head < R10K::Git::Ref

data/lib/r10k/git/ref.rb

@@ -5,6 +5,9 @@ require 'r10k/git/repository'
 # particular object. They may be stored in a file under $GIT_DIR/refs/
 # directory, or in the $GIT_DIR/packed-refs file.
 #
+# @deprecated This has been replaced by the ShellGit provider and the
+#   StatefulRepository class and will be removed in 2.0.0
+#
 # @see https://www.kernel.org/pub/software/scm/git/docs/gitglossary.html
 # @api private
 class R10K::Git::Ref

data/lib/r10k/git/remote_head.rb

@@ -1,5 +1,10 @@
 require 'r10k/git'
 
+# :nocov:
+#
+# @deprecated This has been replaced by the ShellGit provider and the
+#   StatefulRepository class and will be removed in 2.0.0
+#
 # @api private
 class R10K::Git::RemoteHead < R10K::Git::Head
 
@@ -11,3 +16,4 @@ class R10K::Git::RemoteHead < R10K::Git::Head
     end
   end
 end
+# :nocov:

data/lib/r10k/git/repository.rb

@@ -2,6 +2,11 @@ require 'r10k/git'
 require 'r10k/util/subprocess'
 
 # Define an abstract base class for git repositories.
+#
+# @deprecated This has been replaced by the ShellGit provider and the
+#   StatefulRepository class and will be removed in 2.0.0
+#
+# :nocov:
 class R10K::Git::Repository
 
   # @!attribute [r] remote
@@ -150,3 +155,4 @@ class R10K::Git::Repository
     result
   end
 end
+# :nocov: