r10k 2.2.2 → 2.3.0

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

@@ -36,7 +36,12 @@ class R10K::Git::Rugged::WorkingRepository < R10K::Git::Rugged::BaseRepository
     # alternate object database.
     options = {:credentials => credentials}
     options.merge!(:alternates => [File.join(opts[:reference], 'objects')]) if opts[:reference]
-    @_rugged_repo = ::Rugged::Repository.clone_at(remote, @path.to_s, options)
+
+    proxy = R10K::Git.get_proxy_for_remote(remote)
+
+    R10K::Git.with_proxy(proxy) do
+      @_rugged_repo = ::Rugged::Repository.clone_at(remote, @path.to_s, options)
+    end
 
     if opts[:reference]
       alternates << File.join(opts[:reference], 'objects')
@@ -70,11 +75,19 @@ class R10K::Git::Rugged::WorkingRepository < R10K::Git::Rugged::BaseRepository
     end
   end
 
-  def fetch(remote = 'origin')
-    logger.debug1 { "Fetching remote '#{remote}' at #{@path}" }
+  def fetch(remote_name = 'origin')
+    logger.debug1 { "Fetching remote '#{remote_name}' at #{@path}" }
     options = {:credentials => credentials}
-    refspecs = ["+refs/heads/*:refs/remotes/#{remote}/*"]
-    results = with_repo { |repo| repo.fetch(remote, refspecs, options) }
+    refspecs = ["+refs/heads/*:refs/remotes/#{remote_name}/*"]
+
+    remote = remotes[remote_name]
+    proxy = R10K::Git.get_proxy_for_remote(remote)
+    results = nil
+
+    R10K::Git.with_proxy(proxy) do
+      results = with_repo { |repo| repo.fetch(remote_name, refspecs, options) }
+    end
+
     report_transfer(results, remote)
   rescue Rugged::SshError, Rugged::NetworkError => e
     raise R10K::Git::GitError.new(e.message, :git_dir => git_dir, :backtrace => e.backtrace)

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

@@ -21,11 +21,20 @@ class R10K::Git::ShellGit::BareRepository < R10K::Git::ShellGit::BaseRepository
   end
 
   def clone(remote)
-    git ['clone', '--mirror', remote, git_dir.to_s]
+    proxy = R10K::Git.get_proxy_for_remote(remote)
+
+    R10K::Git.with_proxy(proxy) do
+      git ['clone', '--mirror', remote, git_dir.to_s]
+    end
   end
 
-  def fetch
-    git ['fetch', '--prune'], :git_dir => git_dir.to_s
+  def fetch(remote_name='origin')
+    remote = remotes[remote_name]
+    proxy = R10K::Git.get_proxy_for_remote(remote)
+
+    R10K::Git.with_proxy(proxy) do
+      git ['fetch', remote_name, '--prune'], :git_dir => git_dir.to_s
+    end
   end
 
   def exist?

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

@@ -1,4 +1,5 @@
 require 'r10k/git/shellgit'
+require 'r10k/util/subprocess'
 require 'r10k/logging'
 
 class R10K::Git::ShellGit::BaseRepository
@@ -47,6 +48,23 @@ class R10K::Git::ShellGit::BaseRepository
     end
   end
 
+  # @return [Hash] Collection of remotes for this repo, keys are the remote name and values are the remote URL.
+  def remotes
+    result = git ['config', '--local', '--get-regexp', '^remote\..*\.url$'], :git_dir => git_dir.to_s, :raise_on_fail => false
+
+    if result.success?
+      Hash[
+        result.stdout.split("\n").collect do |remote|
+          matches = /^remote\.(.*)\.url (.*)$/.match(remote)
+
+          [matches[1], matches[2]]
+        end
+      ]
+    else
+      {}
+    end
+  end
+
   include R10K::Logging
 
   private
@@ -95,8 +113,6 @@ class R10K::Git::ShellGit::BaseRepository
     subproc.raise_on_fail = raise_on_fail
     subproc.logger = self.logger
 
-    result = subproc.execute
-
-    result
+    subproc.execute
   end
 end

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

@@ -32,7 +32,12 @@ class R10K::Git::ShellGit::WorkingRepository < R10K::Git::ShellGit::BaseReposito
     if opts[:reference]
       argv += ['--reference', opts[:reference]]
     end
-    git argv
+
+    proxy = R10K::Git.get_proxy_for_remote(remote)
+
+    R10K::Git.with_proxy(proxy) do
+      git argv
+    end
 
     if opts[:ref]
       checkout(opts[:ref])
@@ -46,8 +51,13 @@ class R10K::Git::ShellGit::WorkingRepository < R10K::Git::ShellGit::BaseReposito
     git ['checkout', ref], :path => @path.to_s
   end
 
-  def fetch
-    git ['fetch'], :path => @path.to_s
+  def fetch(remote_name='origin')
+    remote = remotes[remote_name]
+    proxy = R10K::Git.get_proxy_for_remote(remote)
+
+    R10K::Git.with_proxy(proxy) do
+      git ['fetch', remote_name, '--prune'], :path => @path.to_s
+    end
   end
 
   def exist?

data/lib/r10k/initializers.rb

@@ -42,6 +42,7 @@ module R10K
         with_setting(:provider) { |value| R10K::Git.provider = value }
         with_setting(:username) { |value| R10K::Git.settings[:username] = value }
         with_setting(:private_key) { |value| R10K::Git.settings[:private_key] = value }
+        with_setting(:proxy) { |value| R10K::Git.settings[:proxy] = value }
         with_setting(:repositories) { |value| R10K::Git.settings[:repositories] = value }
       end
     end

data/lib/r10k/settings.rb

@@ -7,6 +7,7 @@ module R10K
 
     require 'r10k/settings/collection'
     require 'r10k/settings/definition'
+    require 'r10k/settings/list'
 
     def self.git_settings
       R10K::Settings::Collection.new(:git, [
@@ -29,20 +30,33 @@ module R10K
                     Only used by the 'rugged' Git provider.",
         }),
 
-        Definition.new(:repositories, {
-        :desc => "Repository specific configuration.",
-        :default => [],
-        :normalize => lambda do |repositories|
-        # The config file loading logic recursively converts hash keys that are strings to symbols,
-        # It doesn't understand hashes inside arrays though so we have to do this manually.
-          repositories.map do |repo|
-            repo.inject({}) do |retval, (key, value)|
-              retval[key.to_sym] = value
-              retval
-            end
-          end
-        end
-      }),
+        URIDefinition.new(:proxy, {
+          :desc => "An optional proxy server to use when interacting with Git sources via HTTP(S).",
+          :default => :inherit,
+        }),
+
+        List.new(:repositories, lambda {
+          R10K::Settings::Collection.new(nil, [
+            Definition.new(:remote, {
+              :desc => "Remote source that repository-specific settings should apply to.",
+            }),
+
+            Definition.new(:private_key, {
+              :desc => "The path to the SSH private key for Git SSH remotes.
+                        Only used by the 'rugged' Git provider.",
+              :default => :inherit,
+            }),
+
+            URIDefinition.new(:proxy, {
+              :desc => "An optional proxy server to use when interacting with Git sources via HTTP(S).",
+              :default => :inherit,
+            }),
+          ])
+        },
+        {
+          :desc => "Repository specific configuration.",
+          :default => [],
+        }),
       ])
     end
 
@@ -50,14 +64,7 @@ module R10K
       R10K::Settings::Collection.new(:forge, [
         URIDefinition.new(:proxy, {
           :desc => "An optional proxy server to use when downloading modules from the forge.",
-          :default => lambda do
-            [
-              ENV['HTTPS_PROXY'],
-              ENV['https_proxy'],
-              ENV['HTTP_PROXY'],
-              ENV['http_proxy']
-            ].find { |value| value }
-          end
+          :default => :inherit,
         }),
 
         URIDefinition.new(:baseurl, {
@@ -104,6 +111,18 @@ module R10K
           end
         }),
 
+        URIDefinition.new(:proxy, {
+          :desc => "Proxy to use for all r10k operations which occur over HTTP(S).",
+          :default => lambda {
+            [
+              ENV['HTTPS_PROXY'],
+              ENV['https_proxy'],
+              ENV['HTTP_PROXY'],
+              ENV['http_proxy']
+            ].find { |value| value }
+          },
+        }),
+
         R10K::Settings.forge_settings,
 
         R10K::Settings.git_settings,

data/lib/r10k/settings/collection.rb

@@ -1,3 +1,4 @@
+require 'r10k/settings/helpers'
 require 'r10k/settings/definition'
 require 'r10k/util/setopts'
 require 'r10k/util/symbolize_keys'
@@ -9,6 +10,7 @@ module R10K
     # Define a group of settings, which can be single definitions or nested
     # collections.
     class Collection
+      include R10K::Settings::Helpers
 
       # @!attribute [r] name
       #   @return [String] The name of this collection
@@ -18,7 +20,14 @@ module R10K
       # @param settings [Array] All settings in this collection
       def initialize(name, settings)
         @name = name
-        @settings = Hash[settings.map { |s| [s.name, s] }]
+
+        @settings = {}
+
+        # iterate through settings and adopt them
+        settings.each do |s|
+          s.parent = self
+          @settings[s.name] = s
+        end
       end
 
       # Assign new values, perform validation checks, and return the final
@@ -39,8 +48,8 @@ module R10K
       def assign(newvalues)
         return if newvalues.nil?
 
-        # TODO: this results in inconsistency for hashes inside arrays.
         R10K::Util::SymbolizeKeys.symbolize_keys!(newvalues)
+
         @settings.each_pair do |name, setting|
           if newvalues.key?(name)
             setting.assign(newvalues[name])
@@ -64,7 +73,13 @@ module R10K
         end
 
         if !errors.empty?
-          raise ValidationError.new("Validation failed for #{@name} settings group", :errors => errors)
+          if @name
+            msg = "Validation failed for '#{@name}' settings group"
+          else
+            msg = "Validation failed for settings group"
+          end
+
+          raise ValidationError.new(msg, :errors => errors)
         end
       end
 
@@ -72,12 +87,19 @@ module R10K
       # @return [Hash]
       def resolve
         rv = {}
+
         @settings.each_pair do |name, setting|
           rv[name] = setting.resolve
         end
+
         rv.freeze
       end
 
+      # Access individual settings via a Hash-like interface.
+      def [](name)
+        @settings[name]
+      end
+
       class ValidationError < R10K::Error
 
         attr_reader :errors
@@ -95,24 +117,6 @@ module R10K
           end
           struct.join("\n")
         end
-
-        private
-
-        def structure_exception(name, exc)
-          struct = []
-          struct << "#{name}:"
-          if exc.is_a? ValidationError
-            struct << indent(exc.format)
-          else
-            struct << indent(exc.message)
-          end
-          struct.join("\n")
-        end
-
-        def indent(str, level = 4)
-          prefix = ' ' * level
-          str.gsub(/^/, prefix)
-        end
       end
     end
   end

data/lib/r10k/settings/definition.rb

@@ -1,3 +1,4 @@
+require 'r10k/settings/helpers'
 require 'r10k/util/setopts'
 
 module R10K
@@ -6,10 +7,10 @@ module R10K
     # Define a single setting and additional attributes like descriptions,
     # default values, and validation.
     class Definition
-
       require 'r10k/settings/uri_definition'
       require 'r10k/settings/enum_definition'
 
+      include R10K::Settings::Helpers
       include R10K::Util::Setopts
 
       # @!attribute [r] name
@@ -90,7 +91,18 @@ module R10K
         if !@value.nil?
           @value
         elsif @default
-          @default.is_a?(Proc) ? @default.call : @default
+          if @default == :inherit
+            # walk all the way up to root, starting with grandparent
+            ancestor = parent
+
+            while ancestor = ancestor.parent
+              return ancestor[@name].resolve if ancestor.respond_to?(:[]) && ancestor[@name]
+            end
+          elsif @default.is_a?(Proc)
+            @default.call
+          else
+            @default
+          end
         end
       end
 

data/lib/r10k/settings/helpers.rb

@@ -0,0 +1,38 @@
+require 'r10k/errors'
+require 'r10k/settings/collection'
+
+module R10K
+  module Settings
+    module Helpers
+      def self.included(klass)
+        klass.send(:include, InstanceMethods)
+        klass.send(:extend, ClassMethods)
+      end
+
+      module InstanceMethods
+        # Assign a parent collection to this setting. Parent may only be
+        # assigned once.
+        #
+        # @param new_parent [R10K::Settings::Collection] Parent collection
+        def parent=(new_parent)
+          unless @parent.nil?
+            raise R10K::Error.new("#{self.class} instances cannot be reassigned to a new parent.")
+          end
+
+          unless new_parent.is_a?(R10K::Settings::Collection) || new_parent.is_a?(R10K::Settings::List)
+            raise R10K::Error.new("#{self.class} instances may only belong to a settings collection or list.")
+          end
+
+          @parent = new_parent
+        end
+
+        def parent
+          @parent
+        end
+      end
+
+      module ClassMethods
+      end
+    end
+  end
+end

data/lib/r10k/settings/list.rb

@@ -0,0 +1,107 @@
+require 'r10k/settings/helpers'
+require 'r10k/settings/collection'
+require 'r10k/errors'
+require 'r10k/util/setopts'
+
+module R10K
+  module Settings
+
+    # A container for an arbitrarily long list of other settings.
+    class List
+      include R10K::Settings::Helpers
+      include R10K::Util::Setopts
+
+      # @!attribute [r] name
+      #   @return [String] The name of this collection
+      attr_reader :name
+
+      # @param name [Symbol] The name of the setting for this definition.
+      # @param item_proc [#call] An object whose #call method will return a
+      #   new instance of another R10K::Settings class to hold each item
+      #   added to this list.
+      # @param opts [Hash] Additional options for this definition to control
+      #   validation, normalization, and the like.
+      #
+      # @options opts [String] :desc Extended description of this setting.
+      # @options opts [Array] :default Initial/default contents of the list.
+      def initialize(name, item_proc, opts = {})
+        @name = name
+        @item_proc = item_proc
+        @items = []
+
+        setopts(opts, allowed_initialize_opts)
+      end
+
+      # Takes an array of key/value pairs and assigns each into a
+      # new instance created by invoking @item_proc.
+      #
+      # @param items [Array] List of items to add to this list.
+      def assign(items)
+        return if items.nil?
+
+        items.each do |values|
+          new_item = @item_proc.call
+          new_item.parent = self
+          new_item.assign(values)
+          @items << new_item
+        end
+      end
+
+      # Validate all items in the list and return validation errors
+      #
+      # @return [nil, Hash] If all validation passed nil will be returned; if
+      #   validation failed then a hash of those errors will be returned.
+      def validate
+        errors = {}
+
+        @items.each_with_index do |item, idx|
+          begin
+            item.validate
+          rescue => error
+            errors[idx+1] = error
+          end
+        end
+
+        if !errors.empty?
+          raise ValidationError.new("Validation failed for '#{@name}' settings list", :errors => errors)
+        end
+      end
+
+      # Evaluate all items in the list and return a frozen array of the final values.
+      # @return [Array]
+      def resolve
+        @items.collect { |item| item.resolve }.freeze
+      end
+
+      class ValidationError < R10K::Error
+        attr_reader :errors
+
+        def initialize(mesg, options = {})
+          super
+          @errors = options[:errors]
+        end
+
+        def format
+          struct = []
+          struct << "#{message}:"
+          @errors.each do |item, error|
+            struct << indent(structure_exception("Item #{item}", error))
+          end
+          struct.join("\n")
+        end
+      end
+
+      private
+
+      # Subclasses may define additional params that are accepted at
+      # initialization; they should override this method to add any
+      # additional fields that should be respected.
+      def allowed_initialize_opts
+        {
+          :desc      => true,
+          :default   => true,
+        }
+      end
+    end
+  end
+end