r10k 1.2.4 → 1.3.0rc1

data/lib/r10k/environment/git.rb

@@ -0,0 +1,79 @@
+require 'r10k/logging'
+require 'r10k/puppetfile'
+require 'r10k/git/working_dir'
+
+# This class implements an environment based on a Git branch.
+#
+# @since 1.3.0
+class R10K::Environment::Git < R10K::Environment::Base
+
+  include R10K::Logging
+
+  # @!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] working_dir
+  #   @api private
+  #   @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.
+  # @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]
+
+    @working_dir = R10K::Git::WorkingDir.new(@ref, @remote, @basedir, @dirname)
+    @puppetfile  = R10K::Puppetfile.new(@full_path)
+  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
+    recursive_needed = !(@working_dir.cloned?)
+    @working_dir.sync
+
+    if recursive_needed
+      logger.debug "Environment #{@full_path} is a fresh clone; automatically updating modules."
+      sync_modules
+    end
+  end
+
+  # @api private
+  def sync_modules
+    modules.each do |mod|
+      logger.debug "Deploying module #{mod.name}"
+      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

@@ -0,0 +1,73 @@
+require 'r10k/puppetfile'
+require 'r10k/svn/working_dir'
+
+# This class implements an environment based on an SVN branch.
+#
+# @since 1.3.0
+class R10K::Environment::SVN < R10K::Environment::Base
+
+  include R10K::Logging
+
+  # @!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] 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.
+  # @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 SVN branch to check out
+  def initialize(name, basedir, dirname, options = {})
+    super
+
+    @remote = options[:remote]
+
+    @working_dir = R10K::SVN::WorkingDir.new(Pathname.new(@full_path))
+    @puppetfile  = R10K::Puppetfile.new(@full_path)
+  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)
+      logger.debug "Environment #{@full_path} is a fresh clone; automatically updating modules."
+      sync_modules
+    end
+  end
+
+  # @return [Array<R10K::Module::Base>] All modules defined in the Puppetfile
+  #   associated with this environment.
+  def modules
+    @puppetfile.load
+    @puppetfile.modules
+  end
+
+  # @api private
+  def sync_modules
+    modules.each do |mod|
+      logger.debug "Deploying module #{mod.name}"
+      mod.sync
+    end
+  end
+end

data/lib/r10k/environment.rb

@@ -0,0 +1,7 @@
+module R10K
+  module Environment
+    require 'r10k/environment/base'
+    require 'r10k/environment/git'
+    require 'r10k/environment/svn'
+  end
+end

data/lib/r10k/execution.rb

@@ -1,4 +1,3 @@
-require 'r10k/logging'
 require 'r10k/errors'
 
 require 'systemu'

data/lib/r10k/git/cache.rb

@@ -1,5 +1,3 @@
-require 'r10k/logging'
-
 require 'r10k/git'
 require 'r10k/git/repository'
 
@@ -15,12 +13,20 @@ class R10K::Git::Cache < R10K::Git::Repository
 
   def_setting_attr :cache_root, File.expand_path(ENV['HOME'] ? '~/.r10k/git': '/root/.r10k/git')
 
-  def self.registry
-    @registry ||= R10K::Registry.new(self)
+  # Lazily construct an instance cache for R10K::Git::Cache objects
+  # @api private
+  def self.instance_cache
+    @instance_cache ||= R10K::InstanceCache.new(self)
   end
 
+  # Generate a new instance with the given remote or return an existing object
+  # with the given remote. This should be used over R10K::Git::Cache.new.
+  #
+  # @api public
+  # @param remote [String] The git remote to cache
+  # @return [R10K::Git::Cache] The requested cache object.
   def self.generate(remote)
-    registry.generate(remote)
+    instance_cache.generate(remote)
   end
 
   include R10K::Logging

data/lib/r10k/git/repository.rb

@@ -84,7 +84,7 @@ class R10K::Git::Repository
 
     ret = {}
     output.stdout.each_line do |line|
-      next if line.match(/\(push\)/)
+      next if line.match /\(push\)/
       name, url, _ = line.split(/\s+/)
       ret[name] = url
     end
@@ -92,13 +92,6 @@ class R10K::Git::Repository
     ret
   end
 
-  def tags
-    entries = []
-    output = git(['tag', '-l'], :git_dir => @git_dir).stdout
-    output.each_line { |line| entries << line.chomp }
-    entries
-  end
-
   private
 
   # Fetch objects and refs from the given git remote

data/lib/r10k/git/working_dir.rb

@@ -1,5 +1,4 @@
 require 'forwardable'
-require 'r10k/logging'
 require 'r10k/git'
 require 'r10k/git/cache'
 
@@ -41,8 +40,7 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
     @full_path = File.join(@basedir, @dirname)
     @git_dir   = File.join(@full_path, '.git')
 
-    @alternates = R10K::Git::Alternates.new(@git_dir)
-    @cache      = R10K::Git::Cache.generate(@remote)
+    @cache = R10K::Git::Cache.generate(@remote)
 
     if ref.is_a? String
       @ref = R10K::Git::Ref.new(ref, self)
@@ -62,9 +60,7 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
   end
 
   def update
-    update_remotes if update_remotes?
-
-    if ref_needs_fetch?
+    if fetch?
       fetch_from_cache
       checkout(@ref)
     elsif needs_checkout?
@@ -117,17 +113,22 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
 
   private
 
-  # Do we need to fetch additional objects and refs in order to resolve the given ref?
-  # @return [true, false]
-  def ref_needs_fetch?
+  def fetch?
     @ref.fetch?
   end
 
   def fetch_from_cache
+    set_cache_remote
     @cache.sync
     fetch('cache')
   end
 
+  def set_cache_remote
+    if self.remote != @cache.remote
+      git ["remote", "set-url", "cache", @cache.git_dir], :path => @full_path
+    end
+  end
+
   # Perform a non-bare clone of a git repository.
   def clone
     @cache.sync
@@ -149,30 +150,6 @@ class R10K::Git::WorkingDir < R10K::Git::Repository
     expected = ref.sha1
     actual   = rev_parse('HEAD')
 
-    !(expected == actual)
-  end
-
-  def update_remotes?
-    real_remotes = remotes
-
-    expected_origin = @remote
-    expected_cache  = @cache.git_dir
-
-    !(expected_origin == real_remotes['origin'] and expected_cache == real_remotes['cache'])
-  end
-
-  def update_remotes
-    # todo: remove all existing refs as they may belong to the old remote
-    git ['remote', 'set-url', 'origin', remote], :path => @full_path
-    git ['remote', 'set-url', 'cache', @cache.git_dir], :path => @full_path
-    @alternates << File.join(@cache.git_dir, 'objects')
-    logger.debug("Removing stale git tags from #{@full_path}")
-    remove_tags
-  end
-
-  def remove_tags
-    tags.each do |tag|
-      git ['tag', '-d', tag], :path => @full_path
-    end
+    ! (expected == actual)
   end
 end

data/lib/r10k/git.rb

@@ -10,7 +10,6 @@ module R10K
 
     require 'r10k/git/repository'
     require 'r10k/git/cache'
-    require 'r10k/git/alternates'
     require 'r10k/git/working_dir'
   end
 end

data/lib/r10k/instance_cache.rb

@@ -0,0 +1,32 @@
+module R10K
+
+  # This class implements a generic object memoization container. It caches
+  # new objects and returns cached objects based on the instantiation arguments.
+  class InstanceCache
+
+    # Initialize a new registry with a given class
+    #
+    # @param klass [Class] The class to memoize
+    # @param method [Symbol] The method name to use when creating objects.
+    #                        Defaults to :new.
+    def initialize(klass, method = :new)
+      @klass  = klass
+      @method = method
+      @instances = {}
+    end
+
+    # Create a new object, or return a memoized object.
+    #
+    # @param args [*Object] The arguments to pass to the initialize method
+    #
+    # @return [Object] A memoized instance of the registered class
+    def generate(*args)
+      @instances[args] ||= @klass.send(@method, *args)
+    end
+
+    # Clear all memoized objects
+    def clear!
+      @instances = {}
+    end
+  end
+end

data/lib/r10k/keyed_factory.rb

@@ -0,0 +1,39 @@
+module R10K
+
+  # This implements a factory by storing classes indexed with a given key and
+  # creates objects based on that key.
+  class KeyedFactory
+
+    # @!attribute [r] implementations
+    #   @return [Hash<Object, Class>] A hash of keys and the associated
+    #     implementations that this factory can generate.
+    attr_reader :implementations
+
+    def initialize
+      @implementations = {}
+    end
+
+    def register(key, klass)
+      if @implementations.has_key?(key)
+        raise DuplicateImplementationError, "Class already registered for #{key}"
+      else
+        @implementations[key] = klass
+      end
+    end
+
+    def retrieve(key)
+      @implementations[key]
+    end
+
+    def generate(key, *args)
+      if (impl = @implementations[key])
+        impl.new(*args)
+      else
+        raise UnknownImplementationError, "No class registered for #{key}"
+      end
+    end
+
+    class DuplicateImplementationError < StandardError; end
+    class UnknownImplementationError < StandardError; end
+  end
+end

data/lib/r10k/module/forge.rb

@@ -1,6 +1,5 @@
 require 'r10k/module'
 require 'r10k/errors'
-require 'r10k/logging'
 require 'r10k/module/metadata'
 require 'r10k/util/subprocess'
 require 'r10k/module_repository/forge'
@@ -126,7 +125,7 @@ class R10K::Module::Forge < R10K::Module::Base
     cmd = []
     cmd << 'install'
     cmd << "--version=#{expected_version}" if expected_version
-    cmd << "--force"
+    cmd << "--ignore-dependencies"
     cmd << @full_name
     pmt cmd
   end
@@ -135,7 +134,7 @@ class R10K::Module::Forge < R10K::Module::Base
     cmd = []
     cmd << 'upgrade'
     cmd << "--version=#{expected_version}" if expected_version
-    cmd << "--force"
+    cmd << "--ignore-dependencies"
     cmd << @full_name
     pmt cmd
   end

data/lib/r10k/module/svn.rb

@@ -1,6 +1,5 @@
 require 'r10k/module'
 require 'r10k/execution'
-require 'r10k/logging'
 require 'r10k/svn/working_dir'
 
 class R10K::Module::SVN < R10K::Module::Base

data/lib/r10k/puppetfile.rb

@@ -1,5 +1,4 @@
 require 'r10k/module'
-require 'r10k/logging'
 require 'r10k/util/purgeable'
 
 module R10K

data/lib/r10k/registry.rb

@@ -1,32 +1,4 @@
-module R10K
+require 'r10k/instance_cache'
 
-  # R10K::Registry implements a generic object memoization container. It caches
-  # new objects and returns cached objects based on the instantiation arguments.
-  class Registry
-
-    # Initialize a new registry with a given class
-    #
-    # @param klass [Class] The class to memoize
-    # @param method [Symbol] The method name to use when creating objects.
-    #                        Defaults to :new.
-    def initialize(klass, method = :new)
-      @klass  = klass
-      @method = method
-      @instances = {}
-    end
-
-    # Create a new object, or return a memoized object.
-    #
-    # @param args [*Object] The arguments to pass to the initialize method
-    #
-    # @return [Object] A memoized instance of the registered class
-    def generate(*args)
-      @instances[args] ||= @klass.send(@method, *args)
-    end
-
-    # Clear all memoized objects
-    def clear!
-      @instances = {}
-    end
-  end
-end
+# @deprecated
+R10K::Registry = R10K::InstanceCache

data/lib/r10k/source/base.rb

@@ -0,0 +1,60 @@
+# 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 [true, false] Whether the source name should be prefixed to each
+  #     environment basedir. Defaults to false
+  attr_reader :prefix
+
+  # 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] :prefix Whether to prefix the source name to the
+  #   environment directory names. All sources should respect this option.
+  #   Defaults to false.
+  def initialize(name, basedir, options = {})
+    @name    = name
+    @basedir = basedir
+    @prefix  = options.delete(:prefix)
+    @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, "#{self.class} has not implemented method #{__method__}"
+  end
+end