bolt 2.37.0 → 2.44.0

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
@@ -20,7 +20,7 @@ module Bolt
   class Config
     include Bolt::Config::Options
 
-    attr_reader :config_files, :logs, :data, :transports, :project, :modified_concurrency, :deprecations
+    attr_reader :config_files, :data, :transports, :project, :modified_concurrency
 
     BOLT_CONFIG_NAME = 'bolt.yaml'
     BOLT_DEFAULTS_NAME = 'bolt-defaults.yaml'
@@ -33,9 +33,6 @@ module Bolt
     end
 
     def self.from_project(project, overrides = {})
-      logs         = []
-      deprecations = []
-
       conf = if project.project_file == project.config_file
                project.data
              else
@@ -43,34 +40,28 @@ 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 } }
-
-                 validator.deprecations.each do |dep|
-                   deprecations << { type: "#{BOLT_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
 
-               logs << { debug: "Loaded configuration from #{project.config_file}" } if File.exist?(project.config_file)
+               if File.exist?(project.config_file)
+                 Bolt::Logger.debug("Loaded configuration from #{project.config_file}")
+               end
                c
              end
 
       data = load_defaults(project).push(
-        filepath:     project.config_file,
-        data:         conf,
-        logs:         logs,
-        deprecations: deprecations
+        filepath: project.config_file,
+        data: conf
       )
 
       new(project, data, overrides)
     end
 
     def self.from_file(configfile, overrides = {})
-      project      = Bolt::Project.create_project(Pathname.new(configfile).expand_path.dirname)
-      logs         = []
-      deprecations = []
+      project = Bolt::Project.create_project(Pathname.new(configfile).expand_path.dirname)
 
       conf = if project.project_file == project.config_file
                project.data
@@ -79,46 +70,55 @@ 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 } }
-
-                 validator.deprecations.each do |dep|
-                   deprecations << { type: "#{BOLT_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
 
-               logs << { debug: "Loaded configuration from #{configfile}" }
+               Bolt::Logger.debug("Loaded configuration from #{configfile}")
+
                c
              end
 
       data = load_defaults(project).push(
-        filepath:     configfile,
-        data:         conf,
-        logs:         logs,
-        deprecations: deprecations
+        filepath: configfile,
+        data: conf
       )
 
       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
 
-      base['inventory-config'][:properties] = inventory
-      base
+    # 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
+
+      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
@@ -141,27 +141,24 @@ module Bolt
     def self.load_bolt_defaults_yaml(dir)
       filepath     = dir + BOLT_DEFAULTS_NAME
       data         = Bolt::Util.read_yaml_hash(filepath, 'config')
-      logs         = [{ debug: "Loaded configuration from #{filepath}" }]
-      deprecations = []
+
+      Bolt::Logger.debug("Loaded configuration from #{filepath}")
 
       # Warn if 'bolt.yaml' detected in same directory.
       if File.exist?(bolt_yaml = dir + BOLT_CONFIG_NAME)
-        logs.push(
-          warn: "Detected multiple configuration files: ['#{bolt_yaml}', '#{filepath}']. '#{bolt_yaml}' "\
+        Bolt::Logger.warn(
+          "multiple_config_files",
+          "Detected multiple configuration files: ['#{bolt_yaml}', '#{filepath}']. '#{bolt_yaml}' "\
           "will be ignored."
         )
       end
 
       # 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 } }
-
-        validator.deprecations.each do |dep|
-          deprecations << { type: "#{BOLT_DEFAULTS_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
 
       # Remove project-specific config such as hiera-config, etc.
@@ -169,8 +166,10 @@ module Bolt
 
       if project_config.any?
         data.reject! { |key, _| project_config.include?(key) }
-        logs.push(
-          warn: "Unsupported project configuration detected in '#{filepath}': #{project_config.keys}. "\
+
+        Bolt::Logger.warn(
+          "unsupported_project_config",
+          "Unsupported project configuration detected in '#{filepath}': #{project_config.keys}. "\
           "Project configuration should be set in 'bolt-project.yaml'."
         )
       end
@@ -180,8 +179,10 @@ module Bolt
 
       if transport_config.any?
         data.reject! { |key, _| transport_config.include?(key) }
-        logs.push(
-          warn: "Unsupported inventory configuration detected in '#{filepath}': #{transport_config.keys}. "\
+
+        Bolt::Logger.warn(
+          "unsupported_inventory_config",
+          "Unsupported inventory configuration detected in '#{filepath}': #{transport_config.keys}. "\
           "Transport configuration should be set under the 'inventory-config' option or "\
           "in 'inventory.yaml'."
         )
@@ -206,7 +207,7 @@ module Bolt
         data = data.merge(data.delete('inventory-config'))
       end
 
-      { filepath: filepath, data: data, logs: logs, deprecations: deprecations }
+      { filepath: filepath, data: data }
     end
 
     # Loads a 'bolt.yaml' file, the legacy configuration file. There's no special munging needed
@@ -214,24 +215,24 @@ module Bolt
     def self.load_bolt_yaml(dir)
       filepath     = dir + BOLT_CONFIG_NAME
       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 Bolt 3.0. "\
-                        "See https://pup.pt/update-bolt-config for how to update to the latest Bolt practices." }]
+
+      Bolt::Logger.debug("Loaded configuration from #{filepath}")
+
+      Bolt::Logger.deprecate(
+        "bolt_yaml",
+        "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 } }
-
-        validator.deprecations.each do |dep|
-          deprecations << { type: "#{BOLT_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
 
-      { filepath: filepath, data: data, logs: logs, deprecations: deprecations }
+      { filepath: filepath, data: data }
     end
 
     def self.load_defaults(project)
@@ -262,16 +263,11 @@ module Bolt
 
     def initialize(project, config_data, overrides = {})
       unless config_data.is_a?(Array)
-        config_data = [{ filepath: project.config_file,
-                         data: config_data,
-                         logs: [],
-                         deprecations: [] }]
+        config_data = [{ filepath: project.config_file, data: config_data }]
       end
 
       @logger       = Bolt::Logger.logger(self)
       @project      = project
-      @logs         = @project.logs.dup
-      @deprecations = @project.deprecations.dup
       @transports   = {}
       @config_files = []
 
@@ -281,14 +277,17 @@ module Bolt
         'color'               => true,
         'compile-concurrency' => Etc.nprocessors,
         'concurrency'         => default_concurrency,
+        'disable-warnings'    => [],
         'format'              => 'human',
         'log'                 => { 'console' => {} },
+        'module-install'      => {},
         'plugin-hooks'        => {},
         'plugin_hooks'        => {},
         'plugins'             => {},
         'puppetdb'            => {},
         'puppetfile'          => {},
         'save-rerun'          => true,
+        'spinner'             => true,
         'transport'           => 'ssh'
       }
 
@@ -300,9 +299,6 @@ module Bolt
       end
 
       loaded_data = config_data.each_with_object([]) do |data, acc|
-        @logs.concat(data[:logs]) if data[:logs].any?
-        @deprecations.concat(data[:deprecations]) if data[:deprecations].any?
-
         if data[:data].any?
           @config_files.push(data[:filepath])
           acc.push(data[:data])
@@ -353,7 +349,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
@@ -373,6 +369,9 @@ module Bolt
           # Hash values are shallow merged
           when 'puppetdb', 'plugin-hooks', 'plugin_hooks', 'apply-settings', 'apply_settings', 'log'
             val1.merge(val2)
+          # Disabled warnings are concatenated
+          when 'disable-warnings'
+            val1.concat(val2)
           # All other values are overwritten
           else
             val2
@@ -408,7 +407,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,46 +432,23 @@ 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)
-
-        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
+        next unless acc[name][:level] == 'notice'
 
-          if v == 'notice'
-            @deprecations << {
-              type: 'notice log level',
-              msg:  "Log level 'notice' is deprecated and will be removed in Bolt 3.0. Use 'info' instead."
-            }
-          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
+        Bolt::Logger.deprecate(
+          "notice_log_level",
+          "Log level 'notice' is deprecated and will be removed in Bolt 3.0. Use 'info' instead."
+        )
       end
     end
 
     def validate
       if @data['future']
-        msg = "Configuration option 'future' no longer exposes future behavior."
-        @logs << { warn: msg }
+        Bolt::Logger.warn(
+          "future_option",
+          "Configuration option 'future' no longer exposes future behavior."
+        )
       end
 
       if @project.modules && @data['modulepath']&.include?(@project.managed_moduledir.to_s)
@@ -494,8 +470,35 @@ 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'
+        Bolt::Logger.warn(
+          "module_install_config",
+          "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?
+        Bolt::Logger.warn(
+          "module_install_config",
+          "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?
+        Bolt::Logger.warn(
+          "module_install_config",
+          "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?
+        Bolt::Logger.warn(
+          "module_install_config",
+          "Detected configuration for 'puppetfile' and 'module-install'. Using "\
+          "configuration for 'puppetfile' because 'modules' is not configured."
+        )
       end
     end
 
@@ -565,6 +568,10 @@ module Bolt
       @data['save-rerun']
     end
 
+    def spinner
+      @data['spinner']
+    end
+
     def inventoryfile
       @data['inventoryfile']
     end
@@ -584,7 +591,7 @@ module Bolt
     def plugin_hooks
       if @data['plugin-hooks'].any? && @data['plugin_hooks'].any?
         Bolt::Logger.warn_once(
-          "plugin-hooks and plugin_hooks set",
+          "plugin_hooks_conflict",
           "Detected configuration for 'plugin-hooks' and 'plugin_hooks'. Bolt will ignore 'plugin_hooks'."
         )
 
@@ -603,7 +610,7 @@ module Bolt
     def apply_settings
       if @data['apply-settings'].any? && @data['apply_settings'].any?
         Bolt::Logger.warn_once(
-          "apply-settings and apply_settings set",
+          "apply_settings_conflict",
           "Detected configuration for 'apply-settings' and 'apply_settings'. Bolt will ignore 'apply_settings'."
         )
 
@@ -619,6 +626,14 @@ module Bolt
       @data['transport']
     end
 
+    def module_install
+      @project.module_install || @data['module-install']
+    end
+
+    def disable_warnings
+      Set.new(@project.disable_warnings + @data['disable-warnings'])
+    end
+
     # Check if there is a case-insensitive match to the path
     def check_path_case(type, paths)
       return if paths.nil?
@@ -627,7 +642,7 @@ module Bolt
       if matches.any?
         msg = "WARNING: Bolt is case sensitive when specifying a #{type}. Did you mean:\n"
         matches.each { |path| msg += "         #{path}\n" }
-        @logger.warn msg
+        Bolt::Logger.warn("path_case", msg)
       end
     end