r10k 3.5.2

data/lib/r10k/environment/git.rb

@@ -0,0 +1,81 @@
+require 'r10k/logging'
+require 'r10k/puppetfile'
+require 'r10k/git/stateful_repository'
+require 'forwardable'
+
+# This class implements an environment based on a Git branch.
+#
+# @since 1.3.0
+class R10K::Environment::Git < R10K::Environment::WithModules
+
+  include R10K::Logging
+
+  R10K::Environment.register(:git, self)
+  # Register git as the default environment type
+  R10K::Environment.register(nil, self)
+
+  # @!attribute [r] remote
+  #   @return [String] The URL to the remote git repository
+  attr_reader :remote
+
+  # @!attribute [r] ref
+  #   @return [String] The git reference to use for this environment
+  attr_reader :ref
+
+  # @!attribute [r] repo
+  #   @api private
+  #   @return [R10K::Git::StatefulRepository] The git repo backing this environment
+  attr_reader :repo
+
+  # Initialize the given Git environment.
+  #
+  # @param name [String] The unique name describing this environment.
+  # @param basedir [String] The base directory where this environment will be created.
+  # @param dirname [String] The directory name for this environment.
+  # @param options [Hash] An additional set of options for this environment.
+  #
+  # @param options [String] :remote The URL to the remote git repository
+  # @param options [String] :ref The git reference to use for this environment
+  def initialize(name, basedir, dirname, options = {})
+    super
+    @remote = options[:remote]
+    @ref    = options[:ref]
+
+    @repo = R10K::Git::StatefulRepository.new(@remote, @basedir, @dirname)
+  end
+
+  # Clone or update the given Git environment.
+  #
+  # If the environment is being created for the first time, it will
+  # automatically update all modules to ensure that the environment is complete.
+  #
+  # @api public
+  # @return [void]
+  def sync
+    @repo.sync(@ref)
+  end
+
+  def status
+    @repo.status(@ref)
+  end
+
+  # Return a sting which uniquely identifies (per source) the current state of the
+  # environment.
+  #
+  # @api public
+  # @return [String]
+  def signature
+    @repo.head
+  end
+
+  include R10K::Util::Purgeable
+
+  # Returns an array of the full paths to all the content being managed.
+  # @note This implements a required method for the Purgeable mixin
+  # @return [Array<String>]
+  def desired_contents
+    desired = [File.join(@full_path, '.git')]
+    desired += @repo.tracked_paths.map { |entry| File.join(@full_path, entry) }
+    desired += super
+  end
+end

data/lib/r10k/environment/name.rb

@@ -0,0 +1,86 @@
+module R10K
+  module Environment
+    # Handle environment name validation and modification.
+    #
+    # @api private
+    class Name
+
+      # @!attribute [r] name
+      #   @return [String] The unmodified name of the environment
+      attr_reader :name
+
+      INVALID_CHARACTERS = %r[\W]
+
+      def initialize(name, opts)
+        @name   = name
+        @opts   = opts
+
+        @source  = opts[:source]
+        @prefix  = opts[:prefix]
+        @invalid = opts[:invalid]
+
+        case @invalid
+        when 'correct_and_warn'
+          @validate = true
+          @correct  = true
+        when 'correct'
+          @validate = false
+          @correct  = true
+        when 'error'
+          @validate = true
+          @correct  = false
+        when NilClass
+          @validate = opts[:validate]
+          @correct = opts[:correct]
+        end
+      end
+
+      # Should the environment name have invalid characters removed?
+      def correct?
+        @correct
+      end
+
+      def validate?
+        @validate
+      end
+
+      def valid?
+        if @validate
+          ! @name.match(INVALID_CHARACTERS)
+        else
+          true
+        end
+      end
+
+      # The directory name for the environment, modified as necessary to remove
+      # invalid characters.
+      #
+      # @return [String]
+      def dirname
+        dir = @name.dup
+
+        prefix = derive_prefix(@source,@prefix)
+
+        if @correct
+          dir.gsub!(INVALID_CHARACTERS, '_')
+        end
+
+        "#{prefix}#{dir}"
+      end
+
+
+      private
+
+      def derive_prefix(source,prefix)
+
+        if prefix == true
+          "#{source}_"
+        elsif prefix.is_a? String
+          "#{prefix}_"
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/r10k/environment/svn.rb

@@ -0,0 +1,91 @@
+require 'r10k/puppetfile'
+require 'r10k/svn/working_dir'
+require 'r10k/util/setopts'
+
+# This class implements an environment based on an SVN branch.
+#
+# @since 1.3.0
+class R10K::Environment::SVN < R10K::Environment::Base
+
+  include R10K::Logging
+
+  R10K::Environment.register(:svn, self)
+
+  # @!attribute [r] remote
+  #   @return [String] The URL to the remote SVN branch to check out
+  attr_reader :remote
+
+  # @!attribute [r] working_dir
+  #   @api private
+  #   @return [R10K::SVN::WorkingDir] The SVN working directory backing this environment
+  attr_reader :working_dir
+
+  # @!attribute [r] username
+  #   @return [String, nil] The SVN username to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :username
+
+  # @!attribute [r] password
+  #   @return [String, nil] The SVN password to be passed to the underlying SVN commands
+  #   @api private
+  attr_reader :password
+
+  include R10K::Util::Setopts
+
+  # Initialize the given SVN environment.
+  #
+  # @param name [String] The unique name describing this environment.
+  # @param basedir [String] The base directory where this environment will be created.
+  # @param dirname [String] The directory name for this environment.
+  # @param options [Hash] An additional set of options for this environment.
+  #
+  # @option options [String] :remote The URL to the remote SVN branch to check out
+  # @option options [String] :username The SVN username
+  # @option options [String] :password The SVN password
+  def initialize(name, basedir, dirname, options = {})
+    super
+
+    setopts(options, {:remote => :self, :username => :self, :password => :self, :puppetfile_name => :self })
+
+    @working_dir = R10K::SVN::WorkingDir.new(Pathname.new(@full_path), :username => @username, :password => @password)
+  end
+
+  # Perform an initial checkout of the SVN repository or update the repository.
+  #
+  # If the environment is being created for the first time, it will
+  # automatically update all modules to ensure that the environment is complete.
+  #
+  # @api public
+  # @return [void]
+  def sync
+    if @working_dir.is_svn?
+      @working_dir.update
+    else
+      @working_dir.checkout(@remote)
+    end
+    @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
+    elsif !@working_dir.is_svn?
+      :mismatched
+    elsif !(@remote == @working_dir.url)
+      :mismatched
+    elsif !@synced
+      :outdated
+    else
+      :insync
+    end
+  end
+end

data/lib/r10k/environment/with_modules.rb

@@ -0,0 +1,139 @@
+require 'r10k/logging'
+require 'r10k/util/purgeable'
+
+# This abstract base class implements an environment that can include module
+# content
+#
+# @since 3.4.0
+class R10K::Environment::WithModules < R10K::Environment::Base
+
+  include R10K::Logging
+
+  # @!attribute [r] moduledir
+  #   @return [String] The directory to install environment-defined modules
+  #     into (default: #{basedir}/modules)
+  attr_reader :moduledir
+
+  # Initialize the given environment.
+  #
+  # @param name [String] The unique name describing this environment.
+  # @param basedir [String] The base directory where this environment will be created.
+  # @param dirname [String] The directory name for this environment.
+  # @param options [Hash] An additional set of options for this environment.
+  #
+  # @param options [String] :moduledir The path to install modules to
+  # @param options [Hash] :modules Modules to add to the environment
+  def initialize(name, basedir, dirname, options = {})
+    super(name, basedir, dirname, options)
+
+    @managed_content = {}
+    @modules = []
+    @moduledir = case options[:moduledir]
+                 when nil
+                   File.join(@basedir, @dirname, 'modules')
+                 when File.absolute_path(options[:moduledir])
+                   options.delete(:moduledir)
+                 else
+                   File.join(@basedir, @dirname, options.delete(:moduledir))
+                 end
+
+    modhash = options.delete(:modules)
+    load_modules(modhash) unless modhash.nil?
+  end
+
+  # @return [Array<R10K::Module::Base>] All modules associated with this environment.
+  #   Modules may originate from either:
+  #     - The r10k environment object
+  #     - A Puppetfile in the environment's content
+  def modules
+    return @modules if @puppetfile.nil?
+
+    @puppetfile.load unless @puppetfile.loaded?
+    @modules + @puppetfile.modules
+  end
+
+  def accept(visitor)
+    visitor.visit(:environment, self) do
+      @modules.each do |mod|
+        mod.accept(visitor)
+      end
+
+      puppetfile.accept(visitor)
+      validate_no_module_conflicts
+    end
+  end
+
+  def load_modules(module_hash)
+    module_hash.each do |name, args|
+      add_module(name, args)
+    end
+  end
+
+  # @param [String] name
+  # @param [*Object] args
+  def add_module(name, args)
+    if args.is_a?(Hash)
+      # symbolize keys in the args hash
+      args = args.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo }
+    end
+
+    if args.is_a?(Hash) && install_path = args.delete(:install_path)
+      install_path = resolve_install_path(install_path)
+      validate_install_path(install_path, name)
+    else
+      install_path = @moduledir
+    end
+
+    # Keep track of all the content this environment is managing to enable purging.
+    @managed_content[install_path] = Array.new unless @managed_content.has_key?(install_path)
+
+    mod = R10K::Module.new(name, install_path, args, self.name)
+    mod.origin = 'Environment'
+
+    @managed_content[install_path] << mod.name
+    @modules << mod
+  end
+
+  def validate_no_module_conflicts
+    @puppetfile.load unless @puppetfile.loaded?
+    conflicts = (@modules + @puppetfile.modules)
+                .group_by { |mod| mod.name }
+                .select { |_, v| v.size > 1 }
+                .map(&:first)
+    unless conflicts.empty?
+      msg = _('Puppetfile cannot contain module names defined by environment %{name}') % {name: self.name}
+      msg += ' '
+      msg += _("Remove the conflicting definitions of the following modules: %{conflicts}" % { conflicts: conflicts.join(' ') })
+      raise R10K::Error.new(msg)
+    end
+  end
+
+  include R10K::Util::Purgeable
+
+  # Returns an array of the full paths that can be purged.
+  # @note This implements a required method for the Purgeable mixin
+  # @return [Array<String>]
+  def managed_directories
+    [@full_path]
+  end
+
+  # Returns an array of the full paths of filenames that should exist. Files
+  # inside managed_directories that are not listed in desired_contents will
+  # be purged.
+  # @note This implements a required method for the Purgeable mixin
+  # @return [Array<String>]
+  def desired_contents
+    list = @managed_content.keys
+    list += @managed_content.flat_map do |install_path, modnames|
+      modnames.collect { |name| File.join(install_path, name) }
+    end
+  end
+
+  def purge_exclusions
+    super + @managed_content.flat_map do |install_path, modnames|
+      modnames.map do |name|
+        File.join(install_path, name, '**', '*')
+      end
+    end
+  end
+end

data/lib/r10k/errors.rb

@@ -0,0 +1,61 @@
+require 'r10k'
+
+module R10K
+
+  # An error class that accepts an optional hash and wrapped error message
+  #
+  class Error < StandardError
+    attr_accessor :original
+
+    # Generate a wrapped exception
+    #
+    # @param original [Exception] The exception to wrap
+    # @param mesg [String]
+    # @param options [Hash]
+    #
+    # @return [R10K::Error]
+    def self.wrap(original, mesg, options = {})
+      new(mesg, options).tap do |e|
+        e.set_backtrace(caller(4))
+        e.original = original
+      end
+    end
+
+    # @overload initialize(mesg)
+    #   @param mesg [String] The exception mesg
+    #
+    # @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
+
+    protected
+
+    def structure_exception(name, exc)
+      struct = []
+      struct << "#{name}:"
+      if exc.respond_to?(:format)
+        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