bolt 2.33.2 → 2.38.0

data/lib/bolt/inventory/group.rb

@@ -241,10 +241,11 @@ module Bolt
         end
 
         if input.key?('nodes')
+          command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
           msg = <<~MSG.chomp
                 Found 'nodes' key in group #{@name}. This looks like a v1 inventory file, which is
                 no longer supported by Bolt. Migrate to a v2 inventory file automatically using
-                'bolt project migrate'.
+                '#{command}'.
                 MSG
           raise ValidationError.new(msg, nil)
         end

data/lib/bolt/inventory/options.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'bolt/config/options'
+
+module Bolt
+  class Inventory
+    module Options
+      # Top-level options available in the inventory.
+      OPTIONS = %w[
+        config
+        facts
+        features
+        groups
+        targets
+        vars
+      ].freeze
+
+      # Definitions used to validate the data.
+      # https://github.com/puppetlabs/bolt/blob/main/schemas/README.md
+      DEFINITIONS = {
+        "alias" => {
+          description: "A unique alias to refer to the target. Aliases cannot conflict "\
+                       "with the name of a group, the name of a target, or another alias.",
+          type: [String, Array],
+          uniqueItems: true,
+          items: {
+            type: String,
+            _plugin: true
+          },
+          _plugin: true
+        },
+        "config" => {
+          description: "A map of configuration options.",
+          type: Hash,
+          # These properties are populated as part of Bolt::Inventory.schema
+          properties: {},
+          _plugin: true
+        },
+        "facts" => {
+          description: "A map of system information, also known as facts, for the target.",
+          type: Hash,
+          _plugin: true
+        },
+        "features" => {
+          description: "A list of available features for the target.",
+          type: Array,
+          uniqueItems: true,
+          items: {
+            type: String,
+            _plugin: true
+          },
+          _plugin: true
+        },
+        "groups" => {
+          description: "A list of groups and their associated configuration.",
+          type: Array,
+          items: {
+            type: Hash,
+            required: ["name"],
+            properties: {
+              "config"       => { _ref: "config" },
+              "facts"        => { _ref: "facts" },
+              "features"     => { _ref: "features" },
+              "groups"       => { _ref: "groups" },
+              "name"         => { _ref: "name" },
+              "plugin_hooks" => { _ref: "plugin_hooks" },
+              "targets"      => { _ref: "targets" },
+              "vars"         => { _ref: "vars" }
+            },
+            _plugin: true
+          },
+          _plugin: true
+        },
+        "name" => {
+          description: "A human-readable name to refer to the group or target. Names "\
+                       "cannot conflict with the name of a group, the name of a target, "\
+                       "or the alias of a target. A name is required for a group and is "\
+                       "required for a target unless the uri option is set.",
+          type: String,
+          _plugin: true
+        },
+        "plugin_hooks" => {
+          description: "Configuration for the Puppet library plugin used to install the "\
+                       "Puppet agent on the target. For more information, see "\
+                       "https://pup.pt/bolt-plugin-hooks",
+          type: Hash,
+          properties: {
+            "puppet_library" => {
+              description: "Configuration for the Puppet library plugin.",
+              type: Hash,
+              _plugin: true
+            }
+          },
+          _plugin: true
+        },
+        "targets" => {
+          description: "A list of targets and their associated configuration.",
+          type: Array,
+          items: {
+            type: [String, Hash],
+            properties: {
+              "alias"        => { _ref: "alias" },
+              "config"       => { _ref: "config" },
+              "facts"        => { _ref: "facts" },
+              "features"     => { _ref: "features" },
+              "name"         => { _ref: "name" },
+              "plugin_hooks" => { _ref: "plugin_hooks" },
+              "uri"          => { _ref: "uri" },
+              "vars"         => { _ref: "vars" }
+            },
+            _plugin: true
+          },
+          _plugin: true
+        },
+        "uri" => {
+          description: "The URI of the target. This option is required unless the name "\
+                       "option is set.",
+          type: String,
+          format: "uri",
+          _plugin: true
+        },
+        "vars" => {
+          description: "A map of variables for the group or target.",
+          type: Hash,
+          _plugin: true
+        }
+      }.freeze
+    end
+  end
+end

data/lib/bolt/inventory/target.rb

@@ -31,7 +31,8 @@ module Bolt
         end
 
         if @name == 'localhost'
-          target_data = localhost_defaults(target_data)
+          default = { 'config' => { 'transport' => 'local' } }
+          target_data = Bolt::Util.deep_merge(default, target_data)
         end
 
         @config = target_data['config'] || {}
@@ -49,18 +50,16 @@ module Bolt
         validate
       end
 
-      def localhost_defaults(data)
+      def set_local_defaults
+        return if @set_local_default
         defaults = {
-          'config' => {
-            'transport' => 'local',
-            'local' => { 'interpreters' => { '.rb' => RbConfig.ruby } }
-          },
-          'features' => ['puppet-agent']
+          'local' => { 'interpreters' => { '.rb' => RbConfig.ruby } }
         }
-        data = Bolt::Util.deep_merge(defaults, data)
-        # If features is an empty array deep_merge won't add the puppet-agent
-        data['features'] += ['puppet-agent'] if data['features'].empty?
-        data
+        old_config = @config
+        @config = Bolt::Util.deep_merge(defaults, @config)
+        invalidate_config_cache! if old_config != @config
+        set_feature('puppet-agent')
+        @set_local_default = true
       end
 
       # rubocop:disable Naming/AccessorMethodName

data/lib/bolt/module_installer.rb

@@ -17,14 +17,14 @@ module Bolt
 
     # Adds a single module to the project.
     #
-    def add(name, specs, puppetfile_path, moduledir, config_path)
+    def add(name, specs, puppetfile_path, moduledir, project_file, config)
       project_specs = Specs.new(specs)
 
       # Exit early if project config already includes a spec with this name.
       if project_specs.include?(name)
         @outputter.print_message(
-          "Project configuration file #{config_path} already includes specification with name "\
-          "#{name}. Nothing to do."
+          "Project configuration file #{project_file} already includes specification "\
+          "with name #{name}. Nothing to do."
         )
         return true
       end
@@ -47,30 +47,32 @@ module Bolt
       # a version conflict.
       @outputter.print_action_step("Resolving module dependencies, this may take a moment")
 
+      @outputter.start_spin
       begin
         resolve_specs.add_specs('name' => name)
-        puppetfile = Resolver.new.resolve(resolve_specs)
+        puppetfile = Resolver.new.resolve(resolve_specs, config)
       rescue Bolt::Error
         project_specs.add_specs('name' => name)
-        puppetfile = Resolver.new.resolve(project_specs)
+        puppetfile = Resolver.new.resolve(project_specs, config)
       end
+      @outputter.stop_spin
 
       # Display the diff between the existing Puppetfile and the new Puppetfile.
       print_puppetfile_diff(existing_puppetfile, puppetfile)
 
       # Add the module to the project configuration.
-      @outputter.print_action_step("Updating project configuration file at #{config_path}")
+      @outputter.print_action_step("Updating project configuration file at #{project_file}")
 
-      data = Bolt::Util.read_yaml_hash(config_path, 'project')
+      data = Bolt::Util.read_yaml_hash(project_file, 'project')
       data['modules'] ||= []
       data['modules'] << name.tr('-', '/')
 
       begin
-        File.write(config_path, data.to_yaml)
+        File.write(project_file, data.to_yaml)
       rescue SystemCallError => e
         raise Bolt::FileError.new(
           "Unable to update project configuration file: #{e.message}",
-          config
+          project_file
         )
       end
 
@@ -79,7 +81,7 @@ module Bolt
       puppetfile.write(puppetfile_path, moduledir)
 
       # Install the modules.
-      install_puppetfile(puppetfile_path, moduledir)
+      install_puppetfile(puppetfile_path, moduledir, config)
     end
 
     # Outputs a diff of an old Puppetfile and a new Puppetfile.
@@ -145,7 +147,7 @@ module Bolt
 
     # Installs a project's module dependencies.
     #
-    def install(specs, path, moduledir, force: false, resolve: true)
+    def install(specs, path, moduledir, config = {}, force: false, resolve: true)
       @outputter.print_message("Installing project modules\n\n")
 
       if resolve != false
@@ -155,7 +157,11 @@ module Bolt
         # and write a Puppetfile.
         if force || !path.exist?
           @outputter.print_action_step("Resolving module dependencies, this may take a moment")
-          puppetfile = Resolver.new.resolve(specs)
+
+          # This doesn't use the block as it's more testable to just mock *_spin
+          @outputter.start_spin
+          puppetfile = Resolver.new.resolve(specs, config)
+          @outputter.stop_spin
 
           # We get here either through 'bolt module install' which uses the
           # managed modulepath (which isn't configurable) or through bolt
@@ -177,14 +183,16 @@ module Bolt
       end
 
       # Install the modules.
-      install_puppetfile(path, moduledir)
+      install_puppetfile(path, moduledir, config)
     end
 
     # Installs the Puppetfile and generates types.
     #
     def install_puppetfile(path, moduledir, config = {})
       @outputter.print_action_step("Syncing modules from #{path} to #{moduledir}")
+      @outputter.start_spin
       ok = Installer.new(config).install(path, moduledir)
+      @outputter.stop_spin
 
       # Automatically generate types after installing modules
       @outputter.print_action_step("Generating type references")

data/lib/bolt/module_installer/resolver.rb

@@ -9,7 +9,7 @@ module Bolt
     class Resolver
       # Resolves module specs and returns a Puppetfile object.
       #
-      def resolve(specs)
+      def resolve(specs, _config = {})
         require 'puppetfile-resolver'
 
         # Build the document model from the specs.

data/lib/bolt/outputter.rb

@@ -2,24 +2,25 @@
 
 module Bolt
   class Outputter
-    def self.for_format(format, color, verbose, trace)
+    def self.for_format(format, color, verbose, trace, spin)
       case format
       when 'human'
-        Bolt::Outputter::Human.new(color, verbose, trace)
+        Bolt::Outputter::Human.new(color, verbose, trace, spin)
       when 'json'
-        Bolt::Outputter::JSON.new(color, verbose, trace)
+        Bolt::Outputter::JSON.new(color, verbose, trace, false)
       when 'rainbow'
-        Bolt::Outputter::Rainbow.new(color, verbose, trace)
+        Bolt::Outputter::Rainbow.new(color, verbose, trace, spin)
       when nil
         raise "Cannot use outputter before parsing."
       end
     end
 
-    def initialize(color, verbose, trace, stream = $stdout)
+    def initialize(color, verbose, trace, spin, stream = $stdout)
       @color = color
       @verbose = verbose
       @trace = trace
       @stream = stream
+      @spin = spin
     end
 
     def indent(indent, string)
@@ -34,6 +35,19 @@ module Bolt
     def print_error
       raise NotImplementedError, "print_error() must be implemented by the outputter class"
     end
+
+    def start_spin; end
+
+    def stop_spin; end
+
+    def spin
+      start_spin
+      begin
+        yield
+      ensure
+        stop_spin
+      end
+    end
   end
 end
 

data/lib/bolt/outputter/human.rb

@@ -14,12 +14,13 @@ module Bolt
 
       def print_head; end
 
-      def initialize(color, verbose, trace, stream = $stdout)
+      def initialize(color, verbose, trace, spin, stream = $stdout)
         super
         # Plans and without_default_logging() calls can both be nested, so we
         # track each of them with a "stack" consisting of an integer.
         @plan_depth = 0
         @disable_depth = 0
+        @pinwheel = %w[- \\ | /]
       end
 
       def colorize(color, string)
@@ -30,6 +31,24 @@ module Bolt
         end
       end
 
+      def start_spin
+        return unless @spin
+        @spin = true
+        @spin_thread = Thread.new do
+          loop do
+            sleep(0.1)
+            @stream.print(colorize(:cyan, @pinwheel.rotate!.first + "\b"))
+          end
+        end
+      end
+
+      def stop_spin
+        return unless @spin
+        @spin_thread.terminate
+        @spin = false
+        @stream.print("\b")
+      end
+
       def remove_trail(string)
         string.sub(/\s\z/, '')
       end
@@ -214,9 +233,10 @@ module Bolt
       end
 
       def print_tasks(tasks, modulepath)
-        print_table(tasks)
+        command = Bolt::Util.powershell? ? 'Get-BoltTask -Task <TASK NAME>' : 'bolt task show <TASK NAME>'
+        tasks.any? ? print_table(tasks) : print_message('No available tasks')
         print_message("\nMODULEPATH:\n#{modulepath.join(File::PATH_SEPARATOR)}\n"\
-                        "\nUse `bolt task show <task-name>` to view "\
+                        "\nUse '#{command}' to view "\
                         "details and parameters for a specific task.")
       end
 
@@ -225,20 +245,26 @@ module Bolt
         # Building lots of strings...
         pretty_params = +""
         task_info = +""
-        usage = +"bolt task run --targets <node-name> #{task.name}"
+        usage = if Bolt::Util.powershell?
+                  +"Invoke-BoltTask -Name #{task.name} -Targets <targets>"
+                else
+                  +"bolt task run #{task.name} --targets <targets>"
+                end
 
         task.parameters&.each do |k, v|
           pretty_params << "- #{k}: #{v['type'] || 'Any'}\n"
           pretty_params << "    Default: #{v['default'].inspect}\n" if v.key?('default')
           pretty_params << "    #{v['description']}\n" if v['description']
-          usage << if v['type'].is_a?(Puppet::Pops::Types::POptionalType)
+          usage << if v['type'].start_with?("Optional")
                      " [#{k}=<value>]"
                    else
                      " #{k}=<value>"
                    end
         end
 
-        usage << " [--noop]" if task.supports_noop
+        if task.supports_noop
+          usage << Bolt::Util.powershell? ? '[-Noop]' : '[--noop]'
+        end
 
         task_info << "\n#{task.name}"
         task_info << " - #{task.description}" if task.description
@@ -261,7 +287,11 @@ module Bolt
         # Building lots of strings...
         pretty_params = +""
         plan_info = +""
-        usage = +"bolt plan run #{plan['name']}"
+        usage = if Bolt::Util.powershell?
+                  +"Invoke-BoltPlan -Name #{plan['name']}"
+                else
+                  +"bolt plan run #{plan['name']}"
+                end
 
         plan['parameters'].each do |name, p|
           pretty_params << "- #{name}: #{p['type']}\n"
@@ -287,16 +317,17 @@ module Bolt
       end
 
       def print_plans(plans, modulepath)
-        print_table(plans)
+        command = Bolt::Util.powershell? ? 'Get-BoltPlan -Name <PLAN NAME>' : 'bolt plan show <PLAN NAME>'
+        plans.any? ? print_table(plans) : print_message('No available plans')
         print_message("\nMODULEPATH:\n#{modulepath.join(File::PATH_SEPARATOR)}\n"\
-                        "\nUse `bolt plan show <plan-name>` to view "\
+                        "\nUse '#{command}' to view "\
                         "details and parameters for a specific plan.")
       end
 
       def print_topics(topics)
         print_message("Available topics are:")
         print_message(topics.join("\n"))
-        print_message("\nUse `bolt guide <topic>` to view a specific guide.")
+        print_message("\nUse 'bolt guide <TOPIC>' to view a specific guide.")
       end
 
       def print_guide(guide, _topic)