bolt 2.33.2 → 2.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 956382104b8c11e17fdafa4349b50ec3d7c5ce6b03eaa57ce429bbfad768f8d3
-  data.tar.gz: dd838e10c07c8f0f87266ff5edf3af4f5595fab45e6aab0ebf82e381226d3897
+  metadata.gz: 5d33993b3430c33f173a3a2d07220d175d4545c1992e9bed3bd75a7be7bae9be
+  data.tar.gz: 68fe674fd2d8ec196149938668d68b3e4c2becd3a97639c49ee85a637bb2e5a8
 SHA512:
-  metadata.gz: 6c2b97a1c268d0fd93f1086efe623c740b74d9d1318596b9a74720e0e944455e244bfc2be2d02ba18634ed543a6ad87f6f27b88dc19189b22cd8fa495b75de02
-  data.tar.gz: cff4bdac98aad6247866f989f9f3814dd11497fd73d90b08ecf15824ef0ee2b36c73fffeb296ecb8a6cae19eb2e71ec7b834dfe461fdbadd06d46b05b560a758
+  metadata.gz: 89e8fd86df6d1427fa61df4e54b0a1973ec607bcd46744a5fa4f0316f217ae02fa0b72428527a6d3ef15303f9fae371c62954d5b53a600d4d71589a3b2108656
+  data.tar.gz: e40ee91802e4dcb6a5d542f131800b28f4916ad2245837b34f26bcef128d99485c3d96ab02e498033476fe01fe6e5740be74b985370fd390ded7b8b0683b0e04

data/lib/bolt/bolt_option_parser.rb

@@ -88,7 +88,7 @@ module Bolt
           { flags: OPTIONS[:global] + OPTIONS[:global_config_setters],
             banner: PLAN_CONVERT_HELP }
         when 'new'
-          { flags: OPTIONS[:global] + %w[configfile project],
+          { flags: OPTIONS[:global] + %w[configfile project pp],
             banner: PLAN_NEW_HELP }
         when 'run'
           { flags: ACTION_OPTS + %w[params compile-concurrency tmpdir hiera-config],
@@ -945,6 +945,11 @@ module Bolt
         @options[:resolve] = resolve
       end
 
+      separator "\nPLAN OPTIONS"
+      define('--pp', 'Create a new Puppet language plan.') do |pp|
+        @options[:puppet] = pp
+      end
+
       separator "\nDISPLAY OPTIONS"
       define('--filter FILTER', 'Filter tasks and plans by a matching substring') do |filter|
         unless /^[a-z0-9_:]+$/.match(filter)

data/lib/bolt/cli.rb

@@ -15,17 +15,18 @@ require 'bolt/config'
 require 'bolt/error'
 require 'bolt/executor'
 require 'bolt/inventory'
-require 'bolt/rerun'
 require 'bolt/logger'
+require 'bolt/module_installer'
 require 'bolt/outputter'
-require 'bolt/puppetdb'
+require 'bolt/pal'
+require 'bolt/plan_creator'
 require 'bolt/plugin'
 require 'bolt/project_migrator'
-require 'bolt/pal'
+require 'bolt/puppetdb'
+require 'bolt/rerun'
+require 'bolt/secret'
 require 'bolt/target'
 require 'bolt/version'
-require 'bolt/secret'
-require 'bolt/module_installer'
 
 module Bolt
   class CLIExit < StandardError; end
@@ -196,10 +197,6 @@ module Bolt
 
       warn_inventory_overrides_cli(options)
 
-      # Assert whether the puppetfile/module commands are available depending
-      # on whether 'modules' is configured.
-      assert_puppetfile_or_module_command(config.project.modules)
-
       options
     rescue Bolt::Error => e
       outputter.fatal_error(e)
@@ -228,9 +225,9 @@ module Bolt
 
     def validate(options)
       unless COMMANDS.include?(options[:subcommand])
+        command = Bolt::Util.powershell? ? 'Get-Command -Module PuppetBolt' : 'bolt help'
         raise Bolt::CLIError,
-              "Expected subcommand '#{options[:subcommand]}' to be one of " \
-              "#{COMMANDS.keys.join(', ')}"
+              "'#{options[:subcommand]}' is not a Bolt command. See '#{command}'."
       end
 
       actions = COMMANDS[options[:subcommand]]
@@ -285,8 +282,9 @@ module Bolt
       end
 
       if options[:subcommand] == 'module' && options[:action] == 'install' && options[:object]
+        command = Bolt::Util.powershell? ? 'Add-BoltModule -Module' : 'bolt module add'
         raise Bolt::CLIError, "Invalid argument '#{options[:object]}'. To add a new module to "\
-                              "the project, run 'bolt module add #{options[:object]}'."
+                              "the project, run '#{command} #{options[:object]}'."
       end
 
       if options[:subcommand] != 'file' && options[:subcommand] != 'script' &&
@@ -465,7 +463,16 @@ module Bolt
       when 'plan'
         case options[:action]
         when 'new'
-          code = new_plan(options[:object])
+          command = Bolt::Util.powershell? ? 'New-BoltPlan' : 'bolt plan new'
+          @logger.warn("Command '#{command}' is experimental and subject to changes.")
+          plan_name = options[:object]
+
+          # If this passes validation, it will return the path to the plan to create
+          Bolt::PlanCreator.validate_input(config.project, plan_name)
+          code = Bolt::PlanCreator.create_plan(config.project.plans_path,
+                                               plan_name,
+                                               outputter,
+                                               options[:puppet])
         when 'run'
           code = run_plan(options[:object], options[:task_options], options[:target_args], options)
         end
@@ -617,118 +624,6 @@ module Bolt
       outputter.print_groups(groups)
     end
 
-    def new_plan(plan_name)
-      @logger.warn("Command 'bolt plan new' is experimental and subject to changes.")
-
-      if config.project.name.nil?
-        raise Bolt::Error.new(
-          "Project directory '#{config.project.path}' is not a named project. Unable to create "\
-          "a project-level plan. To name a project, set the 'name' key in the 'bolt-project.yaml' "\
-          "configuration file.",
-          "bolt/unnamed-project-error"
-        )
-      end
-
-      if plan_name !~ Bolt::Module::CONTENT_NAME_REGEX
-        message = <<~MESSAGE.chomp
-          Invalid plan name '#{plan_name}'. Plan names are composed of one or more name segments
-          separated by double colons '::'.
-
-          Each name segment must begin with a lowercase letter, and may only include lowercase
-          letters, digits, and underscores.
-
-          Examples of valid plan names:
-              - #{config.project.name}
-              - #{config.project.name}::my_plan
-        MESSAGE
-
-        raise Bolt::ValidationError, message
-      end
-
-      prefix, *name_segments, basename = plan_name.split('::')
-
-      # If the plan name is just the project name, then create an 'init' plan.
-      # Otherwise, use the last name segment for the plan's filename.
-      basename ||= 'init'
-
-      unless prefix == config.project.name
-        message = "First segment of plan name '#{plan_name}' must match project name '#{config.project.name}'. "\
-                  "Did you mean '#{config.project.name}::#{plan_name}'?"
-
-        raise Bolt::ValidationError, message
-      end
-
-      dir_path = config.project.plans_path.join(*name_segments)
-
-      %w[pp yaml].each do |ext|
-        next unless (path = config.project.plans_path + "#{basename}.#{ext}").exist?
-        raise Bolt::Error.new(
-          "A plan with the name '#{plan_name}' already exists at '#{path}', nothing to do.",
-          'bolt/existing-plan-error'
-        )
-      end
-
-      begin
-        FileUtils.mkdir_p(dir_path)
-      rescue Errno::EEXIST => e
-        raise Bolt::Error.new(
-          "#{e.message}; unable to create plan directory '#{dir_path}'",
-          'bolt/existing-file-error'
-        )
-      end
-
-      plan_path = dir_path + "#{basename}.yaml"
-
-      plan_template = <<~PLAN
-        # This is the structure of a simple plan. To learn more about writing
-        # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans
-
-        # The description sets the description of the plan that will appear
-        # in 'bolt plan show' output.
-        description: A plan created with bolt plan new
-
-        # The parameters key defines the parameters that can be passed to
-        # the plan.
-        parameters:
-          targets:
-            type: TargetSpec
-            description: A list of targets to run actions on
-            default: localhost
-
-        # The steps key defines the actions the plan will take in order.
-        steps:
-          - message: Hello from #{plan_name}
-          - name: command_step
-            command: whoami
-            targets: $targets
-
-        # The return key sets the return value of the plan.
-        return: $command_step
-      PLAN
-
-      begin
-        File.write(plan_path, plan_template)
-      rescue Errno::EACCES => e
-        raise Bolt::FileError.new(
-          "#{e.message}; unable to create plan",
-          plan_path
-        )
-      end
-
-      output = <<~OUTPUT
-        Created plan '#{plan_name}' at '#{plan_path}'
-
-        Show this plan with:
-            bolt plan show #{plan_name}
-        Run this plan with:
-            bolt plan run #{plan_name}
-      OUTPUT
-
-      outputter.print_message(output)
-
-      0
-    end
-
     def run_plan(plan_name, plan_arguments, nodes, options)
       unless nodes.empty?
         if plan_arguments['nodes'] || plan_arguments['targets']
@@ -820,10 +715,12 @@ module Bolt
     end
 
     def list_modules
+      assert_puppetfile_or_module_command(config.project.modules)
       outputter.print_module_list(pal.list_modules)
     end
 
     def generate_types
+      assert_puppetfile_or_module_command(config.project.modules)
       # generate_types will surface a nice error with helpful message if it fails
       pal.generate_types
       0
@@ -844,8 +741,9 @@ module Bolt
             "project name must begin with a lowercase letter and can include lowercase "\
             "letters, numbers, and underscores."
         else
+          command = Bolt::Util.powershell? ? 'New-BoltProject -Name <NAME>' : 'bolt project init <NAME>'
           raise Bolt::ValidationError, "The current directory name '#{name}' is an invalid "\
-            "project name. Please specify a name using 'bolt project init <name>'."
+            "project name. Please specify a name using '#{command}'."
         end
       end
 
@@ -902,6 +800,7 @@ module Bolt
     #
     def install_project_modules(project, force, resolve)
       assert_project_file(project)
+      assert_puppetfile_or_module_command(project.modules)
 
       unless project.modules
         outputter.print_message "Project configuration file #{project.project_file} does not "\
@@ -923,6 +822,7 @@ module Bolt
     #
     def add_project_module(name, project)
       assert_project_file(project)
+      assert_puppetfile_or_module_command(project.modules)
 
       modules   = project.modules || []
       installer = Bolt::ModuleInstaller.new(outputter, pal)
@@ -940,11 +840,13 @@ module Bolt
     def assert_project_file(project)
       unless project.project_file?
         msg = if project.config_file.exist?
+                command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
                 "Detected Bolt configuration file #{project.config_file}, unable to install "\
-                "modules. To update to a project configuration file, run 'bolt project migrate'."
+                "modules. To update to a project configuration file, run '#{command}'."
               else
+                command = Bolt::Util.powershell? ? 'New-BoltProject' : 'bolt project init'
                 "Could not find project configuration file #{project.project_file}, unable "\
-                "to install modules. To create a Bolt project, run 'bolt project init'."
+                "to install modules. To create a Bolt project, run '#{command}'."
               end
 
         raise Bolt::Error.new(msg, 'bolt/missing-project-config-error')
@@ -953,10 +855,12 @@ module Bolt
 
     # Loads a Puppetfile and installs its modules.
     #
-    def install_puppetfile(config, puppetfile, moduledir)
+    def install_puppetfile(puppetfile_config, puppetfile, moduledir)
+      assert_puppetfile_or_module_command(config.project.modules)
+
       outputter.print_message("Installing modules from Puppetfile")
       installer = Bolt::ModuleInstaller.new(outputter, pal)
-      ok = installer.install_puppetfile(puppetfile, moduledir, config)
+      ok = installer.install_puppetfile(puppetfile, moduledir, puppetfile_config)
       ok ? 0 : 1
     end
 
@@ -964,17 +868,36 @@ module Bolt
     # modules being configured.
     #
     def assert_puppetfile_or_module_command(modules)
+      if Bolt::Util.powershell?
+        case options[:action]
+        when 'generate-types'
+          old_command = 'Register-BoltPuppetfileTypes'
+          new_command = 'Register-BoltModuleTypes'
+        when 'install'
+          old_command = 'Install-BoltPuppetfile'
+          new_command = 'Install-BoltModule'
+        when 'show', 'show-modules'
+          old_command = 'Get-BoltPuppetfileModules'
+          new_command = 'Get-BoltModule'
+        end
+      else
+        old_command = "bolt puppetfile #{options[:action]}"
+        new_command = if options[:action] == 'show-modules'
+                        'bolt module show'
+                      else
+                        "bolt module #{options[:action]}"
+                      end
+      end
+
       if modules && options[:subcommand] == 'puppetfile'
         raise Bolt::CLIError,
-              "Unable to use command 'bolt puppetfile #{options[:action]}' when "\
-              "'modules' is configured in bolt-project.yaml. Use the 'module' command "\
-              "instead. For a list of available actions for the 'module' command, run "\
-              "'bolt module --help'."
+              "Unable to use command '#{old_command}' when 'modules' is configured in "\
+              "bolt-project.yaml. Use '#{new_command}' instead."
       elsif modules.nil? && options[:subcommand] == 'module'
-        raise Bolt::CLIError,
-              "Unable to use command 'bolt module #{options[:action]}'. To use "\
-              "this command, update your project configuration to manage module "\
-              "dependencies."
+        msg  = "Unable to use command '#{new_command}' when 'modules' is not configured in "\
+               "bolt-project.yaml. "
+        msg += "Use '#{old_command}' instead." if options[:action] != 'add'
+        raise Bolt::CLIError, msg
       end
     end
 

data/lib/bolt/error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bolt/util'
+
 module Bolt
   class Error < RuntimeError
     attr_reader :kind, :details, :issue_code, :error_code
@@ -37,13 +39,17 @@ module Bolt
     end
 
     def self.unknown_task(task)
-      new("Could not find a task named \"#{task}\". For a list of available tasks, run \"bolt task show\"",
-          'bolt/unknown-task')
+      command = Bolt::Util.powershell? ? "Get-BoltTask" : "bolt task show"
+      new(
+        "Could not find a task named '#{task}'. For a list of available tasks, run '#{command}'.",
+        'bolt/unknown-task'
+      )
     end
 
     def self.unknown_plan(plan)
+      command = Bolt::Util.powershell? ? "Get-BoltPlan" : "bolt plan show"
       new(
-        "Could not find a plan named \"#{plan}\". For a list of available plans, run \"bolt plan show\"",
+        "Could not find a plan named '#{plan}'. For a list of available plans, run '#{command}'.",
         'bolt/unknown-plan'
       )
     end

data/lib/bolt/executor.rb

@@ -293,6 +293,18 @@ module Bolt
       end
     end
 
+    def run_task_with_minimal_logging(targets, task, arguments, options = {})
+      description = options.fetch(:description, "task #{task.name}")
+      log_action(description, targets) do
+        options[:run_as] = run_as if run_as && !options.key?(:run_as)
+        arguments['_task'] = task.name
+
+        batch_execute(targets) do |transport, batch|
+          transport.batch_task(batch, task, arguments, options, [], &method(:publish_event))
+        end
+      end
+    end
+
     def run_task_with(target_mapping, task, options = {}, position = [])
       targets = target_mapping.keys
       description = options.fetch(:description, "task #{task.name}")

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/outputter/human.rb

@@ -214,9 +214,10 @@ module Bolt
       end
 
       def print_tasks(tasks, modulepath)
+        command = Bolt::Util.powershell? ? 'Get-BoltTask -Task <TASK NAME>' : 'bolt task show <TASK NAME>'
         print_table(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 +226,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 +268,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 +298,17 @@ module Bolt
       end
 
       def print_plans(plans, modulepath)
+        command = Bolt::Util.powershell? ? 'Get-BoltPlan -Name <PLAN NAME>' : 'bolt plan show <PLAN NAME>'
         print_table(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)

data/lib/bolt/pal.rb

@@ -390,7 +390,7 @@ module Bolt
                         plan.docstring
                       end
 
-        defaults = plan.parameters.reject { |_, value| value.nil? }.to_h
+        defaults = plan.parameters.to_h.compact
         signature_params = Set.new(plan.parameters.map(&:first))
         parameters = plan.tags(:param).each_with_object({}) do |param, params|
           name = param.name

data/lib/bolt/plan_creator.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+require 'bolt/logger'
+require 'bolt/module'
+require 'bolt/util'
+
+module Bolt
+  module PlanCreator
+    def self.validate_input(project, plan_name)
+      if project.name.nil?
+        raise Bolt::Error.new(
+          "Project directory '#{project.path}' is not a named project. Unable to create "\
+          "a project-level plan. To name a project, set the 'name' key in the 'bolt-project.yaml' "\
+          "configuration file.",
+          "bolt/unnamed-project-error"
+        )
+      end
+
+      if plan_name !~ Bolt::Module::CONTENT_NAME_REGEX
+        message = <<~MESSAGE.chomp
+          Invalid plan name '#{plan_name}'. Plan names are composed of one or more name segments
+          separated by double colons '::'.
+
+          Each name segment must begin with a lowercase letter, and may only include lowercase
+          letters, digits, and underscores.
+
+          Examples of valid plan names:
+              - #{project.name}
+              - #{project.name}::my_plan
+        MESSAGE
+
+        raise Bolt::ValidationError, message
+      end
+
+      prefix, _, basename = segment_plan_name(plan_name)
+
+      unless prefix == project.name
+        message = "First segment of plan name '#{plan_name}' must match project name '#{project.name}'. "\
+                  "Did you mean '#{project.name}::#{plan_name}'?"
+
+        raise Bolt::ValidationError, message
+      end
+
+      %w[pp yaml].each do |ext|
+        next unless (path = project.plans_path + "#{basename}.#{ext}").exist?
+        raise Bolt::Error.new(
+          "A plan with the name '#{plan_name}' already exists at '#{path}', nothing to do.",
+          'bolt/existing-plan-error'
+        )
+      end
+    end
+
+    def self.create_plan(plans_path, plan_name, outputter, is_puppet)
+      _, name_segments, basename = segment_plan_name(plan_name)
+      dir_path = plans_path.join(*name_segments)
+
+      begin
+        FileUtils.mkdir_p(dir_path)
+      rescue Errno::EEXIST => e
+        raise Bolt::Error.new(
+          "#{e.message}; unable to create plan directory '#{dir_path}'",
+          'bolt/existing-file-error'
+        )
+      end
+
+      type = is_puppet ? 'pp' : 'yaml'
+      plan_path = dir_path + "#{basename}.#{type}"
+      plan_template = is_puppet ? puppet_plan(plan_name) : yaml_plan(plan_name)
+
+      begin
+        File.write(plan_path, plan_template)
+      rescue Errno::EACCES => e
+        raise Bolt::FileError.new(
+          "#{e.message}; unable to create plan",
+          plan_path
+        )
+      end
+
+      if Bolt::Util.powershell?
+        show_command = 'Get-BoltPlan -Name '
+        run_command  = 'Invoke-BoltPlan -Name '
+      else
+        show_command = 'bolt plan show'
+        run_command  = 'bolt plan run'
+      end
+
+      output = <<~OUTPUT
+        Created plan '#{plan_name}' at '#{plan_path}'
+
+        Show this plan with:
+            #{show_command} #{plan_name}
+        Run this plan with:
+            #{run_command} #{plan_name}
+      OUTPUT
+
+      outputter.print_message(output)
+      0
+    end
+
+    def self.segment_plan_name(plan_name)
+      prefix, *name_segments, basename = plan_name.split('::')
+
+      # If the plan name is just the project name, then create an 'init' plan.
+      # Otherwise, use the last name segment for the plan's filename.
+      basename ||= 'init'
+
+      [prefix, name_segments, basename]
+    end
+
+    def self.yaml_plan(plan_name)
+      <<~YAML
+        # This is the structure of a simple plan. To learn more about writing
+        # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans
+
+        # The description sets the description of the plan that will appear
+        # in 'bolt plan show' output.
+        description: A plan created with bolt plan new
+
+        # The parameters key defines the parameters that can be passed to
+        # the plan.
+        parameters:
+          targets:
+            type: TargetSpec
+            description: A list of targets to run actions on
+            default: localhost
+
+        # The steps key defines the actions the plan will take in order.
+        steps:
+          - message: Hello from #{plan_name}
+          - name: command_step
+            command: whoami
+            targets: $targets
+
+        # The return key sets the return value of the plan.
+        return: $command_step
+      YAML
+    end
+
+    def self.puppet_plan(plan_name)
+      <<~PUPPET
+        # This is the structure of a simple plan. To learn more about writing
+        # Puppet plans, see the documentation: http://pup.pt/bolt-puppet-plans
+
+        # The summary sets the description of the plan that will appear
+        # in 'bolt plan show' output. Bolt uses puppet-strings to parse the
+        # summary and parameters from the plan.
+        # @summary A plan created with bolt plan new.
+        # @param targets The targets to run on.
+        plan #{plan_name} (
+          TargetSpec $targets = "localhost"
+        ) {
+          out::message("Hello from #{plan_name}")
+          $command_result = run_command('whoami', $targets)
+          return $command_result
+        }
+      PUPPET
+    end
+  end
+end

data/lib/bolt/plugin.rb

@@ -290,7 +290,7 @@ module Bolt
       begin
         validate_proc = get_hook(plugin_name, :validate_resolve_reference)
       rescue PluginError
-        validate_proc = proc { |*args| }
+        validate_proc = proc { |*args| } # Nothing to do
       end
 
       validate_proc.call(reference)

data/lib/bolt/project.rb

@@ -11,9 +11,9 @@ module Bolt
     PROJECT_SETTINGS = {
       "name"  => "The name of the project",
       "plans" => "An array of plan names to show, if they exist in the project."\
-                 "These plans are included in `bolt plan show` output",
+                 "These plans are included in `bolt plan show` and `Get-BoltPlan` output",
       "tasks" => "An array of task names to show, if they exist in the project."\
-                 "These tasks are included in `bolt task show` output"
+                 "These tasks are included in `bolt task show` and `Get-BoltTask` output"
     }.freeze
 
     attr_reader :path, :data, :config_file, :inventory_file, :hiera_config,

data/lib/bolt/project_migrator/config.rb

@@ -54,10 +54,11 @@ module Bolt
         @outputter.print_action_step("Renaming bolt.yaml to bolt-project.yaml")
         FileUtils.mv(config_file, project_file)
 
+        command = Bolt::Util.powershell? ? 'Get-Help about_bolt_project' : 'bolt guide project'
         @outputter.print_action_step(
           "Successfully migrated config. Please add a 'name' key to bolt-project.yaml "\
           "to use project-level tasks and plans. Learn more about projects by running "\
-          "'bolt guide project'."
+          "'#{command}'."
         )
 
         true

data/lib/bolt/project_migrator/inventory.rb

@@ -6,12 +6,12 @@ module Bolt
   class ProjectMigrator
     class Inventory < Base
       def migrate(inventory_file, backup_dir)
-        inventory_1_to_2(inventory_file, backup_dir)
+        inventory1to2(inventory_file, backup_dir)
       end
 
       # Migrates an inventory v1 file to inventory v2.
       #
-      private def inventory_1_to_2(inventory_file, backup_dir)
+      private def inventory1to2(inventory_file, backup_dir)
         unless File.exist?(inventory_file)
           return true
         end

data/lib/bolt/puppetdb/config.rb

@@ -6,14 +6,14 @@ require 'bolt/util'
 module Bolt
   module PuppetDB
     class Config
-      if !ENV['HOME'].nil?
-        DEFAULT_TOKEN = File.expand_path('~/.puppetlabs/token')
-        DEFAULT_CONFIG = { user: File.expand_path('~/.puppetlabs/client-tools/puppetdb.conf'),
-                           global: '/etc/puppetlabs/client-tools/puppetdb.conf' }.freeze
-      else
+      if ENV['HOME'].nil?
         DEFAULT_TOKEN = Bolt::Util.windows? ? 'nul' : '/dev/null'
         DEFAULT_CONFIG = { user: '/etc/puppetlabs/puppet/puppetdb.conf',
                            global: '/etc/puppetlabs/puppet/puppetdb.conf' }.freeze
+      else
+        DEFAULT_TOKEN = File.expand_path('~/.puppetlabs/token')
+        DEFAULT_CONFIG = { user: File.expand_path('~/.puppetlabs/client-tools/puppetdb.conf'),
+                           global: '/etc/puppetlabs/client-tools/puppetdb.conf' }.freeze
 
       end
 

data/lib/bolt/shell/powershell.rb

@@ -11,7 +11,7 @@ module Bolt
       def initialize(target, conn)
         super
 
-        extensions = [target.options['extensions'] || []].flatten.map { |ext| ext[0] != '.' ? '.' + ext : ext }
+        extensions = [target.options['extensions'] || []].flatten.map { |ext| ext[0] == '.' ? ext : '.' + ext }
         extensions += target.options['interpreters'].keys if target.options['interpreters']
         @extensions = DEFAULT_EXTENSIONS + extensions
       end

data/lib/bolt/task/run.rb

@@ -42,7 +42,7 @@ module Bolt
         if targets.empty?
           Bolt::ResultSet.new([])
         else
-          result = executor.run_task(targets, task, params, options)
+          result = executor.run_task_with_minimal_logging(targets, task, params, options)
 
           if !result.ok && !options[:catch_errors]
             raise Bolt::RunFailure.new(result, 'run_task', task.name)

data/lib/bolt/transport/orch.rb

@@ -10,10 +10,10 @@ require 'bolt/transport/orch/connection'
 module Bolt
   module Transport
     class Orch < Base
-      CONF_FILE = if !ENV['HOME'].nil?
-                    File.expand_path('~/.puppetlabs/client-tools/orchestrator.conf')
-                  else
+      CONF_FILE = if ENV['HOME'].nil?
                     '/etc/puppetlabs/client-tools/orchestrator.conf'
+                  else
+                    File.expand_path('~/.puppetlabs/client-tools/orchestrator.conf')
                   end
       BOLT_COMMAND_TASK = Struct.new(:name).new('bolt_shim::command').freeze
       BOLT_SCRIPT_TASK = Struct.new(:name).new('bolt_shim::script').freeze

data/lib/bolt/transport/remote.rb

@@ -29,7 +29,7 @@ module Bolt
       def run_task(target, task, arguments, options = {}, position = [])
         proxy_target = get_proxy(target)
         transport = @executor.transport(proxy_target.transport)
-        arguments = arguments.merge('_target' => target.to_h.reject { |_, v| v.nil? })
+        arguments = arguments.merge('_target' => target.to_h.compact)
 
         remote_task = task.remote_instance
 

data/lib/bolt/util.rb

@@ -273,6 +273,11 @@ module Bolt
         !!File::ALT_SEPARATOR
       end
 
+      # Returns true if running in PowerShell.
+      def powershell?
+        !!ENV['PSModulePath']
+      end
+
       # Accept hash and return hash with top level keys of type "String" converted to symbols.
       def symbolize_top_level_keys(hsh)
         hsh.each_with_object({}) { |(k, v), h| k.is_a?(String) ? h[k.to_sym] = v : h[k] = v }

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '2.33.2'
+  VERSION = '2.34.0'
 end

data/lib/bolt_server/file_cache.rb

@@ -63,6 +63,7 @@ module BoltServer
     end
 
     def client
+      # rubocop:disable Naming/VariableNumber
       @client ||= begin
         uri = URI(@config['file-server-uri'])
         https = Net::HTTP.new(uri.host, uri.port)
@@ -75,6 +76,7 @@ module BoltServer
         https.open_timeout = @config['file-server-conn-timeout']
         https
       end
+      # rubocop:enable Naming/VariableNumber
     end
 
     def request_file(path, params, file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.33.2
+  version: 2.34.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -506,6 +506,7 @@ files:
 - lib/bolt/pal/yaml_plan/step/task.rb
 - lib/bolt/pal/yaml_plan/step/upload.rb
 - lib/bolt/pal/yaml_plan/transpiler.rb
+- lib/bolt/plan_creator.rb
 - lib/bolt/plan_result.rb
 - lib/bolt/plugin.rb
 - lib/bolt/plugin/env_var.rb