bolt 2.1.0 → 2.2.0

data/lib/bolt/transport/orch.rb

@@ -21,30 +21,10 @@ module Bolt
 
       attr_writer :plan_context
 
-      OPTIONS = {
-        "cacert"            => "The path to the CA certificate.",
-        "host"              => "Host name.",
-        "job-poll-interval" => "Set interval to poll orchestrator for job status.",
-        "job-poll-timeout"  => "Set time to wait for orchestrator job status.",
-        "service-url"       => "The URL of the orchestrator API.",
-        "task-environment"  => "The environment the orchestrator loads task code from.",
-        "token-file"        => "The path to the token file."
-      }.freeze
-
-      def self.options
-        OPTIONS.keys
-      end
-
-      def self.default_options
-        { 'task-environment' => 'production' }
-      end
-
       def provided_features
         ['puppet-agent']
       end
 
-      def self.validate(options); end
-
       def initialize(*args)
         # lazy-load expensive gem code
         require 'orchestrator_client'

data/lib/bolt/transport/remote.rb

@@ -6,26 +6,6 @@ require 'bolt/transport/base'
 module Bolt
   module Transport
     class Remote < Base
-      OPTIONS = {
-        "run-on" => "The proxy target that the task executes on."
-      }.freeze
-
-      # The options for the remote transport not defined.
-      def self.filter_options(unfiltered)
-        unfiltered
-      end
-
-      def self.default_options
-        { 'run-on' => 'localhost' }
-      end
-
-      def self.validate(options)
-        # This will fail when validating global config
-        # unless options['device-type']
-        #  raise Bolt::ValidationError, 'Must specify device-type for devices'
-        # end
-      end
-
       # TODO: this should have access to inventory so target doesn't have to
       def initialize(executor)
         super()

data/lib/bolt/transport/ssh.rb

@@ -8,95 +8,10 @@ require 'shellwords'
 module Bolt
   module Transport
     class SSH < Sudoable
-      OPTIONS = {
-        "connect-timeout"    => "How long to wait when establishing connections.",
-        "disconnect-timeout" => "How long to wait before force-closing a connection.",
-        "host"               => "Host name.",
-        "host-key-check"     => "Whether to perform host key validation when connecting.",
-        "interpreters"       => "A map of an extension name to the absolute path of an executable, "\
-                                "enabling you to override the shebang defined in a task executable. The "\
-                                "extension can optionally be specified with the `.` character (`.py` and "\
-                                "`py` both map to a task executable `task.py`) and the extension is case "\
-                                "sensitive. When a target's name is `localhost`, Ruby tasks run with the "\
-                                "Bolt Ruby interpreter by default.",
-        "load-config"        => "Whether to load system SSH configuration.",
-        "password"           => "Login password.",
-        "port"               => "Connection port.",
-        "private-key"        => "Either the path to the private key file to use for authentication, or a "\
-                                "hash with the key `key-data` and the contents of the private key.",
-        "proxyjump"          => "A jump host to proxy connections through, and an optional user to "\
-                                "connect with.",
-        "run-as"             => "A different user to run commands as after login.",
-        "run-as-command"     => "The command to elevate permissions. Bolt appends the user and command "\
-                                "strings to the configured `run-as-command` before running it on the "\
-                                "target. This command must not require an interactive password prompt, "\
-                                "and the `sudo-password` option is ignored when `run-as-command` is "\
-                                "specified. The `run-as-command` must be specified as an array.",
-        "script-dir"         => "The subdirectory of the tmpdir to use in place of a randomized "\
-                                "subdirectory for uploading and executing temporary files on the "\
-                                "target. It's expected that this directory already exists as a subdir "\
-                                "of tmpdir, which is either configured or defaults to `/tmp`.",
-        "sudo-executable"    => "The executable to use when escalating to the configured `run-as` "\
-                                "user. This is useful when you want to escalate using the configured "\
-                                "`sudo-password`, since `run-as-command` does not use `sudo-password` "\
-                                "or support prompting. The command executed on the target is "\
-                                "`<sudo-executable> -S -u <user> -p custom_bolt_prompt <command>`. "\
-                                "**This option is experimental.**",
-        "sudo-password"      => "Password to use when changing users via `run-as`.",
-        "tmpdir"             => "The directory to upload and execute temporary files on the target.",
-        "tty"                => "Request a pseudo tty for the session. This option is generally "\
-                                "only used in conjunction with the `run-as` option when the sudoers "\
-                                "policy requires a `tty`.",
-        "user"               => "Login user."
-      }.freeze
-
-      def self.options
-        OPTIONS.keys
-      end
-
-      def self.default_options
-        {
-          'connect-timeout' => 10,
-          'tty' => false,
-          'load-config' => true,
-          'disconnect-timeout' => 5
-        }
-      end
-
       def provided_features
         ['shell']
       end
 
-      def self.validate(options)
-        validate_sudo_options(options)
-
-        host_key = options['host-key-check']
-        unless host_key.nil? || !!host_key == host_key
-          raise Bolt::ValidationError, 'host-key-check option must be a Boolean true or false'
-        end
-
-        if (key_opt = options['private-key'])
-          unless key_opt.instance_of?(String) || (key_opt.instance_of?(Hash) && key_opt.include?('key-data'))
-            raise Bolt::ValidationError,
-                  "private-key option must be the path to a private key file or a hash containing the 'key-data'"
-          end
-        end
-
-        %w[connect-timeout disconnect-timeout].each do |timeout|
-          timeout_value = options[timeout]
-          unless timeout_value.is_a?(Integer) || timeout_value.nil?
-            error_msg = "#{timeout} value must be an Integer, received #{timeout_value}:#{timeout_value.class}"
-            raise Bolt::ValidationError, error_msg
-          end
-        end
-
-        if (dir_opt = options['script-dir'])
-          unless dir_opt.is_a?(String) && !dir_opt.empty?
-            raise Bolt::ValidationError, "script-dir option must be a non-empty string"
-          end
-        end
-      end
-
       def initialize
         super
 

data/lib/bolt/transport/sudoable.rb

@@ -6,13 +6,6 @@ require 'bolt/transport/base'
 module Bolt
   module Transport
     class Sudoable < Base
-      def self.validate_sudo_options(options)
-        run_as_cmd = options['run-as-command']
-        if run_as_cmd && (!run_as_cmd.is_a?(Array) || run_as_cmd.any? { |n| !n.is_a?(String) })
-          raise Bolt::ValidationError, "run-as-command must be an Array of Strings, received #{run_as_cmd}"
-        end
-      end
-
       def self.sudo_prompt
         '[sudo] Bolt needs to run as another user, password: '
       end

data/lib/bolt/transport/winrm.rb

@@ -7,46 +7,6 @@ require 'bolt/transport/powershell'
 module Bolt
   module Transport
     class WinRM < Base
-      OPTIONS = {
-        "cacert"          => "The path to the CA certificate.",
-        "connect-timeout" => "How long Bolt should wait when establishing connections.",
-        "extensions"      => "List of file extensions that are accepted for scripts or tasks. "\
-                              "Scripts with these file extensions rely on the target's file type "\
-                              "association to run. For example, if Python is installed on the system, "\
-                              "a `.py` script runs with `python.exe`. The extensions `.ps1`, `.rb`, and "\
-                              "`.pp` are always allowed and run via hard-coded executables.",
-        "file-protocol"   => "Which file transfer protocol to use. Either `winrm` or `smb`. Using `smb` is "\
-                              "recommended for large file transfers.",
-        "host"            => "Host name.",
-        "interpreters"    => "A map of an extension name to the absolute path of an executable, "\
-                              "enabling you to override the shebang defined in a task executable. The "\
-                              "extension can optionally be specified with the `.` character (`.py` and "\
-                              "`py` both map to a task executable `task.py`) and the extension is case "\
-                              "sensitive. When a target's name is `localhost`, Ruby tasks run with the "\
-                              "Bolt Ruby interpreter by default.",
-        "password"        => "Login password. **Required unless using Kerberos.**",
-        "port"            => "Connection port.",
-        "realm"           => "Kerberos realm (Active Directory domain) to authenticate against.",
-        "smb-port"        => "With file-protocol set to smb, this is the port to establish a connection on.",
-        "ssl"             => "When true, Bolt uses secure https connections for WinRM.",
-        "ssl-verify"      => "When true, verifies the targets certificate matches the cacert.",
-        "tmpdir"          => "The directory to upload and execute temporary files on the target.",
-        "user"            => "Login user. **Required unless using Kerberos.**"
-      }.freeze
-
-      def self.options
-        OPTIONS.keys
-      end
-
-      def self.default_options
-        {
-          'connect-timeout' => 10,
-          'ssl' => true,
-          'ssl-verify' => true,
-          'file-protocol' => 'winrm'
-        }
-      end
-
       def provided_features
         ['powershell']
       end
@@ -56,32 +16,6 @@ module Bolt
         input_method
       end
 
-      def self.validate(options)
-        ssl_flag = options['ssl']
-        unless !!ssl_flag == ssl_flag
-          raise Bolt::ValidationError, 'ssl option must be a Boolean true or false'
-        end
-
-        if ssl_flag && (options['file-protocol'] == 'smb')
-          raise Bolt::ValidationError, 'SMB file transfers are not allowed with SSL enabled'
-        end
-
-        if ssl_flag && (ca_path = options['cacert'])
-          Bolt::Util.validate_file('cacert', ca_path)
-        end
-
-        ssl_verify_flag = options['ssl-verify']
-        unless !!ssl_verify_flag == ssl_verify_flag
-          raise Bolt::ValidationError, 'ssl-verify option must be a Boolean true or false'
-        end
-
-        timeout_value = options['connect-timeout']
-        unless timeout_value.is_a?(Integer) || timeout_value.nil?
-          error_msg = "connect-timeout value must be an Integer, received #{timeout_value}:#{timeout_value.class}"
-          raise Bolt::ValidationError, error_msg
-        end
-      end
-
       def initialize
         super
         require 'winrm'

data/lib/bolt/util.rb

@@ -238,6 +238,17 @@ module Bolt
       def symbolize_top_level_keys(hsh)
         hsh.each_with_object({}) { |(k, v), h| k.is_a?(String) ? h[k.to_sym] = v : h[k] = v }
       end
+
+      # Recursively searches a data structure for plugin references
+      def references?(input)
+        if input.is_a?(Hash)
+          input.key?('_plugin') || input.values.any? { |v| references?(v) }
+        elsif input.is_a?(Array)
+          input.any? { |v| references?(v) }
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/bolt/version.rb

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

data/lib/bolt_server/transport_app.rb

@@ -4,6 +4,7 @@ require 'sinatra'
 require 'addressable/uri'
 require 'bolt'
 require 'bolt/error'
+require 'bolt/inventory'
 require 'bolt/target'
 require 'bolt_server/file_cache'
 require 'bolt/task/puppet_server'

data/lib/bolt_spec/plans.rb

@@ -181,7 +181,7 @@ module BoltSpec
     end
 
     def inventory
-      @inventory ||= Bolt::Inventory.create_version(inventory_data, config, plugins)
+      @inventory ||= Bolt::Inventory.create_version(inventory_data, config.transport, config.transports, plugins)
     end
 
     # Provided as a class so expectations can be placed on it.

data/lib/bolt_spec/plans/action_stubs/command_stub.rb

@@ -36,7 +36,7 @@ module BoltSpec
 
       def with_params(params)
         @invocation[:options] = params.select { |k, _v| k.start_with?('_') }
-                                      .map { |k, v| [k.sub(/^_/, '').to_sym, v] }.to_h
+                                      .transform_keys { |k| k.sub(/^_/, '').to_sym }
         self
       end
     end

data/lib/bolt_spec/plans/action_stubs/script_stub.rb

@@ -44,7 +44,7 @@ module BoltSpec
         @invocation[:params] = params
         @invocation[:arguments] = params['arguments']
         @invocation[:options] = params.select { |k, _v| k.start_with?('_') }
-                                      .map { |k, v| [k.sub(/^_/, '').to_sym, v] }.to_h
+                                      .transform_keys { |k| k.sub(/^_/, '').to_sym }
         self
       end
     end

data/lib/bolt_spec/plans/action_stubs/task_stub.rb

@@ -23,7 +23,7 @@ module BoltSpec
         @calls += 1
         if @return_block
           # Merge arguments and options into params to match puppet function signature.
-          params = options.map { |k, v| ["_#{k}", v] }.to_h
+          params = options.transform_keys { |k| "_#{k}" }
           params = params.merge(arguments)
 
           check_resultset(@return_block.call(targets: targets, task: task, params: params), task)
@@ -49,7 +49,7 @@ module BoltSpec
         @invocation[:params] = params
         @invocation[:arguments] = params.reject { |k, _v| k.start_with?('_') }
         @invocation[:options] = params.select { |k, _v| k.start_with?('_') }
-                                      .map { |k, v| [k.sub(/^_/, '').to_sym, v] }.to_h
+                                      .transform_keys { |k| k.sub(/^_/, '').to_sym }
         self
       end
     end

data/lib/bolt_spec/plans/action_stubs/upload_stub.rb

@@ -57,7 +57,7 @@ module BoltSpec
 
       def with_params(params)
         @invocation[:options] = params.select { |k, _v| k.start_with?('_') }
-                                      .map { |k, v| [k.sub(/^_/, '').to_sym, v] }.to_h
+                                      .transform_keys { |k| k.sub(/^_/, '').to_sym }
         self
       end
     end

data/lib/bolt_spec/run.rb

@@ -148,7 +148,7 @@ module BoltSpec
       end
 
       def inventory
-        @inventory ||= Bolt::Inventory.create_version(@inventory_data, config, plugins)
+        @inventory ||= Bolt::Inventory.create_version(@inventory_data, config.transport, config.transports, plugins)
       end
 
       def plugins

data/libexec/apply_catalog.rb

@@ -68,7 +68,7 @@ begin
     end
 
     # Transport.connect will modify this hash!
-    transport_conn_info = conn_info.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+    transport_conn_info = conn_info.transform_keys(&:to_sym)
 
     transport = Puppet::ResourceApi::Transport.connect(type, transport_conn_info)
     Puppet::ResourceApi::Transport.inject_device(type, transport)

data/libexec/custom_facts.rb

@@ -46,7 +46,7 @@ Dir.mktmpdir do |puppet_root|
     end
 
     # Transport.connect will modify this hash!
-    transport_conn_info = conn_info.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+    transport_conn_info = conn_info.transform_keys(&:to_sym)
     transport = Puppet::ResourceApi::Transport.connect(type, transport_conn_info)
     Puppet::ResourceApi::Transport.inject_device(type, transport)
 

data/libexec/query_resources.rb

@@ -53,7 +53,7 @@ Dir.mktmpdir do |puppet_root|
     end
 
     # Transport.connect will modify this hash!
-    transport_conn_info = conn_info.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+    transport_conn_info = conn_info.transform_keys(&:to_sym)
 
     transport = Puppet::ResourceApi::Transport.connect(type, transport_conn_info)
     Puppet::ResourceApi::Transport.inject_device(type, transport)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -400,6 +400,13 @@ files:
 - lib/bolt/catalog/logging.rb
 - lib/bolt/cli.rb
 - lib/bolt/config.rb
+- lib/bolt/config/transport/base.rb
+- lib/bolt/config/transport/docker.rb
+- lib/bolt/config/transport/local.rb
+- lib/bolt/config/transport/orch.rb
+- lib/bolt/config/transport/remote.rb
+- lib/bolt/config/transport/ssh.rb
+- lib/bolt/config/transport/winrm.rb
 - lib/bolt/error.rb
 - lib/bolt/executor.rb
 - lib/bolt/inventory.rb