bolt 2.44.0 → 3.0.0

data/lib/bolt/config.rb

@@ -22,8 +22,7 @@ module Bolt
 
     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,57 +32,9 @@ module Bolt
     end
 
     def self.from_project(project, overrides = {})
-      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| Bolt::Logger.warn(warning[:id], warning[:msg]) }
-                 validator.deprecations.each { |dep| Bolt::Logger.deprecate(dep[:id], dep[:msg]) }
-               end
-
-               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
-      )
-
-      new(project, data, overrides)
-    end
-
-    def self.from_file(configfile, overrides = {})
-      project = Bolt::Project.create_project(Pathname.new(configfile).expand_path.dirname)
-
-      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| Bolt::Logger.warn(warning[:id], warning[:msg]) }
-                 validator.deprecations.each { |dep| Bolt::Logger.deprecate(dep[:id], dep[:msg]) }
-               end
-
-               Bolt::Logger.debug("Loaded configuration from #{configfile}")
-
-               c
-             end
-
-      data = load_defaults(project).push(
-        filepath: configfile,
-        data: conf
+      data = load_defaults.push(
+        filepath: project.project_file,
+        data: project.data
       )
 
       new(project, data, overrides)
@@ -102,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)
       }
 
@@ -111,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'))
@@ -136,23 +77,14 @@ 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')
 
       Bolt::Logger.debug("Loaded configuration from #{filepath}")
 
-      # Warn if 'bolt.yaml' detected in same directory.
-      if File.exist?(bolt_yaml = dir + BOLT_CONFIG_NAME)
-        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.
       Bolt::Validator.new.tap do |validator|
@@ -162,7 +94,7 @@ module Bolt
       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) }
@@ -210,52 +142,17 @@ module Bolt
       { filepath: filepath, data: data }
     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')
-
-      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.
-      Bolt::Validator.new.tap do |validator|
-        validator.validate(data, bolt_schema, filepath)
-        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 }
-    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
@@ -263,7 +160,7 @@ module Bolt
 
     def initialize(project, config_data, overrides = {})
       unless config_data.is_a?(Array)
-        config_data = [{ filepath: project.config_file, data: config_data }]
+        config_data = [{ filepath: project.project_file, data: config_data }]
       end
 
       @logger       = Bolt::Logger.logger(self)
@@ -273,7 +170,6 @@ module Bolt
 
       default_data = {
         'apply-settings'      => {},
-        'apply_settings'      => {},
         'color'               => true,
         'compile-concurrency' => Etc.nprocessors,
         'concurrency'         => default_concurrency,
@@ -282,10 +178,8 @@ module Bolt
         'log'                 => { 'console' => {} },
         'module-install'      => {},
         'plugin-hooks'        => {},
-        'plugin_hooks'        => {},
         'plugins'             => {},
         'puppetdb'            => {},
-        'puppetfile'          => {},
         'save-rerun'          => true,
         'spinner'             => true,
         'transport'           => 'ssh'
@@ -328,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
@@ -367,7 +258,7 @@ 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'
@@ -407,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
@@ -433,13 +324,6 @@ module Bolt
 
         name = normalize_log(key)
         acc[name] = val.slice('append', 'level').transform_keys(&:to_sym)
-
-        next unless acc[name][:level] == 'notice'
-
-        Bolt::Logger.deprecate(
-          "notice_log_level",
-          "Log level 'notice' is deprecated and will be removed in Bolt 3.0. Use 'info' instead."
-        )
       end
     end
 
@@ -451,7 +335,7 @@ module Bolt
         )
       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."
@@ -469,37 +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'
-        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
 
     def default_inventoryfile
@@ -515,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
@@ -580,27 +427,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_conflict",
-          "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
@@ -608,18 +440,7 @@ module Bolt
     end
 
     def apply_settings
-      if @data['apply-settings'].any? && @data['apply_settings'].any?
-        Bolt::Logger.warn_once(
-          "apply_settings_conflict",
-          "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

data/lib/bolt/config/options.rb

@@ -53,42 +53,6 @@ module Bolt
       # Definitions used to validate config options.
       # https://github.com/puppetlabs/bolt/blob/main/schemas/README.md
       OPTIONS = {
-        "apply_settings" => {
-          description: "A map of Puppet settings to use when applying Puppet code using the `apply` "\
-                       "plan function or the `bolt apply` command.",
-          type: Hash,
-          properties: {
-            "evaltrace" => {
-              description: "Whether each resource should log when it is being evaluated.",
-              type: [TrueClass, FalseClass],
-              _example: true,
-              _default: false
-            },
-            "log_level" => {
-              description: "The log level for logs in apply reports from Puppet. These can be seen "\
-                           "in ApplyResults.",
-              type: String,
-              enum: %w[debug info notice warning err alert emerg crit],
-              _example: "debug",
-              _default: "notice"
-            },
-            "show_diff" => {
-              description: "Whether to log and report a contextual diff.",
-              type: [TrueClass, FalseClass],
-              _example: true,
-              _default: false
-            },
-            "trace" => {
-              description: "Whether to print stack traces on some errors. Will print internal Ruby "\
-                           "stack trace interleaved with Puppet function frames.",
-              type: [TrueClass, FalseClass],
-              _example: true,
-              _default: false
-            }
-          },
-          _plugin: false,
-          _deprecation: "This option will be removed in Bolt 3.0. Use `apply-settings` instead."
-        },
         "apply-settings" => {
           description: "A map of Puppet settings to use when applying Puppet code using the `apply` "\
                        "plan function or the `bolt apply` command.",
@@ -182,18 +146,6 @@ module Bolt
           _plugin: false,
           _example: {}
         },
-        "inventoryfile" => {
-          description: "The path to a structured data inventory file used to refer to groups of targets on the "\
-                       "command line and from plans. Read more about using inventory files in [Inventory "\
-                       "files](inventory_file_v2.md).",
-          type: String,
-          _plugin: false,
-          _deprecation: "This option will be removed in Bolt 3.0. Use the `--inventoryfile` command-line option "\
-                        "to use a non-default inventory file or move the file contents to `inventory.yaml` in the "\
-                        "project directory.",
-          _example: "~/.puppetlabs/bolt/inventory.yaml",
-          _default: "project/inventory.yaml"
-        },
         "plugin-cache" => {
           description: "This feature is experimental. Enable plugin caching and set the time-to-live.",
           type: Hash,
@@ -225,7 +177,7 @@ module Bolt
                 "level" => {
                   description: "The type of information to log.",
                   type: String,
-                  enum: %w[trace debug error info notice warn fatal any],
+                  enum: %w[trace debug error info warn fatal any],
                   _default: "warn"
                 }
               }
@@ -244,7 +196,7 @@ module Bolt
               "level" => {
                 description: "The type of information to log.",
                 type: String,
-                enum: %w[trace debug error info notice warn fatal any],
+                enum: %w[trace debug error info warn fatal any],
                 _default: "warn"
               }
             }
@@ -262,7 +214,7 @@ module Bolt
           },
           _plugin: false,
           _example: ["~/.puppetlabs/bolt/modules", "~/.puppetlabs/bolt/site-modules"],
-          _default: ["project/modules", "project/site-modules", "project/site"]
+          _default: ["project/modules"]
         },
         "module-install" => {
           description: "Options that configure where Bolt downloads modules from. This option is only used when "\
@@ -349,6 +301,7 @@ module Bolt
             ]
           },
           _plugin: false,
+          _default: [],
           _example: [
             "puppetlabs-facts",
             { "name" => "puppetlabs-mysql" },
@@ -377,16 +330,6 @@ module Bolt
           _plugin: false,
           _example: ["myproject", "myproject::foo", "myproject::bar", "myproject::deploy::*"]
         },
-        "plugin_hooks" => {
-          description: "A map of [plugin hooks](writing_plugins.md#hooks) and which plugins a hook should use. "\
-                       "The only configurable plugin hook is `puppet_library`, which can use two possible plugins: "\
-                       "[`puppet_agent`](https://github.com/puppetlabs/puppetlabs-puppet_agent#puppet_agentinstall) "\
-                       "and [`task`](using_plugins.md#task).",
-          type: Hash,
-          _plugin: true,
-          _example: { "puppet_library" => { "plugin" => "puppet_agent", "version" => "6.15.0", "_run_as" => "root" } },
-          _deprecation: "This option will be removed in Bolt 3.0. Use `plugin-hooks` instead."
-        },
         "plugin-hooks" => {
           description: "A map of [plugin hooks](writing_plugins.md#hooks) and which plugins a hook should use. "\
                        "The only configurable plugin hook is `puppet_library`, which can use two possible plugins: "\
@@ -464,42 +407,6 @@ module Bolt
           },
           _plugin: true
         },
-        "puppetfile" => {
-          description: "A map containing options for the `bolt puppetfile install` command and "\
-                       "`Install-BoltPuppetfile` cmdlet.",
-          type: Hash,
-          properties: {
-            "forge" => {
-              description: "A subsection that can have its own `proxy` setting to set an HTTP proxy for Forge "\
-                           "operations only, and a `baseurl` setting to specify a different Forge host.",
-              type: Hash,
-              properties: {
-                "baseurl" => {
-                  description: "The URL to the Forge host.",
-                  type: String,
-                  format: "uri",
-                  _example: "https://forge.example.com"
-                },
-                "proxy" => {
-                  description: "The HTTP proxy to use for Forge operations.",
-                  type: String,
-                  format: "uri",
-                  _example: "https://my-forge-proxy.com:8080"
-                }
-              },
-              _example: { "baseurl" => "https://forge.example.com", "proxy" => "https://my-forge-proxy.com:8080" }
-            },
-            "proxy" => {
-              description: "The HTTP proxy to use for Git and Forge operations.",
-              type: String,
-              format: "uri",
-              _example: "https://my-proxy.com:8080"
-            }
-          },
-          _deprecation: "This option 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.",
-          _plugin: false
-        },
         "save-rerun" => {
           description: "Whether to update `.rerun.json` in the Bolt project directory. If "\
                        "your target names include passwords, set this value to `false` to avoid "\
@@ -543,8 +450,8 @@ module Bolt
 
       # Options that configure the inventory, specifically the default transport
       # used by targets and the transports themselves. These options are used in
-      # bolt.yaml, under a 'config' key in inventory.yaml, and under the
-      # 'inventory-config' key in bolt-defaults.yaml.
+      # bolt-defaults.yaml under 'inventory-config' and in inventory.yaml under
+      # 'config'.
       INVENTORY_OPTIONS = {
         "transport" => {
           description: "The default transport to use when the transport for a target is not "\
@@ -595,30 +502,20 @@ module Bolt
         }
       }.freeze
 
-      # Options that are available in a bolt.yaml file
-      BOLT_OPTIONS = %w[
-        apply-settings
-        apply_settings
-        color
+      # Options that are available on the command line
+      # This only includes options where users can provide arbitrary
+      # values from the command-line, allowing the validator to check them
+      CLI_OPTIONS = %w[
         compile-concurrency
         concurrency
         format
-        hiera-config
-        inventoryfile
         log
         modulepath
-        plugin-hooks
-        plugin_hooks
-        plugins
-        puppetdb
-        puppetfile
-        save-rerun
-        spinner
-        trusted-external-command
+        transport
       ].freeze
 
       # Options that are available in a bolt-defaults.yaml file
-      BOLT_DEFAULTS_OPTIONS = %w[
+      DEFAULTS_OPTIONS = %w[
         color
         compile-concurrency
         concurrency
@@ -629,25 +526,21 @@ module Bolt
         module-install
         plugin-cache
         plugin-hooks
-        plugin_hooks
         plugins
         puppetdb
-        puppetfile
         save-rerun
         spinner
       ].freeze
 
       # Options that are available in a bolt-project.yaml file
-      BOLT_PROJECT_OPTIONS = %w[
+      PROJECT_OPTIONS = %w[
         apply-settings
-        apply_settings
         color
         compile-concurrency
         concurrency
         disable-warnings
         format
         hiera-config
-        inventoryfile
         log
         modulepath
         module-install
@@ -656,10 +549,8 @@ module Bolt
         plans
         plugin-cache
         plugin-hooks
-        plugin_hooks
         plugins
         puppetdb
-        puppetfile
         save-rerun
         spinner
         tasks