r10k 3.5.2

data/lib/r10k/source/yaml.rb

@@ -0,0 +1,20 @@
+class R10K::Source::Yaml < R10K::Source::Hash
+  R10K::Source.register(:yaml, self)
+
+  def initialize(name, basedir, options = {})
+    config = options[:config] || '/etc/puppetlabs/r10k/environments.yaml'
+
+    begin
+      contents = ::YAML.load_file(config)
+    rescue => e
+      raise ConfigError, _("Couldn't open environments file %{file}: %{err}") % {file: config, err: e.message}
+    end
+
+    # Set the environments key for the parent class to consume
+    options[:environments] = contents
+
+    # All we need to do is supply options with the :environments hash.
+    # The R10K::Source::Hash parent class takes care of the rest.
+    super(name, basedir, options)
+  end
+end

data/lib/r10k/source/yamldir.rb

@@ -0,0 +1,32 @@
+class R10K::Source::Yamldir < R10K::Source::Hash
+  R10K::Source.register(:yamldir, self)
+
+  def initialize(name, basedir, options = {})
+    config = options[:config] || '/etc/puppetlabs/r10k/environments.d'
+
+    unless File.directory?(config)
+      raise R10K::Deployment::Config::ConfigError, _("Error opening %{dir}: config must be a directory") % {dir: config}
+    end
+
+    unless File.readable?(config)
+      raise R10K::Deployment::Config::ConfigError, _("Error opening %{dir}: permission denied") % {dir: config}
+    end
+
+    environment_data = Dir.glob(File.join(config, '*.yaml')).reduce({}) do |memo,path|
+      name = File.basename(path, '.yaml')
+      begin
+        contents = ::YAML.load_file(path)
+      rescue => e
+        raise R10K::Deployment::Config::ConfigError, _("Error loading %{path}: %{err}") % {path: path, err: e.message}
+      end
+      memo.merge({name => contents })
+    end
+
+    # Set the environments key for the parent class to consume
+    options[:environments] = environment_data
+
+    # All we need to do is supply options with the :environments hash.
+    # The R10K::Source::Hash parent class takes care of the rest.
+    super(name, basedir, options)
+  end
+end

data/lib/r10k/svn.rb

@@ -0,0 +1,6 @@
+module R10K
+  module SVN
+    require 'r10k/svn/working_dir'
+    require 'r10k/svn/remote'
+  end
+end

data/lib/r10k/svn/remote.rb

@@ -0,0 +1,68 @@
+require 'r10k/util/subprocess'
+require 'r10k/util/setopts'
+
+# Inspect and interact with SVN remote repositories
+#
+# @api private
+# @since 1.3.0
+class R10K::SVN::Remote
+
+  include R10K::Util::Setopts
+
+  def initialize(baseurl, opts = {})
+    @baseurl = baseurl
+    setopts(opts, {:username => :self, :password => :self})
+  end
+
+  # @todo validate that the path to trunk exists in the remote
+  def trunk
+    "#{@baseurl}/trunk"
+  end
+
+  # @todo gracefully handle cases where no branches exist
+  def branches
+    argv = ['ls', "#{@baseurl}/branches"]
+    argv.concat(auth)
+    text = svn(argv)
+    text.lines.map do |line|
+      line.chomp!
+      line.gsub!(%r[/$], '')
+      line
+    end
+  end
+
+  private
+
+  # Format authentication information for SVN command args, if applicable
+  def auth
+    auth = []
+    if @username
+      auth << "--username" << @username
+      auth << "--password" << @password
+    end
+    auth
+  end
+
+  include R10K::Logging
+
+  # Wrap SVN commands
+  #
+  # @param argv [Array<String>]
+  # @param opts [Hash]
+  #
+  # @option opts [Pathname] :cwd The directory to run the command in
+  #
+  # @return [String] The stdout from the given command
+  def svn(argv, opts = {})
+    argv.unshift('svn', '--non-interactive')
+
+    subproc = R10K::Util::Subprocess.new(argv)
+    subproc.raise_on_fail = true
+    subproc.logger = self.logger
+
+    subproc.cwd = opts[:cwd]
+    result = subproc.execute
+
+    result.stdout
+  end
+end

data/lib/r10k/svn/working_dir.rb

@@ -0,0 +1,125 @@
+require 'r10k/util/subprocess'
+require 'r10k/util/setopts'
+
+module R10K
+  module SVN
+
+    # Manage an SVN working copy.
+    #
+    # If SVN authentication is required, both username and password must be specified.
+    #
+    # @api private
+    # @since 1.2.0
+    class WorkingDir
+
+      include R10K::Util::Setopts
+
+      # @attribute [r] path
+      #   @return [Pathname] The full path to the SVN working directory
+      #   @api private
+      attr_reader :path
+
+      # @!attribute [r] username
+      #   @return [String, nil] The SVN username, if provided
+      #   @api private
+      attr_reader :username
+
+      # @!attribute [r] password
+      #   @return [String, nil] The SVN password, if provided
+      #   @api private
+      attr_reader :password
+
+      # @param path [Pathname]
+      # @param opts [Hash]
+      #
+      # @option opts [String] :username
+      # @option opts [String] :password
+      def initialize(path, opts = {})
+        @path = path
+
+        setopts(opts, {:username => :self, :password => :self})
+
+        if !!(@username) ^ !!(@password)
+          raise ArgumentError, _("Both username and password must be specified")
+        end
+      end
+
+      # Is the directory at this path actually an SVN repository?
+      def is_svn?
+        dot_svn = @path + '.svn'
+        dot_svn.exist?
+      end
+
+      def revision
+        info.slice(/^Revision: (\d+)$/, 1)
+      end
+
+      def url
+        info.slice(/^URL: (.*)$/, 1)
+      end
+
+      def root
+        info.slice(/^Repository Root: (.*)$/, 1)
+      end
+
+      def update(revision = nil)
+        argv = %w[update]
+        argv << '-r' << revision if revision
+        argv.concat(auth)
+
+        svn(argv, :cwd => @path)
+      end
+
+      def checkout(url, revision = nil)
+        argv = ['checkout', url]
+        argv << '-r' << revision if revision
+        argv << @path.basename.to_s
+        argv.concat(auth)
+        argv << '-q'
+
+        svn(argv, :cwd => @path.parent)
+      end
+
+      private
+
+      def info
+        argv = %w[info]
+        argv.concat(auth)
+        svn(argv, :cwd => @path)
+      end
+
+      # Format authentication information for SVN command args, if applicable
+      def auth
+        auth = []
+        if @username
+          auth << "--username" << @username
+          auth << "--password" << @password
+        end
+        auth
+      end
+
+      include R10K::Logging
+
+      # Wrap SVN commands
+      #
+      # @param argv [Array<String>]
+      # @param opts [Hash]
+      #
+      # @option opts [Pathname] :cwd The directory to run the command in
+      #
+      # @return [String] The stdout from the given command
+      def svn(argv, opts = {})
+        argv.unshift('svn', '--non-interactive')
+
+        subproc = R10K::Util::Subprocess.new(argv)
+        subproc.raise_on_fail = true
+        subproc.logger = self.logger
+
+        subproc.cwd = opts[:cwd]
+        result = subproc.execute
+
+        result.stdout
+      end
+    end
+  end
+end

data/lib/r10k/util/attempt.rb

@@ -0,0 +1,84 @@
+require 'r10k/logging'
+require 'r10k/errors/formatting'
+require 'r10k/util/setopts'
+require 'colored2'
+
+module R10K
+  module Util
+
+    # Attempt a series of dependent nested tasks and cleanly handle errors.
+    #
+    # @api private
+    class Attempt
+
+      include R10K::Logging
+      include R10K::Util::Setopts
+
+      # @!attribute [r] status
+      #   @return [Symbol] The status of this task
+      attr_reader :status
+
+      def initialize(initial, opts = {})
+        @initial = initial
+        @tries = []
+        @status = :notrun
+        setopts(opts, {:trace => :self})
+      end
+
+      # Run this attempt to completion.
+      #
+      # @todo determine the structure of the ret
+      # @return [Object] The aggregate result of all work performed.
+      def run
+        @status = :running
+        result = apply(@initial, @tries)
+        @status = :ok if @status == :running
+        result
+      end
+
+      # Add another action to take for this attempt
+      #
+      # @yieldparam [Object] The result of the previous action.
+      # @yieldreturn [Object, Array<Object>, NilClass] The result of this action.
+      #   If the value is an object, it will be passed to the next attempt. If
+      #   the value is an Array then each element will be individually passed
+      #   to the next try. If the value is false or nil then no further action
+      #   will be taken.
+      def try(&block)
+        @tries << block
+        self
+      end
+
+      def ok?
+        @status == :ok
+      end
+
+      private
+
+      def apply(input, tries)
+        return input if tries.empty?
+
+        case input
+        when Array
+          apply_all(input, tries)
+        when NilClass, FalseClass
+          input
+        else
+          apply_one(input, tries)
+        end
+      end
+
+      def apply_all(values, tries)
+        values.map { |v| apply_one(v, tries) }
+      end
+
+      def apply_one(value, tries)
+        apply(tries.first.call(value), tries.drop(1))
+      rescue => e
+        @status = :failed
+        logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+        e
+      end
+    end
+  end
+end

data/lib/r10k/util/basedir.rb

@@ -0,0 +1,65 @@
+require 'r10k/deployment'
+require 'r10k/logging'
+require 'r10k/util/purgeable'
+
+module R10K
+  module Util
+
+    # Represents a directory that can purge unmanaged contents
+    #
+    # @todo pick a better name than basedir. Expect this class to be renamed.
+    #
+    # @api private
+    class Basedir
+
+      include R10K::Util::Purgeable
+      include R10K::Logging
+
+      # Create a new Basedir by selecting sources from a deployment that match
+      # the specified path.
+      #
+      # @param path [String]
+      # @param deployment [R10K::Deployment]
+      #
+      # @return [R10K::Util::Basedir]
+      def self.from_deployment(path, deployment)
+        sources = deployment.sources.select { |source| source.managed_directory == path }
+        new(path, sources)
+      end
+
+      # @param path [String] The path to the directory to manage
+      # @param sources [Array<#desired_contents>] A list of objects that may create filesystem entries
+      def initialize(path, sources)
+        if sources.is_a? R10K::Deployment
+          raise ArgumentError, _("Expected Array<#desired_contents>, got R10K::Deployment")
+        end
+        @path    = path
+        @sources = sources
+      end
+
+      # Return the path of the basedir
+      # @note This implements a required method for the Purgeable mixin
+      # @return [Array]
+      def managed_directories
+        [@path]
+      end
+
+      # List all environments that should exist in this basedir
+      # @note This implements a required method for the Purgeable mixin
+      # @return [Array<String>]
+      def desired_contents
+        @sources.flat_map do |src|
+          src.desired_contents.collect { |env| File.join(@path, env) }
+        end
+      end
+
+      def purge!
+        @sources.each do |source|
+          logger.debug1 _("Source %{source_name} in %{path} manages contents %{contents}") % {source_name: source.name, path: @path, contents: source.desired_contents.inspect}
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/r10k/util/commands.rb

@@ -0,0 +1,31 @@
+module R10K
+  module Util
+    module Commands
+      module_function
+
+      # Find the full path of a shell command.
+      #
+      # On POSIX platforms, the PATHEXT environment variable will be unset, so
+      # the first command named 'cmd' will be returned.
+      #
+      # On Windows platforms, the PATHEXT environment variable will contain a
+      # semicolon delimited list of executable file extensions, so the first
+      # command with a matching path extension will be returned.
+      #
+      # @param cmd [String] The name of the command to search for
+      # @return [String, nil] The path to the file if found, nil otherwise
+      def which(cmd)
+        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
+          exts.each do |ext|
+            path = File.join(dir, "#{cmd}#{ext}")
+            if File.executable?(path) && File.file?(path)
+              return path
+            end
+          end
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/r10k/util/exec_env.rb

@@ -0,0 +1,36 @@
+module R10K
+  module Util
+
+    # Utility methods for dealing with environment variables
+    module ExecEnv
+      module_function
+
+      # Swap out all environment settings
+      #
+      # @param env [Hash] The new environment to use
+      # @return [void]
+      def reset(env)
+        env.each_pair do |key, value|
+          ENV[key] = value
+        end
+
+        (ENV.keys - env.keys).each do |key|
+          ENV.delete(key)
+        end
+      end
+
+      # Add the specified settings to the env for the supplied block
+      #
+      # @param env [Hash] The values to add to the environment
+      # @param block [Proc] The code to call with the modified environnment
+      # @return [void]
+      def withenv(env, &block)
+        original = ENV.to_hash
+        reset(original.merge(env))
+        block.call
+      ensure
+        reset(original)
+      end
+    end
+  end
+end