bolt 2.20.0 → 2.24.1

data/lib/bolt/pal/yaml_plan/transpiler.rb

@@ -21,10 +21,18 @@ module Bolt
           validate_path
 
           plan_object = parse_plan
+          param_descriptions = plan_object.parameters.map do |param|
+            str = String.new("# @param #{param.name}")
+            str << " #{param.description}" if param.description
+            str
+          end.join("\n")
 
-          plan_string = String.new("# WARNING: This is an autogenerated plan. " \
-                                   "It may not behave as expected.\n" \
-                                   "plan #{plan_object.name}(")
+          plan_string = String.new('')
+          plan_string << "# #{plan_object.description}\n" if plan_object.description
+          plan_string << "# WARNING: This is an autogenerated plan. It may not behave as expected.\n"
+          plan_string << "#{param_descriptions}\n" unless param_descriptions.empty?
+
+          plan_string << "plan #{plan_object.name}("
           # Parameters are Bolt::PAL::YamlPlan::Parameter
           plan_object.parameters&.each_with_index do |param, i|
             plan_string << param.transpile

data/lib/bolt/plugin/prompt.rb

@@ -18,9 +18,9 @@ module Bolt
       end
 
       def resolve_reference(opts)
-        STDERR.print("#{opts['message']}: ")
-        value = STDIN.noecho(&:gets).to_s.chomp
-        STDERR.puts
+        $stderr.print("#{opts['message']}: ")
+        value = $stdin.noecho(&:gets).to_s.chomp
+        $stderr.puts
 
         value
       end

data/lib/bolt/project.rb

@@ -3,6 +3,7 @@
 require 'pathname'
 require 'bolt/config'
 require 'bolt/pal'
+require 'bolt/module'
 
 module Bolt
   class Project
@@ -17,7 +18,7 @@ module Bolt
 
     attr_reader :path, :data, :config_file, :inventory_file, :modulepath, :hiera_config,
                 :puppetfile, :rerunfile, :type, :resource_types, :warnings, :project_file,
-                :deprecations, :downloads
+                :deprecations, :downloads, :plans_path
 
     def self.default_project
       create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user')
@@ -82,6 +83,7 @@ module Bolt
       @resource_types = @path + '.resource_types'
       @type = type
       @downloads = @path + 'downloads'
+      @plans_path = @path + 'plans'
 
       tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys
       if tc.any?
@@ -138,10 +140,10 @@ module Bolt
 
     def validate
       if name
-        name_regex = /^[a-z][a-z0-9_]*$/
-        if name !~ name_regex
+        if name !~ Bolt::Module::MODULE_NAME_REGEX
           raise Bolt::ValidationError, <<~ERROR_STRING
-          Invalid project name '#{name}' in bolt-project.yaml; project name must match #{name_regex.inspect}
+          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)
           raise Bolt::ValidationError, "The project '#{name}' will not be loaded. The project name conflicts "\

data/lib/bolt/project_migrate.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Bolt
+  class ProjectMigrate
+    attr_reader :path, :project_file, :backup_dir, :outputter, :inventory_file, :config_file
+
+    # This init mostly makes testing easier
+    def initialize(path, outputter, configured_inventory = nil)
+      @path = Pathname.new(path).expand_path
+      @project_file = @path + 'bolt-project.yaml'
+      @config_file = @path + 'bolt.yaml'
+      @backup_dir = @path + '.bolt-bak'
+      @inventory_file = configured_inventory || @path + 'inventory.yaml'
+      @outputter = outputter
+    end
+
+    def migrate_project
+      inv_ok = inventory_1_to_2(inventory_file, outputter) if inventory_file.file?
+      config_ok = bolt_yaml_to_bolt_project(inventory_file, outputter)
+      inv_ok && config_ok ? 0 : 1
+    end
+
+    # This could be made public and used elsewhere if the need arises
+    private def backup_file(origin_path)
+      unless File.exist?(origin_path)
+        outputter.print_message "Could not find file #{origin_path}, skipping backup."
+        return
+      end
+
+      date = Time.new.strftime("%Y%m%d_%H%M%S%L")
+      FileUtils.mkdir_p(backup_dir)
+
+      filename = File.basename(origin_path)
+      backup_path = File.join(backup_dir, "#{filename}.#{date}.bak")
+
+      outputter.print_message "Backing up #{filename} from #{origin_path} to #{backup_path}"
+
+      begin
+        FileUtils.cp(origin_path, backup_path)
+      rescue StandardError => e
+        raise Bolt::FileError.new("#{e.message}; unable to create backup of #{filename}.", origin_path)
+      end
+    end
+
+    private def bolt_yaml_to_bolt_project(inventory_file, outputter)
+      # If bolt-project.yaml already exists
+      if project_file.file?
+        outputter.print_message "bolt-project.yaml already exists in Bolt "\
+          "project at #{path}. Skipping project file update."
+
+      # If bolt.yaml doesn't exist
+      elsif !config_file.file?
+        outputter.print_message "Could not find bolt.yaml in project at "\
+          "#{path}. Skipping project file update."
+
+      else
+        config_data = Bolt::Util.read_optional_yaml_hash(config_file, 'config')
+        transport_data, project_data = config_data.partition do |k, _|
+          Bolt::Config::INVENTORY_OPTIONS.keys.include?(k)
+        end.map(&:to_h)
+
+        if transport_data.any?
+          if File.exist?(inventory_file)
+            inventory_data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
+            merged = Bolt::Util.deep_merge(transport_data, inventory_data['config'] || {})
+            inventory_data['config'] = merged
+            backup_file(inventory_file)
+          else
+            FileUtils.touch(inventory_file)
+            inventory_data = { 'config' => transport_data }
+          end
+
+          backup_file(config_file)
+
+          begin
+            outputter.print_message "Moving transportation configuration options "\
+              "'#{transport_data.keys.join(', ')}' from bolt.yaml to inventory.yaml"
+            File.write(inventory_file, inventory_data.to_yaml)
+            File.write(config_file, project_data.to_yaml)
+          rescue StandardError => e
+            raise Bolt::FileError.new("#{e.message}; unable to write inventory.", inventory_file)
+          end
+        end
+
+        outputter.print_message "Renaming bolt.yaml to bolt-project.yaml"
+        FileUtils.mv(config_file, project_file)
+        outputter.print_message "Successfully updated project. 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'."
+        # If nothing errored, this succeeded
+        true
+      end
+    end
+
+    private def inventory_1_to_2(inventory_file, outputter)
+      data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
+      data.delete('version') if data['version'] != 2
+      migrated = migrate_group(data)
+
+      ok = if migrated
+             backup_file(inventory_file)
+             File.write(inventory_file, data.to_yaml)
+           end
+
+      result = if migrated && ok
+                 "Successfully migrated Bolt inventory to the latest version."
+               elsif !migrated
+                 "Bolt inventory is already on the latest version. Skipping inventory update."
+               else
+                 "Could not migrate Bolt inventory to the latest version. See "\
+                 "https://puppet.com/docs/bolt/latest/inventory_file_v2.html to manually update."
+               end
+      outputter.print_message(result)
+      ok
+    end
+
+    # Walks an inventory hash and replaces all 'nodes' keys with 'targets' keys
+    # and all 'name' keys nested in a 'targets' hash with 'uri' keys. Data is
+    # modified in place.
+    private def migrate_group(group)
+      migrated = false
+      if group.key?('nodes')
+        migrated = true
+        targets = group['nodes'].map do |target|
+          target['uri'] = target.delete('name') if target.is_a?(Hash)
+          target
+        end
+        group.delete('nodes')
+        group['targets'] = targets
+      end
+      (group['groups'] || []).each do |subgroup|
+        migrated_group = migrate_group(subgroup)
+        migrated ||= migrated_group
+      end
+      migrated
+    end
+  end
+end

data/lib/bolt/shell/bash.rb

@@ -103,7 +103,7 @@ module Bolt
                                 " using '#{execute_options[:interpreter]}' interpreter"
                               end
           # log the arguments with sensitive data redacted, do NOT log unwrapped_arguments
-          logger.debug("Running '#{executable}' with #{arguments.to_json}#{interpreter_debug}")
+          logger.trace("Running '#{executable}' with #{arguments.to_json}#{interpreter_debug}")
           # unpack any Sensitive data
           arguments = unwrap_sensitive_args(arguments)
 
@@ -203,13 +203,13 @@ module Bolt
 
       def handle_sudo_errors(err)
         if err =~ /^#{conn.user} is not in the sudoers file\./
-          @logger.debug { err }
+          @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\./
-          @logger.debug { err }
+          @logger.trace { err }
           raise Bolt::Node::EscalateError.new(
             "Sudo password for user #{conn.user} not recognized on #{target}",
             'BAD_PASSWORD'
@@ -351,7 +351,7 @@ module Bolt
 
         command_str = [sudo_str, env_decl, command_str].compact.join(' ')
 
-        @logger.debug { "Executing: #{command_str}" }
+        @logger.trace { "Executing `#{command_str}`" }
 
         in_buffer = if !use_sudo && options[:stdin]
                       String.new(options[:stdin], encoding: 'binary')
@@ -431,16 +431,16 @@ module Bolt
         result_output.exit_code = t.value.respond_to?(:exitstatus) ? t.value.exitstatus : t.value
 
         if result_output.exit_code == 0
-          @logger.debug { "Command returned successfully" }
+          @logger.trace { "Command `#{command_str}` returned successfully" }
         else
-          @logger.info { "Command failed with exit code #{result_output.exit_code}" }
+          @logger.trace { "Command #{command_str} failed with exit code #{result_output.exit_code}" }
         end
         result_output
       rescue StandardError
         # Ensure we close stdin and kill the child process
         inp&.close
         t&.terminate if t&.alive?
-        @logger.debug { "Command aborted" }
+        @logger.trace { "Command aborted" }
         raise
       end
 

data/lib/bolt/transport/docker/connection.rb

@@ -12,7 +12,7 @@ module Bolt
           @target = target
           @logger = Logging.logger[target.safe_name]
           @docker_host = @target.options['service-url']
-          @logger.debug("Initializing docker connection to #{@target.safe_name}")
+          @logger.trace("Initializing docker connection to #{@target.safe_name}")
         end
 
         def connect
@@ -25,7 +25,7 @@ module Bolt
           output = execute_local_docker_json_command('inspect', [output[index]["ID"]])
           # Store the container information for later
           @container_info = output[0]
-          @logger.debug { "Opened session" }
+          @logger.trace { "Opened session" }
           true
         rescue StandardError => e
           raise Bolt::Node::ConnectError.new(
@@ -57,16 +57,16 @@ module Bolt
           command_options << container_id
           command_options.concat(command)
 
-          @logger.debug { "Executing: exec #{command_options}" }
+          @logger.trace { "Executing: exec #{command_options}" }
 
           stdout_str, stderr_str, status = execute_local_docker_command('exec', command_options, options[:stdin])
 
           # The actual result is the exitstatus not the process object
           status = status.nil? ? -32768 : status.exitstatus
           if status == 0
-            @logger.debug { "Command returned successfully" }
+            @logger.trace { "Command returned successfully" }
           else
-            @logger.info { "Command failed with exit code #{status}" }
+            @logger.trace { "Command failed with exit code #{status}" }
           end
           stdout_str.force_encoding(Encoding::UTF_8)
           stderr_str.force_encoding(Encoding::UTF_8)
@@ -75,12 +75,12 @@ module Bolt
           stderr_str.gsub!("\r\n", "\n")
           [stdout_str, stderr_str, status]
         rescue StandardError
-          @logger.debug { "Command aborted" }
+          @logger.trace { "Command aborted" }
           raise
         end
 
         def write_remote_file(source, destination)
-          @logger.debug { "Uploading #{source}, to #{destination}" }
+          @logger.trace { "Uploading #{source} to #{destination}" }
           _, stdout_str, status = execute_local_docker_command('cp', [source, "#{container_id}:#{destination}"])
           unless status.exitstatus.zero?
             raise "Error writing file to container #{@container_id}: #{stdout_str}"
@@ -90,7 +90,7 @@ module Bolt
         end
 
         def write_remote_directory(source, destination)
-          @logger.debug { "Uploading #{source}, to #{destination}" }
+          @logger.trace { "Uploading #{source} to #{destination}" }
           _, stdout_str, status = execute_local_docker_command('cp', [source, "#{container_id}:#{destination}"])
           unless status.exitstatus.zero?
             raise "Error writing directory to container #{@container_id}: #{stdout_str}"
@@ -100,7 +100,7 @@ module Bolt
         end
 
         def download_remote_content(source, destination)
-          @logger.debug { "Downloading #{source} to #{destination}" }
+          @logger.trace { "Downloading #{source} to #{destination}" }
           # Create the destination directory, otherwise copying a source directory with Docker will
           # copy the *contents* of the directory.
           # https://docs.docker.com/engine/reference/commandline/cp/

data/lib/bolt/transport/local/connection.rb

@@ -28,7 +28,7 @@ module Bolt
         end
 
         def upload_file(source, dest)
-          @logger.debug { "Uploading #{source}, to #{dest}" }
+          @logger.trace { "Uploading #{source} to #{dest}" }
           if source.is_a?(StringIO)
             Tempfile.create(File.basename(dest)) do |f|
               f.write(source.read)
@@ -46,7 +46,7 @@ module Bolt
         end
 
         def download_file(source, dest, _download)
-          @logger.debug { "Downloading #{source} to #{dest}" }
+          @logger.trace { "Downloading #{source} to #{dest}" }
           # Create the destination directory for the target, or the
           # copied file will have the target's name
           FileUtils.mkdir_p(dest)

data/lib/bolt/transport/orch.rb

@@ -38,7 +38,7 @@ module Bolt
           @connections.each_value do |conn|
             conn.finish_plan(result)
           rescue StandardError => e
-            @logger.debug("Failed to finish plan on #{conn.key}: #{e.message}")
+            @logger.trace("Failed to finish plan on #{conn.key}: #{e.message}")
           end
         end
       end
@@ -133,7 +133,7 @@ module Bolt
           next unless File.file?(file)
 
           tar_path = Pathname.new(file).relative_path_from(Pathname.new(directory))
-          @logger.debug("Packing #{file} to #{tar_path}")
+          @logger.trace("Packing #{file} to #{tar_path}")
           stat = File.stat(file)
           content = File.binread(file)
           output.tar.add_file_simple(
@@ -146,7 +146,7 @@ module Bolt
         end
 
         duration = Time.now - start_time
-        @logger.debug("Packed upload in #{duration * 1000} ms")
+        @logger.trace("Packed upload in #{duration * 1000} ms")
 
         output.close
         io.string

data/lib/bolt/transport/ssh/connection.rb

@@ -28,7 +28,7 @@ module Bolt
 
           @logger = Logging.logger[@target.safe_name]
           @transport_logger = transport_logger
-          @logger.debug("Initializing ssh connection to #{@target.safe_name}")
+          @logger.trace("Initializing ssh connection to #{@target.safe_name}")
 
           if target.options['private-key']&.instance_of?(String)
             begin
@@ -131,7 +131,7 @@ module Bolt
 
           @session = Net::SSH.start(target.host, @user, options)
           validate_ssh_version
-          @logger.debug { "Opened session" }
+          @logger.trace { "Opened session" }
         rescue Net::SSH::AuthenticationFailed => e
           raise Bolt::Node::ConnectError.new(
             e.message,
@@ -161,7 +161,7 @@ module Bolt
             rescue Timeout::Error
               @session.shutdown!
             end
-            @logger.debug { "Closed session" }
+            @logger.trace { "Closed session" }
           end
         end
 
@@ -237,7 +237,7 @@ module Bolt
 
         def upload_file(source, destination)
           # Do not log wrapper script content
-          @logger.debug { "Uploading #{source}, to #{destination}" } unless source.is_a?(StringIO)
+          @logger.trace { "Uploading #{source} to #{destination}" } unless source.is_a?(StringIO)
           @session.scp.upload!(source, destination, recursive: true)
         rescue StandardError => e
           raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
@@ -245,7 +245,7 @@ module Bolt
 
         def download_file(source, destination, _download)
           # Do not log wrapper script content
-          @logger.debug { "Downloading #{source} to #{destination}" }
+          @logger.trace { "Downloading #{source} to #{destination}" }
           @session.scp.download!(source, destination, recursive: true)
         rescue StandardError => e
           raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')

data/lib/bolt/transport/ssh/exec_connection.rb

@@ -66,7 +66,7 @@ module Bolt
         end
 
         def upload_file(source, dest)
-          @logger.debug { "Uploading #{source}, to #{userhost}:#{dest}" } unless source.is_a?(StringIO)
+          @logger.trace { "Uploading #{source} to #{dest}" } unless source.is_a?(StringIO)
 
           cp_conf = @target.transport_config['copy-command'] || ["scp", "-r"]
           cp_cmd = Array(cp_conf)
@@ -87,7 +87,7 @@ module Bolt
                          end
 
           if stat.success?
-            @logger.debug "Successfully uploaded #{source} to #{dest}"
+            @logger.trace "Successfully uploaded #{source} to #{dest}"
           else
             message = "Could not copy file to #{dest}: #{err}"
             raise Bolt::Node::FileError.new(message, 'COPY_ERROR')
@@ -95,7 +95,7 @@ module Bolt
         end
 
         def download_file(source, dest, _download)
-          @logger.debug { "Downloading #{userhost}:#{source} to #{dest}" }
+          @logger.trace { "Downloading #{userhost}:#{source} to #{dest}" }
 
           FileUtils.mkdir_p(dest)
 
@@ -108,7 +108,7 @@ module Bolt
           _, err, stat = Open3.capture3(*cp_cmd)
 
           if stat.success?
-            @logger.debug "Successfully downloaded #{userhost}:#{source} to #{dest}"
+            @logger.trace "Successfully downloaded #{userhost}:#{source} to #{dest}"
           else
             message = "Could not copy file to #{dest}: #{err}"
             raise Bolt::Node::FileError.new(message, 'COPY_ERROR')