bolt 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5cea3288b0599937b773308e2f7286661c8e325ee2f04cb69b7e5521423d487
-  data.tar.gz: c1bffcef93f5167db8ecc2a21ce934a74b59ea40280a91b1bbcfde9b74d1b6dc
+  metadata.gz: c0387b7b6348b7003f02a2433a92e90c73464ac6a7d1cf135c847142bc44cb52
+  data.tar.gz: 502dc3c14c15925ff40604763b4cf5dc1e83d222e37b6c0a47cb5827f696e236
 SHA512:
-  metadata.gz: 07a86d3b9ab1a6d5d736a00e1384a0955164db3a978f5a3532d9422396116df5c024254c10afeed4af7a9253acd0bc64a78b640531716e5fe917f54b2deca3da
-  data.tar.gz: e30621636ccc9a6da616b7b9802a7aee40c99146e6983c89358332f091c004c3430a963beb2ebe3b1bee5685b2fa5e7be578a907be80971fa07fea0362b3ba7b
+  metadata.gz: 8c89fe321fc1c14d00cc011fa346241aa140d5da3cce8f6ea9624e46df8e35a61a5cc4055371d94b61b2d53c46868f1a8dcbdf69ac1f05e065955b65ad36c3dd
+  data.tar.gz: 4a1ed6da115e53825f75f5a27a7452e57037874d0665244d8bf2a35aa7ab591765bbc8a879d3bbcf8737b20500b29dca1a60f7a46860bc22a71047f48a248fe9

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Catches errors in a given block and returns them. This will return the
+# output of the block if no errors are raised. Accepts an optional list of
+# error kinds to catch.
+#
+# **NOTE:** Not available in apply block
+Puppet::Functions.create_function(:catch_errors) do
+  # @param error_types An array of error types to catch
+  # @param block The block of steps to catch errors on
+  # @return Undef If an error is raised in the block then the error will be
+  # returned, otherwise the result will be returned
+  # @example Catch errors for a block
+  #   catch_errors() || {
+  #     run_command("whoami", $nodes)
+  #     run_command("adduser ryan", $nodes)
+  #   }
+  # @example Catch parse errors for a block of code
+  #   catch_errors(['bolt/parse-error']) || {
+  #    run_plan('canary', $nodes)
+  #    run_plan('other_plan)
+  #    apply($nodes) || {
+  #      notify { "Hello": }
+  #    }
+  #   }
+  dispatch :catch_errors do
+    optional_param 'Array[String[1]]', :error_types
+    block_param 'Callable[0, 0]', :block
+  end
+
+  def catch_errors(error_types = nil)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue
+        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+                              action: self.class.name)
+    end
+
+    executor = Puppet.lookup(:bolt_executor)
+    executor.report_function_call(self.class.name)
+
+    begin
+      yield
+    rescue Puppet::PreformattedError => e
+      if e.cause.is_a?(Bolt::Error)
+        if error_types.nil?
+          return e.cause.to_puppet_error
+        elsif error_types.include?(e.cause.to_h['kind'])
+          return e.cause.to_puppet_error
+        else
+          raise e
+        end
+      else
+        raise e
+      end
+    end
+  end
+end

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

@@ -7,9 +7,9 @@ require 'bolt/error'
 #
 # **NOTE:** Not available in apply block
 Puppet::Functions.create_function(:upload_file, Puppet::Functions::InternalFunction) do
-  # Upload a file.
-  # @param source A source path, either an absolute path or a modulename/filename selector for a file in
-  #               <moduleroot>/files.
+  # Upload a file or directory.
+  # @param source A source path, either an absolute path or a modulename/filename selector for a
+  #               file or directory in <moduleroot>/files.
   # @param destination An absolute path on the target(s).
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param options Additional options: '_catch_errors', '_run_as'.
@@ -27,9 +27,9 @@ Puppet::Functions.create_function(:upload_file, Puppet::Functions::InternalFunct
     return_type 'ResultSet'
   end
 
-  # Upload a file, logging the provided description.
-  # @param source A source path, either an absolute path or a modulename/filename selector for a file in
-  #               <moduleroot>/files.
+  # Upload a file or directory, logging the provided description.
+  # @param source A source path, either an absolute path or a modulename/filename selector for a
+  #               file or directory in <moduleroot>/files.
   # @param destination An absolute path on the target(s).
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param description A description to be output when calling this function.

data/lib/bolt/bolt_option_parser.rb

@@ -22,7 +22,7 @@ Usage: bolt <subcommand> <action> [options]
 
 Available subcommands:
   bolt command run <command>       Run a command remotely
-  bolt file upload <src> <dest>    Upload a local file
+  bolt file upload <src> <dest>    Upload a local file or directory
   bolt script run <script>         Upload a local script and run it remotely
   bolt task show                   Show list of available tasks
   bolt task show <task>            Show documentation for task
@@ -93,7 +93,7 @@ Available options are:
 Usage: bolt file <action> [options]
 
 Available actions are:
-  upload <src> <dest>              Upload local file <src> to <dest> on each node
+  upload <src> <dest>              Upload local file or directory <src> to <dest> on each node
 
 #{examples('file upload /tmp/source /etc/profile.d/login.sh', 'upload a file to')}
 Available options are:

data/lib/bolt/config.rb

@@ -40,7 +40,7 @@ module Bolt
                            private-key tty tmpdir user connect-timeout
                            cacert token-file service-url interpreters file-protocol smb-port].freeze
 
-    PUPPETFILE_OPTIONS = %w[proxy].freeze
+    PUPPETFILE_OPTIONS = %w[proxy forge].freeze
 
     def self.default
       new(Bolt::Boltdir.new('.'), {})

data/lib/bolt/executor.rb

@@ -292,7 +292,11 @@ module Bolt
               wait_until(wait_time, retry_interval) { transport.batch_connected?(batch) }
               batch.map { |target| Result.new(target) }
             rescue TimeoutError => e
-              batch.map { |target| Result.from_exception(target, e) }
+              available, unavailable = batch.partition { |target| transport.batch_connected?([target]) }
+              (
+                available.map { |target| Result.new(target) } +
+                unavailable.map { |target| Result.from_exception(target, e) }
+              )
             end
           end
         end

data/lib/bolt/transport/local_windows.rb

@@ -63,7 +63,8 @@ module Bolt
       private :with_tmpscript
 
       def execute(*command, options)
-        command.unshift(options[:interpreter]) if options[:interpreter]
+        # Interpreter can be an array or string. It will be appended to the command array.
+        command.unshift(options[:interpreter]).flatten! if options[:interpreter]
         command = [options[:env]] + command if options[:env]
 
         if options[:stdin]
@@ -106,7 +107,8 @@ module Bolt
           arguments = unwrap_sensitive_args(arguments)
           if Powershell.powershell_file?(file)
             command = Powershell.run_script(arguments, file)
-            output = execute(command, dir: dir, env: "powershell.exe")
+            interpreter = ['powershell.exe', *Powershell.ps_args]
+            output = execute(command, dir: dir, interpreter: interpreter)
           else
             path, args = *Powershell.process_from_extension(file)
             args += Powershell.escape_arguments(arguments)
@@ -166,7 +168,7 @@ module Bolt
           if Powershell.powershell_file?(script) && stdin.nil?
             command = Powershell.run_ps_task(arguments, script, input_method)
             command = environment_params + Powershell.shell_init + command
-            interpreter ||= 'powershell.exe'
+            interpreter ||= ['powershell.exe', *Powershell.ps_args]
             output =
               if input_method == 'powershell'
                 execute(command, dir: dir, interpreter: interpreter)

data/lib/bolt/transport/powershell.rb

@@ -4,9 +4,9 @@ module Bolt
   module Transport
     module Powershell
       class << self
-        PS_ARGS = %w[
-          -NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass
-        ].freeze
+        def ps_args
+          %w[-NoProfile -NonInteractive -NoLogo -ExecutionPolicy Bypass]
+        end
 
         def powershell_file?(path)
           Pathname(path).extname.casecmp('.ps1').zero?
@@ -22,7 +22,7 @@ module Bolt
           when '.ps1'
             [
               'powershell.exe',
-              [*PS_ARGS, '-File', "\"#{path}\""]
+              [*ps_args, '-File', "\"#{path}\""]
             ]
           when '.pp'
             [

data/lib/bolt/transport/winrm/connection.rb

@@ -77,7 +77,7 @@ module Bolt
             theres_your_problem = "\nAre you using SSL to connect to a non-SSL port?"
           end
           if target.options['ssl-verify'] && e.message.include?('certificate verify failed')
-            theres_your_problem = "\nIs the remote host using a self-signed SSL"\
+            theres_your_problem = "\nIs the remote host using a self-signed SSL "\
                                   "certificate? Use --no-ssl-verify to disable "\
                                   "remote host SSL verification."
           end

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '1.22.0'
+  VERSION = '1.23.0'
 end

data/modules/canary/plans/init.pp

@@ -1,3 +1,30 @@
+# @summary
+#   Run a task, command or script on canary nodes before running it on all nodes.
+#
+# This plan accepts a action and a $nodes parameter. The action can be the name
+# of a task, a script or a command to run. It will run the action on a canary
+# group of nodes and only continue to the rest of the nodes if it succeeds on
+# all canaries. This returns a ResultSet object with a Result for every node.
+# Any skipped nodes will have a 'canary/skipped-node' error kind.
+#
+# @param task
+#  The name of the task to run. Mutually exclusive with command and script.
+# @param command
+#   The command to run. Mutually exclusive with task and script.
+# @param script
+#   The script to run. Mutually exclusive with task and command.
+# @param nodes
+#   The target to run on.
+# @param params
+#   The parameters to use for the task.
+# @param canary_size
+#   How many targets to use in the canary group.
+#
+# @return ResultSet a merged resultset from running the action on all targets
+#
+# @example Run a command
+#   run_plan(canary, command => 'whoami', nodes => $mynodes)
+
 plan canary(
   Optional[String[0]] $task = undef,
   Optional[String[0]] $command = undef,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -326,6 +326,7 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/add_facts.rb
 - bolt-modules/boltlib/lib/puppet/functions/add_to_group.rb
 - bolt-modules/boltlib/lib/puppet/functions/apply_prep.rb
+- bolt-modules/boltlib/lib/puppet/functions/catch_errors.rb
 - bolt-modules/boltlib/lib/puppet/functions/facts.rb
 - bolt-modules/boltlib/lib/puppet/functions/fail_plan.rb
 - bolt-modules/boltlib/lib/puppet/functions/get_resources.rb