bolt 2.42.0 → 2.44.0

data/lib/bolt/project.rb

@@ -12,46 +12,49 @@ module Bolt
     CONFIG_NAME  = 'bolt-project.yaml'
 
     attr_reader :path, :data, :config_file, :inventory_file, :hiera_config,
-                :puppetfile, :rerunfile, :type, :resource_types, :logs, :project_file,
-                :deprecations, :downloads, :plans_path, :modulepath, :managed_moduledir,
-                :backup_dir, :cache_file
+                :puppetfile, :rerunfile, :type, :resource_types, :project_file,
+                :downloads, :plans_path, :modulepath, :managed_moduledir,
+                :backup_dir, :plugin_cache_file, :plan_cache_file
 
-    def self.default_project(logs = [])
-      create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user', logs)
+    def self.default_project
+      create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user')
     # If homedir isn't defined use the system config path
     rescue ArgumentError
-      create_project(Bolt::Config.system_path, 'system', logs)
+      create_project(Bolt::Config.system_path, 'system')
     end
 
     # Search recursively up the directory hierarchy for the Project. Look for a
     # directory called Boltdir or a file called bolt.yaml (for a control repo
     # type Project). Otherwise, repeat the check on each directory up the
     # hierarchy, falling back to the default if we reach the root.
-    def self.find_boltdir(dir, logs = [], deprecations = [])
+    def self.find_boltdir(dir)
       dir = Pathname.new(dir)
 
       if (dir + BOLTDIR_NAME).directory?
-        create_project(dir + BOLTDIR_NAME, 'embedded', logs)
+        create_project(dir + BOLTDIR_NAME, 'embedded')
       elsif (dir + 'bolt.yaml').file?
         command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
-        msg = "Configuration file #{dir + 'bolt.yaml'} is deprecated and will be "\
+        Bolt::Logger.deprecate(
+          "bolt_yaml",
+          "Configuration file #{dir + 'bolt.yaml'} is deprecated and will be "\
           "removed in Bolt 3.0.\nUpdate your Bolt project to the latest Bolt practices "\
-          "using #{command}"
-        deprecations << { type: "Project level bolt.yaml",
-                          msg: msg }
-        create_project(dir, 'local', logs, deprecations)
+          "using #{command}."
+        )
+        create_project(dir, 'local')
       elsif (dir + CONFIG_NAME).file?
-        create_project(dir, 'local', logs)
+        create_project(dir, 'local')
       elsif dir.root?
-        default_project(logs)
+        default_project
       else
-        logs << { debug: "Did not detect Boltdir, bolt.yaml, or bolt-project.yaml at '#{dir}'. "\
-                  "This directory won't be loaded as a project." }
-        find_boltdir(dir.parent, logs, deprecations)
+        Bolt::Logger.debug(
+          "Did not detect Boltdir, bolt.yaml, or bolt-project.yaml at '#{dir}'. "\
+          "This directory won't be loaded as a project."
+        )
+        find_boltdir(dir.parent)
       end
     end
 
-    def self.create_project(path, type = 'option', logs = [], deprecations = [])
+    def self.create_project(path, type = 'option')
       fullpath = Pathname.new(path).expand_path
 
       if type == 'user'
@@ -59,8 +62,11 @@ module Bolt
           # This is already expanded if the type is user
           FileUtils.mkdir_p(path)
         rescue StandardError
-          logs << { warn: "Could not create default project at #{path}. Continuing without a writeable project. "\
-                    "Log and rerun files will not be written." }
+          Bolt::Logger.warn(
+            "non_writeable_project",
+            "Could not create default project at #{path}. Continuing without a writeable project. "\
+            "Log and rerun files will not be written."
+          )
         end
       end
 
@@ -81,19 +87,17 @@ module Bolt
       default      = type =~ /user|system/ ? 'default ' : ''
       exist        = File.exist?(File.expand_path(project_file))
 
-      logs << { info: "Loaded #{default}project from '#{fullpath}'" } if exist
+      if exist
+        Bolt::Logger.info("Loaded #{default}project from '#{fullpath}'")
+      end
 
       Bolt::Validator.new.tap do |validator|
         validator.validate(data, schema, project_file)
-
-        validator.warnings.each { |warning| logs << { warn: warning } }
-
-        validator.deprecations.each do |dep|
-          deprecations << { type: "#{CONFIG_NAME} #{dep[:option]}", msg: dep[:message] }
-        end
+        validator.warnings.each { |warning| Bolt::Logger.warn(warning[:id], warning[:msg]) }
+        validator.deprecations.each { |dep| Bolt::Logger.deprecate(dep[:id], dep[:msg]) }
       end
 
-      new(data, path, type, logs, deprecations)
+      new(data, path, type)
     end
 
     # Builds the schema for bolt-project.yaml used by the validator.
@@ -106,17 +110,17 @@ module Bolt
       }
     end
 
-    def initialize(raw_data, path, type = 'option', logs = [], deprecations = [])
+    def initialize(raw_data, path, type = 'option')
       @path         = Pathname.new(path).expand_path
       @project_file = @path + CONFIG_NAME
-      @logs         = logs
-      @deprecations = deprecations
 
       if (@path + 'bolt.yaml').file? && project_file?
-        msg = "Project-level configuration in bolt.yaml is deprecated if using bolt-project.yaml. "\
+        Bolt::Logger.deprecate(
+          "bolt_yaml",
+          "Project-level configuration in bolt.yaml is deprecated if using bolt-project.yaml. "\
           "Transport config should be set in inventory.yaml, all other config should be set in "\
           "bolt-project.yaml."
-        @deprecations << { type: 'Using bolt.yaml for project configuration', msg: msg }
+        )
       end
 
       @inventory_file    = @path + 'inventory.yaml'
@@ -129,12 +133,14 @@ module Bolt
       @plans_path        = @path + 'plans'
       @managed_moduledir = @path + '.modules'
       @backup_dir        = @path + '.bolt-bak'
-      @cache_file        = @path + '.plugin_cache.json'
+      @plugin_cache_file = @path + '.plugin_cache.json'
+      @plan_cache_file   = @path + '.plan_cache.json'
 
-      tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys
-      if tc.any?
-        msg = "Transport configuration isn't supported in bolt-project.yaml. Ignoring keys #{tc}"
-        @logs << { warn: msg }
+      if (tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys).any?
+        Bolt::Logger.warn(
+          "project_transport_config",
+          "Transport configuration isn't supported in bolt-project.yaml. Ignoring keys #{tc}."
+        )
       end
 
       @data = raw_data.reject { |k, _| Bolt::Config::INVENTORY_OPTIONS.include?(k) }
@@ -151,8 +157,10 @@ module Bolt
       # and replaced with .project_file in lib/bolt/config.rb
       @config_file = if (Bolt::Config::BOLT_OPTIONS & @data.keys).any?
                        if (@path + 'bolt.yaml').file?
-                         msg = "bolt-project.yaml contains valid config keys, bolt.yaml will be ignored"
-                         @logs << { warn: msg }
+                         Bolt::Logger.warn(
+                           "project_config_conflict",
+                           "bolt-project.yaml contains valid config keys, bolt.yaml will be ignored"
+                         )
                        end
                        @project_file
                      else
@@ -206,6 +214,10 @@ module Bolt
       @data['module-install']
     end
 
+    def disable_warnings
+      @data['disable-warnings'] || []
+    end
+
     def modules
       @modules ||= @data['modules']&.map do |mod|
         if mod.is_a?(String)
@@ -232,14 +244,15 @@ module Bolt
             File.directory?(@path + 'tasks') ||
             File.directory?(@path + 'files'))
         message = "No project name is specified in bolt-project.yaml. Project-level content will not be available."
-        @logs << { warn: message }
+
+        Bolt::Logger.warn("missing_project_name", message)
       end
     end
 
     def check_deprecated_file
       if (@path + 'project.yaml').file?
         msg = "Project configuration file 'project.yaml' is deprecated; use 'bolt-project.yaml' instead."
-        Bolt::Logger.deprecation_warning('Using project.yaml instead of bolt-project.yaml', msg)
+        Bolt::Logger.warn("project_yaml", msg)
       end
     end
   end

data/lib/bolt/rerun.rb

@@ -49,7 +49,7 @@ module Bolt
         end
       end
     rescue StandardError => e
-      Bolt::Logger.warn_once('unwriteable_file', "Failed to save result to #{@path}: #{e.message}")
+      Bolt::Logger.warn_once("unwriteable_file", "Failed to save result to #{@path}: #{e.message}")
     end
   end
 end

data/lib/bolt/shell/bash.rb

@@ -299,7 +299,7 @@ module Bolt
           if target.options['cleanup']
             dir.delete
           else
-            @logger.warn("Skipping cleanup of tmpdir #{dir}")
+            Bolt::Logger.warn("skip_cleanup", "Skipping cleanup of tmpdir #{dir}")
           end
         end
       end

data/lib/bolt/shell/bash/tmpdir.rb

@@ -48,7 +48,10 @@ module Bolt
         def delete
           result = @shell.execute(['rm', '-rf', @path], sudoable: true, run_as: @owner)
           if result.exit_code != 0
-            @logger.warn("Failed to clean up tmpdir '#{@path}': #{result.stderr.string}")
+            Bolt::Logger.warn(
+              "fail_cleanup",
+              "Failed to clean up tmpdir '#{@path}': #{result.stderr.string}"
+            )
           end
           # For testing
           result.stderr.string

data/lib/bolt/shell/powershell.rb

@@ -27,7 +27,7 @@ module Bolt
             "bolt-debug.log or run with '--log-level debug' to see the full "\
             "list of targets with PowerShell 2."
 
-          Bolt::Logger.deprecation_warning("PowerShell 2", msg)
+          Bolt::Logger.deprecate_once("powershell_2", msg)
           @logger.debug("Detected PowerShell 2 on #{target}.")
         end
       end
@@ -163,7 +163,7 @@ module Bolt
           if target.options['cleanup']
             rmdir(@tmpdir)
           else
-            @logger.warn("Skipping cleanup of tmpdir '#{@tmpdir}'")
+            Bolt::Logger.warn("Skipping cleanup of tmpdir '#{@tmpdir}'", "skip_cleanup")
           end
         end
       end

data/lib/bolt/task.rb

@@ -149,7 +149,7 @@ module Bolt
       if unknown_keys.any?
         msg = "Metadata for task '#{@name}' contains unknown keys: #{unknown_keys.join(', ')}."
         msg += " This could be a typo in the task metadata or may result in incorrect behavior."
-        @logger.warn(msg)
+        Bolt::Logger.warn("unknown_task_metadata_keys", msg)
       end
     end
   end

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

@@ -140,10 +140,10 @@ module Bolt
             if @target.options['cleanup']
               _, stderr, exitcode = execute('rm', '-rf', dir, {})
               if exitcode != 0
-                @logger.warn("Failed to clean up tmpdir '#{dir}': #{stderr}")
+                Bolt::Logger.warn("fail_cleanup", "Failed to clean up tmpdir '#{dir}': #{stderr}")
               end
             else
-              @logger.warn("Skipping cleanup of tmpdir '#{dir}'")
+              Bolt::Logger.warn("skip_cleanup", "Skipping cleanup of tmpdir '#{dir}'")
             end
           end
         end

data/lib/bolt/transport/local.rb

@@ -20,7 +20,7 @@ module Bolt
           msg = "The local transport will default to using Bolt's Ruby interpreter and "\
             "setting the 'puppet-agent' feature in Bolt 3.0. Enable or disable these "\
             "defaults by setting 'bundled-ruby' in the local transport config."
-          Bolt::Logger.warn_once('local default config', msg)
+          Bolt::Logger.warn_once("local_default_config", msg)
         end
 
         yield Connection.new(target)

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

@@ -21,7 +21,7 @@ module Bolt
 
           @logger = logger
           @key = self.class.get_key(opts)
-          client_opts = opts.slice('token-file', 'cacert', 'job-poll-interval', 'job-poll-timeout')
+          client_opts = opts.slice('token-file', 'cacert', 'job-poll-interval', 'job-poll-timeout', 'read-timeout')
 
           if opts['service-url']
             uri = Addressable::URI.parse(opts['service-url'])

data/lib/bolt/transport/ssh.rb

@@ -23,8 +23,7 @@ module Bolt
 
       def with_connection(target)
         if target.transport_config['ssh-command'] && !target.transport_config['native-ssh']
-          Bolt::Logger.warn_once("ssh-command and native-ssh conflict",
-                                 "native-ssh must be true to use ssh-command")
+          Bolt::Logger.warn_once("native_ssh_disabled", "native-ssh must be true to use ssh-command")
         end
 
         conn = if target.transport_config['native-ssh']

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

@@ -34,7 +34,7 @@ module Bolt
             begin
               Bolt::Util.validate_file('ssh key', target.options['private-key'])
             rescue Bolt::FileError => e
-              @logger.warn(e.msg)
+              Bolt::Logger.warn("invalid_ssh_key", e.msg)
             end
           end
         end

data/lib/bolt/validator.rb

@@ -147,7 +147,7 @@ module Bolt
         message += " at '#{path}'" if @path.any?
         message += " at #{@location}" if @location
         message += "."
-        @warnings << message
+        @warnings << { id: 'unknown_option', msg: message }
       end
     end
 
@@ -160,7 +160,7 @@ module Bolt
         message  = "Option '#{path}' "
         message += "at #{@location} " if @location
         message += "is deprecated. #{definition[:_deprecation]}"
-        @deprecations << { option: key, message: message }
+        @deprecations << { id: "#{key}_option", msg: message }
       end
     end
 

data/lib/bolt/version.rb

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

data/lib/bolt_server/config.rb

@@ -9,7 +9,7 @@ module BoltServer
     def config_keys
       super + %w[concurrency cache-dir file-server-conn-timeout
                  file-server-uri projects-dir environments-codedir
-                 environmentpath basemodulepath]
+                 environmentpath basemodulepath builtin-content-dir]
     end
 
     def env_keys

data/lib/bolt_server/transport_app.rb

@@ -280,7 +280,8 @@ module BoltServer
         bolt_config = config_from_project(versioned_project)
         modulepath_object = Bolt::Config::Modulepath.new(
           bolt_config.modulepath,
-          boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH]
+          boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH],
+          builtin_content_path: @config['builtin-content-dir']
         )
         pal = Bolt::PAL.new(modulepath_object, nil, nil, nil, nil, nil, bolt_config.project)
         context = {

data/libexec/bolt_catalog

@@ -56,7 +56,7 @@ when "compile"
               else
                 e.message
               end
-    puts({ message: message }.to_json)
+    puts({ message: message, backtrace: e.backtrace }.to_json)
     exit 1
   rescue StandardError => e
     puts({ message: e.message }.to_json)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.42.0
+  version: 2.44.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -350,16 +350,16 @@ dependencies:
   name: puppetlabs_spec_helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.15.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -523,6 +523,7 @@ files:
 - lib/bolt/plugin/env_var.rb
 - lib/bolt/plugin/module.rb
 - lib/bolt/plugin/prompt.rb
+- lib/bolt/plugin/puppet_connect_data.rb
 - lib/bolt/plugin/puppetdb.rb
 - lib/bolt/plugin/task.rb
 - lib/bolt/project.rb