bolt 0.17.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9ea02d63dd2b45747f5eda9d07187f39842332f
-  data.tar.gz: 3768ff96fafe4b6cb9d05fdad94c17ce3809e2be
+  metadata.gz: 9b5850dae92768743f9faa35a5972efc6c3b83da
+  data.tar.gz: 80c524fd01e4b66c1d969e1c98fe29bbf836369d
 SHA512:
-  metadata.gz: 26863769817e4f0b644041dc32b2eda8c961d75ab34bc805db0ff497ff8c624672c5d3d6051cdd6add2fa921e862310d9236879cacf61aa35144fd795f159c03
-  data.tar.gz: 6b767b8e2dab9368e0bd5bc7feee4b397f18a39005eca646d2bad44e3a400bdca5009f1e6d1e51d1688ab8265e02996a2b127840e918cdd405c618a6fe00a52c
+  metadata.gz: 50ee00db02f62fafeb43d1553186442728db8dfc8d69ec646fd284415b6595c78445a95435d90fd894071ce5c7c39ec3d0f06dbb52337be648e237ebebb97677
+  data.tar.gz: bc78146c6b867e02c70fb4ea612c498a6ac1260917c490a31c0435a4978a1777fc763f34013e31d65d88dedb537a647ed2656a6a92a7d3ede3af13191b48f256

data/bolt-modules/boltlib/lib/puppet/datatypes/result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Puppet::DataTypes.create_type('Result') do
   interface <<-PUPPET
     attributes => {

data/bolt-modules/boltlib/lib/puppet/datatypes/resultset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Puppet::DataTypes.create_type('ResultSet') do
   interface <<-PUPPET
     attributes => {

data/bolt-modules/boltlib/lib/puppet/datatypes/target.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Puppet::DataTypes.create_type('Target') do
   interface <<-PUPPET
     attributes => {

data/bolt-modules/boltlib/lib/puppet/functions/add_facts.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+
+# Deep merges a hash of facts with the existing facts has on a target.
+
+Puppet::Functions.create_function(:add_facts) do
+  dispatch :add_facts do
+    param 'Target', :target
+    param 'Hash', :facts
+  end
+
+  def add_facts(target, facts)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Puppet::Pops::Issues::TASK_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, operation: 'add_facts'
+      )
+    end
+
+    inventory = Puppet.lookup(:bolt_inventory) { nil }
+
+    unless inventory
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('add facts')
+      )
+    end
+
+    inventory.add_facts(target, facts)
+  end
+end

data/bolt-modules/boltlib/lib/puppet/functions/facts.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+
+# Returns the facts hash for a target.
+# This functions takes one parameter, the target to get facts for
+Puppet::Functions.create_function(:facts) do
+  dispatch :facts do
+    param 'Target', :target
+    return_type 'Hash[String, Data]'
+  end
+
+  def facts(target)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Puppet::Pops::Issues::TASK_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, operation: 'facts'
+      )
+    end
+
+    inventory = Puppet.lookup(:bolt_inventory) { nil }
+
+    unless inventory
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('get facts for a target')
+      )
+    end
+
+    inventory.facts(target)
+  end
+end

data/bolt-modules/boltlib/lib/puppet/functions/fail_plan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Raises a Bolt::PlanFailure exception to signal to callers that the plan failed
@@ -20,7 +22,7 @@ Puppet::Functions.create_function(:fail_plan) do
     raise Bolt::PlanFailure.new(msg, kind || 'bolt/plan-failure', details, issue_code)
   end
 
-  def from_error(e)
-    from_args(e.message, e.kind, e.details, e.issue_code)
+  def from_error(err)
+    from_args(err.message, err.kind, err.details, err.issue_code)
   end
 end

data/bolt-modules/boltlib/lib/puppet/functions/file_upload.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Uploads the given file or directory to the given set of targets and returns the result from each upload.

data/bolt-modules/boltlib/lib/puppet/functions/get_targets.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Parses common ways of referring to targets and returns an array of Targets.

data/bolt-modules/boltlib/lib/puppet/functions/run_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Runs a command on the given set of targets and returns the result from each command execution.

data/bolt-modules/boltlib/lib/puppet/functions/run_plan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Runs the `plan` referenced by its name passing giving arguments to it given as a hash of name to value mappings.
@@ -47,8 +49,7 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
       begin
         result = func.class.dispatcher.dispatchers[0].call_by_name_with_scope(scope, params, true)
       rescue Puppet::PreformattedError => err
-        if named_args['_catch_errors'] &&
-           err.respond_to?(:cause) && err.cause && err.cause.is_a?(Bolt::Error)
+        if named_args['_catch_errors'] && err.cause.is_a?(Bolt::Error)
           result = err.cause.to_puppet_error
         else
           raise err

data/bolt-modules/boltlib/lib/puppet/functions/run_script.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Uploads the given script to the given set of targets and returns the result of having each target execute the script.
 #
 # * This function does nothing if the list of targets is empty.
@@ -45,7 +47,6 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
     # Ensure that given targets are all Target instances)
     targets = inventory.get_targets(targets)
 
-    #
     r = if targets.empty?
           Bolt::ResultSet.new([])
         else

data/bolt-modules/boltlib/lib/puppet/functions/run_task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Runs a given instance of a `Task` on the given set of targets and returns the result from each.

data/bolt-modules/boltlib/lib/puppet/functions/set_var.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Sets a variable { key => value } for a target.
@@ -24,6 +26,12 @@ Puppet::Functions.create_function(:set_var) do
 
     inventory = Puppet.lookup(:bolt_inventory) { nil }
 
+    unless inventory
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('set a var on a target')
+      )
+    end
+
     inventory.set_var(target, key, value)
   end
 end

data/bolt-modules/boltlib/lib/puppet/functions/vars.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bolt/error'
 
 # Returns a hash of the 'vars' (variables) assigned to a target through the
@@ -16,12 +18,18 @@ Puppet::Functions.create_function(:vars) do
   def vars(target)
     unless Puppet[:tasks]
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
-        Puppet::Pops::Issues::TASK_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, operation: 'set_var'
+        Puppet::Pops::Issues::TASK_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, operation: 'vars'
       )
     end
 
     inventory = Puppet.lookup(:bolt_inventory) { nil }
 
+    unless inventory
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('get vars')
+      )
+    end
+
     inventory.vars(target)
   end
 end

data/exe/bolt

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bolt'
 require 'bolt/cli'

data/exe/bolt-inventory-pdb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bolt_ext/puppetdb_inventory'
 

data/lib/bolt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bolt
   require 'bolt/executor'
 end

data/lib/bolt/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'benchmark'
 require 'json'
@@ -26,7 +28,7 @@ module Bolt
 
   class CLI
     class BoltOptionParser < OptionParser
-      BANNER = <<-HELP.freeze
+      BANNER = <<-HELP
 Usage: bolt <subcommand> <action> [options]
 
 Available subcommands:
@@ -43,7 +45,7 @@ Available subcommands:
 where [options] are:
       HELP
 
-      TASK_HELP = <<-HELP.freeze
+      TASK_HELP = <<-HELP
 Usage: bolt task <action> <task> [options] [parameters]
 
 Available actions are:
@@ -56,7 +58,7 @@ Parameters are of the form <parameter>=<value>.
 Available options are:
       HELP
 
-      COMMAND_HELP = <<-HELP.freeze
+      COMMAND_HELP = <<-HELP
 Usage: bolt command <action> <command> [options]
 
 Available actions are:
@@ -65,7 +67,7 @@ Available actions are:
 Available options are:
       HELP
 
-      SCRIPT_HELP = <<-HELP.freeze
+      SCRIPT_HELP = <<-HELP
 Usage: bolt script <action> <script> [[arg1] ... [argN]] [options]
 
 Available actions are:
@@ -74,7 +76,7 @@ Available actions are:
 Available options are:
       HELP
 
-      PLAN_HELP = <<-HELP.freeze
+      PLAN_HELP = <<-HELP
 Usage: bolt plan <action> <plan> [options] [parameters]
 
 Available actions are:
@@ -87,7 +89,7 @@ Parameters are of the form <parameter>=<value>.
 Available options are:
       HELP
 
-      FILE_HELP = <<-HELP.freeze
+      FILE_HELP = <<-HELP
 Usage: bolt file <action> [options]
 
 Available actions are:
@@ -168,7 +170,7 @@ Available options are:
         end
         define('--modulepath MODULES',
                'List of directories containing modules, ' \
-               'separated by ' << File::PATH_SEPARATOR) do |modulepath|
+               "separated by #{File::PATH_SEPARATOR}") do |modulepath|
           @options[:modulepath] = modulepath.split(File::PATH_SEPARATOR)
         end
         define('--params PARAMETERS',
@@ -188,8 +190,12 @@ Available options are:
                'Use SSL with WinRM') do |ssl|
           @options[:ssl] = ssl
         end
+        define('--[no-]ssl-verify',
+               'Verify remote host SSL certificate with WinRM') do |ssl_verify|
+          @options[:'ssl-verify'] = ssl_verify
+        end
         define('--transport TRANSPORT', TRANSPORTS.keys.map(&:to_s),
-               'Specify a default transport: ' << TRANSPORTS.keys.join(', ')) do |t|
+               "Specify a default transport: #{TRANSPORTS.keys.join(', ')}") do |t|
           @options[:transport] = t
         end
         define('--run-as USER',
@@ -317,34 +323,28 @@ Available options are:
     end
     private :inventory
 
+    def help?(parser, remaining)
+      # Set the mode
+      options[:mode] = remaining.shift
+
+      if options[:mode] == 'help'
+        options[:help] = true
+        options[:mode] = remaining.shift
+      end
+
+      # Update the parser for the new mode
+      parser.update
+
+      options[:help]
+    end
+    private :help?
+
     def parse
       parser = BoltOptionParser.new(options)
 
-      if @argv.empty? ||
-         begin
-           # RuboCop apparently doesn't realize this is a block and issues
-           # the Lint/AssignmentInCondition warning for every assignment in
-           # it, so we disable that warning here.
-           # rubocop:disable Lint/AssignmentInCondition
-           remaining = handle_parser_errors do
-             parser.permute(@argv)
-           end
-
-           # Set the mode
-           options[:mode] = remaining.shift
-
-           if options[:mode] == 'help'
-             options[:help] = true
-             options[:mode] = remaining.shift
-           end
-
-           # Update the parser for the new mode
-           parser.update
-
-           options[:help]
-           # rubocop:enable Lint/AssignmentInCondition
-         end
-      then # rubocop:disable Style/MultilineIfThen
+      # This part aims to handle both `bolt <mode> --help` and `bolt help <mode>`.
+      remaining = handle_parser_errors { parser.permute(@argv) } unless @argv.empty?
+      if @argv.empty? || help?(parser, remaining)
         puts parser.help
         raise Bolt::CLIExit
       end
@@ -366,7 +366,9 @@ Available options are:
                 "Parameters must be specified through either the --params " \
                 "option or param=value pairs, not both"
         end
+        options[:params_parsed] = true
       else
+        options[:params_parsed] = false
         options[:task_options] = Hash[task_options.map { |a| a.split('=', 2) }]
       end
 
@@ -467,7 +469,7 @@ Available options are:
 
       handler = Signal.trap :INT do |signo|
         @logger.info(
-          "Exiting after receiving SIG#{Signal.signame(signo)} signal." << (message ? ' ' << message : '')
+          "Exiting after receiving SIG#{Signal.signame(signo)} signal.#{message ? ' ' + message : ''}"
         )
         exit!
       end
@@ -499,6 +501,10 @@ Available options are:
 
       message = 'There may be processes left executing on some nodes.'
 
+      if options[:task_options] && !options[:params_parsed] && pal
+        options[:task_options] = pal.parse_params(options[:mode], options[:object], options[:task_options])
+      end
+
       if options[:mode] == 'plan'
         unless options[:nodes].empty?
           if options[:task_options]['nodes']

data/lib/bolt/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'logging'
 require 'bolt/cli'
@@ -48,7 +50,8 @@ module Bolt
         'host-key-check' => true
       },
       winrm: {
-        'ssl' => true
+        'ssl' => true,
+        'ssl-verify' => true
       },
       pcp: {
         'task-environment' => 'production',
@@ -96,7 +99,7 @@ module Bolt
     def normalize_log(target)
       return target if target == 'console'
       target = target[5..-1] if target.start_with?('file:')
-      'file:' << File.expand_path(target)
+      'file:' + File.expand_path(target)
     end
 
     def update_from_file(data)
@@ -164,6 +167,10 @@ module Bolt
         self[:transports][:winrm]['ssl'] = options[:ssl]
       end
 
+      if options.key?(:'ssl-verify') # this defaults to true so we need to check the presence of the key
+        self[:transports][:winrm]['ssl-verify'] = options[:'ssl-verify']
+      end
+
       if options.key?(:'host-key-check') # this defaults to true so we need to check the presence of the key
         self[:transports][:ssh]['host-key-check'] = options[:'host-key-check']
       end

data/lib/bolt/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bolt
   class Error < RuntimeError
     attr_reader :kind, :details, :issue_code, :error_code

data/lib/bolt/executor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Used for $ERROR_INFO. This *must* be capitalized!
 require 'English'
 require 'json'