bolt 1.48.0 → 1.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 006dcb3a880fefec3005eebb9f31126c3dc164c45d90010f5e7d5b6d984556e2
-  data.tar.gz: eaf4f944a88fba6aa4f1a0bb6fabe227246fa1ca90a63516a60d8db656f05176
+  metadata.gz: cf6891d9f3f208d516d962db7af3e26df0b8de95312c465f3cc8add22948730a
+  data.tar.gz: d58605a7bff94d170ab8c95f3b9a024eb60173f60d5bda83cd29c5084baa7450
 SHA512:
-  metadata.gz: 3fc3a8337bed7f52c5b091a94b388de07514d3dcc0840d1523b1417769e244dfa1840b8a77616170589343ceb451e726121752eb4927db271cda526ad7eb0b0e
-  data.tar.gz: 617985134dd23308316303222af69da7ca08bf1840b5fb7301a0dc9b609ba0cc1430877b3bf02c7aaa1f2173c1ca20a76dc36594332f0b8f979aa65b5620f449
+  metadata.gz: 742d7bd9cf8f7943412e8fbcb363541b787cccfb019e52c913690a00cfe567787fbe16aa20fd5c4a7b0095724f5b5a124c5d4026879c7b3e0f58d342c5c24124
+  data.tar.gz: 436bb36efdefc26efc08de99769af0d9912c1a34caaf0e9255950e4738a92b65ebcf05df20a4add6b47a54add18c1757d11643fb426c214ce840d83dbd80fd86

data/lib/bolt/apply_result.rb

@@ -130,5 +130,9 @@ module Bolt
     def report
       @value['report']
     end
+
+    def generic_value
+      {}
+    end
   end
 end

data/lib/bolt/cli.rb

@@ -277,15 +277,13 @@ module Bolt
                            Bolt::Inventory::ENVIRONMENT_VAR
                          elsif @config.inventoryfile && Bolt::Util.file_stat(@config.inventoryfile)
                            @config.inventoryfile
-                         elsif (inventory_file = @config.default_inventoryfile.find do |file|
-                                  begin
-                                    Bolt::Util.file_stat(file)
-                                  rescue Errno::ENOENT
-                                    false
-                                  end
-                                end
-                               )
-                           inventory_file
+                         else
+                           begin
+                             Bolt::Util.file_stat(@config.default_inventoryfile)
+                             @config.default_inventoryfile
+                           rescue Errno::ENOENT
+                             nil
+                           end
                          end
 
       inventory_cli_opts = %i[authentication escalation transports].each_with_object([]) do |key, acc|

data/lib/bolt/config.rb

@@ -116,7 +116,7 @@ module Bolt
     def self.from_boltdir(boltdir, overrides = {})
       data = {
         filepath: boltdir.config_file,
-        data: Bolt::Util.read_config_file(nil, [boltdir.config_file], 'config')
+        data: Bolt::Util.read_optional_yaml_hash(boltdir.config_file, 'config')
       }
 
       data = load_defaults.push(data).select { |config| config[:data]&.any? }
@@ -129,9 +129,8 @@ module Bolt
 
       data = {
         filepath: boltdir.config_file,
-        data: Bolt::Util.read_config_file(configfile, [], 'config')
+        data: Bolt::Util.read_yaml_hash(configfile, 'config')
       }
-
       data = load_defaults.push(data).select { |config| config[:data]&.any? }
 
       new(boltdir, data, overrides)
@@ -148,8 +147,8 @@ module Bolt
                     end
       user_path = Pathname.new(File.expand_path(File.join('~', '.puppetlabs', 'etc', 'bolt', 'bolt.yaml')))
 
-      [{ filepath: system_path, data: Bolt::Util.read_config_file(nil, [system_path], 'config') },
-       { filepath: user_path, data: Bolt::Util.read_config_file(nil, [user_path], 'config') }]
+      [{ filepath: system_path, data: Bolt::Util.read_optional_yaml_hash(system_path, 'config') },
+       { filepath: user_path, data: Bolt::Util.read_optional_yaml_hash(user_path, 'config') }]
     end
 
     def initialize(boltdir, config_data, overrides = {})
@@ -182,7 +181,6 @@ module Bolt
       end
 
       @config_files = config_data.map { |config| config[:filepath] }
-
       config_data = merge_config_data(config_data)
       update_from_file(config_data)
 
@@ -376,7 +374,7 @@ module Bolt
     end
 
     def default_inventoryfile
-      [@boltdir.inventory_file]
+      @boltdir.inventory_file
     end
 
     def rerunfile

data/lib/bolt/inventory.rb

@@ -52,7 +52,11 @@ module Bolt
           raise Bolt::ParseError, "Could not parse inventory from $#{ENVIRONMENT_VAR}"
         end
       else
-        data = Bolt::Util.read_config_file(config.inventoryfile, config.default_inventoryfile, 'inventory')
+        data = if config.inventoryfile
+                 Bolt::Util.read_yaml_hash(config.inventoryfile, 'inventory')
+               else
+                 Bolt::Util.read_optional_yaml_hash(config.default_inventoryfile, 'inventory')
+               end
       end
 
       inventory = create_version(data, config, plugins)

data/lib/bolt/inventory/target.rb

@@ -143,12 +143,26 @@ module Bolt
         @uri_obj.port || transport_config['port']
       end
 
+      # For remote targets, protocol is the value of the URI scheme. For
+      # non-remote targets, there is no protocol.
       def protocol
-        transport
+        if remote?
+          @uri_obj.scheme
+        end
       end
 
+      # For remote targets, the transport is always 'remote'. Otherwise, it
+      # will be either the URI scheme or set explicitly.
       def transport
-        @uri_obj.scheme || transport_config_cache['transport']
+        if remote?
+          'remote'
+        else
+          @uri_obj.scheme || transport_config_cache['transport']
+        end
+      end
+
+      def remote?
+        @uri_obj.scheme == 'remote' || transport_config_cache['transport'] == 'remote'
       end
 
       def user

data/lib/bolt/target.rb

@@ -118,11 +118,11 @@ module Bolt
     end
 
     def transport
-      inventory_target.protocol
+      inventory_target.transport
     end
 
     def protocol
-      inventory_target.protocol
+      inventory_target.protocol || inventory_target.transport
     end
 
     def user

data/lib/bolt/transport/remote.rb

@@ -48,7 +48,7 @@ module Bolt
       # Cannot batch because arugments differ
       def run_task(target, task, arguments, options = {})
         proxy_target = get_proxy(target)
-        transport = @executor.transport(proxy_target.protocol)
+        transport = @executor.transport(proxy_target.transport)
         arguments = arguments.merge('_target' => target.to_h.reject { |_, v| v.nil? })
 
         remote_task = task.remote_instance

data/lib/bolt/transport/ssh.rb

@@ -101,11 +101,6 @@ module Bolt
 
         require 'net/ssh'
         require 'net/scp'
-        begin
-          require 'net/ssh/krb'
-        rescue LoadError
-          logger.debug("Authentication method 'gssapi-with-mic' (Kerberos) is not available.")
-        end
 
         @transport_logger = Logging.logger[Net::SSH]
         @transport_logger.level = :warn

data/lib/bolt/util.rb

@@ -3,32 +3,20 @@
 module Bolt
   module Util
     class << self
-      def read_config_file(path, default_paths = nil, file_name = 'file')
+      def read_yaml_hash(path, file_name)
         require 'yaml'
 
         logger = Logging.logger[self]
-        path_passed = path
-        if path.nil? && default_paths
-          found_default = default_paths.select { |p| File.exist?(p) }
-          if found_default.size > 1
-            logger.warn "Found #{file_name}s at #{found_default.join(', ')}, using the first"
-          end
-          # Use first found, fall back to first default and try to load even if it didn't exist
-          path = found_default.first || default_paths.first
-        end
-
         path = File.expand_path(path)
-        content = File.open(path, "r:UTF-8") { |f| YAML.safe_load(f.read) }
+        content = File.open(path, "r:UTF-8") { |f| YAML.safe_load(f.read) } || {}
+        unless content.is_a?(Hash)
+          msg = "Invalid content for #{file_name} file: #{path} should be a Hash or empty, not #{content.class}"
+          raise Bolt::FileError.new(msg, path)
+        end
         logger.debug("Loaded #{file_name} from #{path}")
         content
       rescue Errno::ENOENT
-        msg = "Could not read #{file_name} file: #{path}"
-        if path_passed
-          raise Bolt::FileError.new(msg, path)
-        else
-          logger.debug(msg)
-          nil
-        end
+        raise Bolt::FileError.new("Could not read #{file_name} file: #{path}", path)
       rescue Psych::Exception => e
         raise Bolt::FileError.new("Could not parse #{file_name} file: #{path}\n"\
                                   "Error at line #{e.line} column #{e.column}", path)
@@ -37,6 +25,10 @@ module Bolt
                                   "error: #{e}", path)
       end
 
+      def read_optional_yaml_hash(path, file_name)
+        File.exist?(path) ? read_yaml_hash(path, file_name) : {}
+      end
+
       # Accepts a path with either 'plans' or 'tasks' in it and determines
       # the name of the module
       def module_name(path)

data/lib/bolt/version.rb

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

data/lib/bolt_server/pe/pal.rb

@@ -51,7 +51,10 @@ module BoltServer
         basemodulepath = plan_executor_config['basemodulepath'] || "#{codedir}/modules:/opt/puppetlabs/puppet/modules"
 
         with_pe_pal_init_settings(codedir, environmentpath, basemodulepath) do
+          modulepath_dirs = []
+          modulepath_setting_from_bolt = nil
           environment = Puppet.lookup(:environments).get!(environment_name)
+          path_to_env = environment.configuration.path_to_env
 
           # In the instance where the environment is "production" but no production dir
           # exists, the lookup will succeed, but the configuration will be mostly empty.
@@ -64,17 +67,28 @@ module BoltServer
           # environment: _technically_ that environment always exists, but if the dir
           # isn't there it won't find the module and fail with "plan not found" rather
           # than "environment doesn't exist"
-          if environment.configuration.path_to_env
-            bolt_config = File.join(environment.configuration.path_to_env, 'bolt.yaml')
+          if path_to_env
+            bolt_yaml = File.join(environment.configuration.path_to_env, 'bolt.yaml')
+            modulepath_setting_from_bolt = Bolt::Util.read_optional_yaml_hash(bolt_yaml, 'config')['modulepath']
+          end
+
+          # If we loaded a bolt.yaml in the environment root and it contained a modulepath setting:
+          # we will use that modulepath rather than the one loaded through puppet. modulepath will
+          # be the _only_ setting that will work from bolt.yaml in plans in PE.
+          if modulepath_setting_from_bolt
+            modulepath_setting_from_bolt.split(File::PATH_SEPARATOR).each do |path|
+              if Pathname.new(path).absolute? && File.exist?(path)
+                modulepath_dirs << path
+              elsif File.exist?(File.join(path_to_env, path))
+                modulepath_dirs << File.join(path_to_env, path)
+              end
+            end
+
+            # Append the basemodulepath to include "built-in" modules.
+            modulepath_dirs.concat(basemodulepath.split(File::PATH_SEPARATOR))
+          else
+            modulepath_dirs = environment.modulepath
           end
-          # If we find a bolt.yaml config in the environment root, we load that instead of
-          # environment.conf to find the modulepath. modulepath will be the _only_ setting
-          # that will work from bolt.yaml in plans in PE.
-          modulepath_dirs = if bolt_config && File.exist?(bolt_config)
-                              Bolt::Util.read_config_file(bolt_config)['modulepath'].split(File::PATH_SEPARATOR)
-                            else
-                              environment.modulepath
-                            end
 
           # A new modulepath is created from scratch (rather than using super's @modulepath)
           # so that we can have full control over all the entries in modulepath. In the future

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 1.48.0
+  version: 1.49.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-krb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: orchestrator_client
   requirement: !ruby/object:Gem::Requirement