r10k 1.3.5 → 1.4.0

data/lib/r10k/svn/working_dir.rb

@@ -1,16 +1,52 @@
 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
 
-      # @param full_path [Pathname]
-      def initialize(full_path)
-        @full_path = full_path
+      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 = @full_path + '.svn'
+        dot_svn = @path + '.svn'
         dot_svn.exist?
       end
 
@@ -29,22 +65,37 @@ module R10K
       def update(revision = nil)
         argv = %w[update]
         argv << '-r' << revision if revision
+        argv.concat(auth)
 
-        svn argv, :cwd => @full_path
+        svn(argv, :cwd => @path)
       end
 
       def checkout(url, revision = nil)
         argv = ['checkout', url]
         argv << '-r' << revision if revision
-        argv << @full_path.basename.to_s
+        argv << @path.basename.to_s
+        argv.concat(auth)
+        argv << '-q'
 
-        svn argv, :cwd => @full_path.parent
+        svn(argv, :cwd => @path.parent)
       end
 
       private
 
       def info
-        svn ["info"], :cwd => @full_path
+        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
@@ -58,7 +109,7 @@ module R10K
       #
       # @return [String] The stdout from the given command
       def svn(argv, opts = {})
-        argv.unshift('svn')
+        argv.unshift('svn', '--non-interactive')
 
         subproc = R10K::Util::Subprocess.new(argv)
         subproc.raise_on_fail = true

data/lib/r10k/task.rb

@@ -1,5 +1,6 @@
 module R10K
 module Task
+  # @deprecated
   class Base
     include R10K::Logging
 

data/lib/r10k/task/deployment.rb

@@ -4,9 +4,13 @@ require 'r10k/task_runner'
 require 'r10k/task/environment'
 require 'r10k/task/puppetfile'
 
+require 'r10k/util/basedir'
+
 module R10K
 module Task
 module Deployment
+
+  # @deprecated
   module SharedBehaviors
 
     private
@@ -54,6 +58,7 @@ module Deployment
     end
   end
 
+  # @deprecated
   class DeployEnvironments < R10K::Task::Base
 
     include SharedBehaviors
@@ -83,6 +88,7 @@ module Deployment
     end
   end
 
+  # @deprecated
   class DeployModules < R10K::Task::Base
 
     include SharedBehaviors
@@ -110,6 +116,7 @@ module Deployment
     end
   end
 
+  # @deprecated
   class PurgeEnvironments < R10K::Task::Base
 
     def initialize(deployment)
@@ -119,13 +126,14 @@ module Deployment
 
     def call
       @basedirs.each do |path|
-        basedir = R10K::Deployment::Basedir.new(path,@deployment)
+        basedir = R10K::Util::Basedir.from_deployment(path, @deployment)
         logger.info "Purging stale environments from #{path}"
         basedir.purge!
       end
     end
   end
 
+  # @deprecated
   class Display < R10K::Task::Base
 
     attr_accessor :puppetfile

data/lib/r10k/task/environment.rb

@@ -4,6 +4,8 @@ require 'r10k/task/puppetfile'
 module R10K
 module Task
 module Environment
+
+  # @deprecated
   class Deploy < R10K::Task::Base
 
     attr_writer :update_puppetfile

data/lib/r10k/task/module.rb

@@ -3,6 +3,7 @@ require 'r10k/task'
 module R10K
 module Task
 module Module
+  # @deprecated
   class Sync < R10K::Task::Base
     def initialize(mod)
       @mod = mod

data/lib/r10k/task/puppetfile.rb

@@ -6,6 +6,7 @@ require 'r10k/task_runner'
 module R10K
 module Task
 module Puppetfile
+  # @deprecated
   class Sync < R10K::Task::Base
     def initialize(puppetfile)
       @puppetfile = puppetfile
@@ -25,6 +26,7 @@ module Puppetfile
     end
   end
 
+  # @deprecated
   class DeployModules < R10K::Task::Base
 
     attr_accessor :module_names
@@ -73,6 +75,7 @@ module Puppetfile
     end
   end
 
+  # @deprecated
   class Purge < R10K::Task::Base
     def initialize(puppetfile)
       @puppetfile = puppetfile

data/lib/r10k/task_runner.rb

@@ -1,6 +1,7 @@
 require 'r10k/task'
 
 module R10K
+# @deprecated
 class TaskRunner
 
   include R10K::Logging

data/lib/r10k/util/attempt.rb

@@ -0,0 +1,84 @@
+require 'r10k/logging'
+require 'r10k/errors/formatting'
+require 'r10k/util/setopts'
+require 'colored'
+
+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<R10K::Util::Purgeable>] A list of purgeable objects
+      def initialize(path, sources)
+        if sources.is_a? R10K::Deployment
+          raise ArgumentError, "Expected Array<Purgeable>, 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 [String]
+      def managed_directory
+        @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.map(&:desired_contents).flatten
+      end
+
+      def purge!
+        @sources.each do |source|
+          logger.debug1 "Source #{source.name} in #{@path} claimed contents #{source.desired_contents.inspect}"
+        end
+        if !stale_contents.empty?
+          logger.debug "No sources in #{@path} claimed contents #{stale_contents.inspect}"
+        end
+        super
+      end
+    end
+  end
+end

data/lib/r10k/util/purgeable.rb

@@ -1,50 +1,60 @@
 require 'fileutils'
-module R10K
-module Util
-module Purgeable
-  # Mixin for purging stale directory contents.
-  #
-  # @abstract Classes using this mixin need to implement {#managed_directory} and
-  #   {#desired_contents}
-
-  # @!method desired_contents
-  #   @abstract Including classes must implement this method to list the
-  #     expected filenames of managed_directory
-  #   @return [Array<String>] A list of directory contents that should be present
-
-  # @!method managed_directory
-  #   @abstract Including classes must implement this method to return the
-  #     path to the directory that can be purged
-  #   @return [String] The path to the directory to be purged
-
-  # @return [Array<String>] The present directory entries in `self.managed_directory`
-  def current_contents
-    dir = self.managed_directory
-    glob_exp = File.join(dir, '*')
-
-    Dir.glob(glob_exp).map do |fname|
-      File.basename fname
-    end
-  end
 
-  # @return [Array<String>] Directory contents that are expected but not present
-  def pending_contents
-    desired_contents - current_contents
-  end
-
-  # @return [Array<String>] Directory contents that are present but not expected
-  def stale_contents
-    current_contents - desired_contents
-  end
-
-  # Forcibly remove all unmanaged content in `self.managed_directory`
-  def purge!
-    stale_contents.each do |fname|
-      fpath = File.join(self.managed_directory, fname)
-      FileUtils.rm_rf fpath, :secure => true
+module R10K
+  module Util
+
+    # Mixin for purging stale directory contents.
+    #
+    # @abstract Classes using this mixin need to implement {#managed_directory} and
+    #   {#desired_contents}
+    module Purgeable
+
+      # @!method logger
+      #   @abstract Including classes must provide a logger method
+      #   @return [Log4r::Logger]
+
+      # @!method desired_contents
+      #   @abstract Including classes must implement this method to list the
+      #     expected filenames of managed_directory
+      #   @return [Array<String>] A list of directory contents that should be present
+
+      # @!method managed_directory
+      #   @abstract Including classes must implement this method to return the
+      #     path to the directory that can be purged
+      #   @return [String] The path to the directory to be purged
+
+      # @return [Array<String>] The present directory entries in `self.managed_directory`
+      def current_contents
+        dir = self.managed_directory
+        glob_exp = File.join(dir, '*')
+
+        Dir.glob(glob_exp).map do |fname|
+          File.basename(fname)
+        end
+      end
+
+      # @return [Array<String>] Directory contents that are expected but not present
+      def pending_contents
+        desired_contents - current_contents
+      end
+
+      # @return [Array<String>] Directory contents that are present but not expected
+      def stale_contents
+        current_contents - desired_contents
+      end
+
+      # Forcibly remove all unmanaged content in `self.managed_directory`
+      def purge!
+        if stale_contents.empty?
+          logger.debug1 "No stale contents in #{managed_directory}, nothing to purge"
+        else
+          stale_contents.each do |fname|
+            fpath = File.join(self.managed_directory, fname)
+            logger.debug "Removing stale path #{fpath}"
+            FileUtils.rm_rf(fpath, :secure => true)
+          end
+        end
+      end
     end
   end
-
-end
-end
 end