bolt 2.21.0 → 2.25.0

data/lib/bolt/config.rb

@@ -213,6 +213,13 @@ module Bolt
         'transport'           => 'ssh'
       }
 
+      if project.path.directory?
+        default_data['log']['bolt-debug.log'] = {
+          'level' => 'debug',
+          'append' => false
+        }
+      end
+
       loaded_data = config_data.each_with_object([]) do |data, acc|
         @warnings.concat(data[:warnings]) if data[:warnings].any?
         @deprecations.concat(data[:deprecations]) if data[:deprecations].any?

data/lib/bolt/config/options.rb

@@ -186,8 +186,8 @@ module Bolt
                 "level" => {
                   description: "The type of information to log.",
                   type: String,
-                  enum: %w[debug error info notice warn fatal any],
-                  _default: "warn for console, notice for file"
+                  enum: %w[trace debug error info warn fatal any],
+                  _default: "warn"
                 }
               }
             }
@@ -204,8 +204,8 @@ module Bolt
               "level" => {
                 description: "The type of information to log.",
                 type: String,
-                enum: %w[debug error info notice warn fatal any],
-                _default: "warn for console, notice for file"
+                enum: %w[trace debug error info warn fatal any],
+                _default: "warn"
               }
             }
           },

data/lib/bolt/executor.rb

@@ -56,11 +56,12 @@ module Bolt
       @reported_transports = Set.new
       @subscribers = {}
       @publisher = Concurrent::SingleThreadExecutor.new
+      @publisher.post { Thread.current[:name] = 'event-publisher' }
 
       @noop = noop
       @run_as = nil
       @pool = if concurrency > 0
-                Concurrent::ThreadPoolExecutor.new(max_threads: concurrency)
+                Concurrent::ThreadPoolExecutor.new(name: 'exec', max_threads: concurrency)
               else
                 Concurrent.global_immediate_executor
               end
@@ -125,6 +126,7 @@ module Bolt
           # Pass this argument through to avoid retaining a reference to a
           # local variable that will change on the next iteration of the loop.
           @pool.post(batch_promises) do |result_promises|
+            Thread.current[:name] ||= Thread.current.name
             results = yield transport, batch
             Array(results).each do |result|
               result_promises[result.target].set(result)
@@ -241,7 +243,7 @@ module Bolt
 
       @analytics&.event('Plan', 'yaml', plan_steps: steps, return_type: return_type)
     rescue StandardError => e
-      @logger.debug { "Failed to submit analytics event: #{e.message}" }
+      @logger.trace { "Failed to submit analytics event: #{e.message}" }
     end
 
     def with_node_logging(description, batch)
@@ -381,19 +383,19 @@ module Bolt
     end
 
     def prompt(prompt, options)
-      unless STDIN.tty?
+      unless $stdin.tty?
         raise Bolt::Error.new('STDIN is not a tty, unable to prompt', 'bolt/no-tty-error')
       end
 
-      STDERR.print("#{prompt}: ")
+      $stderr.print("#{prompt}: ")
 
       value = if options[:sensitive]
-                STDIN.noecho(&:gets).to_s.chomp
+                $stdin.noecho(&:gets).to_s.chomp
               else
-                STDIN.gets.to_s.chomp
+                $stdin.gets.to_s.chomp
               end
 
-      STDERR.puts if options[:sensitive]
+      $stderr.puts if options[:sensitive]
 
       value
     end

data/lib/bolt/inventory/group.rb

@@ -119,7 +119,7 @@ module Bolt
         end
 
         if contains_target?(t_name)
-          @logger.warn("Ignoring duplicate target in #{@name}: #{target}")
+          @logger.debug("Ignoring duplicate target in #{@name}: #{target}")
           return
         end
 
@@ -200,14 +200,14 @@ module Bolt
           # If this is an alias for an existing target, then add it to this group
           elsif (canonical_name = aliases[string_target])
             if contains_target?(canonical_name)
-              @logger.warn("Ignoring duplicate target in #{@name}: #{canonical_name}")
+              @logger.debug("Ignoring duplicate target in #{@name}: #{canonical_name}")
             else
               @unresolved_targets[canonical_name] = { 'name' => canonical_name }
             end
           # If it's not the name or alias of an existing target, then make a
           # new target using the string as the URI
           elsif contains_target?(string_target)
-            @logger.warn("Ignoring duplicate target in #{@name}: #{string_target}")
+            @logger.debug("Ignoring duplicate target in #{@name}: #{string_target}")
           else
             @unresolved_targets[string_target] = { 'uri' => string_target }
           end

data/lib/bolt/logger.rb

@@ -14,13 +14,12 @@ module Bolt
       # redefs, so skip it if it's already been initialized
       return if Logging.initialized?
 
-      Logging.init :debug, :info, :notice, :warn, :error, :fatal, :any
+      Logging.init :trace, :debug, :info, :notice, :warn, :error, :fatal, :any
       @mutex = Mutex.new
 
       Logging.color_scheme(
         'bolt',
         lines: {
-          notice: :green,
           warn: :yellow,
           error: :red,
           fatal: %i[white on_red]
@@ -81,7 +80,7 @@ module Bolt
 
     def self.default_layout
       Logging.layouts.pattern(
-        pattern: '%d %-6l %c: %m\n',
+        pattern: '%d %-6l [%T] [%c] %m\n',
         date_pattern: '%Y-%m-%dT%H:%M:%S.%6N'
       )
     end
@@ -91,7 +90,7 @@ module Bolt
     end
 
     def self.default_file_level
-      :notice
+      :warn
     end
 
     # Explicitly check the log level names instead of the log level number, as levels

data/lib/bolt/module.rb

@@ -3,7 +3,8 @@
 # Is this Bolt::Pobs::Module?
 module Bolt
   class Module
-    MODULE_NAME_REGEX = /\A[a-z][a-z0-9_]*\z/.freeze
+    CONTENT_NAME_REGEX = /\A[a-z][a-z0-9_]*(::[a-z][a-z0-9_]*)*\z/.freeze
+    MODULE_NAME_REGEX  = /\A[a-z][a-z0-9_]*\z/.freeze
 
     def self.discover(modulepath)
       modulepath.each_with_object({}) do |path, mods|

data/lib/bolt/outputter.rb

@@ -21,6 +21,62 @@ module Bolt
       @trace = trace
       @stream = stream
     end
+
+    def indent(indent, string)
+      indent = ' ' * indent
+      string.gsub(/^/, indent.to_s)
+    end
+
+    def print_message_event(event)
+      print_message(stringify(event[:message]))
+    end
+
+    def print_message
+      raise NotImplementedError, "print_message() must be implemented by the outputter class"
+    end
+
+    def stringify(message)
+      formatted = format_message(message)
+      if formatted.is_a?(Hash) || formatted.is_a?(Array)
+        ::JSON.pretty_generate(formatted)
+      else
+        formatted
+      end
+    end
+
+    def format_message(message)
+      case message
+      when Array
+        message.map { |item| format_message(item) }
+      when Bolt::ApplyResult
+        format_apply_result(message)
+      when Bolt::Result, Bolt::ResultSet
+        # This is equivalent to to_s, but formattable
+        message.to_data
+      when Bolt::RunFailure
+        formatted_resultset = message.result_set.to_data
+        message.to_h.merge('result_set' => formatted_resultset)
+      when Hash
+        message.each_with_object({}) do |(k, v), h|
+          h[format_message(k)] = format_message(v)
+        end
+      when Integer, Float, NilClass
+        message
+      else
+        message.to_s
+      end
+    end
+
+    def format_apply_result(result)
+      logs = result.resource_logs&.map do |log|
+        # Omit low-level info/debug messages
+        next if %w[info debug].include?(log['level'])
+        indent(2, format_log(log))
+      end
+      hash = result.to_data
+      hash['logs'] = logs unless logs.empty?
+      hash
+    end
   end
 end
 

data/lib/bolt/outputter/human.rb

@@ -27,11 +27,6 @@ module Bolt
         end
       end
 
-      def indent(indent, string)
-        indent = ' ' * indent
-        string.gsub(/^/, indent.to_s)
-      end
-
       def remove_trail(string)
         string.sub(/\s\z/, '')
       end
@@ -291,6 +286,16 @@ module Bolt
                         "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.")
+      end
+
+      def print_guide(guide, _topic)
+        @stream.puts(guide)
+      end
+
       def print_module_list(module_list)
         module_list.each do |path, modules|
           if (mod = modules.find { |m| m[:internal_module_group] })
@@ -372,10 +377,6 @@ module Bolt
         end
       end
 
-      def print_message_event(event)
-        print_message(event[:message])
-      end
-
       def fatal_error(err)
         @stream.puts(colorize(:red, err.message))
         if err.is_a? Bolt::RunFailure

data/lib/bolt/outputter/json.rb

@@ -83,6 +83,17 @@ module Bolt
         @stream.puts result.to_json
       end
 
+      def print_topics(topics)
+        print_table('topics' => topics)
+      end
+
+      def print_guide(guide, topic)
+        @stream.puts({
+          'topic' => topic,
+          'guide' => guide
+        }.to_json)
+      end
+
       def print_puppetfile_result(success, puppetfile, moduledir)
         @stream.puts({ "success": success,
                        "puppetfile": puppetfile,
@@ -121,10 +132,6 @@ module Bolt
         @stream.puts '}' if @object_open
       end
 
-      def print_message_event(event)
-        print_message(event[:message])
-      end
-
       def print_message(message)
         $stderr.puts(message)
       end

data/lib/bolt/outputter/logger.rb

@@ -40,13 +40,13 @@ module Bolt
 
       def log_plan_start(event)
         plan = event[:plan]
-        @logger.notice("Starting: plan #{plan}")
+        @logger.info("Starting: plan #{plan}")
       end
 
       def log_plan_finish(event)
         plan = event[:plan]
         duration = event[:duration]
-        @logger.notice("Finished: plan #{plan} in #{duration.round(2)} sec")
+        @logger.info("Finished: plan #{plan} in #{duration.round(2)} sec")
       end
     end
   end

data/lib/bolt/outputter/rainbow.rb

@@ -86,6 +86,21 @@ module Bolt
         total_msg << " in #{duration_to_string(elapsed_time)}" unless elapsed_time.nil?
         @stream.puts colorize(:rainbow, total_msg)
       end
+
+      def print_guide(guide, _topic)
+        @stream.puts colorize(:rainbow, guide)
+      end
+
+      def print_topics(topics)
+        content  = String.new("Available topics are:\n")
+        content += topics.join("\n")
+        content += "\n\nUse `bolt guide <topic>` to view a specific guide."
+        @stream.puts colorize(:rainbow, content)
+      end
+
+      def print_message(message)
+        @stream.puts colorize(:rainbow, message)
+      end
     end
   end
 end

data/lib/bolt/pal.rb

@@ -48,7 +48,7 @@ module Bolt
       end
     end
 
-    attr_reader :modulepath
+    attr_reader :modulepath, :user_modulepath
 
     def initialize(modulepath, hiera_config, resource_types, max_compiles = Etc.nprocessors,
                    trusted_external = nil, apply_settings = {}, project = nil)
@@ -56,7 +56,7 @@ module Bolt
       # is safe and in practice only happens in tests
       self.class.load_puppet
 
-      @original_modulepath = modulepath
+      @user_modulepath = modulepath
       @modulepath = [BOLTLIB_PATH, *modulepath, MODULES_PATH]
       @hiera_config = hiera_config
       @trusted_external = trusted_external
@@ -67,7 +67,7 @@ module Bolt
 
       @logger = Logging.logger[self]
       if modulepath && !modulepath.empty?
-        @logger.info("Loading modules from #{@modulepath.join(File::PATH_SEPARATOR)}")
+        @logger.debug("Loading modules from #{@modulepath.join(File::PATH_SEPARATOR)}")
       end
 
       @loaded = false
@@ -208,7 +208,7 @@ module Bolt
           # Skip syncing built-in plugins, since we vendor some Puppet 6
           # versions of "core" types, which are already present on the agent,
           # but may cause issues on Puppet 5 agents.
-          @original_modulepath,
+          @user_modulepath,
           @project,
           pdb_client,
           @hiera_config,
@@ -278,10 +278,6 @@ module Bolt
       end
     end
 
-    def list_modulepath
-      @modulepath - [BOLTLIB_PATH, MODULES_PATH]
-    end
-
     def parse_params(type, object_name, params)
       in_bolt_compiler do |compiler|
         case type
@@ -413,7 +409,7 @@ module Bolt
                      end
           params[name] = { 'type' => type_str }
           params[name]['sensitive'] = param.type_expr.instance_of?(Puppet::Pops::Types::PSensitiveType)
-          params[name]['default_value'] = param.value
+          params[name]['default_value'] = param.value unless param.value.nil?
           params[name]['description'] = param.description if param.description
         end
         {

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

@@ -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/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 "\