bolt 2.37.0 → 2.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cbd90e42181c76bad4eee913ee67369202296852cfa5153a1f5490def4e77d3
-  data.tar.gz: 87ac43d10edeebefaa31f581f49cbcf9f729e25f5d7efec583e09dcf04f97be6
+  metadata.gz: 33e89c3fc601a61c1da47fe1f0c7773d54643738e959c297f34e5fe4096ef2b5
+  data.tar.gz: 0edc4e35b500bb08315ef5d6064563d7dad0cbaecd88d3aac03dc4cf43572b33
 SHA512:
-  metadata.gz: 392f0d453c49a536852692e873e5c5f55807294fa0bd914593722c26d39459e494b83453a3b995319b04b8f2e6f3a1f04f7661400841192bdffc56df47e4170e
-  data.tar.gz: 750cd8e9c29008e8bb4dfc7350d52a268c01d91fa088e9007ff241648e31a90e76d9cabfef9f1db5675d33f6b82b2898a54f758bc21c17c18d888919d0441807
+  metadata.gz: f2d3a5675a1560203dc0236cdd7b5a9367728b6b1decdfc85a99136488ab2ed1a10bc492996b2aa5b2681fdba8f2029f9e092a3011d8be4d5bfb2395358ffb6a
+  data.tar.gz: 79b4418d6628573320b1db7740d8196ddb73f55d93f299a68a3c5f436c5986fc9382e48bd5d2e14903d18e3bf648b47493041a9ad0196983e1fb7a06ff9cf4bd

data/Puppetfile

@@ -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/cli.rb

@@ -491,9 +491,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
@@ -538,12 +538,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
@@ -678,7 +681,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)
@@ -743,7 +748,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)
 
@@ -753,30 +758,55 @@ module Bolt
         return 0
       end
 
+      if resolve != false && config.any?
+        @logger.warn(
+          "Detected configuration for 'module-install'. This configuration is currently "\
+          "only supported when installing modules, not when resolving module dependencies. "\
+          "For more information, see https://pup.pt/bolt-module-install"
+        )
+      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)
 
+      if config.any?
+        @logger.warn(
+          "Detected configuration for 'module-install'. This configuration is currently "\
+          "only supported when installing modules, not when resolving module dependencies. "\
+          "For more information, see https://pup.pt/bolt-module-install"
+        )
+      end
+
       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
 
@@ -805,7 +835,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
 
@@ -911,7 +944,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
 
-      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
@@ -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 } }
@@ -221,7 +234,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, 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
@@ -497,6 +512,25 @@ module Bolt
       unless TRANSPORT_CONFIG.include?(transport)
         raise UnknownTransportError, transport
       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
@@ -565,6 +599,10 @@ module Bolt
       @data['save-rerun']
     end
 
+    def spinner
+      @data['spinner']
+    end
+
     def inventoryfile
       @data['inventoryfile']
     end
@@ -619,6 +657,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?

data/lib/bolt/config/options.rb

@@ -50,70 +50,8 @@ module Bolt
         }
       }.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` "\
@@ -272,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 "\
@@ -377,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" => {
@@ -434,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
@@ -460,6 +441,14 @@ 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 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 "\
@@ -494,7 +483,7 @@ module Bolt
                        "specified in the URI.",
           type: String,
           enum: TRANSPORT_CONFIG.keys,
-          _plugin: false,
+          _plugin: true,
           _example: "winrm",
           _default: "ssh"
         },
@@ -555,6 +544,7 @@ module Bolt
         puppetdb
         puppetfile
         save-rerun
+        spinner
         trusted-external-command
       ].freeze
 
@@ -566,6 +556,7 @@ module Bolt
         format
         inventory-config
         log
+        module-install
         plugin-cache
         plugin-hooks
         plugin_hooks
@@ -573,6 +564,7 @@ module Bolt
         puppetdb
         puppetfile
         save-rerun
+        spinner
       ].freeze
 
       # Options that are available in a bolt-project.yaml file
@@ -587,6 +579,7 @@ module Bolt
         inventoryfile
         log
         modulepath
+        module-install
         modules
         name
         plans
@@ -597,6 +590,7 @@ module Bolt
         puppetdb
         puppetfile
         save-rerun
+        spinner
         tasks
         trusted-external-command
       ].freeze