bolt 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bf0d0dd4615b52385ed0e9322d17ecaee392951
-  data.tar.gz: 6d5c006a8e472c547a99a24c90769b041730c24f
+  metadata.gz: b45ba6bf81dbfe329d47a503bf505f1eaf3e5449
+  data.tar.gz: 7d701baa18ad45ddec7cf1cdca86c06e41df1178
 SHA512:
-  metadata.gz: ec8f8eb029f0b7a35ee7bce810859c3d2c143ec25bf5ad08544e9a79a8dc28831f721d2fa6037c188ec874d57678eb80e6ae4d1c681e70a7a998d8f07f627e08
-  data.tar.gz: '09ea1f87c8b36045fd6e55837d89977a1106efec8882797dcd9a11297518ab845feedc766fb8a957b87f6c427168992695808eb5fea173c06878715b0e1379f9'
+  metadata.gz: 28a20849dbc613f7aea831a27162906e7b70a988b97e75931fc17f6bb9605bc9d731aaa1778182f070188b5f84ba74654e40c95cef405e8987139e93fea419f8
+  data.tar.gz: c875018a2539e59aedb3c247ec41faad45f86e1aa12ab3dfc6ac7eb6553b1203d6c730596e1d67e4c6e37c2e97a977bb9fd594e1543a1b316a791fddb4fc5a1b

data/lib/bolt/cli.rb

@@ -109,6 +109,7 @@ HELP
       }
       @config = Bolt::Config.new
       @parser = create_option_parser(@options)
+      @logger = Logger.new(STDERR)
     end
 
     def create_option_parser(results)
@@ -186,11 +187,6 @@ HELP
                 "User to run as using privilege escalation") do |user|
           results[:run_as] = user
         end
-        opts.on('--sudo [PROGRAM]',
-                "Program to execute for privilege escalation. " \
-                "Currently only sudo is supported.") do |program|
-          results[:sudo] = program || 'sudo'
-        end
         opts.on('--sudo-password [PASSWORD]',
                 'Password for privilege escalation') do |password|
           if password.nil?

data/lib/bolt/config.rb

@@ -21,7 +21,7 @@ module Bolt
       log_destination: STDERR
     }.freeze
 
-    TRANSPORT_OPTIONS = %i[insecure password run_as sudo sudo_password
+    TRANSPORT_OPTIONS = %i[insecure password run_as sudo_password
                            key tty tmpdir user connect_timeout cacert
                            token_file orch_task_environment service_url].freeze
 
@@ -112,6 +112,9 @@ module Bolt
         if data['ssh']['tmpdir']
           self[:transports][:ssh][:tmpdir] = data['ssh']['tmpdir']
         end
+        if data['ssh']['run-as']
+          self[:transports][:ssh][:run_as] = data['ssh']['run-as']
+        end
       end
 
       if data['winrm']
@@ -167,14 +170,17 @@ 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
       TRANSPORTS.each do |transport|
-        tconf = self[:transports][transport]
-        if tconf[:sudo] && tconf[:sudo] != 'sudo'
-          raise Bolt::CLIError, "Only 'sudo' is supported for privilege escalation."
-        end
+        self[:transports][transport]
       end
 
       unless %w[human json].include? self[:format]

data/lib/bolt/execution_result.rb

@@ -13,7 +13,7 @@ module Bolt
       end
 
       def to_s
-        Puppet::Pops::Types::StringConverter.singleton.convert(self)
+        @result_hash.to_s
       end
     else
       def iterator

data/lib/bolt/node.rb

@@ -46,7 +46,6 @@ module Bolt
       @tty = transport_conf[:tty]
       @insecure = transport_conf[:insecure]
       @connect_timeout = transport_conf[:connect_timeout]
-      @sudo = transport_conf[:sudo]
       @sudo_password = transport_conf[:sudo_password]
       @run_as = transport_conf[:run_as]
       @tmpdir = transport_conf[:tmpdir]

data/lib/bolt/node/ssh.rb

@@ -99,7 +99,7 @@ module Bolt
 
     def execute(command, sudoable: false, **options)
       result_output = Bolt::Node::Output.new
-      use_sudo = sudoable && (@sudo || @run_as)
+      use_sudo = sudoable && @run_as
       if use_sudo
         user_clause = if @run_as
                         "-u #{@run_as}"
@@ -276,7 +276,7 @@ SCRIPT
 
     def _run_task(task, input_method, arguments)
       export_args = {}
-      stdin = nil
+      stdin, output = nil
 
       @logger.info { "Running task '#{task}'" }
       @logger.debug { "arguments: #{arguments}\ninput_method: #{input_method}" }
@@ -291,15 +291,21 @@ SCRIPT
         end.join(' ')
       end
 
-      with_remote_task(task, stdin) do |remote_path|
-        command = if export_args.empty?
-                    "'#{remote_path}'"
-                  else
-                    "#{export_args} '#{remote_path}'"
-                  end
-        output = execute(command, sudoable: true)
-        Bolt::TaskResult.from_output(output)
+      command = export_args.empty? ? '' : "#{export_args} "
+
+      if @run_as
+        with_remote_task(task, stdin) do |remote_path|
+          command += "'#{remote_path}'"
+          output = execute(command, sudoable: true)
+        end
+      else
+        with_remote_file(task) do |remote_path|
+          command += "'#{remote_path}'"
+          output = execute(command, stdin: stdin)
+        end
       end
+      Bolt::TaskResult.from_output(output)
+
     # TODO: We should be able to rely on the excutor for this but it will mean
     # a test refactor
     rescue StandardError => e

data/lib/bolt/version.rb

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

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

@@ -15,6 +15,7 @@ Puppet::Functions.create_function(:file_upload, Puppet::Functions::InternalFunct
     param 'String[1]', :source
     param 'String[1]', :destination
     repeated_param 'TargetOrTargets', :targets
+    return_type 'ExecutionResult'
   end
 
   def file_upload(scope, source, destination, *targets)

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

@@ -13,6 +13,7 @@ Puppet::Functions.create_function(:run_command) do
   dispatch :run_command do
     param 'String[1]', :command
     repeated_param 'TargetOrTargets', :targets
+    return_type 'ExecutionResult'
   end
 
   def run_command(command, *targets)

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

@@ -15,12 +15,14 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
     param 'String[1]', :script
     param 'TargetOrTargets', :targets
     param 'Struct[arguments => Array[String]]', :arguments
+    return_type 'ExecutionResult'
   end
 
   dispatch :run_script do
     scope_param
     param 'String[1]', :script
     repeated_param 'TargetOrTargets', :targets
+    return_type 'ExecutionResult'
   end
 
   def run_script(scope, script, *targets)

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

@@ -14,6 +14,7 @@ Puppet::Functions.create_function(:run_task) do
     param 'String[1]', :task_name
     param 'TargetOrTargets', :targets
     optional_param 'Hash[String[1], Any]', :task_args
+    return_type 'ExecutionResult'
   end
 
   # this is used from 'bolt task run'
@@ -56,6 +57,11 @@ Puppet::Functions.create_function(:run_task) do
     task_signature.runnable_with?(use_args) do |mismatch|
       raise Puppet::ParseError, mismatch
     end || (raise Puppet::ParseError, 'Task parameters did not match')
+
+    unless Puppet::Pops::Types::TypeFactory.data.instance?(use_args)
+      raise Puppet::ParseError, 'Task parameters is not of type Data'
+    end
+
     task = task_signature.task
 
     if executor.noop

data/vendored/puppet/lib/puppet/application/filebucket.rb

@@ -66,7 +66,8 @@ central filebucket.
 Note that 'filebucket' defaults to using a network-based filebucket
 available on the server named 'puppet'. To use this, you'll have to be
 running as a user with valid Puppet certificates. Alternatively, you can
-use your local file bucket by specifying '--local'.
+use your local file bucket by specifying '--local', or by specifying
+'--bucket' with a local path.
 
 
 OPTIONS
@@ -77,33 +78,40 @@ setting, so you can specify '--ssldir <directory>' as an
 argument.
 
 See the configuration file documentation at
-https://docs.puppetlabs.com/puppet/latest/reference/configuration.html for the
+https://puppet.com/docs/puppet/latest/configuration.html for the
 full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppet with
 '--genconfig'.
 
+* --bucket:
+  Specify a filebucket path. If '--local' is also set, this path
+  overrides the default '--local' path set in '$clientbucketdir'.
+
 * --debug:
   Enable full debugging.
 
 * --fromdate:
-  (list only) Select bucket files from 'fromdate'
+  (list only) Select bucket files from 'fromdate'.
 
 * --help:
-  Print this help message
+  Print this help message.
 
 * --local:
-  Use the local filebucket. This will use the default configuration
-  information.
+  Use the local filebucket. This uses the default configuration
+  information and the bucket located at the '$clientbucketdir'
+  setting by default. If '--bucket' is set, puppet uses that
+  path instead.
 
 * --remote:
-  Use a remote filebucket. This will use the default configuration
-  information.
+  Use a remote filebucket. This uses the default configuration
+  information and the bucket located at the '$bucketdir' setting
+  by default.
 
 * --server:
   The server to send the file to, instead of locally.
 
 * --todate:
-  (list only) Select bucket files until 'todate'
+  (list only) Select bucket files until 'todate'.
 
 * --verbose:
   Print extra information.
@@ -130,7 +138,7 @@ EXAMPLE
     $ echo again >> /tmp/TestFile
     $ puppet filebucket -l backup /tmp/TestFile
     /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef
-    $ puppet filebucket -l  list
+    $ puppet filebucket -l list
     d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
     7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
     $ puppet filebucket -l -f 2015-01-01 -t 2015-01-11 list
@@ -142,6 +150,11 @@ EXAMPLE
     7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile
     $ puppet filebucket -l -t "2015-05-11 09:30:00" list
     d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
+    ## Manage files in a specific local filebucket
+    $ puppet filebucket -b /tmp/TestBucket backup /tmp/TestFile2
+    /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e
+    $ puppet filebucket -b /tmp/TestBucket list
+    d41d8cd98f00b204e9800998ecf8427e 2015-05-11 09:33:22 /tmp/TestFile2
 
 AUTHOR
 ------

data/vendored/puppet/lib/puppet/defaults.rb

@@ -1594,23 +1594,33 @@ EOT
     :splaylimit => {
       :default    => "$runinterval",
       :type       => :duration,
-      :desc       => "The maximum time to delay before runs.  Defaults to being the same as the
-        run interval. #{AS_DURATION}",
+      :desc       => "The maximum time to delay before an agent's first run when
+        `splay` is enabled. Defaults to the agent's `$runinterval`. The
+        `splay` interval is random and recalculated each time the agent is started or
+        restarted. #{AS_DURATION}",
     },
     :splay => {
       :default    => false,
       :type       => :boolean,
-      :desc       => "Whether to sleep for a pseudo-random (but consistent) amount of time before
-        a run.
-
-        For example, without `splay` enabled, your agent checks in every 30
-        minutes at :01 and :31 past the hour. After enabling `splay`, the agent
-        will wait the pseudorandom sleep time, say eight minutes, and then check
-        in every 30 minutes, at :09 and :39 after the hour. If you restart the
-        same agent at 12:45 PM, it will wait its eight minutes, and check in at
-        12:52 PM, and every 30 minutes after that, at 1:22 PM, 1:52 PM, and so
-        on. Other agents will have different sleep times, and so will check in
-        at different times even if they are all restarted at the same time.",
+      :desc       => "Whether to sleep for a random amount of time, ranging from
+        immediately up to its `$splaylimit`, before performing its first agent run
+        after a service restart. After this period, the agent runs periodically
+        on its `$runinterval`.
+
+        For example, assume a default 30-minute `$runinterval`, `splay` set to its
+        default of `false`, and an agent starting at :00 past the hour. The agent
+        would check in every 30 minutes at :01 and :31 past the hour.
+
+        With `splay` enabled, it waits any amount of time up to its `$splaylimit`
+        before its first run. For example, it might randomly wait 8 minutes,
+        then start its first run at :08 past the hour. With the `$runinterval`
+        at its default 30 minutes, its next run will be at :38 past the hour.
+
+        If you restart an agent's puppet service with `splay` enabled, it
+        recalculates its splay period and delays its first agent run after
+        restarting for this new period. If you simultaneously restart a group of
+        puppet agents with `splay` enabled, their checkins to your puppet masters
+        can be distributed more evenly.",
     },
     :clientbucketdir => {
       :default  => "$vardir/clientbucket",

data/vendored/puppet/lib/puppet/pops/pcore.rb

@@ -62,7 +62,7 @@ module Pcore
                 Struct[
                   Optional[description] => String,
                   Optional[sensitive] => Boolean,
-                  type => Type[Optional[Data]]]]],
+                  type => Type]]],
               value => undef
             },
 
@@ -73,7 +73,7 @@ module Pcore
                 Struct[
                   Optional[description] => String,
                   Optional[sensitive] => Boolean,
-                  type => Type[Optional[Data]]]]],
+                  type => Type]]],
               value => undef
             },
  

data/vendored/puppet/lib/puppet/pops/types/type_formatter.rb

@@ -680,7 +680,13 @@ class TypeFormatter
   end
 
   def range_array_part(t)
-    t.nil? || t.unbounded? ? EMPTY_ARRAY : [t.from.nil? ? 'default' : t.from.to_s , t.to.nil? ? 'default' : t.to.to_s ]
+    if t.nil? || t.unbounded?
+      EMPTY_ARRAY
+    else
+      result = [t.from.nil? ? 'default' : t.from.to_s]
+      result << t.to.to_s unless t.to.nil?
+      result
+    end
   end
 
   def append_object_hash(hash)

data/vendored/puppet/lib/puppet/reference/configuration.rb

@@ -48,7 +48,7 @@ config = Puppet::Util::Reference.newreference(:configuration, :depth => 1, :doc
 end
 
 config.header = <<EOT
-## Configuration Settings
+## Configuration settings
 
 * Each of these settings can be specified in `puppet.conf` or on the
   command line.
@@ -67,6 +67,8 @@ config.header = <<EOT
   combined with other units, and defaults to seconds when omitted. Examples are
   '3600' which is equivalent to '1h' (one hour), and '1825d' which is equivalent
   to '5y' (5 years).
+* If you use the `splay` setting, note that the period that it waits changes
+  each time the Puppet agent is restarted.
 * Settings that take a single file or directory can optionally set the owner,
   group, and mode for their value: `rundir = $vardir/run { owner = puppet,
   group = puppet, mode = 644 }`
@@ -75,7 +77,7 @@ config.header = <<EOT
 
 See the [configuration guide][confguide] for more details.
 
-[confguide]: https://docs.puppetlabs.com/puppet/latest/reference/config_about_settings.html
+[confguide]: https://puppet.com/docs/puppet/latest/config_about_settings.html
 
 * * *
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -1577,7 +1577,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Execute commands remotely over SSH and WinRM