bolt 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b45ba6bf81dbfe329d47a503bf505f1eaf3e5449
-  data.tar.gz: 7d701baa18ad45ddec7cf1cdca86c06e41df1178
+  metadata.gz: 6515bd6a3cf63131c23e0809aa98a057030977a3
+  data.tar.gz: eee81f558aefb21e761082b04bd73bd631e6685d
 SHA512:
-  metadata.gz: 28a20849dbc613f7aea831a27162906e7b70a988b97e75931fc17f6bb9605bc9d731aaa1778182f070188b5f84ba74654e40c95cef405e8987139e93fea419f8
-  data.tar.gz: c875018a2539e59aedb3c247ec41faad45f86e1aa12ab3dfc6ac7eb6553b1203d6c730596e1d67e4c6e37c2e97a977bb9fd594e1543a1b316a791fddb4fc5a1b
+  metadata.gz: 5598b32bf144d8fe0a2cc0601f5ec136235646b182c1a4dc9c4f00aef467f6ea88cdcfcdec25c4fbf88241aa3485d5e9317f34a5d44d8a982f81725678ce8f1b
+  data.tar.gz: 2aac3a8c35530eecaf1e57e206d24f8ae3c0f4eb0f53199ff4d14c491cbef873a8b0791843242fb5ff5890393356da0f0f1235b815d093f075c31938cf1d2e4d

data/exe/bolt

@@ -10,6 +10,5 @@ begin
 rescue Bolt::CLIExit
   exit
 rescue Bolt::CLIError => e
-  warn e.message
   exit e.error_code
 end

data/lib/bolt/cli.rb

@@ -1,7 +1,7 @@
 require 'uri'
 require 'optparse'
 require 'benchmark'
-require 'logger'
+require 'bolt/logger'
 require 'json'
 require 'bolt/node'
 require 'bolt/version'
@@ -109,7 +109,6 @@ HELP
       }
       @config = Bolt::Config.new
       @parser = create_option_parser(@options)
-      @logger = Logger.new(STDERR)
     end
 
     def create_option_parser(results)
@@ -249,6 +248,7 @@ HELP
 
       @config.load_file(options[:configfile])
       @config.update_from_cli(options)
+      Logger.configure(@config)
       @config.validate
 
       # This section handles parsing non-flag options which are
@@ -272,6 +272,9 @@ HELP
       validate(options)
 
       options
+    rescue Bolt::CLIError => e
+      warn e.message
+      raise e
     end
 
     def print_help(mode)
@@ -417,11 +420,11 @@ HELP
         return
       end
 
-      executor = Bolt::Executor.new(@config, options[:noop])
-
       if options[:mode] == 'plan'
+        executor = Bolt::Executor.new(@config, options[:noop], true)
         execute_plan(executor, options)
       else
+        executor = Bolt::Executor.new(@config, options[:noop])
         nodes = executor.from_uris(options[:nodes])
 
         results = nil
@@ -478,8 +481,6 @@ HELP
                  options[:task_options],
                  &block)
       end
-    rescue Puppet::Error
-      raise Bolt::CLIError, "Exiting because of an error in Puppet code"
     end
 
     def execute_plan(executor, options)
@@ -489,8 +490,6 @@ HELP
                  options[:task_options])
       end
       outputter.print_plan(result)
-    rescue Puppet::Error
-      raise Bolt::CLIError, "Exiting because of an error in Puppet code"
     end
 
     def validate_file(type, path)
@@ -517,13 +516,24 @@ HELP
       @outputter ||= Bolt::Outputter.for_format(@config[:format])
     end
 
+    # Runs a block in a PAL script compiler configured for Bolt.
+    # Catches exceptions thrown by the block and re-raises them as Bolt::CLIError.
     def in_bolt_compiler(opts = [])
       Puppet.initialize_settings(opts)
-      Puppet::Pal.in_tmp_environment('bolt', modulepath: [BOLTLIB_PATH] + @config[:modulepath], facts: {}) do |pal|
+      r = Puppet::Pal.in_tmp_environment('bolt', modulepath: [BOLTLIB_PATH] + @config[:modulepath], facts: {}) do |pal|
         pal.with_script_compiler do |compiler|
-          yield compiler
+          begin
+            yield compiler
+          rescue Puppet::PreformattedError => err
+            err.cause
+          rescue StandardError => err
+            err
+          end
         end
       end
+
+      raise Bolt::CLIError, r.message if r.is_a? StandardError
+      r
     end
 
     def list_tasks
@@ -534,16 +544,12 @@ HELP
           [task_name, task_sig.task.description]
         end
       end
-    rescue Puppet::Error
-      raise Bolt::CLIError, "Failure while reading task metadata"
     end
 
     def list_plans
       in_bolt_compiler do |compiler|
         compiler.list_plans.map { |plan| [plan.name] }.sort
       end
-    rescue Puppet::Error
-      raise Bolt::CLIError, "Failure while reading plans"
     end
 
     def get_task_info(task_name)
@@ -552,26 +558,12 @@ HELP
       end
       raise Bolt::CLIError, "Could not find task #{task_name} in your modulepath" if task.nil?
       task.task_hash
-    rescue Puppet::Error
-      raise Bolt::CLIError, "Failure while reading task metadata"
     end
 
     def run_task(name, nodes, args, &block)
-      parse_error = nil
-      result = in_bolt_compiler do |compiler|
-        begin
-          compiler.call_function('run_task', name, nodes, args, &block)
-        rescue Puppet::ParseError => e
-          # we assume that the Puppet::ParseError is due to a problem with
-          # the task and/or its parameters, but since the with_script_compiler
-          # method rescues these errors and raises different ones instead,
-          # we save it in a local variable and raise it as Bolt::CLIError
-          # outside of the block
-          parse_error = e
-        end
+      in_bolt_compiler do |compiler|
+        compiler.call_function('run_task', name, nodes, args, &block)
       end
-      raise Bolt::CLIError, parse_error.message if parse_error
-      result
     end
 
     # Expects to be called with a configured Puppet compiler or error.instance? will fail

data/lib/bolt/config.rb

@@ -1,4 +1,4 @@
-require 'logger'
+require 'bolt/logger'
 require 'yaml'
 require 'bolt/cli'
 
@@ -6,7 +6,6 @@ module Bolt
   Config = Struct.new(
     :concurrency,
     :format,
-    :log_destination,
     :log_level,
     :modulepath,
     :transport,
@@ -16,12 +15,10 @@ module Bolt
     DEFAULTS = {
       concurrency: 100,
       transport: 'ssh',
-      format: 'human',
-      log_level: Logger::WARN,
-      log_destination: STDERR
+      format: 'human'
     }.freeze
 
-    TRANSPORT_OPTIONS = %i[insecure password run_as sudo_password
+    TRANSPORT_OPTIONS = %i[insecure password run_as sudo_password extensions
                            key tty tmpdir user connect_timeout cacert
                            token_file orch_task_environment service_url].freeze
 
@@ -61,7 +58,7 @@ module Bolt
       if path.nil?
         found_default = default_paths.select { |p| File.exist?(p) }
         if found_default.size > 1
-          logger = Logger.new(self[:log_destination])
+          logger = Logger.get_logger
           logger.warn "Config files found at #{found_default.join(', ')}, using the first"
         end
         # Use first found, fall back to first default and try to load even if it didn't exist
@@ -130,6 +127,11 @@ module Bolt
         if data['winrm']['cacert']
           self[:transports][:winrm][:cacert] = data['winrm']['cacert']
         end
+        if data['winrm']['extensions']
+          # Accept a single entry or a list, ensure each is prefixed with '.'
+          self[:transports][:winrm][:extensions] =
+            [data['winrm']['extensions']].flatten.map { |ext| ext[0] != '.' ? '.' + ext : ext }
+        end
       end
 
       if data['pcp']
@@ -170,12 +172,6 @@ module Bolt
           self[:transports][transport][key] = options[key] if options[key]
         end
       end
-
-      if options[:sudo_password] && self[:transports][:ssh][:run_as].nil?
-        logger = Logger.new(self[:log_destination])
-        logger.warn("'--sudo-password will not be used without specifying a" \
-                    "user to escalate to with --run-as")
-      end
     end
 
     def validate
@@ -187,6 +183,12 @@ module Bolt
         raise Bolt::CLIError, "Unsupported format: '#{self[:format]}'"
       end
 
+      if self[:transports][:ssh][:sudo_password] && self[:transports][:ssh][:run_as].nil?
+        logger = Logger.get_logger
+        logger.warn("--sudo-password will not be used without specifying a " \
+                    "user to escalate to with --run-as")
+      end
+
       self[:transports].each_value do |v|
         timeout_value = v[:connect_timeout]
         unless timeout_value.is_a?(Integer) || timeout_value.nil?

data/lib/bolt/execution_result.rb

@@ -47,7 +47,7 @@ module Bolt
 
     def error_nodes
       result = {}
-      @result_hash.each_pair { |k, v| result[k] = v if v.is_a?(Error) }
+      @result_hash.each_pair { |k, v| result[k] = v if v.is_a?(Puppet::DataTypes::Error) }
       self.class.new(result, true)
     end
 
@@ -56,7 +56,7 @@ module Bolt
     end
 
     def ok
-      @result_hash.values.none? { |v| v.is_a?(Error) }
+      @result_hash.values.none? { |v| v.is_a?(Puppet::DataTypes::Error) }
     end
     alias ok? ok
 

data/lib/bolt/executor.rb

@@ -1,22 +1,20 @@
-require 'logger'
+require 'bolt/logger'
+require 'json'
 require 'concurrent'
 require 'bolt/result'
 require 'bolt/config'
-require 'bolt/formatter'
 require 'bolt/notifier'
 
 module Bolt
   class Executor
     attr_reader :noop
 
-    def initialize(config = Bolt::Config.new, noop = nil)
+    def initialize(config = Bolt::Config.new, noop = nil, plan_logging = false)
       @config = config
-      @logger = Logger.new(config[:log_destination])
-      @logger.progname = 'executor'
-      @logger.level = config[:log_level]
-      @logger.formatter = Bolt::Formatter.new
+      @logger = Logger.get_logger(progname: 'executor')
       @noop = noop
       @notifier = Bolt::Notifier.new
+      @plan_logging = plan_logging
     end
 
     def from_uris(nodes)
@@ -67,36 +65,73 @@ module Bolt
       results_to_hash(results)
     end
 
+    def summary(action, object, result)
+      fc = result.select { |_, r| r.error }.length
+      npl = result.length == 1 ? '' : 's'
+      fpl = fc == 1 ? '' : 's'
+      "Ran #{action} '#{object}' on #{result.length} node#{npl} with #{fc} failure#{fpl}"
+    end
+
     def run_command(nodes, command)
+      level = @plan_logging ? Logger::NOTICE : Logger::INFO
+      @logger.log(level, "Starting command run '#{command}' on #{nodes.map(&:uri)}")
       callback = block_given? ? Proc.new : nil
 
-      on(nodes, callback) do |node|
-        node.run_command(command)
+      r = on(nodes, callback) do |node|
+        @logger.debug("Running command '#{command}' on #{node.uri}")
+        node_result = node.run_command(command)
+        @logger.debug("Result on #{node.uri}: #{JSON.dump(node_result.to_result)}")
+        node_result
       end
+      @logger.log(level, summary('command', command, r))
+      r
     end
 
     def run_script(nodes, script, arguments)
+      level = @plan_logging ? Logger::NOTICE : Logger::INFO
+      @logger.log(level, "Starting script run #{script} on #{nodes.map(&:uri)}")
+      @logger.debug("Arguments: #{arguments}")
       callback = block_given? ? Proc.new : nil
 
-      on(nodes, callback) do |node|
-        node.run_script(script, arguments)
+      r = on(nodes, callback) do |node|
+        @logger.debug { "Running script '#{script}' on #{node.uri}" }
+        node_result = node.run_script(script, arguments)
+        @logger.debug("Result on #{node.uri}: #{JSON.dump(node_result.to_result)}")
+        node_result
       end
+      @logger.log(level, summary('script', script, r))
+      r
     end
 
     def run_task(nodes, task, input_method, arguments)
+      level = @plan_logging ? Logger::NOTICE : Logger::INFO
+      @logger.log(level, "Starting task #{task} on #{nodes.map(&:uri)}")
+      @logger.debug("Arguments: #{arguments} Input method: #{input_method}")
       callback = block_given? ? Proc.new : nil
 
-      on(nodes, callback) do |node|
-        node.run_task(task, input_method, arguments)
+      r = on(nodes, callback) do |node|
+        @logger.debug { "Running task run '#{task}' on #{node.uri}" }
+        node_result = node.run_task(task, input_method, arguments)
+        @logger.debug("Result on #{node.uri}: #{JSON.dump(node_result.to_result)}")
+        node_result
       end
+      @logger.log(level, summary('task', task, r))
+      r
     end
 
     def file_upload(nodes, source, destination)
+      level = @plan_logging ? Logger::NOTICE : Logger::INFO
+      @logger.log(level, "Starting file upload from #{source} to #{destination} on #{nodes.map(&:uri)}")
       callback = block_given? ? Proc.new : nil
 
-      on(nodes, callback) do |node|
-        node.upload(source, destination)
+      r = on(nodes, callback) do |node|
+        @logger.debug { "Uploading: '#{source}' to #{node.uri}" }
+        node_result = node.upload(source, destination)
+        @logger.debug("Result on #{node.uri}: #{JSON.dump(node_result.to_result)}")
+        node_result
       end
+      @logger.log(level, summary('upload', source, r))
+      r
     end
 
     private

data/lib/bolt/logger.rb

@@ -0,0 +1,56 @@
+require 'logger'
+require 'bolt/formatter'
+
+class Logger
+  send :remove_const, 'SEV_LABEL'
+
+  SEV_LABEL = {
+    0 => 'DEBUG',
+    1 => 'INFO',
+    2 => 'NOTICE',
+    3 => 'WARN',
+    4 => 'ERROR',
+    5 => 'FATAL',
+    6 => 'ANY'
+  }.freeze
+
+  module Severity
+    levels = %w[WARN ERROR FATAL ANY]
+    levels.each do |level|
+      send(:remove_const, level) if const_defined?(level)
+    end
+    NOTICE = 2
+    WARN = 3
+    ERROR = 4
+    FATAL = 5
+    ANY = 6
+  end
+
+  def notice(progname = nil, &block)
+    add(NOTICE, nil, progname, &block)
+  end
+
+  def notice?
+    @level <= NOTICE
+  end
+
+  # rubocop:disable Style/ClassVars
+  @@config = {
+    log_destination: STDERR,
+    log_level: NOTICE
+  }
+
+  # Not thread safe call only during startup
+  def self.configure(config)
+    @@config[:log_level] = config[:log_level] if config[:log_level]
+  end
+
+  def self.get_logger(**conf)
+    conf = @@config.merge(conf)
+    logger = new(conf[:log_destination])
+    logger.level = conf[:log_level]
+    logger.progname = conf[:progname] if conf[:progname]
+    logger.formatter = Bolt::Formatter.new
+    logger
+  end
+end

data/lib/bolt/node.rb

@@ -1,6 +1,5 @@
-require 'logger'
+require 'bolt/logger'
 require 'bolt/node_uri'
-require 'bolt/formatter'
 require 'bolt/result'
 require 'bolt/config'
 require 'bolt/target'
@@ -52,17 +51,10 @@ module Bolt
       @service_url = transport_conf[:service_url]
       @token_file = transport_conf[:token_file]
       @orch_task_environment = transport_conf[:orch_task_environment]
+      @extensions = transport_conf[:extensions]
 
-      @logger = init_logger(config[:log_destination], config[:log_level])
-      @transport_logger = init_logger(config[:log_destination], Logger::WARN)
-    end
-
-    def init_logger(destination, level)
-      logger = Logger.new(destination)
-      logger.progname = @host
-      logger.level = level
-      logger.formatter = Bolt::Formatter.new
-      logger
+      @logger = Logger.get_logger(progname: @host)
+      @transport_logger = Logger.get_logger(progname: @host, log_level: Logger::WARN)
     end
 
     def upload(source, destination)
@@ -76,12 +68,10 @@ module Bolt
     end
 
     def run_command(command)
-      @logger.info { "Running command: #{command}" }
       _run_command(command)
     end
 
     def run_script(script, arguments)
-      @logger.info { "Running script: #{script}" }
       _run_script(script, arguments)
     end
 

data/lib/bolt/node/ssh.rb

@@ -82,13 +82,13 @@ module Bolt
           )
         end
       elsif data =~ /^#{@user} is not in the sudoers file\./
-        @logger.info { data }
+        @logger.debug { data }
         raise Bolt::Node::EscalateError.new(
           "User #{@user} does not have sudo permission on #{@uri}",
           'SUDO_DENIED'
         )
       elsif data =~ /^Sorry, try again\./
-        @logger.info { data }
+        @logger.debug { data }
         raise Bolt::Node::EscalateError.new(
           "Sudo password for user #{@user} not recognized on #{@uri}",
           'BAD_PASSWORD'
@@ -260,9 +260,6 @@ SCRIPT
     end
 
     def _run_script(script, arguments)
-      @logger.info { "Running script '#{script}'" }
-      @logger.debug { "arguments: #{arguments}" }
-
       with_remote_file(script) do |remote_path|
         output = execute("'#{remote_path}' #{Shellwords.join(arguments)}",
                          sudoable: true)
@@ -278,9 +275,6 @@ SCRIPT
       export_args = {}
       stdin, output = nil
 
-      @logger.info { "Running task '#{task}'" }
-      @logger.debug { "arguments: #{arguments}\ninput_method: #{input_method}" }
-
       if STDIN_METHODS.include?(input_method)
         stdin = JSON.dump(arguments)
       end

data/lib/bolt/node/winrm.rb

@@ -2,6 +2,7 @@ require 'winrm'
 require 'winrm-fs'
 require 'bolt/result'
 require 'base64'
+require 'set'
 
 module Bolt
   class WinRM < Node
@@ -16,6 +17,8 @@ module Bolt
 
     def initialize(host, port, user, password, **kwargs)
       super(host, port, user, password, **kwargs)
+      @extensions = DEFAULT_EXTENSIONS.to_set.merge(@extensions || [])
+      @logger.debug { "WinRM initialized for #{@extensions.to_a} extensions" }
     end
 
     def connect
@@ -401,7 +404,7 @@ exit $(Invoke-Interpreter @invokeArgs)
 PS
     end
 
-    VALID_EXTENSIONS = ['.ps1', '.rb', '.pp'].freeze
+    DEFAULT_EXTENSIONS = ['.ps1', '.rb', '.pp'].freeze
 
     PS_ARGS = %w[
       -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass
@@ -428,6 +431,12 @@ PS
           'puppet.bat',
           ['apply', "\"#{path}\""]
         ]
+      else
+        # Run the script via cmd, letting Windows extension handling determine how
+        [
+          'cmd.exe',
+          ['/c', "\"#{path}\""]
+        ]
       end
     end
 
@@ -440,7 +449,6 @@ PS
     end
 
     def write_remote_file(source, destination)
-      @logger.debug { "Uploading #{source} to #{destination}" }
       fs = ::WinRM::FS::FileManager.new(@connection)
       # TODO: raise FileError here if this fails
       fs.upload(source, destination)
@@ -463,10 +471,13 @@ PS
 
     def with_remote_file(file)
       ext = File.extname(file)
-      ext = VALID_EXTENSIONS.include?(ext) ? ext : '.ps1'
-      file_base = File.basename(file, '.*')
+      unless @extensions.include?(ext)
+        raise FileError.new("File extension #{ext} is not enabled, "\
+                            "to run it please add to 'winrm: extensions'", 'FILETYPE_ERROR')
+      end
+      file_base = File.basename(file)
       dir = make_tempdir
-      dest = "#{dir}\\#{file_base}#{ext}"
+      dest = "#{dir}\\#{file_base}"
       begin
         write_remote_file(file, dest)
         shell_init
@@ -488,7 +499,6 @@ PS
     end
 
     def _run_script(script, arguments)
-      @logger.info { "Running script '#{script}'" }
       with_remote_file(script) do |remote_path|
         if powershell_file?(remote_path)
           mapped_args = arguments.map do |a|
@@ -523,9 +533,6 @@ catch
     end
 
     def _run_task(task, input_method, arguments)
-      @logger.info { "Running task '#{task}'" }
-      @logger.debug { "arguments: #{arguments}\ninput_method: #{input_method}" }
-
       if STDIN_METHODS.include?(input_method)
         stdin = JSON.dump(arguments)
       end

data/lib/bolt/outputter/human.rb

@@ -136,7 +136,9 @@ module Bolt
         end
       end
 
-      def fatal_error(e); end
+      def fatal_error(e)
+        @stream.puts(colorize(:red, e.message))
+      end
     end
 
     def print_message(message)

data/lib/bolt/version.rb

@@ -1,3 +1,3 @@
 module Bolt
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -312,6 +312,7 @@ files:
 - lib/bolt/execution_result.rb
 - lib/bolt/executor.rb
 - lib/bolt/formatter.rb
+- lib/bolt/logger.rb
 - lib/bolt/node.rb
 - lib/bolt/node/errors.rb
 - lib/bolt/node/orch.rb
@@ -1577,7 +1578,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Execute commands remotely over SSH and WinRM