bolt 2.36.0 → 2.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1881e4097a89e606b9326f93e2e6fd9d934a7db1eb8609e6f9a09ffa322ac7c4
-  data.tar.gz: '02509b1919e57f137bf4e868332be3b73238d22d83251680dc29c7c93ef90a19'
+  metadata.gz: d520aad8f699a4a52849ac189a6368b799238996a0c4dae22e75f2abfbe43eff
+  data.tar.gz: befcf8835708c4ec4605e560dfd060680a6d680b7614bfd3d4d4baba7fb7cfa5
 SHA512:
-  metadata.gz: 1fc1215430ac99b765c24c87ee210afb03a247a6c0baac9af3b00e34d56cfb58bacb2140dcfafbe197fd655602713463e2697c2df5083c259b66c8d8cd7bc112
-  data.tar.gz: 445a5f77a5beaf8a1a3c4cb2193e973ada23cb4a7a5f3a8caba2ccc47be4fc8a8fdef3ba797e082c0df3b9553c2f2e67c06084f2c2b2684347d2b9a86e45bde0
+  metadata.gz: 0f25f959178fe587c518723cdc1dffd7bd420ea1d943ff1dcfda410cffd0ad592d3cd5714f5d4707dc9a4aa6fec0eb3103382a0266bf56f0625c2c06bc325f98
+  data.tar.gz: 7b05c93e0f507429bd5c43d5a0d0ed51f42d8ac1c0621c1c125ac1905a193a09e6802bb898f90650f7b95d8b0a2c5c513adbf93b3626d109936a447dcfaaf3dd

data/Puppetfile

@@ -5,14 +5,14 @@ forge "http://forge.puppetlabs.com"
 moduledir File.join(File.dirname(__FILE__), 'modules')
 
 # Core modules used by 'apply'
-mod 'puppetlabs-service', '1.3.0'
-mod 'puppetlabs-puppet_agent', '4.2.0'
-mod 'puppetlabs-facts', '1.2.0'
+mod 'puppetlabs-service', '1.4.0'
+mod 'puppetlabs-puppet_agent', '4.3.0'
+mod 'puppetlabs-facts', '1.3.0'
 
 # Core types and providers for Puppet 6
 mod 'puppetlabs-augeas_core', '1.1.1'
 mod 'puppetlabs-host_core', '1.0.3'
-mod 'puppetlabs-scheduled_task', '2.2.1'
+mod 'puppetlabs-scheduled_task', '2.3.1'
 mod 'puppetlabs-sshkeys_core', '2.2.0'
 mod 'puppetlabs-zfs_core', '1.2.0'
 mod 'puppetlabs-cron_core', '1.0.5'
@@ -22,10 +22,10 @@ mod 'puppetlabs-yumrepo_core', '1.0.7'
 mod 'puppetlabs-zone_core', '1.0.3'
 
 # Useful additional modules
-mod 'puppetlabs-package', '1.3.0'
-mod 'puppetlabs-puppet_conf', '0.6.0'
+mod 'puppetlabs-package', '1.4.0'
+mod 'puppetlabs-puppet_conf', '0.8.0'
 mod 'puppetlabs-python_task_helper', '0.4.3'
-mod 'puppetlabs-reboot', '3.0.0'
+mod 'puppetlabs-reboot', '3.1.0'
 mod 'puppetlabs-ruby_task_helper', '0.5.1'
 mod 'puppetlabs-ruby_plugin_helper', '0.1.0'
 mod 'puppetlabs-stdlib', '6.5.0'
@@ -34,7 +34,7 @@ mod 'puppetlabs-stdlib', '6.5.0'
 mod 'puppetlabs-aws_inventory', '0.5.2'
 mod 'puppetlabs-azure_inventory', '0.4.1'
 mod 'puppetlabs-gcloud_inventory', '0.1.3'
-mod 'puppetlabs-http_request', '0.2.0'
+mod 'puppetlabs-http_request', '0.2.1'
 mod 'puppetlabs-pkcs7', '0.1.1'
 mod 'puppetlabs-secure_env_vars', '0.1.0'
 mod 'puppetlabs-terraform', '0.5.0'

data/lib/bolt/bolt_option_parser.rb

@@ -14,7 +14,7 @@ module Bolt
                 global_config_setters: PROJECT_PATHS + %w[modulepath],
                 transports: %w[transport connect-timeout tty native-ssh ssh-command copy-command],
                 display: %w[format color verbose trace],
-                global: %w[help version debug log-level] }.freeze
+                global: %w[help version debug log-level clear-cache] }.freeze
 
     ACTION_OPTS = OPTIONS.values.flatten.freeze
 
@@ -969,8 +969,8 @@ module Bolt
       end
 
       separator "\nPLAN OPTIONS"
-      define('--pp', 'Create a new Puppet language plan.') do |pp|
-        @options[:puppet] = pp
+      define('--pp', 'Create a new Puppet language plan.') do |_|
+        @options[:puppet] = true
       end
 
       separator "\nDISPLAY OPTIONS"
@@ -1025,6 +1025,10 @@ module Bolt
              "trace, debug, info, warn, error, fatal, any.") do |level|
         @options[:log] = { 'console' => { 'level' => level } }
       end
+      define('--clear-cache',
+             "Clear plugin cache before executing") do |_|
+        @options[:clear_cache] = true
+      end
       define('--plugin PLUGIN', 'Select the plugin to use') do |plug|
         @options[:plugin] = plug
       end

data/lib/bolt/cli.rb

@@ -197,7 +197,12 @@ module Bolt
       @parser_deprecations.each { |dep| Bolt::Logger.deprecation_warning(dep[:type], dep[:msg]) }
       config.deprecations.each { |dep| Bolt::Logger.deprecation_warning(dep[:type], dep[:msg]) }
 
+      if options[:clear_cache] && File.exist?(config.project.cache_file)
+        FileUtils.rm(config.project.cache_file)
+      end
+
       warn_inventory_overrides_cli(options)
+      validate_ps_version
 
       options
     rescue Bolt::Error => e
@@ -205,6 +210,20 @@ module Bolt
       raise e
     end
 
+    private def validate_ps_version
+      if Bolt::Util.powershell?
+        command = "powershell.exe -NoProfile -NonInteractive -NoLogo -ExecutionPolicy "\
+                  "Bypass -Command $PSVersionTable.PSVersion.Major"
+        stdout, _stderr, _status = Open3.capture3(command)
+
+        return unless !stdout.empty? && stdout.to_i < 3
+
+        msg = "Detected PowerShell 2 on controller. PowerShell 2 is deprecated and "\
+              "support will be removed in Bolt 3.0."
+        Bolt::Logger.deprecation_warning("PowerShell 2 controller", msg)
+      end
+    end
+
     def update_targets(options)
       target_opts = options.keys.select { |opt| %i[query rerun targets].include?(opt) }
       target_string = "'--targets', '--rerun', or '--query'"
@@ -475,9 +494,9 @@ module Bolt
       when 'module'
         case options[:action]
         when 'add'
-          code = add_project_module(options[:object], config.project)
+          code = add_project_module(options[:object], config.project, config.module_install)
         when 'install'
-          code = install_project_modules(config.project, options[:force], options[:resolve])
+          code = install_project_modules(config.project, config.module_install, options[:force], options[:resolve])
         when 'generate-types'
           code = generate_types
         end
@@ -522,12 +541,15 @@ module Bolt
               validate_file('script', script)
               executor.run_script(targets, script, options[:leftovers], executor_opts)
             when 'task'
-              pal.run_task(options[:object],
-                           targets,
-                           options[:task_options],
-                           executor,
-                           inventory,
-                           options[:description])
+              r = outputter.spin do
+                pal.run_task(options[:object],
+                             targets,
+                             options[:task_options],
+                             executor,
+                             inventory,
+                             options[:description])
+              end
+              r
             when 'file'
               src = options[:object]
               dest = options[:leftovers].first
@@ -662,7 +684,9 @@ module Bolt
 
       executor.subscribe(log_outputter)
       executor.start_plan(plan_context)
-      result = pal.run_plan(plan_name, plan_arguments, executor, inventory, puppetdb_client)
+      result = outputter.spin do
+        pal.run_plan(plan_name, plan_arguments, executor, inventory, puppetdb_client)
+      end
 
       # If a non-bolt exception bubbles up the plan won't get finished
       executor.finish_plan(result)
@@ -727,7 +751,7 @@ module Bolt
 
     # Installs modules declared in the project configuration file.
     #
-    def install_project_modules(project, force, resolve)
+    def install_project_modules(project, config, force, resolve)
       assert_project_file(project)
       assert_puppetfile_or_module_command(project.modules)
 
@@ -737,30 +761,39 @@ module Bolt
         return 0
       end
 
+      modules   = project.modules || []
       installer = Bolt::ModuleInstaller.new(outputter, pal)
 
-      ok = installer.install(project.modules,
-                             project.puppetfile,
-                             project.managed_moduledir,
-                             force: force,
-                             resolve: resolve)
+      ok = outputter.spin do
+        installer.install(modules,
+                          project.puppetfile,
+                          project.managed_moduledir,
+                          config,
+                          force: force,
+                          resolve: resolve)
+      end
+
       ok ? 0 : 1
     end
 
     # Adds a single module to the project.
     #
-    def add_project_module(name, project)
+    def add_project_module(name, project, config)
       assert_project_file(project)
       assert_puppetfile_or_module_command(project.modules)
 
       modules   = project.modules || []
       installer = Bolt::ModuleInstaller.new(outputter, pal)
 
-      ok = installer.add(name,
-                         modules,
-                         project.puppetfile,
-                         project.managed_moduledir,
-                         project.project_file)
+      ok = outputter.spin do
+        installer.add(name,
+                      modules,
+                      project.puppetfile,
+                      project.managed_moduledir,
+                      project.project_file,
+                      config)
+      end
+
       ok ? 0 : 1
     end
 
@@ -789,7 +822,10 @@ module Bolt
 
       outputter.print_message("Installing modules from Puppetfile")
       installer = Bolt::ModuleInstaller.new(outputter, pal)
-      ok = installer.install_puppetfile(puppetfile, moduledir, puppetfile_config)
+      ok = outputter.spin do
+        installer.install_puppetfile(puppetfile, moduledir, puppetfile_config)
+      end
+
       ok ? 0 : 1
     end
 
@@ -822,6 +858,10 @@ module Bolt
         raise Bolt::CLIError,
               "Unable to use command '#{old_command}' when 'modules' is configured in "\
               "bolt-project.yaml. Use '#{new_command}' instead."
+      elsif modules.nil? && options[:subcommand] == 'puppetfile'
+        msg = "Command '#{old_command}' is deprecated and will be removed in Bolt 3.0. Update your project to use "\
+              "the module management feature. For more information, see https://pup.pt/bolt-module-migrate."
+        Bolt::Logger.deprecation_warning('puppetfile command', msg)
       elsif modules.nil? && options[:subcommand] == 'module'
         msg  = "Unable to use command '#{new_command}' when 'modules' is not configured in "\
                "bolt-project.yaml. "
@@ -895,7 +935,11 @@ module Bolt
     end
 
     def outputter
-      @outputter ||= Bolt::Outputter.for_format(config.format, config.color, options[:verbose], config.trace)
+      @outputter ||= Bolt::Outputter.for_format(config.format,
+                                                config.color,
+                                                options[:verbose],
+                                                config.trace,
+                                                config.spinner)
     end
 
     def log_outputter

data/lib/bolt/config.rb

@@ -7,7 +7,7 @@ require 'bolt/project'
 require 'bolt/logger'
 require 'bolt/util'
 require 'bolt/config/options'
-require 'bolt/config/validator'
+require 'bolt/validator'
 
 module Bolt
   class UnknownTransportError < Bolt::Error
@@ -43,7 +43,7 @@ module Bolt
 
                # Validate the config against the schema. This will raise a single error
                # with all validation errors.
-               Validator.new.tap do |validator|
+               Bolt::Validator.new.tap do |validator|
                  validator.validate(c, bolt_schema, project.config_file.to_s)
 
                  validator.warnings.each { |warning| logs << { warn: warning } }
@@ -56,7 +56,6 @@ module Bolt
                logs << { debug: "Loaded configuration from #{project.config_file}" } if File.exist?(project.config_file)
                c
              end
-
       data = load_defaults(project).push(
         filepath:     project.config_file,
         data:         conf,
@@ -79,7 +78,7 @@ module Bolt
 
                # Validate the config against the schema. This will raise a single error
                # with all validation errors.
-               Validator.new.tap do |validator|
+               Bolt::Validator.new.tap do |validator|
                  validator.validate(c, bolt_schema, project.config_file.to_s)
 
                  validator.warnings.each { |warning| logs << { warn: warning } }
@@ -103,22 +102,36 @@ module Bolt
       new(project, data, overrides)
     end
 
-    def self.defaults_schema
-      base      = OPTIONS.slice(*BOLT_DEFAULTS_OPTIONS)
-      inventory = INVENTORY_OPTIONS.each_with_object({}) do |(option, definition), acc|
+    # Builds a hash of definitions for transport configuration.
+    #
+    def self.transport_definitions
+      INVENTORY_OPTIONS.each_with_object({}) do |(option, definition), acc|
         acc[option] = TRANSPORT_CONFIG.key?(option) ? definition.merge(TRANSPORT_CONFIG[option].schema) : definition
       end
+    end
+
+    # Builds the schema for bolt-defaults.yaml used by the validator.
+    #
+    def self.defaults_schema
+      schema = {
+        type:        Hash,
+        properties:  BOLT_DEFAULTS_OPTIONS.map { |opt| [opt, _ref: opt] }.to_h,
+        definitions: OPTIONS.merge(transport_definitions)
+      }
+
+      schema[:definitions]['inventory-config'][:properties] = transport_definitions
 
-      base['inventory-config'][:properties] = inventory
-      base
+      schema
     end
 
+    # Builds the schema for bolt.yaml used by the validator.
+    #
     def self.bolt_schema
-      inventory = INVENTORY_OPTIONS.each_with_object({}) do |(option, definition), acc|
-        acc[option] = TRANSPORT_CONFIG.key?(option) ? definition.merge(TRANSPORT_CONFIG[option].schema) : definition
-      end
-
-      OPTIONS.slice(*BOLT_OPTIONS).merge(inventory)
+      {
+        type:        Hash,
+        properties:  (BOLT_OPTIONS + INVENTORY_OPTIONS.keys).map { |opt| [opt, _ref: opt] }.to_h,
+        definitions: OPTIONS.merge(transport_definitions)
+      }
     end
 
     def self.system_path
@@ -154,7 +167,7 @@ module Bolt
 
       # Validate the config against the schema. This will raise a single error
       # with all validation errors.
-      Validator.new.tap do |validator|
+      Bolt::Validator.new.tap do |validator|
         validator.validate(data, defaults_schema, filepath)
 
         validator.warnings.each { |warning| logs << { warn: warning } }
@@ -216,12 +229,12 @@ module Bolt
       data         = Bolt::Util.read_yaml_hash(filepath, 'config')
       logs         = [{ debug: "Loaded configuration from #{filepath}" }]
       deprecations = [{ type: 'Using bolt.yaml for system configuration',
-                        msg: "Configuration file #{filepath} is deprecated and will be removed in a future version "\
-                        "of Bolt. Use '#{dir + BOLT_DEFAULTS_NAME}' instead." }]
+                        msg: "Configuration file #{filepath} is deprecated and will be removed in Bolt 3.0. "\
+                        "See https://pup.pt/update-bolt-config for how to update to the latest Bolt practices." }]
 
       # Validate the config against the schema. This will raise a single error
       # with all validation errors.
-      Validator.new.tap do |validator|
+      Bolt::Validator.new.tap do |validator|
         validator.validate(data, bolt_schema, filepath)
 
         validator.warnings.each { |warning| logs << { warn: warning } }
@@ -283,12 +296,14 @@ module Bolt
         'concurrency'         => default_concurrency,
         'format'              => 'human',
         'log'                 => { 'console' => {} },
+        'module-install'      => {},
         'plugin-hooks'        => {},
         'plugin_hooks'        => {},
         'plugins'             => {},
         'puppetdb'            => {},
         'puppetfile'          => {},
         'save-rerun'          => true,
+        'spinner'             => true,
         'transport'           => 'ssh'
       }
 
@@ -353,7 +368,7 @@ module Bolt
       overrides['trace'] = opts['trace'] if opts.key?('trace')
 
       # Validate the overrides
-      Validator.new.validate(overrides, OPTIONS, 'command line')
+      Bolt::Validator.new.validate(overrides, self.class.bolt_schema, 'command line')
 
       overrides
     end
@@ -408,7 +423,7 @@ module Bolt
       end
 
       # Filter hashes to only include valid options
-      %w[apply-settings apply_settings puppetfile].each do |opt|
+      %w[apply-settings apply_settings module-install puppetfile].each do |opt|
         @data[opt] = @data[opt].slice(*OPTIONS.dig(opt, :properties).keys)
       end
     end
@@ -433,31 +448,14 @@ module Bolt
         next if val == 'disable'
 
         name = normalize_log(key)
+        acc[name] = val.slice('append', 'level').transform_keys(&:to_sym)
 
-        # But otherwise it has to be a Hash
-        unless val.is_a?(Hash)
-          raise Bolt::ValidationError,
-                "config of log #{name} must be a Hash, received #{val.class} #{val.inspect}"
-        end
-
-        acc[name] = val.slice('append', 'level')
-                       .transform_keys(&:to_sym)
+        next unless acc[name][:level] == 'notice'
 
-        if (v = acc[name][:level])
-          unless v.is_a?(String) || v.is_a?(Symbol)
-            raise Bolt::ValidationError,
-                  "level of log #{name} must be a String or Symbol, received #{v.class} #{v.inspect}"
-          end
-          unless Bolt::Logger.valid_level?(v)
-            raise Bolt::ValidationError,
-                  "level of log #{name} must be one of #{Bolt::Logger.levels.join(', ')}; received #{v}"
-          end
-        end
-
-        if (v = acc[name][:append]) && v != true && v != false
-          raise Bolt::ValidationError,
-                "append flag of log #{name} must be a Boolean, received #{v.class} #{v.inspect}"
-        end
+        @deprecations << {
+          type: 'notice log level',
+          msg:  "Log level 'notice' is deprecated and will be removed in Bolt 3.0. Use 'info' instead."
+        }
       end
     end
 
@@ -486,8 +484,23 @@ module Bolt
         Bolt::Util.validate_file('inventory file', default_inventoryfile)
       end
 
-      unless TRANSPORT_CONFIG.include?(transport)
-        raise UnknownTransportError, transport
+      # Warn the user how they should be using the 'puppetfile' or
+      # 'module-install' config options. We don't error here since these
+      # settings can be set at the user or system level.
+      if @project.modules && puppetfile_config.any? && module_install.empty?
+        command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
+        @logs << { warn: "Detected configuration for 'puppetfile'. This setting is not "\
+                         "used when 'modules' is configured. Use 'module-install' instead. "\
+                         "To automatically update your project configuration, run '#{command}'." }
+      elsif @project.modules.nil? && puppetfile_config.empty? && module_install.any?
+        @logs << { warn: "Detected configuration for 'module-install'. This setting is not "\
+                         "used when 'modules' is not configured. Use 'puppetfile' instead." }
+      elsif @project.modules && puppetfile_config.any? && module_install.any?
+        @logs << { warn: "Detected configuration for 'puppetfile' and 'module-install'. Using "\
+                         "configuration for 'module-install' because 'modules' is also configured." }
+      elsif @project.modules.nil? && puppetfile_config.any? && module_install.any?
+        @logs << { warn: "Detected configuration for 'puppetfile' and 'module-install'. Using "\
+                         "configuration for 'puppetfile' because 'modules' is not configured." }
       end
     end
 
@@ -521,6 +534,10 @@ module Bolt
       @data['modulepath'] = value
     end
 
+    def plugin_cache
+      @project.plugin_cache || @data['plugin-cache'] || {}
+    end
+
     def concurrency
       @data['concurrency']
     end
@@ -553,6 +570,10 @@ module Bolt
       @data['save-rerun']
     end
 
+    def spinner
+      @data['spinner']
+    end
+
     def inventoryfile
       @data['inventoryfile']
     end
@@ -607,6 +628,10 @@ module Bolt
       @data['transport']
     end
 
+    def module_install
+      @project.module_install || @data['module-install']
+    end
+
     # Check if there is a case-insensitive match to the path
     def check_path_case(type, paths)
       return if paths.nil?