bolt 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e2611b80200c25247a4eab55d365449cebb736f
-  data.tar.gz: f95c519a312580492f059a4c94b289cce46872be
+  metadata.gz: b7f70a1d9878c8a40b79b597ed62e5c7307d200b
+  data.tar.gz: f8bdfadbfe729a572acd6f6feabfb3b334c1f16e
 SHA512:
-  metadata.gz: d6b368afa1ee1a1ef1ead7731681223aacceb78232560ada3fe99d89ba47a4e8d8a01957d49fa697267458942bcc068f8140d579de0d5aa1836ae92b4e2ec231
-  data.tar.gz: 41c0349f16bef422ecec574a4a8b29f7bb34169b8778404b265a4d236a9dc3b8af8cf8f53d4bd2df0641b82132881ba0efff4d53fc733294255a31c34327eba0
+  metadata.gz: 68e190c03a5ad2be65fd0832dec9080aaf03de408514d575244997a96663f9f9bdc7ee1b0e18fa4fd35ff3a705fde3b99e40ed5213aa374fa8a359ef28f8a2bf
+  data.tar.gz: 14cc9838705602039e3fd902f229f25b48a96c9580f54efeeb624087debb8ffec0167b5288bcb23d4c7f0309505f39856a4eb37ce24c068fcccba3dc222247ca

data/lib/bolt.rb

@@ -1,10 +1,4 @@
-require 'logger'
-
 module Bolt
-  class << self
-    attr_accessor :log_level
-  end
-
   require 'bolt/executor'
   require 'bolt/node'
 end

data/lib/bolt/cli.rb

@@ -56,7 +56,7 @@ Available options are:
 HELP
 
     SCRIPT_HELP = <<-HELP.freeze
-Usage: bolt script <action> <script> [options]
+Usage: bolt script <action> <script> [[arg1] ... [argN]] [options]
 
 Available actions are:
     run                              Upload a local script and run it remotely
@@ -86,14 +86,19 @@ HELP
 
     MODES = %w[command script task plan file].freeze
     ACTIONS = %w[run upload download].freeze
+    TRANSPORTS = %w[ssh winrm pcp].freeze
 
-    attr_reader :parser
+    attr_reader :parser, :config
     attr_accessor :options
 
     def initialize(argv)
-      @argv = argv
-      @options = {}
-
+      @argv    = argv
+      @options = {
+        nodes: [],
+        insecure: false,
+        transport: 'ssh'
+      }
+      @config = Bolt::Config.new
       @parser = create_option_parser(@options)
     end
 
@@ -111,7 +116,8 @@ HELP
           '* protocol is `ssh` by default, may be `ssh` or `winrm`',
           '* port is `22` by default for SSH, `5985` for winrm (Optional)'
         ) do |nodes|
-          results[:nodes] = parse_nodes(nodes)
+          results[:nodes] += parse_nodes(nodes)
+          results[:nodes].uniq!
         end
         opts.on('-u', '--user USER',
                 "User to authenticate as (Optional)") do |user|
@@ -134,18 +140,23 @@ HELP
                 "(Optional, defaults to 100)") do |concurrency|
           results[:concurrency] = concurrency
         end
-        opts.on('--modules MODULES', "Path to modules directory") do |modules|
-          results[:modules] = modules
+        opts.on('--modulepath MODULES',
+                "List of directories containing modules, " \
+                "separated by #{File::PATH_SEPARATOR}") do |modulepath|
+          results[:modulepath] = modulepath.split(File::PATH_SEPARATOR)
         end
         opts.on('--params PARAMETERS',
                 "Parameters to a task or plan") do |params|
           results[:task_options] = parse_params(params)
         end
-        results[:insecure] = false
         opts.on('-k', '--insecure',
                 "Whether to connect insecurely ") do |insecure|
           results[:insecure] = insecure
         end
+        opts.on('--transport TRANSPORT', TRANSPORTS,
+                "Specify a default transport: #{TRANSPORTS.join(', ')}") do |t|
+          options[:transport] = t
+        end
         opts.on_tail('--[no-]tty',
                      "Request a pseudo TTY on nodes that support it") do |tty|
           results[:tty] = tty
@@ -167,8 +178,6 @@ HELP
     end
 
     def parse
-      Bolt.log_level = Logger::WARN
-
       if @argv.empty?
         options[:help] = true
       end
@@ -188,9 +197,9 @@ HELP
       options[:object] = remaining.shift
 
       if options[:debug]
-        Bolt.log_level = Logger::DEBUG
+        @config[:log_level] = Logger::DEBUG
       elsif options[:verbose]
-        Bolt.log_level = Logger::INFO
+        @config[:log_level] = Logger::INFO
       end
 
       if options[:help]
@@ -270,31 +279,58 @@ HELP
               "#{MODES.join(', ')}"
       end
 
+      if options[:action].nil?
+        raise Bolt::CLIError,
+              "Expected an action of the form 'bolt #{options[:mode]} <action>'"
+      end
+
       unless ACTIONS.include?(options[:action])
         raise Bolt::CLIError,
               "Expected action '#{options[:action]}' to be one of " \
               "#{ACTIONS.join(', ')}"
       end
 
-      if options[:mode] != 'file' && !options[:leftovers].empty?
+      if options[:mode] != 'file' && options[:mode] != 'script' &&
+         !options[:leftovers].empty?
         raise Bolt::CLIError,
-              "unknown argument(s) #{options[:leftovers].join(', ')}"
+              "Unknown argument(s) #{options[:leftovers].join(', ')}"
+      end
+
+      if %w[task plan].include?(options[:mode])
+        if options[:object].nil?
+          raise Bolt::CLIError, "Must specify a #{options[:mode]} to run"
+        end
+        # This may mean that we parsed a parameter as the object
+        unless options[:object] =~ /\A([a-z][a-z0-9_]*)?(::[a-z][a-z0-9_]*)*\Z/
+          raise Bolt::CLIError,
+                "Invalid #{options[:mode]} '#{options[:object]}'"
+        end
+      end
+
+      unless !options[:nodes].empty? || options[:mode] == 'plan'
+        raise Bolt::CLIError, "Option '--nodes' must be specified"
       end
 
-      unless options[:nodes] || options[:mode] == 'plan'
-        raise Bolt::CLIError, "option --nodes must be specified"
+      if %w[task plan].include?(options[:mode]) && options[:modulepath].nil?
+        raise Bolt::CLIError,
+              "Option '--modulepath' must be specified when running" \
+              " a task or plan"
       end
     end
 
     def handle_parser_errors
       yield
     rescue OptionParser::MissingArgument => e
-      raise Bolt::CLIError, "option '#{e.args.first}' needs a parameter"
+      raise Bolt::CLIError, "Option '#{e.args.first}' needs a parameter"
     rescue OptionParser::InvalidOption => e
-      raise Bolt::CLIError, "unknown argument '#{e.args.first}'"
+      raise Bolt::CLIError, "Unknown argument '#{e.args.first}'"
     end
 
     def execute(options)
+      %i[concurrency user password tty insecure transport].each do |key|
+        config[key] = options[key]
+      end
+
       if options[:mode] == 'plan' || options[:mode] == 'task'
         begin
           require_relative '../../vendored/require_vendored'
@@ -303,19 +339,14 @@ HELP
         end
 
         Puppet::Util::Log.newdestination(:console)
-        Puppet[:log_level] = if Bolt.log_level == Logger::DEBUG
+        Puppet[:log_level] = if @config[:log_level] == Logger::DEBUG
                                'debug'
                              else
                                'notice'
                              end
       end
 
-      config = Bolt::Config.new(concurrency: options[:concurrency],
-                                user: options[:user],
-                                password: options[:password],
-                                tty: options[:tty],
-                                insecure: options[:insecure])
-      executor = Bolt::Executor.new(config)
+      executor = Bolt::Executor.new(@config)
 
       if options[:mode] == 'plan'
         execute_plan(executor, options)
@@ -329,11 +360,13 @@ HELP
             when 'command'
               executor.run_command(nodes, options[:object])
             when 'script'
-              executor.run_script(nodes, options[:object])
+              script = options[:object]
+              validate_file('script', script)
+              executor.run_script(nodes, script, options[:leftovers])
             when 'task'
               task_name = options[:object]
 
-              path, metadata = load_task_data(task_name, options[:modules])
+              path, metadata = load_task_data(task_name, options[:modulepath])
               input_method = metadata['input_method']
 
               input_method ||= 'both'
@@ -346,10 +379,8 @@ HELP
 
               if dest.nil?
                 raise Bolt::CLIError, "A destination path must be specified"
-              elsif !file_exist?(src)
-                raise Bolt::CLIError, "The source file '#{src}' does not exist"
               end
-
+              validate_file('source file', src)
               executor.file_upload(nodes, src, dest)
             end
         end
@@ -362,7 +393,7 @@ HELP
       result = Puppet.override(bolt_executor: executor) do
         run_plan(options[:object],
                  options[:task_options],
-                 options[:modules])
+                 options[:modulepath])
       end
       puts result
     rescue Puppet::Error
@@ -390,44 +421,61 @@ HELP
                           elapsed_time)
     end
 
-    def file_exist?(path)
-      File.exist?(path)
-    end
+    def validate_file(type, path)
+      if path.nil?
+        raise Bolt::CLIError, "A #{type} must be specified"
+      end
 
-    def load_task_data(name, modules)
-      if modules.nil?
-        raise Bolt::CLIError,
-              "The '--modules' option must be specified to run a task"
+      stat = file_stat(path)
+
+      if !stat.readable?
+        raise Bolt::CLIError, "The #{type} '#{path}' is unreadable"
+      elsif !stat.file?
+        raise Bolt::CLIError, "The #{type} '#{path}' is not a file"
       end
+    rescue Errno::ENOENT
+      raise Bolt::CLIError, "The #{type} '#{path}' does not exist"
+    end
+
+    def file_stat(path)
+      File.stat(path)
+    end
 
+    def load_task_data(name, modulepath)
       module_name, file_name = name.split('::', 2)
       file_name ||= 'init'
 
-      env = Puppet::Node::Environment.create('bolt', [modules])
-      Puppet.override(environments: Puppet::Environments::Static.new(env)) do
-        data = Puppet::InfoService::TaskInformationService.task_data(
-          env.name, module_name, name
-        )
+      begin
+        env = Puppet::Node::Environment.create('bolt', modulepath)
+        Puppet.override(environments: Puppet::Environments::Static.new(env)) do
+          data = Puppet::InfoService::TaskInformationService.task_data(
+            env.name, module_name, name
+          )
 
-        file = data[:files].find { |f| File.basename(f, '.*') == file_name }
-        if file.nil?
-          raise Bolt::CLIError, "Failed to load task file for '#{name}'"
-        end
-
-        metadata =
-          if data[:metadata_file]
-            JSON.parse(File.read(data[:metadata_file]))
-          else
-            {}
+          file = data[:files].find { |f| File.basename(f, '.*') == file_name }
+          if file.nil?
+            raise Bolt::CLIError, "Failed to load task file for '#{name}'"
           end
 
-        [file, metadata]
+          metadata =
+            if data[:metadata_file]
+              JSON.parse(File.read(data[:metadata_file]))
+            else
+              {}
+            end
+
+          [file, metadata]
+        end
+      rescue Puppet::Module::Task::TaskNotFound
+        raise  Bolt::CLIError,
+               "Could not find task '#{name}' in module '#{module_name}'"
+      rescue Puppet::Module::MissingModule
+        # Generate message so we don't expose "bolt environment"
+        raise  Bolt::CLIError, "Could not find module '#{module_name}'"
       end
     end
 
-    def run_plan(plan, args, modules)
-      modulepath = modules ? [modules] : []
-
+    def run_plan(plan, args, modulepath)
       Dir.mktmpdir('bolt') do |dir|
         cli = []
         Puppet::Settings::REQUIRED_APP_SETTINGS.each do |setting|

data/lib/bolt/config.rb

@@ -1,14 +1,21 @@
+require 'logger'
+
 module Bolt
   Config = Struct.new(:concurrency,
                       :user,
                       :password,
                       :tty,
-                      :insecure) do
-
+                      :insecure,
+                      :transport,
+                      :log_level,
+                      :log_destination) do
     DEFAULTS = {
       concurrency: 100,
       tty: false,
-      insecure: false
+      insecure: false,
+      transport: 'ssh',
+      log_level: Logger::WARN,
+      log_destination: STDERR
     }.freeze
 
     def initialize(**kwargs)

data/lib/bolt/executor.rb

@@ -1,11 +1,17 @@
+require 'logger'
 require 'concurrent'
 require 'bolt/result'
 require 'bolt/config'
+require 'bolt/formatter'
 
 module Bolt
   class Executor
     def initialize(config = Bolt::Config.new)
       @config = config
+      @logger = Logger.new(config[:log_destination])
+      @logger.progname = 'executor'
+      @logger.level = config[:log_level]
+      @logger.formatter = Bolt::Formatter.new
     end
 
     def from_uris(nodes)
@@ -19,6 +25,12 @@ module Bolt
 
       poolsize = [nodes.length, @config[:concurrency]].min
       pool = Concurrent::FixedThreadPool.new(poolsize)
+      @logger.debug { "Started with #{poolsize} thread(s)" }
+
+      nodes.map(&:class).uniq.each do |klass|
+        klass.initialize_transport(@logger)
+      end
+
       nodes.each { |node|
         pool.post do
           results[node] =
@@ -47,9 +59,9 @@ module Bolt
       end
     end
 
-    def run_script(nodes, script)
+    def run_script(nodes, script, arguments)
       on(nodes) do |node|
-        node.run_script(script)
+        node.run_script(script, arguments)
       end
     end
 

data/lib/bolt/formatter.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+module Bolt
+  class Formatter < Logger::Formatter
+    def call(severity, time, progname, msg)
+      "#{format_datetime(time)} #{severity} #{progname}: #{msg2str(msg)}\n"
+    end
+  end
+end

data/lib/bolt/node.rb

@@ -1,6 +1,6 @@
 require 'logger'
 require 'bolt/node_uri'
-require 'bolt/node/formatter'
+require 'bolt/formatter'
 require 'bolt/result'
 require 'bolt/config'
 
@@ -10,7 +10,7 @@ module Bolt
     ENVIRONMENT_METHODS = %w[both environment].freeze
 
     def self.from_uri(uri_string, **kwargs)
-      uri = NodeURI.new(uri_string)
+      uri = NodeURI.new(uri_string, kwargs[:config][:transport])
       klass = case uri.scheme
               when 'winrm'
                 Bolt::WinRM
@@ -27,11 +27,12 @@ module Bolt
                 **kwargs)
     end
 
+    def self.initialize_transport(_logger); end
+
     attr_reader :logger, :host, :uri, :user, :password
 
     def initialize(host, port = nil, user = nil, password = nil, uri: nil,
-                   config: Bolt::Config.new,
-                   log_level: Bolt.log_level || Logger::WARN)
+                   config: Bolt::Config.new)
       @host = host
       @port = port
       @user = user || config[:user]
@@ -40,14 +41,15 @@ module Bolt
       @insecure = config[:insecure]
       @uri = uri
 
-      @logger = init_logger(level: log_level)
-      @transport_logger = init_logger(level: Logger::WARN)
+      @logger = init_logger(config[:log_destination], config[:log_level])
+      @transport_logger = init_logger(config[:log_destination], Logger::WARN)
     end
 
-    def init_logger(destination: STDERR, level: Logger::WARN)
+    def init_logger(destination, level)
       logger = Logger.new(destination)
+      logger.progname = @host
       logger.level = level
-      logger.formatter = Bolt::Node::Formatter.new(@host)
+      logger.formatter = Bolt::Formatter.new
       logger
     end
 
@@ -66,8 +68,8 @@ module Bolt
       _run_command(command).to_command_result
     end
 
-    def run_script(script)
-      _run_script(script).to_command_result
+    def run_script(script, arguments)
+      _run_script(script, arguments).to_command_result
     end
 
     def run_task(task, input_method, arguments)

data/lib/bolt/node/orch.rb

@@ -105,12 +105,13 @@ module Bolt
       _run_task(BOLT_MOCK_FILE, 'stdin', params)
     end
 
-    def _run_script(script)
+    def _run_script(script, arguments)
       content = File.open(script, &:read)
       content = Base64.encode64(content)
       params = {
         action: 'script',
-        content: content
+        content: content,
+        arguments: arguments
       }
       unwrap_bolt_result(_run_task(BOLT_MOCK_FILE, 'stdin', params))
     end

data/lib/bolt/node/ssh.rb

@@ -1,10 +1,19 @@
+require 'json'
+require 'shellwords'
 require 'net/ssh'
 require 'net/sftp'
-require 'json'
 require 'bolt/node/result'
 
 module Bolt
   class SSH < Node
+    def self.initialize_transport(logger)
+      require 'net/ssh/krb'
+    rescue LoadError
+      logger.debug {
+        "Authentication method 'gssapi-with-mic' is not available"
+      }
+    end
+
     def connect
       options = {
         logger: @transport_logger,
@@ -131,10 +140,12 @@ module Bolt
       execute(command)
     end
 
-    def _run_script(script)
+    def _run_script(script, arguments)
       @logger.info { "Running script '#{script}'" }
+      @logger.debug { "arguments: #{arguments}" }
+
       with_remote_file(script) do |remote_path|
-        execute("'#{remote_path}'")
+        execute("'#{remote_path}' #{Shellwords.join(arguments)}")
       end
     end
 

data/lib/bolt/node/winrm.rb

@@ -41,7 +41,8 @@ module Bolt
       return Bolt::Node::Success.new if @shell_initialized
       result = execute(<<-PS)
 
-$ENV:PATH += ";${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\sys\\ruby\\bin\\"
+$ENV:PATH += ";${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\bin\\;" +
+  "${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\sys\\ruby\\bin\\"
 $ENV:RUBYLIB = "${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\puppet\\lib;" +
   "${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\facter\\lib;" +
   "${ENV:ProgramFiles}\\Puppet Labs\\Puppet\\hiera\\lib;" +
@@ -70,6 +71,7 @@ function Invoke-Interpreter
 
   $startInfo = New-Object System.Diagnostics.ProcessStartInfo($Path, $Arguments)
   $startInfo.UseShellExecute = $false
+  $startInfo.WorkingDirectory = Split-Path -Parent (Get-Command $Path).Path
   if ($StdinInput) { $startInfo.RedirectStandardInput = $true }
   $startInfo.RedirectStandardOutput = $true
   $startInfo.RedirectStandardError = $true
@@ -129,12 +131,20 @@ PS
     # 10 minutes in milliseconds
     DEFAULT_EXECUTION_TIMEOUT = 10 * 60 * 1000
 
-    def execute_process(path = '', arguments = '', stdin = nil,
+    def execute_process(path = '', arguments = [], stdin = nil,
                         timeout_ms = DEFAULT_EXECUTION_TIMEOUT)
+      quoted_args = arguments.map do |arg|
+        "'" + arg.gsub("'", "''") + "'"
+      end.join(',')
+
       execute(<<-PS)
+$quoted_array = @(
+  #{quoted_args}
+)
+
 $invokeArgs = @{
   Path = "#{path}"
-  Arguments = "#{arguments.gsub('"', '""')}"
+  Arguments = $quoted_array -Join ' '
   Timeout = #{timeout_ms}
   #{stdin.nil? ? '' : "StdinInput = @'\n" + stdin + "\n'@"}
 }
@@ -144,22 +154,28 @@ $LASTEXITCODE = Invoke-Interpreter @invokeArgs
 PS
     end
 
-    VALID_EXTENSIONS = ['.ps1', '.rb'].freeze
+    VALID_EXTENSIONS = ['.ps1', '.rb', '.pp'].freeze
 
-    PS_ARGS =
-      '-NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass'.freeze
+    PS_ARGS = %w[
+      -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass
+    ].freeze
 
     def process_from_extension(path)
       case Pathname(path).extname.downcase
       when '.rb'
         [
           'ruby.exe',
-          "-S \"#{path}\""
+          ['-S', "\"#{path}\""]
         ]
       when '.ps1'
         [
           'powershell.exe',
-          "#{PS_ARGS} -File \"#{path}\""
+          [*PS_ARGS, '-File', "\"#{path}\""]
+        ]
+      when '.pp'
+        [
+          'puppet.bat',
+          ['apply', "\"#{path}\""]
         ]
       end
     end
@@ -214,10 +230,11 @@ PS
       execute(command)
     end
 
-    def _run_script(script)
+    def _run_script(script, arguments)
       @logger.info { "Running script '#{script}'" }
       with_remote_file(script) do |remote_path|
-        args = "#{PS_ARGS} -File \"#{remote_path}\""
+        args = [*PS_ARGS, '-File', "\"#{remote_path}\""]
+        args += escape_arguments(arguments)
         execute_process('powershell.exe', args)
       end
     end
@@ -241,7 +258,18 @@ PS
         Bolt::Node::Success.new
       end.then do
         with_remote_file(task) do |remote_path|
-          execute_process(*process_from_extension(remote_path), stdin)
+          path, args = *process_from_extension(remote_path)
+          execute_process(path, args, stdin)
+        end
+      end
+    end
+
+    def escape_arguments(arguments)
+      arguments.map do |arg|
+        if arg =~ / /
+          "\"#{arg}\""
+        else
+          arg
         end
       end
     end

data/lib/bolt/node_uri.rb

@@ -2,19 +2,20 @@ require 'addressable'
 
 module Bolt
   class NodeURI
-    def initialize(string)
-      @uri = parse(string)
+    def initialize(string, transport = 'ssh')
+      @uri = parse(string, transport)
     end
 
-    def parse(string)
-      uri = if string =~ %r{^(ssh|winrm|pcp)://}
+    def parse(string, transport)
+      uri = if string =~ %r{^[^:]+://}
               Addressable::URI.parse(string)
             else
-              Addressable::URI.parse("ssh://#{string}")
+              Addressable::URI.parse("#{transport}://#{string}")
             end
       uri.port ||= 5985 if uri.scheme == 'winrm'
       uri
     end
+    private :parse
 
     def hostname
       @uri.hostname

data/lib/bolt/version.rb

@@ -1,3 +1,3 @@
 module Bolt
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -281,9 +281,9 @@ files:
 - lib/bolt/cli.rb
 - lib/bolt/config.rb
 - lib/bolt/executor.rb
+- lib/bolt/formatter.rb
 - lib/bolt/node.rb
 - lib/bolt/node/errors.rb
-- lib/bolt/node/formatter.rb
 - lib/bolt/node/orch.rb
 - lib/bolt/node/result.rb
 - lib/bolt/node/ssh.rb

data/lib/bolt/node/formatter.rb

@@ -1,15 +0,0 @@
-require 'logger'
-
-module Bolt
-  class Node
-    class Formatter < Logger::Formatter
-      def initialize(host)
-        @host = host
-      end
-
-      def call(severity, time, _progname, msg)
-        "#{format_datetime(time)} #{severity} #{@host}: #{msg2str(msg)}\n"
-      end
-    end
-  end
-end