bolt 2.30.0 → 2.34.0

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,
@@ -190,7 +190,7 @@ module Bolt
           Invalid project name '#{name}' in bolt-project.yaml; project name must begin with a lowercase letter
           and can include lowercase letters, numbers, and underscores.
           ERROR_STRING
-        elsif Dir.children(Bolt::PAL::BOLTLIB_PATH).include?(name)
+        elsif Dir.children(Bolt::Config::Modulepath::BOLTLIB_PATH).include?(name)
           raise Bolt::ValidationError, "The project '#{name}' will not be loaded. The project name conflicts "\
             "with a built-in Bolt module of the same name."
         end
@@ -210,14 +210,9 @@ module Bolt
           raise Bolt::ValidationError, "'modules' in bolt-project.yaml must be an array"
         end
 
-        @data['modules'].each do |mod|
-          next if (mod.is_a?(Hash) && mod.key?('name')) || mod.is_a?(String)
-          raise Bolt::ValidationError, "Module declaration #{mod.inspect} must be a hash with a name key"
-        end
-
-        unknown_keys = modules.flat_map(&:keys).uniq - %w[name version_requirement]
-        if unknown_keys.any?
-          @logs << { warn: "Ignoring unknown keys in module declarations: #{unknown_keys.join(', ')}." }
+        @data['modules'].each do |spec|
+          next if spec.is_a?(Hash) || spec.is_a?(String)
+          raise Bolt::ValidationError, "Module specification #{spec.inspect} must be a hash or string"
         end
       end
     end

data/lib/bolt/project_migrator.rb

@@ -21,7 +21,7 @@ module Bolt
 
       @outputter.print_message("Migrating project #{@config.project.path}\n\n")
 
-      @outputter.print_migrate_step(
+      @outputter.print_action_step(
         "Migrating a Bolt project may make irreversible changes to the project's "\
         "configuration and inventory files. Before continuing, make sure the "\
         "project has a backup or uses a version control system."

data/lib/bolt/project_migrator/base.rb

@@ -12,7 +12,7 @@ module Bolt
 
       protected def backup_file(origin_path, backup_dir)
         unless File.exist?(origin_path)
-          @outputter.print_migrate_step(
+          @outputter.print_action_step(
             "Could not find file #{origin_path}, skipping backup."
           )
           return
@@ -24,7 +24,7 @@ module Bolt
         filename = File.basename(origin_path)
         backup_path = File.join(backup_dir, "#{filename}.#{date}.bak")
 
-        @outputter.print_migrate_step(
+        @outputter.print_action_step(
           "Backing up #{filename} from #{origin_path} to #{backup_path}"
         )
 

data/lib/bolt/project_migrator/config.rb

@@ -39,7 +39,7 @@ module Bolt
           backup_file(config_file, backup_dir)
 
           begin
-            @outputter.print_migrate_step(
+            @outputter.print_action_step(
               "Moving transportation configuration options '#{transport_data.keys.join(', ')}' "\
               "from bolt.yaml to inventory.yaml"
             )
@@ -51,13 +51,14 @@ module Bolt
           end
         end
 
-        @outputter.print_migrate_step("Renaming bolt.yaml to bolt-project.yaml")
+        @outputter.print_action_step("Renaming bolt.yaml to bolt-project.yaml")
         FileUtils.mv(config_file, project_file)
 
-        @outputter.print_migrate_step(
+        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
@@ -28,7 +28,7 @@ module Bolt
 
         begin
           File.write(inventory_file, data.to_yaml)
-          @outputter.print_migrate_step(
+          @outputter.print_action_step(
             "Successfully migrated Bolt inventory to the latest version."
           )
           true

data/lib/bolt/project_migrator/modules.rb

@@ -19,7 +19,7 @@ module Bolt
 
         # Notify user to manually migrate modules if using non-default modulepath
         if configured_modulepath != modulepath
-          @outputter.print_migrate_step(
+          @outputter.print_action_step(
             "Project has a non-default configured modulepath, unable to automatically "\
             "migrate project modules. To migrate project modules manually, see "\
             "http://pup.pt/bolt-modules"
@@ -42,30 +42,32 @@ module Bolt
       # to the new moduledir.
       #
       private def migrate_modules_from_puppetfile(config, puppetfile_path, managed_moduledir, modulepath)
-        require 'bolt/puppetfile'
-        require 'bolt/puppetfile/installer'
+        require 'bolt/module_installer/installer'
+        require 'bolt/module_installer/puppetfile'
+        require 'bolt/module_installer/resolver'
+        require 'bolt/module_installer/specs'
 
         begin
-          @outputter.print_migrate_step("Parsing Puppetfile at #{puppetfile_path}")
-          puppetfile = Bolt::Puppetfile.parse(puppetfile_path, skip_unsupported_modules: true)
+          @outputter.print_action_step("Parsing Puppetfile at #{puppetfile_path}")
+          puppetfile = Bolt::ModuleInstaller::Puppetfile.parse(puppetfile_path, skip_unsupported_modules: true)
         rescue Bolt::Error => e
-          @outputter.print_migrate_error("#{e.message}\nSkipping module migration.")
+          @outputter.print_action_error("#{e.message}\nSkipping module migration.")
           return false
         end
 
         # Prompt for direct dependencies
         modules = select_modules(puppetfile.modules)
 
-        # Create new Puppetfile object
-        puppetfile = Bolt::Puppetfile.new(modules)
+        # Create specs to resolve from
+        specs = Bolt::ModuleInstaller::Specs.new(modules.map(&:to_hash))
 
         # Attempt to resolve dependencies
         begin
           @outputter.print_message('')
-          @outputter.print_migrate_step("Resolving module dependencies, this may take a moment")
-          puppetfile.resolve
+          @outputter.print_action_step("Resolving module dependencies, this may take a moment")
+          puppetfile = Bolt::ModuleInstaller::Resolver.new.resolve(specs)
         rescue Bolt::Error => e
-          @outputter.print_migrate_error("#{e.message}\nSkipping module migration.")
+          @outputter.print_action_error("#{e.message}\nSkipping module migration.")
           return false
         end
 
@@ -90,17 +92,17 @@ module Bolt
           # Show the new Puppetfile content
           message  = "Generated new Puppetfile content:\n\n"
           message += puppetfile.modules.map(&:to_spec).join("\n").to_s
-          @outputter.print_migrate_step(message)
+          @outputter.print_action_step(message)
 
           # Write Puppetfile
-          @outputter.print_migrate_step("Updating Puppetfile at #{puppetfile_path}")
+          @outputter.print_action_step("Updating Puppetfile at #{puppetfile_path}")
           puppetfile.write(puppetfile_path, managed_moduledir)
 
           # Install Puppetfile
-          @outputter.print_migrate_step("Syncing modules from #{puppetfile_path} to #{managed_moduledir}")
-          Bolt::Puppetfile::Installer.new({}).install(puppetfile_path, managed_moduledir)
+          @outputter.print_action_step("Syncing modules from #{puppetfile_path} to #{managed_moduledir}")
+          Bolt::ModuleInstaller::Installer.new.install(puppetfile_path, managed_moduledir)
         else
-          @outputter.print_migrate_step(
+          @outputter.print_action_step(
             "Project does not include any managed modules, deleting Puppetfile "\
             "at #{puppetfile_path}"
           )
@@ -112,7 +114,7 @@ module Bolt
       # the selected modules.
       #
       private def select_modules(modules)
-        @outputter.print_migrate_step(
+        @outputter.print_action_step(
           "Select modules that are direct dependencies of your project. Bolt will "\
           "automatically manage dependencies for each module selected, so do not "\
           "select a module's dependencies unless you use content from it directly "\
@@ -123,7 +125,7 @@ module Bolt
         return modules if all
 
         modules.select do |mod|
-          Bolt::Util.prompt_yes_no("Select #{mod.title}?", @outputter)
+          Bolt::Util.prompt_yes_no("Select #{mod.full_name}?", @outputter)
         end
       end
 
@@ -135,7 +137,7 @@ module Bolt
         sources.select! { |source| Dir.exist?(source) }
 
         if sources.any?
-          @outputter.print_migrate_step(
+          @outputter.print_action_step(
             "Moving modules from #{sources.join(', ')} to #{moduledir}"
           )
 
@@ -166,7 +168,7 @@ module Bolt
       # Deletes modules from a specified directory.
       #
       private def delete_modules(moduledir, modules)
-        @outputter.print_migrate_step("Cleaning up #{moduledir}")
+        @outputter.print_action_step("Cleaning up #{moduledir}")
         moduledir = Pathname.new(moduledir)
 
         modules.each do |mod|
@@ -178,7 +180,7 @@ module Bolt
       # Adds a list of modules to the project configuration file.
       #
       private def update_project_config(modules, config_file)
-        @outputter.print_migrate_step("Updating project configuration at #{config_file}")
+        @outputter.print_action_step("Updating project configuration at #{config_file}")
         data = Bolt::Util.read_optional_yaml_hash(config_file, 'project')
         data.merge!('modules' => modules)
         data.delete('modulepath')

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/result.rb

@@ -7,47 +7,58 @@ module Bolt
   class Result
     attr_reader :target, :value, :action, :object
 
-    def self.from_exception(target, exception, action: 'action')
+    def self.from_exception(target, exception, action: 'action', position: [])
+      details = create_details(position)
       if exception.is_a?(Bolt::Error)
-        error = exception.to_h
+        error = Bolt::Util.deep_merge({ 'details' => details }, exception.to_h)
       else
+        details['class'] = exception.class.to_s
         error = {
           'kind' => 'puppetlabs.tasks/exception-error',
           'issue_code' => 'EXCEPTION',
           'msg' => exception.message,
-          'details' => { 'class' => exception.class.to_s }
+          'details' => details
         }
         error['details']['stack_trace'] = exception.backtrace.join('\n') if exception.backtrace
       end
       Result.new(target, error: error, action: action)
     end
 
-    def self.for_command(target, stdout, stderr, exit_code, action, command)
+    def self.create_details(position)
+      %w[file line].zip(position).to_h.compact
+    end
+
+    def self.for_command(target, stdout, stderr, exit_code, action, command, position)
       value = {
         'stdout' => stdout,
         'stderr' => stderr,
         'exit_code' => exit_code
       }
+
+      details = create_details(position)
       unless exit_code == 0
+        details['exit_code'] = exit_code
         value['_error'] = {
           'kind' => 'puppetlabs.tasks/command-error',
           'issue_code' => 'COMMAND_ERROR',
           'msg' => "The command failed with exit code #{exit_code}",
-          'details' => { 'exit_code' => exit_code }
+          'details' => details
         }
       end
       new(target, value: value, action: action, object: command)
     end
 
-    def self.for_task(target, stdout, stderr, exit_code, task)
+    def self.for_task(target, stdout, stderr, exit_code, task, position)
       stdout.force_encoding('utf-8') unless stdout.encoding == Encoding::UTF_8
+
+      details = create_details(position)
       value = if stdout.valid_encoding?
                 parse_hash(stdout) || { '_output' => stdout }
               else
                 { '_error' => { 'kind' => 'puppetlabs.tasks/task-error',
                                 'issue_code' => 'TASK_ERROR',
                                 'msg' => 'The task result contained invalid UTF-8 on stdout',
-                                'details' => {} } }
+                                'details' => details } }
               end
 
       if exit_code != 0 && value['_error'].nil?
@@ -60,24 +71,26 @@ module Bolt
               else
                 "The task failed with exit code #{exit_code}"
               end
+        details['exit_code'] = exit_code
         value['_error'] = { 'kind' => 'puppetlabs.tasks/task-error',
                             'issue_code' => 'TASK_ERROR',
                             'msg' => msg,
-                            'details' => { 'exit_code' => exit_code } }
+                            'details' => details }
       end
 
       if value.key?('_error')
         unless value['_error'].is_a?(Hash) && value['_error'].key?('msg')
+          details['original_error'] = value['_error']
           value['_error'] = {
             'msg'     => "Invalid error returned from task #{task}: #{value['_error'].inspect}. Error "\
                          "must be an object with a msg key.",
             'kind'    => 'bolt/invalid-task-error',
-            'details' => { 'original_error' => value['_error'] }
+            'details' => details
           }
         end
 
         value['_error']['kind']    ||= 'bolt/error'
-        value['_error']['details'] ||= {}
+        value['_error']['details'] ||= details
       end
 
       if value.key?('_sensitive')
@@ -221,7 +234,6 @@ module Bolt
     def error
       if error_hash
         Puppet::DataTypes::Error.from_asserted_hash(error_hash)
-
       end
     end
 

data/lib/bolt/shell/bash.rb

@@ -21,14 +21,16 @@ module Bolt
         ['shell']
       end
 
-      def run_command(command, options = {})
+      def run_command(command, options = {}, position = [])
         running_as(options[:run_as]) do
           output = execute(command, environment: options[:env_vars], sudoable: true)
           Bolt::Result.for_command(target,
                                    output.stdout.string,
                                    output.stderr.string,
                                    output.exit_code,
-                                   'command', command)
+                                   'command',
+                                   command,
+                                   position)
         end
       end
 
@@ -71,7 +73,7 @@ module Bolt
         end
       end
 
-      def run_script(script, arguments, options = {})
+      def run_script(script, arguments, options = {}, position = [])
         # unpack any Sensitive data
         arguments = unwrap_sensitive_args(arguments)
 
@@ -84,12 +86,14 @@ module Bolt
                                      output.stdout.string,
                                      output.stderr.string,
                                      output.exit_code,
-                                     'script', script)
+                                     'script',
+                                     script,
+                                     position)
           end
         end
       end
 
-      def run_task(task, arguments, options = {})
+      def run_task(task, arguments, options = {}, position = [])
         implementation = select_implementation(target, task)
         executable = implementation['path']
         input_method = implementation['input_method']
@@ -148,7 +152,8 @@ module Bolt
           Bolt::Result.for_task(target, output.stdout.string,
                                 output.stderr.string,
                                 output.exit_code,
-                                task.name)
+                                task.name,
+                                position)
         end
       end
 
@@ -202,13 +207,14 @@ module Bolt
       end
 
       def handle_sudo_errors(err)
-        if err =~ /^#{conn.user} is not in the sudoers file\./
+        case err
+        when /^#{conn.user} is not in the sudoers file\./
           @logger.trace { err }
           raise Bolt::Node::EscalateError.new(
             "User #{conn.user} does not have sudo permission on #{target}",
             'SUDO_DENIED'
           )
-        elsif err =~ /^Sorry, try again\./
+        when /^Sorry, try again\./
           @logger.trace { err }
           raise Bolt::Node::EscalateError.new(
             "Sudo password for user #{conn.user} not recognized on #{target}",

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
@@ -174,7 +174,7 @@ module Bolt
         Bolt::Result.for_download(target, source, destination, download)
       end
 
-      def run_command(command, options = {})
+      def run_command(command, options = {}, position = [])
         command = [*env_declarations(options[:env_vars]), command].join("\r\n") if options[:env_vars]
 
         output = execute(command)
@@ -182,10 +182,12 @@ module Bolt
                                  output.stdout.string,
                                  output.stderr.string,
                                  output.exit_code,
-                                 'command', command)
+                                 'command',
+                                 command,
+                                 position)
       end
 
-      def run_script(script, arguments, options = {})
+      def run_script(script, arguments, options = {}, position = [])
         # unpack any Sensitive data
         arguments = unwrap_sensitive_args(arguments)
         with_tmpdir do |dir|
@@ -204,11 +206,13 @@ module Bolt
                                    output.stdout.string,
                                    output.stderr.string,
                                    output.exit_code,
-                                   'script', script)
+                                   'script',
+                                   script,
+                                   position)
         end
       end
 
-      def run_task(task, arguments, _options = {})
+      def run_task(task, arguments, _options = {}, position = [])
         implementation = select_implementation(target, task)
         executable = implementation['path']
         input_method = implementation['input_method']
@@ -259,7 +263,8 @@ module Bolt
           Bolt::Result.for_task(target, output.stdout.string,
                                 output.stderr.string,
                                 output.exit_code,
-                                task.name)
+                                task.name,
+                                position)
         end
       end