bolt 2.22.0 → 2.26.0

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

@@ -7,7 +7,7 @@ module Bolt
     class YamlPlan
       class Evaluator
         def initialize(analytics = Bolt::Analytics::NoopClient.new)
-          @logger = Logging.logger[self]
+          @logger = Bolt::Logger.logger(self)
           @analytics = analytics
           @evaluator = Puppet::Pops::Parser::EvaluatingParser.new
         end
@@ -109,7 +109,7 @@ module Bolt
         end
 
         def message_step(scope, step)
-          scope.call_function('out::message', step['message'])
+          scope.call_function('out::message', [step['message']])
         end
 
         def generate_manifest(resources)

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/plugin/puppetdb.rb

@@ -19,7 +19,7 @@ module Bolt
       def initialize(config:, context:)
         pdb_config = Bolt::PuppetDB::Config.load_config(config, context.boltdir)
         @puppetdb_client = Bolt::PuppetDB::Client.new(pdb_config)
-        @logger = Logging.logger[self]
+        @logger = Bolt::Logger.logger(self)
       end
 
       def name

data/lib/bolt/project.rb

@@ -17,35 +17,37 @@ module Bolt
     }.freeze
 
     attr_reader :path, :data, :config_file, :inventory_file, :modulepath, :hiera_config,
-                :puppetfile, :rerunfile, :type, :resource_types, :warnings, :project_file,
+                :puppetfile, :rerunfile, :type, :resource_types, :logs, :project_file,
                 :deprecations, :downloads, :plans_path
 
-    def self.default_project
-      create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user')
+    def self.default_project(logs = [])
+      create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user', logs)
     # If homedir isn't defined use the system config path
     rescue ArgumentError
-      create_project(Bolt::Config.system_path, 'system')
+      create_project(Bolt::Config.system_path, 'system', logs)
     end
 
     # Search recursively up the directory hierarchy for the Project. Look for a
     # directory called Boltdir or a file called bolt.yaml (for a control repo
     # type Project). Otherwise, repeat the check on each directory up the
     # hierarchy, falling back to the default if we reach the root.
-    def self.find_boltdir(dir)
+    def self.find_boltdir(dir, logs = [])
       dir = Pathname.new(dir)
 
       if (dir + BOLTDIR_NAME).directory?
-        create_project(dir + BOLTDIR_NAME, 'embedded')
+        create_project(dir + BOLTDIR_NAME, 'embedded', logs)
       elsif (dir + 'bolt.yaml').file? || (dir + 'bolt-project.yaml').file?
-        create_project(dir, 'local')
+        create_project(dir, 'local', logs)
       elsif dir.root?
-        default_project
+        default_project(logs)
       else
-        find_boltdir(dir.parent)
+        logs << { debug: "Did not detect Boltdir, bolt.yaml, or bolt-project.yaml at '#{dir}'. "\
+                  "This directory won't be loaded as a project." }
+        find_boltdir(dir.parent, logs)
       end
     end
 
-    def self.create_project(path, type = 'option')
+    def self.create_project(path, type = 'option', logs = [])
       fullpath = Pathname.new(path).expand_path
 
       if !Bolt::Util.windows? && type != 'environment' && fullpath.world_writable?
@@ -58,15 +60,18 @@ module Bolt
 
       project_file = File.join(fullpath, 'bolt-project.yaml')
       data = Bolt::Util.read_optional_yaml_hash(File.expand_path(project_file), 'project')
-      new(data, path, type)
+      default = type =~ /user|system/ ? 'default ' : ''
+      exist = File.exist?(File.expand_path(project_file))
+      logs << { info: "Loaded #{default}project from '#{fullpath}'" } if exist
+      new(data, path, type, logs)
     end
 
-    def initialize(raw_data, path, type = 'option')
+    def initialize(raw_data, path, type = 'option', logs = [])
       @path = Pathname.new(path).expand_path
 
       @project_file = @path + 'bolt-project.yaml'
 
-      @warnings = []
+      @logs = logs
       @deprecations = []
       if (@path + 'bolt.yaml').file? && project_file?
         msg = "Project-level configuration in bolt.yaml is deprecated if using bolt-project.yaml. "\
@@ -88,7 +93,7 @@ module Bolt
       tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys
       if tc.any?
         msg = "Transport configuration isn't supported in bolt-project.yaml. Ignoring keys #{tc}"
-        @warnings << { msg: msg }
+        @logs << { warn: msg }
       end
 
       @data = raw_data.reject { |k, _| Bolt::Config::INVENTORY_OPTIONS.include?(k) }
@@ -98,7 +103,7 @@ module Bolt
       @config_file = if (Bolt::Config::BOLT_OPTIONS & @data.keys).any?
                        if (@path + 'bolt.yaml').file?
                          msg = "bolt-project.yaml contains valid config keys, bolt.yaml will be ignored"
-                         @warnings << { msg: msg }
+                         @logs << { warn: msg }
                        end
                        @project_file
                      else
@@ -114,7 +119,9 @@ module Bolt
     # This API is used to prepend the project as a module to Puppet's internal
     # module_references list. CHANGE AT YOUR OWN RISK
     def to_h
-      { path: @path.to_s, name: name }
+      { path: @path.to_s,
+        name: name,
+        load_as_module?: load_as_module? }
     end
 
     def eql?(other)
@@ -126,6 +133,10 @@ module Bolt
       @project_file.file?
     end
 
+    def load_as_module?
+      !name.nil?
+    end
+
     def name
       @data['name']
     end
@@ -141,15 +152,17 @@ module Bolt
     def validate
       if name
         if name !~ Bolt::Module::MODULE_NAME_REGEX
-          raise Bolt::ValidationError, "Invalid project name #{name.inspect.tr('"', "'")} in bolt-project.yaml; "\
-                                       "project name must match #{Bolt::Module::MODULE_NAME_REGEX.inspect}"
+          raise Bolt::ValidationError, <<~ERROR_STRING
+          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 "\
             "with a built-in Bolt module of the same name."
         end
       else
         message = "No project name is specified in bolt-project.yaml. Project-level content will not be available."
-        @warnings << { msg: message }
+        @logs << { warn: message }
       end
 
       %w[tasks plans].each do |conf|

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/puppetdb/client.rb

@@ -13,7 +13,7 @@ module Bolt
         @config = config
         @bad_urls = []
         @current_url = nil
-        @logger = Logging.logger[self]
+        @logger = Bolt::Logger.logger(self)
       end
 
       def query_certnames(query)

data/lib/bolt/puppetdb/config.rb

@@ -35,7 +35,7 @@ module Bolt
         begin
           config = JSON.parse(File.read(filepath)) if filepath
         rescue StandardError => e
-          Logging.logger[self].error("Could not load puppetdb.conf from #{filepath}: #{e.message}")
+          Bolt::Logger.logger(self).error("Could not load puppetdb.conf from #{filepath}: #{e.message}")
         end
 
         config = config.fetch('puppetdb', {})

data/lib/bolt/r10k_log_proxy.rb

@@ -7,7 +7,7 @@ module Bolt
     def initialize
       super('bolt')
 
-      @logger = Logging.logger[self]
+      @logger = Bolt::Logger.logger(self)
     end
 
     def canonical_log(event)

data/lib/bolt/rerun.rb

@@ -8,7 +8,7 @@ module Bolt
     def initialize(path, save_failures)
       @path = path
       @save_failures = save_failures
-      @logger = Logging.logger[self]
+      @logger = Bolt::Logger.logger(self)
     end
 
     def data

data/lib/bolt/result.rb

@@ -65,6 +65,10 @@ module Bolt
                             'msg' => msg,
                             'details' => { 'exit_code' => exit_code } }
       end
+
+      if value.key?('_sensitive')
+        value['_sensitive'] = Puppet::Pops::Types::PSensitiveType::Sensitive.new(value['_sensitive'])
+      end
       new(target, value: value, action: 'task', object: task)
     end
 
@@ -205,5 +209,9 @@ module Bolt
 
       end
     end
+
+    def sensitive
+      value['_sensitive']
+    end
   end
 end

data/lib/bolt/shell.rb

@@ -7,7 +7,7 @@ module Bolt
     def initialize(target, conn)
       @target = target
       @conn = conn
-      @logger = Logging.logger[@target.safe_name]
+      @logger = Bolt::Logger.logger(@target.safe_name)
     end
 
     def run_command(*_args)

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