bolt 2.34.0 → 2.40.1

data/lib/bolt/config/options.rb

@@ -33,77 +33,42 @@ module Bolt
             "_plugin" => {
               description: "The name of the plugin.",
               type: "string"
+            },
+            "_cache" => {
+              description: "This feature is experimental. Enable plugin caching and set a time-to-live.",
+              type: "object",
+              required: ["ttl"],
+              properties: {
+                "ttl" => {
+                  description: "Time in seconds to keep the plugin cache.",
+                  type: "integer",
+                  minimum: 0
+                }
+              }
             }
           }
         }
       }.freeze
 
-      # The following constants define the various configuration options available to Bolt.
-      # Each constant is a hash where keys are the configuration option and values are the
-      # option's definition. These options are used in multiple locations:
-      #
-      #   - Automatic type validation when loading and setting configuration
-      #   - Generating reference documentation for configuration files
-      #   - Generating JSON schemas for configuration files
-      #
-      # Data includes keys defined by JSON Schema Draft 07 as well as some metadata used
-      # by Bolt to generate documentation. The following keys are used:
-      #
-      #   :description    String      A detailed description of the option and what it does. This
-      #                               field is used in both documentation and the JSON schemas,
-      #                               and should provide as much detail as possible, including
-      #                               links to relevant documentation.
-      #
-      #   :type           Class       The expected type of a value. These should be Ruby classes,
-      #                               as this field is used to perform automatic type validation.
-      #                               If an option can accept more than one type, this should be
-      #                               an array of types. Boolean values should set :type to
-      #                               [TrueClass, FalseClass], as Ruby does not have a single
-      #                               Boolean class.
-      #
-      #   :items          Hash        A definition hash for items in an array. Similar to values
-      #                               for top-level options, items can have a :description, :type,
-      #                               or any other key in this list.
-      #
-      #   :uniqueItems    Boolean     Whether or not an array should contain only unique items.
-      #
-      #   :properties     Hash        A hash where keys are sub-options and values are definitions
-      #                               for the sub-option. Similar to values for top-level options,
-      #                               properties can have a :description, :type, or any other key
-      #                               in this list.
-      #
-      #   :additionalProperties       A variation of the :properties key, where the hash is a
-      #                   Hash        definition for any properties not specified in :properties.
-      #                               This can be used to permit arbitrary sub-options, such as
-      #                               logs for the 'log' option.
-      #
-      #   :required       Array       An array of properties that are required for options that
-      #                               accept Hash values.
-      #
-      #   :minimum        Integer     The minimum integer value for an option.
-      #
-      #   :enum           Array       An array of values that the option recognizes.
-      #
-      #   :pattern        String      A JSON regex pattern that the option's vaue should match.
-      #
-      #   :format         String      Requires that a string value matches a format defined by the
-      #                               JSON Schema draft.
-      #
-      #   :_plugin        Boolean     Whether the option accepts a plugin reference. This is used
-      #                               when generating the JSON schemas to determine whether or not
-      #                               to include a reference to the _plugin definition. If :_plugin
-      #                               is set to true, the script that generates JSON schemas will
-      #                               automatically recurse through the :items and :properties keys
-      #                               and add plugin references if applicable.
-      #
-      #   :_example       Any         An example value for the option. This is used to generate
-      #                               reference documentation for configuration files.
-      #
-      #   :_default       Any         The documented default value for the option. This is only
-      #                               used to generate reference documentation for configuration
-      #                               files and is not used by Bolt to actually set default values.
+      # 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: {
+            "show_diff" => {
+              description: "Whether to log and report a contextual diff.",
+              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.",
           type: Hash,
@@ -169,9 +134,26 @@ module Bolt
                        "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,
+          required: ["ttl"],
+          properties: {
+            "ttl" => {
+              description: "Time in seconds to keep the plugin cache.",
+              type: Integer,
+              minimum: 0
+            }
+          },
+          _plugin: false,
+          _example: { "ttl" => 3600 }
+        },
         "log" => {
           description: "A map of configuration for the logfile output. Under `log`, you can configure log options "\
                        "for `console` and add configuration for individual log files, such as "\
@@ -183,12 +165,13 @@ module Bolt
           properties: {
             "console" => {
               description: "Configuration for logs output to the console.",
-              type: Hash,
+              type: [String, Hash],
+              enum: ['disable'],
               properties: {
                 "level" => {
                   description: "The type of information to log.",
                   type: String,
-                  enum: %w[trace debug error info warn fatal any],
+                  enum: %w[trace debug error info notice warn fatal any],
                   _default: "warn"
                 }
               }
@@ -207,7 +190,7 @@ module Bolt
               "level" => {
                 description: "The type of information to log.",
                 type: String,
-                enum: %w[trace debug error info warn fatal any],
+                enum: %w[trace debug error info notice warn fatal any],
                 _default: "warn"
               }
             }
@@ -227,6 +210,41 @@ module Bolt
           _example: ["~/.puppetlabs/bolt/modules", "~/.puppetlabs/bolt/site-modules"],
           _default: ["project/modules", "project/site-modules", "project/site"]
         },
+        "module-install" => {
+          description: "Options that configure where Bolt downloads modules from. This option is only used when "\
+                       "installing modules using the `bolt module add|install` commands and "\
+                       "`Add|Install-BoltModule` cmdlets.",
+          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"
+            }
+          },
+          _plugin: false
+        },
         "modules" => {
           description: "A list of module dependencies for the project. Each dependency is a map of data specifying "\
                        "the module to install. To install the project's module dependencies, run the `bolt module "\
@@ -276,14 +294,14 @@ module Bolt
         },
         "name" => {
           description: "The name of the Bolt project. When this option is configured, the project is considered a "\
-                       "[Bolt project](experimental_features.md#bolt-projects), allowing Bolt to load content from "\
-                       "the project directory as though it were a module.",
+                       "[Bolt project](projects.md), allowing Bolt to load content from the project directory "\
+                       "as though it were a module.",
           type: String,
           _plugin: false,
           _example: "myproject"
         },
         "plans" => {
-          description: "A list of plan names to show in `bolt plan show` output, if they exist. This option is used "\
+          description: "A list of plan names and glob patterns to filter the project's plans by. This option is used "\
                        "to limit the visibility of plans for users of the project. For example, project authors "\
                        "might want to limit the visibility of plans that are bundled with Bolt or plans that should "\
                        "only be run as part of another plan. When this option is not configured, all plans are "\
@@ -291,9 +309,19 @@ module Bolt
                        "list.",
           type: Array,
           _plugin: false,
-          _example: ["myproject", "myproject::foo", "myproject::bar"]
+          _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: "\
                        "[`puppet_agent`](https://github.com/puppetlabs/puppetlabs-puppet_agent#puppet_agentinstall) "\
@@ -307,7 +335,11 @@ module Bolt
                        "its value is a map of configuration data. Configurable options are specified by the plugin. "\
                        "Read more about configuring plugins in [Using plugins](using_plugins.md#configuring-plugins).",
           type: Hash,
-          _plugin: true,
+          additionalProperties: {
+            type: Hash,
+            _plugin: true
+          },
+          _plugin: false,
           _example: { "pkcs7" => { "keysize" => 1024 } }
         },
         "puppetdb" => {
@@ -318,49 +350,57 @@ module Bolt
             "cacert" => {
               description: "The path to the ca certificate for PuppetDB.",
               type: String,
-              _example: "/etc/puppetlabs/puppet/ssl/certs/ca.pem"
+              _example: "/etc/puppetlabs/puppet/ssl/certs/ca.pem",
+              _plugin: true
             },
             "cert" => {
               description: "The path to the client certificate file to use for authentication.",
               type: String,
-              _example: "/etc/puppetlabs/puppet/ssl/certs/my-host.example.com.pem"
+              _example: "/etc/puppetlabs/puppet/ssl/certs/my-host.example.com.pem",
+              _plugin: true
             },
             "connect_timeout" => {
               description: "How long to wait in seconds when establishing connections with PuppetDB.",
               type: Integer,
               minimum: 1,
               _default: 60,
-              _example: 120
+              _example: 120,
+              _plugin: true
             },
             "key" => {
               description: "The private key for the certificate.",
               type: String,
-              _example: "/etc/puppetlabs/puppet/ssl/private_keys/my-host.example.com.pem"
+              _example: "/etc/puppetlabs/puppet/ssl/private_keys/my-host.example.com.pem",
+              _plugin: true
             },
             "read_timeout" => {
               description: "How long to wait in seconds for a response from PuppetDB.",
               type: Integer,
               minimum: 1,
               _default: 60,
-              _example: 120
+              _example: 120,
+              _plugin: true
             },
             "server_urls" => {
               description: "An array containing the PuppetDB host to connect to. Include the protocol `https` "\
                            "and the port, which is usually `8081`. For example, "\
                            "`https://my-puppetdb-server.com:8081`.",
               type: Array,
-              _example: ["https://puppet.example.com:8081"]
+              _example: ["https://puppet.example.com:8081"],
+              _plugin: true
             },
             "token" => {
               description: "The path to the PE RBAC Token.",
               type: String,
-              _example: "~/.puppetlabs/token"
+              _example: "~/.puppetlabs/token",
+              _plugin: true
             }
           },
           _plugin: true
         },
         "puppetfile" => {
-          description: "A map containing options for the `bolt puppetfile install` command.",
+          description: "A map containing options for the `bolt puppetfile install` command and "\
+                       "`Install-BoltPuppetfile` cmdlet.",
           type: Hash,
           properties: {
             "forge" => {
@@ -375,19 +415,19 @@ module Bolt
                   _example: "https://forge.example.com"
                 },
                 "proxy" => {
-                  description: "The HTTP proxy to use for Git and Forge operations.",
+                  description: "The HTTP proxy to use for Forge operations.",
                   type: String,
                   format: "uri",
-                  _example: "https://forgeapi.example.com"
+                  _example: "https://my-forge-proxy.com:8080"
                 }
               },
-              _example: { "baseurl" => "https://forge.example.com", "proxy" => "https://forgeapi.example.com" }
+              _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://forgeapi.example.com"
+              _example: "https://my-proxy.com:8080"
             }
           },
           _plugin: false
@@ -401,8 +441,16 @@ module Bolt
           _example: false,
           _default: true
         },
+        "spinner" => {
+          description: "Whether to print a spinner to the console for long-running Bolt operations.",
+          type: [TrueClass, FalseClass],
+          _plugin: false,
+          _example: false,
+          _default: true
+        },
+
         "tasks" => {
-          description: "A list of task names to show in `bolt task show` output, if they exist. This option is used "\
+          description: "A list of task names and glob patterns to filter the project's tasks by. This option is used "\
                        "to limit the visibility of tasks for users of the project. For example, project authors "\
                        "might want to limit the visibility of tasks that are bundled with Bolt or plans that should "\
                        "only be run as part of a larger workflow. When this option is not configured, all tasks "\
@@ -413,7 +461,7 @@ module Bolt
             type: String
           },
           _plugin: false,
-          _example: ["myproject", "myproject::foo", "myproject::bar"]
+          _example: ["myproject", "myproject::foo", "myproject::bar", "myproject::deploy_*"]
         },
         "trusted-external-command" => {
           description: "The path to an executable on the Bolt controller that can produce external trusted facts. "\
@@ -435,7 +483,7 @@ module Bolt
                        "specified in the URI.",
           type: String,
           enum: TRANSPORT_CONFIG.keys,
-          _plugin: false,
+          _plugin: true,
           _example: "winrm",
           _default: "ssh"
         },
@@ -461,6 +509,7 @@ module Bolt
         "remote" => {
           description: "A map of configuration options for the remote transport.",
           type: Hash,
+          additionalProperties: true,
           _plugin: true,
           _example: { "run-on" => "proxy_target" }
         },
@@ -480,6 +529,7 @@ module Bolt
 
       # Options that are available in a bolt.yaml file
       BOLT_OPTIONS = %w[
+        apply-settings
         apply_settings
         color
         compile-concurrency
@@ -489,11 +539,13 @@ module Bolt
         inventoryfile
         log
         modulepath
+        plugin-hooks
         plugin_hooks
         plugins
         puppetdb
         puppetfile
         save-rerun
+        spinner
         trusted-external-command
       ].freeze
 
@@ -505,15 +557,20 @@ module Bolt
         format
         inventory-config
         log
+        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[
+        apply-settings
         apply_settings
         color
         compile-concurrency
@@ -523,14 +580,18 @@ module Bolt
         inventoryfile
         log
         modulepath
+        module-install
         modules
         name
         plans
+        plugin-cache
+        plugin-hooks
         plugin_hooks
         plugins
         puppetdb
         puppetfile
         save-rerun
+        spinner
         tasks
         trusted-external-command
       ].freeze

data/lib/bolt/config/transport/base.rb

@@ -2,6 +2,7 @@
 
 require 'bolt/error'
 require 'bolt/util'
+require 'bolt/validator'
 require 'bolt/config/transport/options'
 
 module Bolt
@@ -90,6 +91,14 @@ module Bolt
           self::OPTIONS
         end
 
+        def self.schema
+          {
+            type:       Hash,
+            properties: self::TRANSPORT_OPTIONS.slice(*self::OPTIONS),
+            _plugin:    true
+          }
+        end
+
         private def defaults
           unless defined? self.class::DEFAULTS
             raise NotImplementedError,
@@ -116,25 +125,7 @@ module Bolt
 
         # Validation defaults to just asserting the option types
         private def validate
-          assert_type
-        end
-
-        # Validates that each option is the correct type. Types are loaded from the TRANSPORT_OPTIONS hash.
-        private def assert_type
-          @config.each_pair do |opt, val|
-            types = Array(TRANSPORT_OPTIONS.dig(opt, :type)).compact
-
-            next if val.nil? || types.empty? || types.include?(val.class)
-
-            # Ruby doesn't have a Boolean class, so add it to the types list if TrueClass or FalseClass
-            # are present.
-            if types.include?(TrueClass) || types.include?(FalseClass)
-              types = types - [TrueClass, FalseClass] + ['Boolean']
-            end
-
-            raise Bolt::ValidationError,
-                  "#{opt} must be of type #{types.join(', ')}; received #{val.class} #{val.inspect} "
-          end
+          Bolt::Validator.new.validate(@config.compact, self.class.schema)
         end
       end
     end