r10k 1.3.5 → 1.4.0

data/lib/r10k/action/cri_runner.rb

@@ -0,0 +1,75 @@
+require 'r10k/action/runner'
+
+module R10K
+  module Action
+
+    # Adapt the Cri runner interface to the R10K::Action::Runner interface
+    #
+    # This class provides the necessary glue to translate behavior specific
+    # to Cri and the CLI component in general to the interface agnostic runner
+    # class.
+    #
+    # @api private
+    class CriRunner
+
+      def self.wrap(klass)
+        new(klass)
+      end
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      # Intercept any instatiations of klass
+      #
+      # Defining #new allows this object to proxy method calls on the wrapped
+      # runner and decorate various methods. Doing so allows this class to
+      # manage CLI specific behaviors and isolate the underlying code from
+      # having to deal with those particularities
+      #
+      # @param opts [Hash]
+      # @param argv [Array<String>]
+      # @param _cmd [Cri::Command] The command that was invoked. This value
+      #   is not used and is only present to adapt the Cri interface to r10k.
+      # @return [self]
+      def new(opts, argv, _cmd = nil)
+        handle_opts(opts)
+        handle_argv(argv)
+        @runner = R10K::Action::Runner.new(@opts, @argv, @klass)
+        self
+      end
+
+      # @return [Hash] The adapted options for the runner
+      def handle_opts(opts)
+        # Translate from the Cri verbose logging option to the internal logging setting.
+        loglevel = opts.delete(:verbose)
+        case loglevel
+        when String, Numeric
+          opts[:loglevel] = loglevel
+        when TrueClass
+          opts[:loglevel] = 'INFO'
+        when NilClass
+          # pass
+        else
+          # When the type is unsure just pass it in as-is and let the internals
+          # raise the appropriate errors.
+          opts[:loglevel] = loglevel
+        end
+
+        @opts = opts
+      end
+
+      # @return [Array] The adapted arguments for the runner
+      def handle_argv(argv)
+        @argv = argv
+      end
+
+      # Invoke the wrapped behavior, determine if it succeeded, and exit with
+      # the resulting exit code.
+      def call
+        rv = @runner.call
+        exit(rv ? 0 : 1)
+      end
+    end
+  end
+end

data/lib/r10k/action/deploy.rb

@@ -0,0 +1,9 @@
+module R10K
+  module Action
+    module Deploy
+      require 'r10k/action/deploy/environment'
+      require 'r10k/action/deploy/module'
+      require 'r10k/action/deploy/display'
+    end
+  end
+end

data/lib/r10k/action/deploy/display.rb

@@ -0,0 +1,104 @@
+require 'r10k/util/setopts'
+require 'r10k/deployment'
+require 'r10k/logging'
+
+module R10K
+  module Action
+    module Deploy
+      class Display
+
+        include R10K::Util::Setopts
+        include R10K::Logging
+
+        def initialize(opts, argv)
+          @opts = opts
+          @argv = argv
+          setopts(opts, {
+            :config     => :self,
+            :puppetfile => :self,
+            :detail     => :self,
+            :trace      => :self
+          })
+
+          @level  = 4
+          @indent = 0
+        end
+
+        def call
+          @visit_ok = true
+          deployment = R10K::Deployment.load_config(@config)
+          deployment.accept(self)
+          @visit_ok
+        end
+
+        include R10K::Action::Visitor
+
+        private
+
+        def visit_deployment(deployment)
+          yield
+        end
+
+        def visit_source(source)
+          source.generate_environments
+          display_text("#{source.name} (#{source.basedir})")
+          yield
+        end
+
+        def visit_environment(environment)
+          if !(@argv.empty? || @argv.include?(environment.dirname))
+            return
+          end
+
+          indent do
+            display_text("- " + environment.dirname)
+            if @puppetfile
+              indent do
+                display_text("modules:")
+                yield
+              end
+            end
+          end
+        end
+
+        def visit_puppetfile(puppetfile)
+          puppetfile.load
+          yield
+        end
+
+        def visit_module(mod)
+          indent do
+            display_text("- " + mod.title)
+            if @detail
+              indent do
+                properties = mod.properties
+                str = properties.keys.sort.map do |key|
+                  "#{key}: #{properties[key]}"
+                end.join("\n")
+                display_text(str)
+              end
+            end
+          end
+        end
+
+        def indent(&block)
+          @indent += @level
+          block.call
+        ensure
+          @indent -= @level
+        end
+
+        def indent_text(str)
+          space = " " * @indent
+          str.lines.map do |line|
+            space + line
+          end.join
+        end
+
+        def display_text(str)
+          puts indent_text(str)
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/deploy/environment.rb

@@ -0,0 +1,92 @@
+require 'r10k/util/setopts'
+require 'r10k/deployment'
+require 'r10k/logging'
+require 'r10k/action/visitor'
+
+module R10K
+  module Action
+    module Deploy
+      class Environment
+
+        include R10K::Util::Setopts
+        include R10K::Logging
+
+        def initialize(opts, argv)
+          @opts = opts
+          @argv = argv
+          setopts(opts, {
+            :config     => :self,
+            :puppetfile => :self,
+            :purge      => :self,
+            :trace      => :self
+          })
+
+          @purge = true
+        end
+
+        def call
+          @visit_ok = true
+          deployment = R10K::Deployment.load_config(@config)
+          deployment.accept(self)
+          @visit_ok
+        end
+
+        include R10K::Action::Visitor
+
+        private
+
+        def visit_deployment(deployment)
+          # Ensure that everything can be preloaded. If we cannot preload all
+          # sources then we can't fully enumerate all environments which
+          # could be dangerous. If this fails then an exception will be raised
+          # and execution will be halted.
+          deployment.preload!
+          deployment.validate!
+
+          yield
+
+          deployment.purge! if @purge
+
+        ensure
+          if (postcmd = deployment.config.setting(:postrun))
+            subproc = R10K::Util::Subprocess.new(postcmd)
+            subproc.logger = logger
+            subproc.execute
+          end
+        end
+
+        def visit_source(source)
+          yield
+        end
+
+        def visit_environment(environment)
+          if !(@argv.empty? || @argv.any? { |name| environment.dirname == name })
+            logger.debug1("Environment #{environment.dirname} does not match environment name filter, skipping")
+            return
+          end
+          status = environment.status
+          logger.info "Deploying environment #{environment.path}"
+          environment.sync
+
+          if status == :absent || @puppetfile
+            if status == :absent
+              logger.debug("Environment #{environment.dirname} is new, updating all modules")
+            end
+            yield
+          end
+        end
+
+        def visit_puppetfile(puppetfile)
+          puppetfile.load
+          yield
+          puppetfile.purge!
+        end
+
+        def visit_module(mod)
+          logger.info "Deploying module #{mod.path}"
+          mod.sync
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/deploy/module.rb

@@ -0,0 +1,70 @@
+require 'r10k/util/setopts'
+require 'r10k/deployment'
+require 'r10k/action/visitor'
+require 'r10k/logging'
+
+module R10K
+  module Action
+    module Deploy
+      class Module
+
+        include R10K::Logging
+        include R10K::Util::Setopts
+
+        def initialize(opts, argv)
+          @opts = opts
+          @argv = argv
+          setopts(opts, {
+            :config      => :self,
+            :environment => nil,
+            :trace       => :self
+          })
+
+          @purge = true
+        end
+
+        def call
+          @visit_ok = true
+          deployment = R10K::Deployment.load_config(@config)
+          deployment.accept(self)
+          @visit_ok
+        end
+
+        include R10K::Action::Visitor
+
+        private
+
+        def visit_deployment(deployment)
+          yield
+        end
+
+        def visit_source(source)
+          yield
+        end
+
+        def visit_environment(environment)
+          if @opts[:environment] && (@opts[:environment] != environment.dirname)
+            logger.debug1("Only updating modules in environment #{@opts[:environment]}, skipping environment #{environment.path}")
+          else
+            logger.debug1("Updating modules #{@argv.inspect} in environment #{environment.path}")
+            yield
+          end
+        end
+
+        def visit_puppetfile(puppetfile)
+          puppetfile.load
+          yield
+        end
+
+        def visit_module(mod)
+          if @argv.include?(mod.name)
+            logger.info "Deploying module #{mod.path}"
+            mod.sync
+          else
+            logger.debug1("Only updating modules #{@argv.inspect}, skipping module #{mod.name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/r10k/action/puppetfile.rb

@@ -0,0 +1,10 @@
+module R10K
+  module Action
+    module Puppetfile
+      require 'r10k/action/puppetfile/cri_runner'
+      require 'r10k/action/puppetfile/install'
+      require 'r10k/action/puppetfile/check'
+      require 'r10k/action/puppetfile/purge'
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'r10k/puppetfile'
+require 'r10k/util/setopts'
+require 'r10k/errors/formatting'
+require 'r10k/logging'
+
+module R10K
+  module Action
+    module Puppetfile
+      class Check
+        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)
+
+          begin
+            pf.load
+            $stderr.puts "Syntax OK"
+            true
+          rescue R10K::Error => e
+            $stderr.puts R10K::Errors::Formatting.format_exception(e, @trace)
+            false
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,32 @@
+require 'r10k/action/cri_runner'
+
+module R10K
+  module Action
+    module Puppetfile
+      # Extend the default Cri Runner to use the PUPPETFILE environment
+      # variables.
+      #
+      # @api private
+      # @deprecated The use of these environment variables is deprecated and
+      #   will be removed in 2.0.0.
+      class CriRunner < R10K::Action::CriRunner
+        def handle_opts(opts)
+          opts[:root]       ||= wd
+          opts[:moduledir]  ||= env['PUPPETFILE_DIR']
+          opts[:puppetfile] ||= env['PUPPETFILE']
+          super(opts)
+        end
+
+        private
+
+        def env
+          ENV
+        end
+
+        def wd
+          Dir.getwd
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require 'r10k/puppetfile'
+require 'r10k/util/setopts'
+require 'r10k/errors/formatting'
+require 'r10k/logging'
+
+module R10K
+  module Action
+    module Puppetfile
+      class Install
+        include R10K::Logging
+        include R10K::Util::Setopts
+
+        def initialize(opts, argv)
+          @opts = opts
+          @argv = argv
+
+          @ok = true
+
+          setopts(opts, {
+            :root       => :self,
+            :moduledir  => :self,
+            :puppetfile => :path,
+            :trace      => :self,
+          })
+        end
+
+        def call
+          pf = R10K::Puppetfile.new(@root, @moduledir, @path)
+          pf.accept(self)
+          @ok
+        end
+
+        def visit(type, other, &block)
+          send("visit_#{type}", other, &block)
+        rescue => e
+          logger.error R10K::Errors::Formatting.format_exception(e, @trace)
+          @ok = false
+        end
+
+        def visit_puppetfile(pf)
+          pf.load
+          yield
+          pf.purge!
+        end
+
+        def visit_module(mod)
+          logger.info "Updating module #{mod.path}"
+          mod.sync
+        end
+      end
+    end
+  end
+end