r10k 1.3.5 → 1.4.0

data/lib/r10k/action/puppetfile/purge.rb

@@ -0,0 +1,37 @@
+require 'r10k/puppetfile'
+require 'r10k/util/setopts'
+require 'r10k/errors/formatting'
+require 'r10k/logging'
+
+module R10K
+  module Action
+    module Puppetfile
+      class Purge
+        include R10K::Logging
+        include R10K::Util::Setopts
+
+        def initialize(opts, argv)
+          @opts = opts
+          @argv = argv
+
+          setopts(opts, {
+            :root       => :self,
+            :moduledir  => :self,
+            :puppetfile => :path,
+            :trace      => :self,
+          })
+        end
+
+        def call
+          pf = R10K::Puppetfile.new(@root, @moduledir, @path)
+          pf.load
+          pf.purge!
+          true
+        rescue => e
+          logger.error R10K::Errors::Formatting.format_exception(e, opts[:trace])
+          false
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/runner.rb

@@ -0,0 +1,36 @@
+module R10K
+  module Action
+    class Runner
+      def initialize(opts, argv, klass)
+        @opts = opts
+        @argv = argv
+        @klass = klass
+      end
+
+      def instance
+        if @_instance.nil?
+          iopts = @opts.dup
+          iopts.delete(:loglevel)
+          @_instance = @klass.new(iopts, @argv)
+        end
+        @_instance
+      end
+
+      def call
+        setup_logging
+        setup_settings
+        # @todo check arguments
+        instance.call
+      end
+
+      def setup_logging
+        if @opts.key?(:loglevel)
+          R10K::Logging.level = @opts[:loglevel]
+        end
+      end
+
+      def setup_settings
+      end
+    end
+  end
+end

data/lib/r10k/action/visitor.rb

@@ -0,0 +1,31 @@
+require 'r10k/errors/formatting'
+
+module R10K
+  module Action
+    # Implement the Visitor pattern via pseudo double dispatch.
+    #
+    # Visitor classes must implement #visit_type methods for each type that may
+    # be visited. If the visitor should descend into child objects the #visit_
+    # method should yield to the passed block.
+    #
+    # Visitor classes must implement #logger so that error messages can be logged.
+    #
+    # @api private
+    module Visitor
+
+      # Dispatch to the type specific visitor method
+      #
+      # @param type [Symbol] The object type to dispatch for
+      # @param other [Object] The actual object to pass to the visitor method
+      # @param block [Proc] The block that the called visitor method may yield
+      #   to in case recursion is desired.
+      # @return [void]
+      def visit(type, other, &block)
+        send("visit_#{type}", other, &block)
+      rescue => e
+        logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+        @visit_ok = false
+      end
+    end
+  end
+end

data/lib/r10k/cli/deploy.rb

@@ -5,6 +5,10 @@ require 'r10k/deployment/config'
 require 'r10k/task_runner'
 require 'r10k/task/deployment'
 
+require 'r10k/action/cri_runner'
+require 'r10k/action/deploy'
+
+
 require 'cri'
 
 module R10K::CLI
@@ -52,26 +56,10 @@ scheduled. On subsequent deployments, Puppetfile deployment will default to off.
 
           flag :p, :puppetfile, 'Deploy modules from a puppetfile'
 
-          run do |opts, args, cmd|
-            deploy = R10K::Deployment.load_config(opts[:config])
-
-            task = R10K::Task::Deployment::DeployEnvironments.new(deploy)
-            task.update_puppetfile = opts[:puppetfile]
-            task.environment_names = args
-
-            purge = R10K::Task::Deployment::PurgeEnvironments.new(deploy)
-
-            runner = R10K::TaskRunner.new(:trace => opts[:trace])
-            runner.append_task task
-            runner.append_task purge
-            runner.run
-
-            exit runner.exit_value
-          end
+          runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Environment)
         end
       end
     end
-    self.command.add_command(Environment.command)
 
     module Module
       def self.command
@@ -88,49 +76,30 @@ try to deploy the given module names in all environments.
 
           required :e, :environment, 'Update the modules in the given environment'
 
-          run do |opts, args, cmd|
-            deploy = R10K::Deployment.load_config(opts[:config])
-
-            task = R10K::Task::Deployment::DeployModules.new(deploy)
-            task.module_names = args
-            task.environment_names = [opts[:environment]] if opts[:environment]
-
-            runner = R10K::TaskRunner.new(:trace => opts[:trace])
-            runner.append_task task
-            runner.run
-
-            exit runner.exit_value
-          end
+          runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Module)
         end
       end
     end
-    self.command.add_command(Module.command)
 
     module Display
       def self.command
         @cmd ||= Cri::Command.define do
           name  'display'
+          aliases 'list'
           usage 'display'
           summary 'Display environments and modules in the deployment'
 
           flag :p, :puppetfile, 'Display Puppetfile modules'
+          flag nil, :detail, 'Display detailed information'
 
-          run do |opts, args, cmd|
-            deploy = R10K::Deployment.load_config(opts[:config])
-
-            task = R10K::Task::Deployment::Display.new(deploy)
-            task.puppetfile = opts[:puppetfile]
-
-            runner = R10K::TaskRunner.new(:trace => opts[:trace])
-            runner.prepend_task task
-            runner.run
-
-            exit runner.exit_value
-          end
+          runner R10K::Action::CriRunner.wrap(R10K::Action::Deploy::Display)
         end
       end
     end
-    self.command.add_command(Display.command)
   end
-  self.command.add_command(Deploy.command)
 end
+
+R10K::CLI.command.add_command(R10K::CLI::Deploy.command)
+R10K::CLI::Deploy.command.add_command(R10K::CLI::Deploy::Environment.command)
+R10K::CLI::Deploy.command.add_command(R10K::CLI::Deploy::Module.command)
+R10K::CLI::Deploy.command.add_command(R10K::CLI::Deploy::Display.command)

data/lib/r10k/cli/puppetfile.rb

@@ -1,5 +1,6 @@
 require 'r10k/cli'
 require 'r10k/puppetfile'
+require 'r10k/action/puppetfile'
 
 require 'cri'
 
@@ -30,54 +31,25 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
           usage   'install'
           summary 'Install all modules from a Puppetfile'
 
-          run do |opts, args, cmd|
-            puppetfile_root = Dir.getwd
-            puppetfile_path = ENV['PUPPETFILE_DIR']
-            puppetfile      = ENV['PUPPETFILE']
-
-            puppetfile = R10K::Puppetfile.new(puppetfile_root, puppetfile_path, puppetfile)
-
-            runner = R10K::TaskRunner.new(:trace => opts[:trace])
-            task   = R10K::Task::Puppetfile::Sync.new(puppetfile)
-            runner.append_task task
-
-            runner.run
-
-            exit runner.exit_value
-          end
+          # @todo add --moduledir option
+          # @todo add --puppetfile option
+          # @todo add --no-purge option
+          runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Install)
         end
       end
     end
-    self.command.add_command(Install.command)
+
     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.'
-          run do |opts,args,cmd|
-            puppetfile_root = Dir.getwd
-            puppetfile_path = ENV['PUPPETFILE_DIR']
-            puppetfile      = ENV['PUPPETFILE']
-
-            puppetfile = R10K::Puppetfile.new(puppetfile_root, puppetfile_path, puppetfile)
-            begin
-              puppetfile.load
-            rescue SyntaxError, LoadError => e
-              $stderr.puts "ERROR: Could not parse Puppetfile"
-              $stderr.puts e.message
-              if opts[:trace]
-                $stderr.puts e.backtrace.join("\n")
-              end
-              exit 1
-            end
-            puts "Syntax OK"
-            exit 0
-          end
+          runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Check)
         end
       end
     end
-    self.command.add_command(Check.command)
+
     module Purge
       def self.command
         @cmd ||= Cri::Command.define do
@@ -85,25 +57,15 @@ Puppetfile (http://bombasticmonkey.com/librarian-puppet/).
           usage 'purge'
           summary 'Purge unmanaged modules from a Puppetfile managed directory'
 
-          run do |opts, args, cmd|
-            puppetfile_root = Dir.getwd
-            puppetfile_path = ENV['PUPPETFILE_DIR']
-            puppetfile      = ENV['PUPPETFILE']
-
-            puppetfile = R10K::Puppetfile.new(puppetfile_root, puppetfile_path, puppetfile)
-
-            runner = R10K::TaskRunner.new(:trace => opts[:trace])
-            task   = R10K::Task::Puppetfile::Purge.new(puppetfile)
-            runner.append_task task
-
-            runner.run
-
-            exit runner.exit_value
-          end
+          runner R10K::Action::Puppetfile::CriRunner.wrap(R10K::Action::Puppetfile::Purge)
         end
       end
     end
-    self.command.add_command(Purge.command)
   end
-  self.command.add_command(Puppetfile.command)
 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/deployment.rb

@@ -1,74 +1,129 @@
-require 'yaml'
-require 'r10k'
 require 'r10k/source'
+require 'r10k/util/basedir'
+require 'r10k/errors'
+require 'set'
 
 module R10K
-class Deployment
-  # Model a full installation of module directories and modules.
+  # 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/environment'
-  require 'r10k/deployment/basedir'
-  require 'r10k/deployment/source'
-  require 'r10k/deployment/config'
+    require 'r10k/deployment/environment'
+    require 'r10k/deployment/basedir'
+    require 'r10k/deployment/source'
+    require 'r10k/deployment/config'
 
-  # Generate a deployment object based on a config
-  #
-  # @param path [String] The path to the deployment config
-  # @return [R10K::Deployment] The deployment loaded with the given config
-  def self.load_config(path)
-    config = R10K::Deployment::Config.new(path)
-    new(config)
-  end
+    # Generate a deployment object based on a config
+    #
+    # @param path [String] The path to the deployment config
+    # @return [R10K::Deployment] The deployment loaded with the given config
+    def self.load_config(path)
+      config = R10K::Deployment::Config.new(path)
+      new(config)
+    end
 
-  def initialize(config)
-    @config = config
-  end
+    # @!attribute [r] config
+    #   @return [R10K::Deployment::Config]
+    attr_reader :config
 
-  def preload!
-    sources.each(&:preload!)
-  end
-  alias fetch_sources preload!
+    def initialize(config)
+      @config = config
+    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
+    def preload!
+      sources.each(&:preload!)
+    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
+    # @deprecated
+    alias fetch_sources preload!
+
+    # 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
 
-  private
+    # 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
 
-  def load_sources
-    sources = @config.setting(:sources)
-    @_sources = sources.map do |(name, hash)|
-      R10K::Source.from_hash(name, hash)
+    # @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
-  end
 
-  def load_environments
-    @_environments = []
-    sources.each do |source|
-      @_environments += source.environments
+    def validate!
+      hash = {}
+      sources.each do |source|
+        source.environments.each do |environment|
+          if hash.key?(environment.path)
+            osource, oenvironment = hash[environment.path]
+            msg = ""
+            msg << "Environment collision at #{environment.path} between "
+            msg << "#{source.name}:#{environment.name} and #{osource.name}:#{oenvironment.name}"
+            raise R10K::R10KError, msg
+          else
+            hash[environment.path] = [source, environment]
+          end
+        end
+      end
+    end
+
+    def accept(visitor)
+      visitor.visit(:deployment, self) do
+        sources.each do |env|
+          env.accept(visitor)
+        end
+      end
+    end
+
+    private
+
+    def load_sources
+      sources = @config.setting(:sources)
+      @_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
-end