r10k 1.3.5 → 1.4.0

data/lib/r10k/deployment/basedir.rb

@@ -1,39 +1,4 @@
-require 'r10k/git/cache'
-require 'r10k/deployment/environment'
-require 'r10k/util/purgeable'
+require 'r10k/util/basedir'
 
-module R10K
-  class Deployment
-
-    # Represents a directory containing environments
-    # @api private
-    class Basedir
-
-      def initialize(path,deployment)
-        @path       = path
-        @deployment = deployment
-      end
-
-      include R10K::Util::Purgeable
-
-      # 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
-        @deployment.sources.inject([])do |list, source|
-          if source.managed_directory == @path
-            list += source.desired_contents
-          end
-          list
-        end
-      end
-    end
-  end
-end
+# @deprecated
+R10K::Deployment::Basedir = R10K::Util::Basedir

data/lib/r10k/deployment/config.rb

@@ -1,5 +1,6 @@
 require 'r10k/deployment'
 require 'r10k/deployment/config/loader'
+require 'yaml'
 
 module R10K
 class Deployment
@@ -42,7 +43,7 @@ class Config
       end
     end
     begin
-      @config = YAML.load_file(@configfile)
+      @config = ::YAML.load_file(@configfile)
       apply_config_settings
     rescue => e
       raise ConfigError, "Couldn't load config file: #{e.message}"

data/lib/r10k/deployment/source.rb

@@ -3,6 +3,7 @@ require 'r10k/util/core_ext/hash_ext'
 
 module R10K
 class Deployment
+# :nocov:
 class Source
   # Create a new source from a hash representation
   #
@@ -34,4 +35,5 @@ class Source
   end
 end
 end
+# :nocov:
 end

data/lib/r10k/environment/base.rb

@@ -15,6 +15,15 @@ class R10K::Environment::Base
   #   @return [String] The directory name for the given environment
   attr_reader :dirname
 
+  # @!attribute [r] path
+  #   @return [Pathname] The full path to the given environment
+  attr_reader :path
+
+  # @!attribute [r] puppetfile
+  #   @api public
+  #   @return [R10K::Puppetfile] The puppetfile instance associated with this environment
+  attr_reader :puppetfile
+
   # Initialize the given environment.
   #
   # @param name [String] The unique name describing this environment.
@@ -29,6 +38,8 @@ class R10K::Environment::Base
     @options = options
 
     @full_path = File.join(@basedir, @dirname)
+    @path = Pathname.new(File.join(@basedir, @dirname))
+    @puppetfile  = R10K::Puppetfile.new(@full_path)
   end
 
   # Synchronize the given environment.
@@ -39,4 +50,33 @@ class R10K::Environment::Base
   def sync
     raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
   end
+
+  # Determine the current status of the environment.
+  #
+  # This can return the following values:
+  #
+  #   * :absent - there is no module installed
+  #   * :mismatched - there is a module installed but it must be removed and reinstalled
+  #   * :outdated - the correct module is installed but it needs to be updated
+  #   * :insync - the correct module is installed and up to date, or the module is actually a boy band.
+  #
+  # @api public
+  # @abstract
+  # @return [Symbol]
+  def status
+    raise NotImplementedError, "#{self.class} has not implemented method #{__method__}"
+  end
+
+  # @return [Array<R10K::Module::Base>] All modules defined in the Puppetfile
+  #   associated with this environment.
+  def modules
+    @puppetfile.load
+    @puppetfile.modules
+  end
+
+  def accept(visitor)
+    visitor.visit(:environment, self) do
+      puppetfile.accept(visitor)
+    end
+  end
 end

data/lib/r10k/environment/git.rb

@@ -22,11 +22,6 @@ class R10K::Environment::Git < R10K::Environment::Base
   #   @return [R10K::Git::WorkingDir] The git working directory backing this environment
   attr_reader :working_dir
 
-  # @!attribute [r] puppetfile
-  #   @api public
-  #   @return [R10K::Puppetfile] The puppetfile instance associated with this environment
-  attr_reader :puppetfile
-
   # Initialize the given SVN environment.
   #
   # @param name [String] The unique name describing this environment.
@@ -42,7 +37,6 @@ class R10K::Environment::Git < R10K::Environment::Base
     @ref    = options[:ref]
 
     @working_dir = R10K::Git::WorkingDir.new(@ref, @remote, @basedir, @dirname)
-    @puppetfile  = R10K::Puppetfile.new(@full_path)
   end
 
   # Clone or update the given Git environment.
@@ -53,15 +47,25 @@ class R10K::Environment::Git < R10K::Environment::Base
   # @api public
   # @return [void]
   def sync
-    recursive_needed = !(@working_dir.cloned?)
     @working_dir.sync
+    @synced = true
+  end
 
-    if recursive_needed
-      logger.debug "Environment #{@full_path} is a fresh clone; automatically updating modules."
-      sync_modules
+  def status
+    if !@working_dir.exist?
+      :absent
+    elsif !@working_dir.git?
+      :mismatched
+    elsif !(@remote == @working_dir.remote)
+      :mismatched
+    elsif !@synced
+      :outdated
+    else
+      :insync
     end
   end
 
+  # @deprecated
   # @api private
   def sync_modules
     modules.each do |mod|
@@ -69,11 +73,4 @@ class R10K::Environment::Git < R10K::Environment::Base
       mod.sync
     end
   end
-
-  # @return [Array<R10K::Module::Base>] All modules defined in the Puppetfile
-  #   associated with this environment.
-  def modules
-    @puppetfile.load
-    @puppetfile.modules
-  end
 end

data/lib/r10k/environment/svn.rb

@@ -1,5 +1,6 @@
 require 'r10k/puppetfile'
 require 'r10k/svn/working_dir'
+require 'r10k/util/setopts'
 
 # This class implements an environment based on an SVN branch.
 #
@@ -17,10 +18,17 @@ class R10K::Environment::SVN < R10K::Environment::Base
   #   @return [R10K::SVN::WorkingDir] The SVN working directory backing this environment
   attr_reader :working_dir
 
-  # @!attribute [r] puppetfile
-  #   @api public
-  #   @return [R10K::Puppetfile] The puppetfile instance associated with this environment
-  attr_reader :puppetfile
+  # @!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.
   #
@@ -29,14 +37,15 @@ class R10K::Environment::SVN < R10K::Environment::Base
   # @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 SVN branch to check out
+  # @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
 
-    @remote = options[:remote]
+    setopts(options, {:remote => :self, :username => :self, :password => :self})
 
-    @working_dir = R10K::SVN::WorkingDir.new(Pathname.new(@full_path))
-    @puppetfile  = R10K::Puppetfile.new(@full_path)
+    @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.
@@ -51,18 +60,25 @@ class R10K::Environment::SVN < R10K::Environment::Base
       @working_dir.update
     else
       @working_dir.checkout(@remote)
-      logger.debug "Environment #{@full_path} is a fresh clone; automatically updating modules."
-      sync_modules
     end
+    @synced = true
   end
 
-  # @return [Array<R10K::Module::Base>] All modules defined in the Puppetfile
-  #   associated with this environment.
-  def modules
-    @puppetfile.load
-    @puppetfile.modules
+  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
 
+  # @deprecated
   # @api private
   def sync_modules
     modules.each do |mod|

data/lib/r10k/errors.rb

@@ -1,32 +1,43 @@
+require 'r10k'
+
 module R10K
+
+  # @deprecated
   class ExecutionFailure < StandardError
     attr_accessor :exit_code, :stdout, :stderr
   end
 
-  # An error class that accepts an optional hash.
-  #
-  # @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
-  #
-  # @overload initialize(options)
-  #   @param options [Hash] A set of options to store on the exception
+  # An error class that accepts an optional hash and wrapped error message
   #
-  class R10KError < StandardError
-    def initialize(mesg = nil, options = {})
-      if mesg.is_a? String
-        super(mesg)
-        @mesg    = mesg
-        @options = options
-      elsif mesg.is_a? Hash
-        @mesg    = nil
-        @options = mesg
-      elsif mesg.nil? and options
-        @options = options
+  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
+    def initialize(mesg, options = {})
+      super(mesg)
+      @options = options
+    end
   end
+
+  # @deprecated
+  R10KError = Error
 end

data/lib/r10k/errors/formatting.rb

@@ -0,0 +1,28 @@
+require 'r10k/errors'
+
+module R10K
+  module Errors
+    module Formatting
+      module_function
+
+      # Format this exception for displaying to the user
+      #
+      # @param exc [Exception] The exception to format
+      # @param with_backtrace [true, false] Whether the backtrace should be
+      #   included with this exception
+      # @return [String]
+      def format_exception(exc, with_backtrace = false)
+        lines = []
+        lines << exc.message
+        if with_backtrace
+          lines.concat(exc.backtrace)
+        end
+        if exc.respond_to?(:original) && exc.original
+          lines << "Original exception:"
+          lines<< format_exception(exc.original, with_backtrace)
+        end
+        lines.join("\n")
+      end
+    end
+  end
+end

data/lib/r10k/execution.rb

@@ -3,6 +3,7 @@ require 'r10k/errors'
 require 'systemu'
 
 module R10K
+# :nocov:
 module Execution
   include R10K::Logging
 
@@ -42,4 +43,5 @@ module Execution
     stdout
   end
 end
+# :nocov:
 end

data/lib/r10k/git/cache.rb

@@ -68,12 +68,7 @@ class R10K::Git::Cache < R10K::Git::Repository
       git ['clone', '--mirror', @remote, git_dir]
     end
   rescue R10K::Util::Subprocess::SubprocessError => e
-    msg = e.result.stderr.slice(/^fatal: .*$/)
-    if msg
-      raise R10K::Git::GitError, "Couldn't update git cache for #{@remote}: #{msg.inspect}"
-    else
-      raise e
-    end
+    raise R10K::Git::GitError.wrap(e, "Couldn't update git cache for #{@remote}")
   end
 
   # @return [Array<String>] A list the branches for the git repository

data/lib/r10k/git/errors.rb

@@ -3,8 +3,7 @@ require 'r10k/errors'
 module R10K
   module Git
 
-    class GitError < R10KError
-    end
+    class GitError < R10K::Error; end
 
     class UnresolvableRefError < GitError
 

data/lib/r10k/git/ref.rb

@@ -48,7 +48,7 @@ class R10K::Git::Ref
   end
 
   def ==(other)
-    other.sha1 == self.sha1
+    other.is_a?(R10K::Git::Ref) && other.sha1 == self.sha1
   rescue ArgumentError, R10K::Git::UnresolvableRefError
     false
   end

data/lib/r10k/module.rb

@@ -31,6 +31,6 @@ module R10K::Module
 
   require 'r10k/module/base'
   require 'r10k/module/git'
-  require 'r10k/module/forge'
   require 'r10k/module/svn'
+  require 'r10k/module/forge'
 end

data/lib/r10k/module/base.rb

@@ -1,10 +1,102 @@
 require 'r10k/module'
 
+# This class defines a common interface for module implementations.
 class R10K::Module::Base
-  attr_accessor :name, :basedir
 
+  # @!attribute [r] title
+  #   @return [String] The forward slash separated owner and name of the module
+  attr_reader :title
+
+  # @!attribute [r] name
+  #   @return [String] The name of the module
+  attr_reader :name
+
+  # @param [r] dirname
+  #   @return [String] The name of the directory containing this module
+  attr_reader :dirname
+
+  # @deprecated
+  alias :basedir :dirname
+
+  # @!attribute [r] owner
+  #   @return [String, nil] The owner of the module if one is specified
+  attr_reader :owner
+
+  # @!attribute [r] path
+  #   @return [Pathname] The full path of the module
+  attr_reader :path
+
+  # There's been some churn over `author` vs `owner` and `full_name` over
+  # `title`, so in the short run it's easier to support both and deprecate one
+  # later.
+  alias :author :owner
+  alias :full_name :title
+
+  # @param title [String]
+  # @param dirname [String]
+  # @param args [Array]
+  def initialize(title, dirname, args)
+    @title   = title
+    @dirname = dirname
+    @args    = args
+    @owner, @name = parse_title(title)
+    @path = Pathname.new(File.join(@dirname, @name))
+  end
+
+  # @deprecated
   # @return [String] The full filesystem path to the module.
   def full_path
-    File.join(@basedir, @name)
+    path.to_s
+  end
+
+  # Synchronize this module with the indicated state.
+  # @abstract
+  def sync
+    raise NotImplementedError
+  end
+
+  # Return the desired version of this module
+  # @abstract
+  def version
+    raise NotImplementedError
+  end
+
+  # Return the status of the currently installed module.
+  #
+  # This can return the following values:
+  #
+  #   * :absent - there is no module installed
+  #   * :mismatched - there is a module installed but it must be removed and reinstalled
+  #   * :outdated - the correct module is installed but it needs to be updated
+  #   * :insync - the correct module is installed and up to date, or the module is actually a boy band.
+  #
+  # @return [Symbol]
+  # @abstract
+  def status
+    raise NotImplementedError
+  end
+
+  def accept(visitor)
+    visitor.visit(:module, self)
+  end
+
+  # Return the properties of the module
+  #
+  # @return [Hash]
+  # @abstract
+  def properties
+    raise NotImplementedError
+  end
+
+  private
+
+  def parse_title(title)
+    if (match = title.match(/\A(\w+)\Z/))
+      [nil, match[1]]
+    elsif (match = title.match(/\A(\w+)[-\/](\w+)\Z/))
+      [match[1], match[2]]
+    else
+      raise ArgumentError, "Module names must match either 'modulename' or 'owner/modulename'"
+    end
   end
 end