bolt 2.42.0 → 3.3.0

data/lib/bolt/config.rb

@@ -20,10 +20,9 @@ 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'
+    DEFAULTS_NAME = 'bolt-defaults.yaml'
 
     # The default concurrency value that is used when the ulimit is not low (i.e. < 700)
     DEFAULT_DEFAULT_CONCURRENCY = 100
@@ -33,70 +32,9 @@ module Bolt
     end
 
     def self.from_project(project, overrides = {})
-      logs         = []
-      deprecations = []
-
-      conf = if project.project_file == project.config_file
-               project.data
-             else
-               c = Bolt::Util.read_optional_yaml_hash(project.config_file, 'config')
-
-               # Validate the config against the schema. This will raise a single error
-               # with all validation errors.
-               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
-               end
-
-               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,
-        logs:         logs,
-        deprecations: deprecations
-      )
-
-      new(project, data, overrides)
-    end
-
-    def self.from_file(configfile, overrides = {})
-      project      = Bolt::Project.create_project(Pathname.new(configfile).expand_path.dirname)
-      logs         = []
-      deprecations = []
-
-      conf = if project.project_file == project.config_file
-               project.data
-             else
-               c = Bolt::Util.read_yaml_hash(configfile, 'config')
-
-               # Validate the config against the schema. This will raise a single error
-               # with all validation errors.
-               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
-               end
-
-               logs << { debug: "Loaded configuration from #{configfile}" }
-               c
-             end
-
-      data = load_defaults(project).push(
-        filepath:     configfile,
-        data:         conf,
-        logs:         logs,
-        deprecations: deprecations
+      data = load_defaults.push(
+        filepath: project.project_file,
+        data: project.data
       )
 
       new(project, data, overrides)
@@ -115,7 +53,7 @@ module Bolt
     def self.defaults_schema
       schema = {
         type:        Hash,
-        properties:  BOLT_DEFAULTS_OPTIONS.map { |opt| [opt, _ref: opt] }.to_h,
+        properties:  DEFAULTS_OPTIONS.map { |opt| [opt, _ref: opt] }.to_h,
         definitions: OPTIONS.merge(transport_definitions)
       }
 
@@ -124,16 +62,6 @@ module Bolt
       schema
     end
 
-    # Builds the schema for bolt.yaml used by the validator.
-    #
-    def self.bolt_schema
-      {
-        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
       if Bolt::Util.windows?
         Pathname.new(File.join(ENV['ALLUSERSPROFILE'], 'PuppetLabs', 'bolt', 'etc'))
@@ -149,41 +77,31 @@ module Bolt
     end
 
     # Loads a 'bolt-defaults.yaml' file, which contains default configuration that applies to all
-    # projects. This file does not allow project-specific configuration such as 'hiera-config' and
-    # 'inventoryfile', and nests all default inventory configuration under an 'inventory-config' key.
+    # projects. This file does not allow project-specific configuration such as 'hiera-config'
+    # and nests all default inventory configuration under an 'inventory-config' key.
     def self.load_bolt_defaults_yaml(dir)
-      filepath     = dir + BOLT_DEFAULTS_NAME
+      filepath     = dir + DEFAULTS_NAME
       data         = Bolt::Util.read_yaml_hash(filepath, 'config')
-      logs         = [{ debug: "Loaded configuration from #{filepath}" }]
-      deprecations = []
-
-      # 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}' "\
-          "will be ignored."
-        )
-      end
+
+      Bolt::Logger.debug("Loaded configuration from #{filepath}")
 
       # Validate the config against the schema. This will raise a single error
       # with all validation errors.
       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.
-      project_config = data.slice(*(BOLT_PROJECT_OPTIONS - BOLT_DEFAULTS_OPTIONS))
+      project_config = data.slice(*(PROJECT_OPTIONS - DEFAULTS_OPTIONS))
 
       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
@@ -193,8 +111,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'."
         )
@@ -219,55 +139,20 @@ module Bolt
         data = data.merge(data.delete('inventory-config'))
       end
 
-      { filepath: filepath, data: data, logs: logs, deprecations: deprecations }
-    end
-
-    # Loads a 'bolt.yaml' file, the legacy configuration file. There's no special munging needed
-    # here since Bolt::Config will just ignore any invalid keys.
-    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." }]
-
-      # Validate the config against the schema. This will raise a single error
-      # with all validation errors.
-      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
-      end
-
-      { filepath: filepath, data: data, logs: logs, deprecations: deprecations }
+      { filepath: filepath, data: data }
     end
 
-    def self.load_defaults(project)
+    def self.load_defaults
       confs = []
 
-      # Load system-level config. Prefer a 'bolt-defaults.yaml' file, but fall back to the
-      # legacy 'bolt.yaml' file. If the project-level config file is also the system-level
-      # config file, don't load it a second time.
-      if File.exist?(system_path + BOLT_DEFAULTS_NAME)
+      # Load system-level config.
+      if File.exist?(system_path + DEFAULTS_NAME)
         confs << load_bolt_defaults_yaml(system_path)
-      elsif File.exist?(system_path + BOLT_CONFIG_NAME) &&
-            (system_path + BOLT_CONFIG_NAME) != project.config_file
-        confs << load_bolt_yaml(system_path)
       end
 
-      # Load user-level config if there is a homedir. Prefer a 'bolt-defaults.yaml' file, but
-      # fall back to the legacy 'bolt.yaml' file.
-      if user_path
-        if File.exist?(user_path + BOLT_DEFAULTS_NAME)
-          confs << load_bolt_defaults_yaml(user_path)
-        elsif File.exist?(user_path + BOLT_CONFIG_NAME)
-          confs << load_bolt_yaml(user_path)
-        end
+      # Load user-level config if there is a homedir.
+      if user_path && File.exist?(user_path + DEFAULTS_NAME)
+        confs << load_bolt_defaults_yaml(user_path)
       end
 
       confs
@@ -275,33 +160,26 @@ 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.project_file, data: config_data }]
       end
 
       @logger       = Bolt::Logger.logger(self)
       @project      = project
-      @logs         = @project.logs.dup
-      @deprecations = @project.deprecations.dup
       @transports   = {}
       @config_files = []
 
       default_data = {
         'apply-settings'      => {},
-        'apply_settings'      => {},
         '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'
@@ -315,9 +193,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])
@@ -347,28 +222,25 @@ module Bolt
     def normalize_overrides(options)
       opts = options.transform_keys(&:to_s)
 
-      # Pull out config options. We need to add 'transport' as it's not part of the
-      # OPTIONS hash but is a valid option that can be set with the --transport CLI option
-      overrides = opts.slice(*OPTIONS.keys, 'transport')
+      # Pull out config options. We need to add 'transport' and 'inventoryfile' as they're
+      # not part of the OPTIONS hash but are valid options that can be set with CLI options
+      overrides = opts.slice(*OPTIONS.keys, 'inventoryfile', 'transport')
 
       # Pull out transport config options
       TRANSPORT_CONFIG.each do |transport, config|
         overrides[transport] = opts.slice(*config.options)
       end
 
-      # Set console log to debug if in debug mode
-      if options[:debug]
-        overrides['log'] = { 'console' => { 'level' => 'debug' } }
-      end
-
-      if options[:puppetfile_path]
-        @puppetfile = options[:puppetfile_path]
-      end
-
       overrides['trace'] = opts['trace'] if opts.key?('trace')
 
-      # Validate the overrides
-      Bolt::Validator.new.validate(overrides, self.class.bolt_schema, 'command line')
+      # Validate the overrides that can have arbitrary values
+      schema = {
+        type:        Hash,
+        properties:  CLI_OPTIONS.map { |opt| [opt, _ref: opt] }.to_h,
+        definitions: OPTIONS.merge(INVENTORY_OPTIONS)
+      }
+
+      Bolt::Validator.new.validate(overrides.slice(*CLI_OPTIONS), schema, 'command line')
 
       overrides
     end
@@ -386,8 +258,11 @@ module Bolt
           when *TRANSPORT_CONFIG.keys
             Bolt::Util.deep_merge(val1, val2)
           # Hash values are shallow merged
-          when 'puppetdb', 'plugin-hooks', 'plugin_hooks', 'apply-settings', 'apply_settings', 'log'
+          when 'apply-settings', 'log', 'plugin-hooks', 'puppetdb'
             val1.merge(val2)
+          # Disabled warnings are concatenated
+          when 'disable-warnings'
+            val1.concat(val2)
           # All other values are overwritten
           else
             val2
@@ -423,7 +298,7 @@ module Bolt
       end
 
       # Filter hashes to only include valid options
-      %w[apply-settings apply_settings module-install puppetfile].each do |opt|
+      %w[apply-settings module-install].each do |opt|
         @data[opt] = @data[opt].slice(*OPTIONS.dig(opt, :properties).keys)
       end
     end
@@ -449,23 +324,18 @@ module Bolt
 
         name = normalize_log(key)
         acc[name] = val.slice('append', 'level').transform_keys(&:to_sym)
-
-        next unless acc[name][:level] == '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
 
     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)
+      if @data['modulepath']&.include?(@project.managed_moduledir.to_s)
         raise Bolt::ValidationError,
               "Found invalid path in modulepath: #{@project.managed_moduledir}. This path "\
               "is automatically appended to the modulepath and cannot be configured."
@@ -483,25 +353,6 @@ module Bolt
       if File.exist?(default_inventoryfile)
         Bolt::Util.validate_file('inventory file', default_inventoryfile)
       end
-
-      # 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
 
     def default_inventoryfile
@@ -517,21 +368,15 @@ module Bolt
     end
 
     def puppetfile
-      @puppetfile || @project.puppetfile
+      @project.puppetfile
     end
 
     def modulepath
-      path = @data['modulepath'] || @project.modulepath
-
-      if @project.modules
-        path + [@project.managed_moduledir.to_s]
-      else
-        path
-      end
+      (@data['modulepath'] || @project.modulepath) + [@project.managed_moduledir.to_s]
     end
 
     def modulepath=(value)
-      @data['modulepath'] = value
+      @data['modulepath'] = Array(value)
     end
 
     def plugin_cache
@@ -574,6 +419,10 @@ module Bolt
       @data['spinner']
     end
 
+    def stream
+      @data['stream']
+    end
+
     def inventoryfile
       @data['inventoryfile']
     end
@@ -582,27 +431,12 @@ module Bolt
       @data['compile-concurrency']
     end
 
-    def puppetfile_config
-      @data['puppetfile']
-    end
-
     def plugins
       @data['plugins']
     end
 
     def plugin_hooks
-      if @data['plugin-hooks'].any? && @data['plugin_hooks'].any?
-        Bolt::Logger.warn_once(
-          "plugin-hooks and plugin_hooks set",
-          "Detected configuration for 'plugin-hooks' and 'plugin_hooks'. Bolt will ignore 'plugin_hooks'."
-        )
-
-        @data['plugin-hooks']
-      elsif @data['plugin-hooks'].any?
-        @data['plugin-hooks']
-      else
-        @data['plugin_hooks']
-      end
+      @data['plugin-hooks']
     end
 
     def trusted_external
@@ -610,18 +444,7 @@ module Bolt
     end
 
     def apply_settings
-      if @data['apply-settings'].any? && @data['apply_settings'].any?
-        Bolt::Logger.warn_once(
-          "apply-settings and apply_settings set",
-          "Detected configuration for 'apply-settings' and 'apply_settings'. Bolt will ignore 'apply_settings'."
-        )
-
-        @data['apply-settings']
-      elsif @data['apply-settings'].any?
-        @data['apply-settings']
-      else
-        @data['apply_settings']
-      end
+      @data['apply-settings']
     end
 
     def transport
@@ -632,6 +455,10 @@ module Bolt
       @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?
@@ -640,7 +467,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