r10k 3.5.2

data/lib/r10k/cli/ext/logging.rb

@@ -0,0 +1,15 @@
+require 'cri'
+
+module Cri
+  class CommandDSL
+    include R10K::Logging
+
+    def logger
+      unless @logger
+        @logger = Log4r::Logger.new(@command.name)
+        @logger.add R10K::Logging.outputter
+      end
+      @logger
+    end
+  end
+end

data/lib/r10k/cli/help.rb

@@ -0,0 +1,7 @@
+require 'r10k/cli'
+require 'cri'
+
+module R10K::CLI
+  help_cmd = Cri::Command.new_basic_help
+  self.command.add_command(help_cmd)
+end

data/lib/r10k/cli/puppetfile.rb

@@ -0,0 +1,74 @@
+require 'r10k/cli'
+require 'r10k/puppetfile'
+require 'r10k/action/puppetfile'
+
+require 'cri'
+
+module R10K::CLI
+  module Puppetfile
+    def self.command
+      @cmd ||= Cri::Command.define do
+        name    'puppetfile'
+        usage   'puppetfile <subcommand>'
+        summary 'Perform operations on a Puppetfile'
+
+        description <<-DESCRIPTION
+`r10k puppetfile` provides an implementation of the librarian-puppet style
+Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
+        DESCRIPTION
+
+        run do |opts, args, cmd|
+          puts cmd.help(:verbose => opts[:verbose])
+          exit 0
+        end
+      end
+    end
+
+    module Install
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name    'install'
+          usage   'install'
+          summary 'Install all modules from a Puppetfile'
+          required nil, :moduledir, 'Path to install modules to'
+          required nil, :puppetfile, 'Path to puppetfile'
+          flag     nil, :force, 'Force locally changed files to be overwritten'
+          runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Install)
+        end
+      end
+    end
+
+    module Check
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name  'check'
+          usage 'check'
+          summary 'Try and load the Puppetfile to verify the syntax is correct.'
+
+          required nil, :puppetfile, 'Path to Puppetfile'
+          runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Check)
+        end
+      end
+    end
+
+    module Purge
+      def self.command
+        @cmd ||= Cri::Command.define do
+          name  'purge'
+          usage 'purge'
+          summary 'Purge unmanaged modules from a Puppetfile managed directory'
+
+          required nil, :moduledir, 'Path to install modules to'
+          required nil, :puppetfile, 'Path to Puppetfile'
+          runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Purge)
+        end
+      end
+    end
+  end
+end
+
+R10K::CLI.command.add_command(R10K::CLI::Puppetfile.command)
+
+R10K::CLI::Puppetfile.command.add_command(R10K::CLI::Puppetfile::Install.command)
+R10K::CLI::Puppetfile.command.add_command(R10K::CLI::Puppetfile::Check.command)
+R10K::CLI::Puppetfile.command.add_command(R10K::CLI::Puppetfile::Purge.command)

data/lib/r10k/cli/version.rb

@@ -0,0 +1,31 @@
+require 'r10k/cli'
+require 'r10k/version'
+
+require 'cri'
+
+module R10K::CLI
+  module Version
+    def self.command
+      @cmd ||= Cri::Command.define do
+        name    'version'
+        usage   'version'
+        summary 'Print the version of r10k'
+
+        run do |opts, args, cmd|
+          puts "r10k #{R10K::VERSION}"
+          if opts[:verbose]
+            puts RUBY_DESCRIPTION
+            cmdpath = caller.last.slice(/\A.*#{$PROGRAM_NAME}/)
+            puts "Command path: #{cmdpath}"
+            puts "Interpreter path: #{Gem.ruby}"
+            if RUBY_VERSION >= '1.9'
+              puts "Default encoding: #{Encoding.default_external.name}"
+            end
+          end
+          exit 0
+        end
+      end
+    end
+  end
+  self.command.add_command(Version.command)
+end

data/lib/r10k/deployment.rb

@@ -0,0 +1,132 @@
+require 'r10k/source'
+require 'r10k/util/basedir'
+require 'r10k/errors'
+require 'set'
+
+module R10K
+  # A deployment models the entire state of the configuration that a Puppet
+  # master can use. It contains a set of sources that can produce environments
+  # and manages the contents of directories where environments are deployed.
+  #
+  # @api private
+  class Deployment
+
+    require 'r10k/deployment/config'
+
+    # Generate a deployment object based on a config
+    #
+    # @deprecated
+    #
+    # @param path [String] The path to the deployment config
+    # @return [R10K::Deployment] The deployment loaded with the given config
+    def self.load_config(path, overrides={})
+      config = R10K::Deployment::Config.new(path, overrides)
+      new(config)
+    end
+
+    # @!attribute [r] config
+    #   @return [R10K::Deployment::Config]
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def preload!
+      sources.each(&:preload!)
+    end
+
+    # Lazily load all sources
+    #
+    # This instantiates the @_sources instance variable, but should not be
+    # used directly as it could be legitimately unset if we're doing lazy
+    # loading.
+    #
+    # @return [Array<R10K::Source::Base>] All repository sources
+    #   specified in the config
+    def sources
+      load_sources if @_sources.nil?
+      @_sources
+    end
+
+    # Lazily load all environments
+    #
+    # This instantiates the @_environments instance variable, but should not be
+    # used directly as it could be legitimately unset if we're doing lazy
+    # loading.
+    #
+    # @return [Array<R10K::Environment::Base>] All enviroments across
+    #   all sources
+    def environments
+      load_environments if @_environments.nil?
+      @_environments
+    end
+
+    # @return [Array<String>] The paths used by all contained sources
+    def paths
+      paths_and_sources.keys
+    end
+
+    # @return [Hash<String, Array<R10K::Source::Base>]
+    def paths_and_sources
+      pathmap = Hash.new { |h, k| h[k] = [] }
+      sources.each { |source| pathmap[source.basedir] << source }
+      pathmap
+    end
+
+    # Remove unmanaged content from all source paths
+    def purge!
+      paths_and_sources.each_pair do |path, sources_at_path|
+        R10K::Util::Basedir.new(path, sources_at_path).purge!
+      end
+    end
+
+    def validate!
+      hash = {}
+      sources.each do |source|
+        source.environments.each do |environment|
+          if hash.key?(environment.path)
+            osource, oenvironment = hash[environment.path]
+            msg = _("Environment collision at %{env_path} between %{source}:%{env_name} and %{osource}:%{oenv_name}") % 
+              {env_path: environment.path,
+               source: source.name,
+               env_name: environment.name,
+               osource: osource.name,
+               oenv_name: oenvironment.name}
+
+            raise R10K::Error, msg
+          else
+            hash[environment.path] = [source, environment]
+          end
+        end
+      end
+    end
+
+    def accept(visitor)
+      visitor.visit(:deployment, self) do
+        sources.each do |source|
+          source.accept(visitor)
+        end
+      end
+    end
+
+    private
+
+    def load_sources
+      sources = @config[:sources]
+      if sources.nil? || sources.empty?
+        raise R10K::Error, _("Unable to load sources; the supplied configuration does not define the 'sources' key")
+      end
+      @_sources = sources.map do |(name, hash)|
+        R10K::Source.from_hash(name, hash)
+      end
+    end
+
+    def load_environments
+      @_environments = []
+      sources.each do |source|
+        @_environments += source.environments
+      end
+    end
+  end
+end

data/lib/r10k/deployment/config.rb

@@ -0,0 +1,56 @@
+require 'r10k/deployment'
+require 'r10k/settings/loader'
+require 'r10k/util/symbolize_keys'
+require 'r10k/errors'
+require 'r10k/initializers'
+require 'yaml'
+
+module R10K
+class Deployment
+class Config
+
+  include R10K::Logging
+
+  attr_accessor :configfile
+
+  def initialize(configfile, overrides={})
+    @configfile = configfile
+    @overrides = overrides
+
+    load_config
+  end
+
+  # Perform a scan for key and check for both string and symbol keys
+  def setting(key)
+    @config[key]
+  end
+
+  alias [] setting
+
+  def settings
+    @config
+  end
+
+  # Load and store a config file, and set relevant options
+  #
+  # @param [String] configfile The path to the YAML config file
+  def load_config
+    loader = R10K::Settings::Loader.new
+    hash = loader.read(@configfile)
+
+    with_overrides = hash.merge(@overrides) do |key, oldval, newval|
+      logger.debug2 _("Overriding config file setting '%{key}': '%{old_val}' -> '%{new_val}'") % {key: key, old_val: oldval, new_val: newval}
+      newval
+    end
+
+    @config = R10K::Settings.global_settings.evaluate(with_overrides)
+
+    initializer = R10K::Initializers::GlobalInitializer.new(@config)
+    initializer.call
+  end
+
+  class ConfigError < R10K::Error
+  end
+end
+end
+end

data/lib/r10k/environment.rb

@@ -0,0 +1,37 @@
+module R10K
+  module Environment
+    def self.factory
+      @factory ||= R10K::KeyedFactory.new
+    end
+
+    def self.register(key, klass)
+      factory.register(key, klass)
+    end
+
+    def self.retrieve(key)
+      factory.retrieve(key)
+    end
+
+    def self.generate(type, name, basedir, dirname, options = {})
+      factory.generate(type, name, basedir, dirname, options)
+    end
+
+    def self.from_hash(name, hash)
+      R10K::Util::SymbolizeKeys.symbolize_keys!(hash)
+
+      basedir = hash.delete(:basedir)
+      dirname = hash.delete(:dirname) || name
+
+      type = hash.delete(:type)
+      type = type.is_a?(String) ? type.to_sym : type
+
+      generate(type, name, basedir, dirname, hash)
+    end
+
+    require 'r10k/environment/base'
+    require 'r10k/environment/with_modules'
+    require 'r10k/environment/bare'
+    require 'r10k/environment/git'
+    require 'r10k/environment/svn'
+  end
+end

data/lib/r10k/environment/bare.rb

@@ -0,0 +1,16 @@
+class R10K::Environment::Bare < R10K::Environment::WithModules
+
+  R10K::Environment.register(:bare, self)
+
+  def sync
+    path.mkpath
+  end
+
+  def status
+    :not_applicable
+  end
+
+  def signature
+    'bare-default'
+  end
+end

data/lib/r10k/environment/base.rb

@@ -0,0 +1,150 @@
+require 'r10k/util/subprocess'
+
+# This class defines a common interface for environment implementations.
+#
+# @since 1.3.0
+class R10K::Environment::Base
+
+  # @!attribute [r] name
+  #   @return [String] A name for this environment that is unique to the given source
+  attr_reader :name
+
+  # @!attribute [r] basedir
+  #   @return [String] The path that this environment will be created in
+  attr_reader :basedir
+
+  # @!attribute [r] dirname
+  #   @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
+
+  # @!attribute [r] puppetfile_name
+  #   @api public
+  #   @return [String] The puppetfile name (relative)
+  attr_reader :puppetfile_name
+
+  # 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.
+  #   The semantics of this environment may depend on the environment implementation.
+  def initialize(name, basedir, dirname, options = {})
+    @name    = name
+    @basedir = basedir
+    @dirname = dirname
+    @options = options
+    @puppetfile_name = options[:puppetfile_name]
+
+    @full_path = File.join(@basedir, @dirname)
+    @path = Pathname.new(File.join(@basedir, @dirname))
+
+    @puppetfile  = R10K::Puppetfile.new(@full_path, nil, nil, @puppetfile_name)
+    @puppetfile.environment = self
+  end
+
+  # Synchronize the given environment.
+  #
+  # @api public
+  # @abstract
+  # @return [void]
+  def sync
+    raise NotImplementedError, _("%{class} has not implemented method %{method}") % {class: self.class, 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, _("%{class} has not implemented method %{method}") % {class: self.class, method: __method__}
+  end
+
+  # Returns a unique identifier for the environment's current state.
+  #
+  # @api public
+  # @abstract
+  # @return [String]
+  def signature
+    raise NotImplementedError, _("%{class} has not implemented method %{method}") %{class: self.class, method: __method__}
+  end
+
+  # Returns a hash describing the current state of the environment.
+  #
+  # @return [Hash]
+  def info
+    {
+      :name => self.name,
+      :signature => self.signature,
+    }
+  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
+
+  def whitelist(user_whitelist=[])
+    user_whitelist.collect { |pattern| File.join(@full_path, pattern) }
+  end
+
+  def purge_exclusions
+    list = [File.join(@full_path, '.r10k-deploy.json')].to_set
+
+    list += @puppetfile.managed_directories
+
+    list += @puppetfile.desired_contents.flat_map do |item|
+      desired_tree = []
+
+      if File.directory?(item)
+        desired_tree << File.join(item, '**', '*')
+      end
+
+      Pathname.new(item).ascend do |path|
+        break if path.to_s == @full_path
+        desired_tree << path.to_s
+      end
+
+      desired_tree
+    end
+
+    list.to_a
+  end
+
+  def generate_types!
+    argv = [R10K::Settings.puppet_path, 'generate', 'types', '--environment', dirname, '--environmentpath', basedir]
+    subproc = R10K::Util::Subprocess.new(argv)
+    subproc.raise_on_fail = true
+    subproc.logger = logger
+    result = subproc.execute
+    unless result.stderr.empty?
+      logger.warn "There were problems generating types for environment #{dirname}:"
+      result.stderr.split(%r{\n}).map { |msg| logger.warn msg }
+    end
+  end
+end