r10k 3.5.2

data/lib/r10k/settings/enum_definition.rb

@@ -0,0 +1,30 @@
+require 'r10k/settings/definition'
+
+module R10K
+  module Settings
+    class EnumDefinition < R10K::Settings::Definition
+
+      def validate
+        if @value
+          if @multi && @value.respond_to?(:select)
+            invalid = @value.select { |val| !@enum.include?(val) }
+
+            if invalid.size > 0
+              raise ArgumentError, _("Setting %{name} may only contain %{enums}; the disallowed values %{invalid} were present") % {name: @name, enums: @enum.inspect, invalid: invalid.inspect}
+            end
+          else
+            if !@enum.include?(@value)
+              raise ArgumentError, _("Setting %{name} should be one of %{enums}, not '%{value}'") % {name: @name, enums: @enum.inspect, value: @value}
+            end
+          end
+        end
+      end
+
+      private
+
+      def allowed_initialize_opts
+        super.merge({:enum => true, :multi => true})
+      end
+    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(_("%{class} instances cannot be reassigned to a new parent.") % {class: self.class} )
+          end
+
+          unless new_parent.is_a?(R10K::Settings::Collection) || new_parent.is_a?(R10K::Settings::List)
+            raise R10K::Error.new(_("%{class} instances may only belong to a settings collection or list.") % {class: self.class} )
+          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") % {name: @name}, :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

data/lib/r10k/settings/loader.rb

@@ -0,0 +1,99 @@
+require 'r10k/logging'
+require 'r10k/errors'
+require 'yaml'
+
+module R10K
+  module Settings
+    # Look for the r10k configuration file in standard locations.
+    #
+    # r10k.yaml is checked for in the following locations:
+    #   - $PWD/r10k.yaml
+    #   - /etc/puppetlabs/r10k/r10k.yaml
+    #   - /etc/r10k.yaml
+    class Loader
+
+      def self.search(override = nil)
+        new.search(override)
+      end
+
+      include R10K::Logging
+
+      attr_reader :loadpath
+
+      CONFIG_FILE = 'r10k.yaml'
+      DEFAULT_LOCATION = File.join('/etc/puppetlabs/r10k', CONFIG_FILE)
+      OLD_DEFAULT_LOCATION = File.join('/etc', CONFIG_FILE)
+
+      def initialize
+        @loadpath = []
+        populate_loadpath
+      end
+
+      # Find the first valid config file.
+      #
+      # @param override [String, nil] An optional path that when is truthy
+      #   will be preferred over all other files, to make it easy to
+      #   optionally supply an explicit configuration file that will always
+      #   be used when set.
+      # @return [String, nil] The path to the first valid configfile, or nil
+      #   if no file was found.
+      def search(override = nil)
+        return override if override
+
+        # If both default files are present, issue a warning.
+        if (File.file? DEFAULT_LOCATION) && (File.file? OLD_DEFAULT_LOCATION)
+          logger.warn _("Both %{default_path} and %{old_default_path} configuration files exist.") % {default_path: DEFAULT_LOCATION, old_default_path: OLD_DEFAULT_LOCATION}
+          logger.warn _("%{default_path} will be used.") % {default_path: DEFAULT_LOCATION}
+        end
+
+        path = @loadpath.find {|filename| File.file? filename}
+
+        if path == OLD_DEFAULT_LOCATION
+          logger.warn _("The r10k configuration file at %{old_default_path} is deprecated.") % {old_default_path: OLD_DEFAULT_LOCATION}
+          logger.warn _("Please move your r10k configuration to %{default_path}.") % {default_path: DEFAULT_LOCATION}
+        end
+
+        path
+      end
+
+      def read(override = nil)
+        path = search(override)
+
+        if path.nil?
+          raise ConfigError, _("No configuration file given, no config file found in current directory, and no global config present")
+        end
+
+        begin
+          contents = ::YAML.load_file(path)
+        rescue => e
+          raise ConfigError, _("Couldn't load config file: %{error_msg}") % {error_msg: e.message}
+        end
+
+        if !contents
+          raise ConfigError, _("File exists at #{path} but doesn't contain any YAML") % {path: path}
+        end
+        R10K::Util::SymbolizeKeys.symbolize_keys!(contents, true)
+        contents
+      end
+
+      private
+
+      def populate_loadpath
+
+        # Add the current directory for r10k.yaml
+        @loadpath << File.join(Dir.getwd, CONFIG_FILE)
+
+        # Add the AIO location for of r10k.yaml
+        @loadpath << DEFAULT_LOCATION
+
+        # Add the old default location last.
+        @loadpath << OLD_DEFAULT_LOCATION
+
+        @loadpath
+      end
+
+      class ConfigError < R10K::Error
+      end
+    end
+  end
+end

data/lib/r10k/settings/mixin.rb

@@ -0,0 +1,54 @@
+module R10K::Settings::Mixin
+
+  def self.included(klass)
+    klass.send(:include, InstanceMethods)
+    klass.send(:extend, ClassMethods)
+  end
+
+  module InstanceMethods
+
+    # @return [R10K::Settings::Container] A settings container for the given instance.
+    def settings
+      @settings ||= R10K::Settings::Container.new(self.class.settings)
+    end
+  end
+
+  module ClassMethods
+
+    # Define a setting and optional default on the extending class.
+    #
+    # @param key [Symbol]
+    # @param default [Object]
+    #
+    # @return [void]
+    def def_setting_attr(key, default = nil)
+      defaults.add_valid_key(key)
+      defaults[key] = default if default
+    end
+
+    # A singleton settings container for storing immutable default configuration
+    # on the extending class.
+    #
+    # @return [R10K::Settings::Container]
+    def defaults
+      @defaults ||= R10K::Settings::Container.new
+    end
+
+    # A singleton settings container for storing manual setting configurations
+    # on the extending class.
+    #
+    # @return [R10K::Settings::Container]
+    def settings
+      @settings ||= R10K::Settings::Container.new(defaults)
+    end
+
+    # Allow subclasses to use the settings of the parent class as default values
+    #
+    # @return [void]
+    def inherited(subclass)
+      subclass.instance_eval do
+        @settings = R10K::Settings::Container.new(superclass.settings)
+      end
+    end
+  end
+end

data/lib/r10k/settings/uri_definition.rb

@@ -0,0 +1,19 @@
+require 'r10k/settings/definition'
+require 'uri'
+
+module R10K
+  module Settings
+    class URIDefinition < R10K::Settings::Definition
+      def validate
+        if @value
+          begin
+            URI.parse(@value)
+          rescue URI::Error
+            raise ArgumentError, _("Setting %{name} requires a URL but '%{value}' could not be parsed as a URL") % {name: @name, value: @value}
+          end
+        end
+        super
+      end
+    end
+  end
+end

data/lib/r10k/source.rb

@@ -0,0 +1,42 @@
+require 'r10k'
+require 'r10k/keyed_factory'
+require 'r10k/util/symbolize_keys'
+
+module R10K
+  module Source
+    def self.factory
+      @factory ||= R10K::KeyedFactory.new
+    end
+
+    def self.register(key, klass)
+      factory.register(key, klass)
+    end
+
+    def self.retrieve(key)
+      factory.retrieve(key)
+    end
+
+    def self.generate(type, basedir, name, options = {})
+      factory.generate(type, basedir, name, options)
+    end
+
+    def self.from_hash(name, hash)
+      R10K::Util::SymbolizeKeys.symbolize_keys!(hash)
+
+      basedir = hash.delete(:basedir)
+
+      type = hash.delete(:type)
+      type = type.is_a?(String) ? type.to_sym : type
+
+      generate(type, name, basedir, hash)
+    end
+
+    require 'r10k/source/base'
+    require 'r10k/source/hash'
+    require 'r10k/source/git'
+    require 'r10k/source/svn'
+    require 'r10k/source/yaml'
+    require 'r10k/source/yamldir'
+    require 'r10k/source/exec'
+  end
+end

data/lib/r10k/source/base.rb

@@ -0,0 +1,74 @@
+# This class defines a common interface for source implementations.
+#
+# @since 1.3.0
+class R10K::Source::Base
+
+  # @!attribute [r] basedir
+  #   @return [String] The path this source will place environments in
+  attr_reader :basedir
+
+  # @!attribute [r] name
+  #   @return [String] The short name for this environment source
+  attr_reader :name
+
+  # @!attribute [r] prefix
+  #   @return [String, nil] The prefix for the environments basedir.
+  #     Defaults to nil.
+  attr_reader :prefix
+
+  # @!attribute [r] puppetfile_name
+  #   @return [String, nil] The Name of the puppetfile
+  #     Defaults to nil.
+  attr_reader :puppetfile_name
+
+  # Initialize the given source.
+  #
+  # @param name [String] The identifier for this source.
+  # @param basedir [String] The base directory where the generated environments will be created.
+  # @param options [Hash] An additional set of options for this source. The
+  #   semantics of this hash may depend on the source implementation.
+  #
+  # @option options [Boolean, String] :prefix If a String this becomes the prefix.
+  #   If true, will use the source name as the prefix. All sources should respect this option.
+  #   Defaults to false for no environment prefix.
+  def initialize(name, basedir, options = {})
+    @name    = name
+    @basedir = Pathname.new(basedir).cleanpath.to_s
+    @prefix  = options.delete(:prefix)
+    @puppetfile_name = options.delete(:puppetfile_name)
+    @options = options
+  end
+
+  # Perform any actions needed for loading environments that may have side
+  # effects.
+  #
+  # Actions done during preloading may include things like updating caches or
+  # performing network queries. If an environment has not been preloaded but
+  # {#environments} is invoked, it should return the best known state of
+  # environments or return an empty list.
+  #
+  # @api public
+  # @abstract
+  # @return [void]
+  def preload!
+
+  end
+
+  # Enumerate the environments associated with this SVN source.
+  #
+  # @api public
+  # @abstract
+  # @return [Array<R10K::Environment::Base>] An array of environments created
+  #   from this source.
+  def environments
+    raise NotImplementedError, _("%{class} has not implemented method %{method}") % {class: self.class, method: __method__}
+  end
+
+  def accept(visitor)
+    visitor.visit(:source, self) do
+      environments.each do |env|
+        env.accept(visitor)
+      end
+    end
+  end
+end