bolt 2.23.0 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f58ca99a18fca1c109d531c61b55bcee45d73c14e55a074575ffaaf1d9f40aac
-  data.tar.gz: ea55e4c9b9ba4ccd8afed70a6c62c603a119a46f406b573f429bd2cd89983672
+  metadata.gz: 1e572a2c5aec9f127f48764b6a2fe903c91566c8aa0f3a1db33e40347bd1630b
+  data.tar.gz: 1445543fb941e0b8c12ec60900975a45e368a08e593ebe75c87ee946317f57b7
 SHA512:
-  metadata.gz: dc8845ebe2a171ce79b704c474594a9679e7078feaca324eb7f26b88e9e903de43361a4dbaa357de3cf47be4ae72b4db4690a76e0910c9595f52aab384768fbc
-  data.tar.gz: 60b30a31debf0d031902d8df21372b2524246ee98749eeccfd588c00b3458bcb9c0ed2a1fbdeab266cce86332537bde1005aead37fece867d440d88989c2486d
+  metadata.gz: 4cdee0a056e3c248a72ea3a4cb1872453611ca241d19ad3c98f5e0e89c550368ab19e34999e121f0e98c5e5cac353fed32eb174fb54fd149bd4558bd84e5706e
+  data.tar.gz: d505e8baf7c6ce5b21c20e27d7979c39c871e5bc69ea7bcf5d898ac94261850afea03028569ed60e192196d215837a2b339fef24231ea9491bc4901e93cba3dd

data/exe/bolt

@@ -4,6 +4,7 @@
 require 'bolt'
 require 'bolt/cli'
 
+Thread.current[:name] ||= 'main'
 cli = Bolt::CLI.new(ARGV)
 begin
   opts = cli.parse

data/guides/inventory.txt

@@ -0,0 +1,19 @@
+TOPIC
+    inventory
+
+DESCRIPTION
+    The inventory describes the targets that you run Bolt commands on, along
+    with any data and configuration for the targets. Targets in an inventory can
+    belong to one or more groups, allowing you to share data and configuration
+    across multiple targets and to specify multiple targets for your Bolt
+    commands without the need to list each target individually.
+
+    In most cases, Bolt loads the inventory from an inventory file in your Bolt
+    project. The inventory file is a YAML file named 'inventory.yaml'. Because
+    Bolt loads the inventory file from a Bolt project, you must have an existing
+    project configuration file named 'bolt-project.yaml' alongside the inventory
+    file.
+
+DOCUMENTATION
+    https://pup.pt/bolt-inventory
+    https://pup.pt/bolt-inventory-reference

data/guides/project.txt

@@ -0,0 +1,22 @@
+TOPIC
+    project
+
+DESCRIPTION
+    A Bolt project is a directory that serves as the launching point for Bolt
+    and allows you to create a shareable orchestration application. Projects
+    typically include a project configuration file, an inventory file, and any
+    content you use in your project workflow, such as tasks and plans.
+
+    When you run Bolt, it runs in the context of a project. If the directory you
+    run Bolt from is not a project, Bolt attempts to find a project by
+    traversing the parent directories. If Bolt is unable to find a project, it
+    runs from the default project, located at '~/.puppetlabs/bolt'.
+
+    A directory is only considered a Bolt project when it has a project
+    configuration file named 'bolt-project.yaml'. Bolt doesn't load project data
+    and content, including inventory files, unless the data and content are part
+    of a project.
+
+DOCUMENTATION
+    https://pup.pt/bolt-projects
+    https://pup.pt/bolt-project-reference

data/lib/bolt/analytics.rb

@@ -161,9 +161,9 @@ module Bolt
         # Handle analytics submission in the background to avoid blocking the
         # app or polluting the log with errors
         Concurrent::Future.execute(executor: @executor) do
-          @logger.debug "Submitting analytics: #{JSON.pretty_generate(params)}"
+          @logger.trace "Submitting analytics: #{JSON.pretty_generate(params)}"
           @http.post(TRACKING_URL, params)
-          @logger.debug "Completed analytics submission"
+          @logger.trace "Completed analytics submission"
         end
       end
 
@@ -215,13 +215,13 @@ module Bolt
       end
 
       def screen_view(screen, **_kwargs)
-        @logger.debug "Skipping submission of '#{screen}' screenview because analytics is disabled"
+        @logger.trace "Skipping submission of '#{screen}' screenview because analytics is disabled"
       end
 
       def report_bundled_content(mode, name); end
 
       def event(category, action, **_kwargs)
-        @logger.debug "Skipping submission of '#{category} #{action}' event because analytics is disabled"
+        @logger.trace "Skipping submission of '#{category} #{action}' event because analytics is disabled"
       end
 
       def finish; end

data/lib/bolt/applicator.rb

@@ -27,7 +27,7 @@ module Bolt
       @hiera_config = hiera_config ? validate_hiera_config(hiera_config) : nil
       @apply_settings = apply_settings || {}
 
-      @pool = Concurrent::ThreadPoolExecutor.new(max_threads: max_compiles)
+      @pool = Concurrent::ThreadPoolExecutor.new(name: 'apply', max_threads: max_compiles)
       @logger = Logging.logger[self]
     end
 
@@ -217,6 +217,7 @@ module Bolt
       r = @executor.log_action(description, targets) do
         futures = targets.map do |target|
           Concurrent::Future.execute(executor: @pool) do
+            Thread.current[:name] ||= Thread.current.name
             @executor.with_node_logging("Compiling manifest block", [target]) do
               compile(target, scope)
             end
@@ -300,7 +301,7 @@ module Bolt
 
         files.each do |file|
           tar_path = Pathname.new(file).relative_path_from(parent)
-          @logger.debug("Packing plugin #{file} to #{tar_path}")
+          @logger.trace("Packing plugin #{file} to #{tar_path}")
           stat = File.stat(file)
           content = File.binread(file)
           output.tar.add_file_simple(
@@ -314,7 +315,7 @@ module Bolt
       end
 
       duration = Time.now - start_time
-      @logger.debug("Packed plugins in #{duration * 1000} ms")
+      @logger.trace("Packed plugins in #{duration * 1000} ms")
 
       output.close
       Base64.encode64(sio.string)

data/lib/bolt/bolt_option_parser.rb

@@ -61,6 +61,9 @@ module Bolt
           { flags: OPTIONS[:global],
             banner: GROUP_HELP }
         end
+      when 'guide'
+        { flags: OPTIONS[:global] + %w[format],
+          banner: GUIDE_HELP }
       when 'plan'
         case action
         when 'convert'
@@ -85,7 +88,7 @@ module Bolt
           { flags: OPTIONS[:global] + %w[modules],
             banner: PROJECT_INIT_HELP }
         when 'migrate'
-          { flags: OPTIONS[:global] + %w[inventoryfile boltdir configfile],
+          { flags: OPTIONS[:global] + %w[inventoryfile project configfile],
             banner: PROJECT_MIGRATE_HELP }
         else
           { flags: OPTIONS[:global],
@@ -164,6 +167,7 @@ module Bolt
           command           Run a command remotely
           file              Copy files between the controller and targets
           group             Show the list of groups in the inventory
+          guide             View guides for Bolt concepts and features
           inventory         Show the list of targets an action would run on
           plan              Convert, create, show, and run Bolt plans
           project           Create and migrate Bolt projects
@@ -171,6 +175,9 @@ module Bolt
           script            Upload a local script and run it remotely
           secret            Create encryption keys and encrypt and decrypt values
           task              Show and run Bolt tasks
+
+      GUIDES
+          For a list of guides on Bolt's concepts and features, run 'bolt guide'.
     HELP
 
     APPLY_HELP = <<~HELP
@@ -289,6 +296,26 @@ module Bolt
           Show the list of groups in the inventory.
     HELP
 
+    GUIDE_HELP = <<~HELP
+      NAME
+          guide
+
+      USAGE
+          bolt guide [topic] [options]
+
+      DESCRIPTION
+          View guides for Bolt's concepts and features.
+
+          Omitting a topic will display a list of available guides,
+          while providing a topic will display the relevant guide.
+
+      EXAMPLES
+          View a list of available guides
+            bolt guide
+          View the 'project' guide page
+            bolt guide project
+    HELP
+
     INVENTORY_HELP = <<~HELP
       NAME
           inventory
@@ -444,10 +471,7 @@ module Bolt
           bolt project migrate [options]
 
       DESCRIPTION
-          Migrate a Bolt project to the latest version.
-
-          Loads a Bolt project's inventory file and migrates it to the latest version. The
-          inventory file is modified in place and will not preserve comments or formatting.
+          Migrate a Bolt project to use current best practices and the latest version of configuration files.
     HELP
 
     PUPPETFILE_HELP = <<~HELP
@@ -863,7 +887,7 @@ module Bolt
       end
       define('--log-level LEVEL',
              "Set the log level for the console. Available options are",
-             "debug, info, notice, warn, error, fatal, any.") do |level|
+             "trace, debug, info, warn, error, fatal, any.") do |level|
         @options[:log] = { 'console' => { 'level' => level } }
       end
       define('--plugin PLUGIN', 'Select the plugin to use') do |plug|

data/lib/bolt/cli.rb

@@ -20,6 +20,7 @@ require 'bolt/logger'
 require 'bolt/outputter'
 require 'bolt/puppetdb'
 require 'bolt/plugin'
+require 'bolt/project_migrate'
 require 'bolt/pal'
 require 'bolt/target'
 require 'bolt/version'
@@ -38,7 +39,8 @@ module Bolt
                  'inventory' => %w[show],
                  'group' => %w[show],
                  'project' => %w[init migrate],
-                 'apply' => %w[] }.freeze
+                 'apply' => %w[],
+                 'guide' => %w[] }.freeze
 
     attr_reader :config, :options
 
@@ -354,7 +356,7 @@ module Bolt
       # Initialize inventory and targets. Errors here are better to catch early.
       # options[:target_args] will contain a string/array version of the targetting options this is passed to plans
       # options[:targets] will contain a resolved set of Target objects
-      unless %w[project puppetfile secret].include?(options[:subcommand]) ||
+      unless %w[project puppetfile secret guide].include?(options[:subcommand]) ||
              %w[convert new show].include?(options[:action])
         update_targets(options)
       end
@@ -411,7 +413,7 @@ module Bolt
         list_modules
         return 0
       when 'convert'
-        convert_plan(options[:object])
+        pal.convert_plan(options[:object])
         return 0
       end
 
@@ -422,12 +424,20 @@ module Bolt
       end
 
       case options[:subcommand]
+      when 'guide'
+        code = if options[:object]
+                 show_guide(options[:object])
+               else
+                 list_topics
+               end
       when 'project'
         case options[:action]
         when 'init'
           code = initialize_project
         when 'migrate'
-          code = migrate_project
+          inv = config.inventoryfile
+          path = config.project.path
+          code = Bolt::ProjectMigrate.new(path, outputter, inv).migrate_project
         end
       when 'plan'
         case options[:action]
@@ -903,49 +913,6 @@ module Bolt
       end
     end
 
-    def migrate_project
-      inventory_file = config.inventoryfile || config.default_inventoryfile
-      data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
-
-      data.delete('version') if data['version'] != 2
-
-      migrated = migrate_group(data)
-
-      ok = File.write(inventory_file, data.to_yaml) if migrated
-
-      result = if migrated && ok
-                 "Successfully migrated Bolt project to latest version."
-               elsif !migrated
-                 "Bolt project already on latest version. Nothing to do."
-               else
-                 "Could not migrate Bolt project to latest version."
-               end
-      outputter.print_message result
-
-      ok ? 0 : 1
-    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.
-    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
-
     def install_puppetfile(config, puppetfile, modulepath)
       require 'r10k/cli'
       require 'bolt/r10k_log_proxy'
@@ -988,8 +955,46 @@ module Bolt
                              config.project)
     end
 
-    def convert_plan(plan)
-      pal.convert_plan(plan)
+    # Collects the list of Bolt guides and maps them to their topics.
+    def guides
+      @guides ||= begin
+                    root_path = File.expand_path(File.join(__dir__, '..', '..', 'guides'))
+                    files     = Dir.children(root_path).sort
+
+                    files.each_with_object({}) do |file, guides|
+                      next if file !~ /\.txt\z/
+                      topic = File.basename(file, '.txt')
+                      guides[topic] = File.join(root_path, file)
+                    end
+                  rescue SystemCallError => e
+                    raise Bolt::FileError.new("#{e.message}: unable to load guides directory", root_path)
+                  end
+    end
+
+    # Display the list of available Bolt guides.
+    def list_topics
+      outputter.print_topics(guides.keys)
+      0
+    end
+
+    # Display a specific Bolt guide.
+    def show_guide(topic)
+      if guides[topic]
+        analytics.event('Guide', 'known_topic', label: topic)
+
+        begin
+          guide = File.read(guides[topic])
+        rescue SystemCallError => e
+          raise Bolt::FileError("#{e.message}: unable to load guide page", filepath)
+        end
+
+        outputter.print_guide(guide, topic)
+      else
+        analytics.event('Guide', 'unknown_topic', label: topic)
+        outputter.print_message("Did not find guide for topic '#{topic}'.\n\n")
+        list_topics
+      end
+      0
     end
 
     def validate_file(type, path, allow_dir = false)
@@ -1056,7 +1061,7 @@ module Bolt
       msg = <<~MSG.chomp
         Loaded configuration from: '#{config.config_files.join("', '")}'
       MSG
-      @logger.debug(msg)
+      @logger.info(msg)
     end
 
     # Gem installs include the aggregate, canary, and puppetdb_fact modules, while

data/lib/bolt/config.rb

@@ -204,7 +204,7 @@ module Bolt
         'compile-concurrency' => Etc.nprocessors,
         'concurrency'         => default_concurrency,
         'format'              => 'human',
-        'log'                 => { 'console' => {} },
+        'log'                 => { 'console' => {}, 'bolt-debug.log' => { 'level' => 'debug', 'append' => false } },
         'plugin_hooks'        => {},
         'plugins'             => {},
         'puppetdb'            => {},

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)

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

@@ -286,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] })

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,

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

@@ -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
@@ -409,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/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/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')

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

@@ -19,7 +19,7 @@ module Bolt
           # Build set of extensions from extensions config as well as interpreters
 
           @logger = Logging.logger[@target.safe_name]
-          logger.debug("Initializing winrm connection to #{@target.safe_name}")
+          logger.trace("Initializing winrm connection to #{@target.safe_name}")
           @transport_logger = transport_logger
         end
 
@@ -55,7 +55,7 @@ module Bolt
 
             @session = @connection.shell(:powershell)
             @session.run('$PSVersionTable.PSVersion')
-            @logger.debug { "Opened session" }
+            @logger.trace { "Opened session" }
           end
         rescue Timeout::Error
           # If we're using the default port with SSL, a timeout probably means the
@@ -97,11 +97,11 @@ module Bolt
         def disconnect
           @session&.close
           @client&.disconnect!
-          @logger.debug { "Closed session" }
+          @logger.trace { "Closed session" }
         end
 
         def execute(command)
-          @logger.debug { "Executing command: #{command}" }
+          @logger.trace { "Executing command: #{command}" }
 
           inp = StringIO.new
           # This transport doesn't accept stdin, so close the stream to ensure
@@ -134,12 +134,12 @@ module Bolt
             "with 'ulimit -n 1024'. See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
           raise Bolt::Error.new(msg, 'bolt/too-many-files')
         rescue StandardError
-          @logger.debug { "Command aborted" }
+          @logger.trace { "Command aborted" }
           raise
         end
 
         def upload_file(source, destination)
-          @logger.debug { "Uploading #{source}, to #{destination}" }
+          @logger.trace { "Uploading #{source} to #{destination}" }
           if target.options['file-protocol'] == 'smb'
             upload_file_smb(source, destination)
           else
@@ -185,7 +185,7 @@ module Bolt
         end
 
         def download_file(source, destination, download)
-          @logger.debug { "Downloading #{source} to #{destination}" }
+          @logger.trace { "Downloading #{source} to #{destination}" }
           if target.options['file-protocol'] == 'smb'
             download_file_smb(source, destination)
           else
@@ -257,7 +257,7 @@ module Bolt
           status = @client.login
           case status
           when WindowsError::NTStatus::STATUS_SUCCESS
-            @logger.debug { "Connected to #{@client.dns_host_name}" }
+            @logger.trace { "Connected to #{@client.dns_host_name}" }
           when WindowsError::NTStatus::STATUS_LOGON_FAILURE
             raise Bolt::Node::ConnectError.new(
               "SMB authentication failed for #{target.safe_name}",

data/lib/bolt/util.rb

@@ -13,7 +13,7 @@ module Bolt
           msg = "Invalid content for #{file_name} file: #{path} should be a Hash or empty, not #{content.class}"
           raise Bolt::FileError.new(msg, path)
         end
-        logger.debug("Loaded #{file_name} from #{path}")
+        logger.trace("Loaded #{file_name} from #{path}")
         content
       rescue Errno::ENOENT
         raise Bolt::FileError.new("Could not read #{file_name} file: #{path}", path)

data/lib/bolt/util/puppet_log_level.rb

@@ -4,9 +4,10 @@ module Bolt
   module Util
     module PuppetLogLevel
       MAPPING = {
-        debug: :debug,
-        info: :info,
-        notice: :notice,
+        # Demote Puppet's logs by one level, since Puppet is an implementation detail of Bolt
+        debug: :trace,
+        info: :debug,
+        notice: :info,
         warning: :warn,
         err: :error,
         # The following are used by Puppet functions of the same name, and are all treated as

data/lib/bolt/version.rb

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

data/lib/bolt_server/base_config.rb

@@ -16,7 +16,7 @@ module BoltServer
 
     def defaults
       { 'host' => '127.0.0.1',
-        'loglevel' => 'notice',
+        'loglevel' => 'warn',
         'ssl-cipher-suites' => %w[ECDHE-ECDSA-AES256-GCM-SHA384
                                   ECDHE-RSA-AES256-GCM-SHA384
                                   ECDHE-ECDSA-CHACHA20-POLY1305

data/lib/bolt_server/transport_app.rb

@@ -221,6 +221,56 @@ module BoltServer
       plan_info
     end
 
+    def build_puppetserver_uri(file_identifier, module_name, environment)
+      segments = file_identifier.split('/', 3)
+      if segments.size == 1
+        {
+          'path' => "/puppet/v3/file_content/tasks/#{module_name}/#{file_identifier}",
+          'params' => {
+            'environment' => environment
+          }
+        }
+      else
+        module_segment, mount_segment, name_segment = *segments
+        {
+          'path' => case mount_segment
+                    when 'files'
+                      "/puppet/v3/file_content/modules/#{module_segment}/#{name_segment}"
+                    when 'tasks'
+                      "/puppet/v3/file_content/tasks/#{module_segment}/#{name_segment}"
+                    when 'lib'
+                      "/puppet/v3/file_content/plugins/#{name_segment}"
+                    end,
+          'params' => {
+            'environment' => environment
+          }
+        }
+      end
+    end
+
+    def pe_task_info(pal, module_name, task_name, environment)
+      # Handle case where task name is simply module name with special `init` task
+      task_name = if task_name == 'init' || task_name.nil?
+                    module_name
+                  else
+                    "#{module_name}::#{task_name}"
+                  end
+      task = pal.get_task(task_name)
+      files = task.files.map do |file_hash|
+        {
+          'filename' => file_hash['name'],
+          'sha256' => Digest::SHA256.hexdigest(File.read(file_hash['path'])),
+          'size_bytes' => File.size(file_hash['path']),
+          'uri' => build_puppetserver_uri(file_hash['name'], module_name, environment)
+        }
+      end
+      {
+        'metadata' => task.metadata,
+        'name' => task.name,
+        'files' => files
+      }
+    end
+
     get '/' do
       200
     end
@@ -351,6 +401,16 @@ module BoltServer
       end
     end
 
+    # Fetches the metadata for a single task
+    #
+    # @param environment [String] the environment to fetch the task from
+    get '/tasks/:module_name/:task_name' do
+      in_pe_pal_env(params['environment']) do |pal|
+        task_info = pe_task_info(pal, params[:module_name], params[:task_name], params['environment'])
+        [200, task_info.to_json]
+      end
+    end
+
     # Fetches the list of plans for an environment, optionally fetching all metadata for each plan
     #
     # @param environment [String] the environment to fetch the list of plans from
@@ -375,6 +435,22 @@ module BoltServer
       end
     end
 
+    # Fetches the list of tasks for an environment
+    #
+    # @param environment [String] the environment to fetch the list of tasks from
+    get '/tasks' do
+      in_pe_pal_env(params['environment']) do |pal|
+        tasks = pal.list_tasks
+        tasks_response = tasks.map { |task_name, _description| { 'name' => task_name } }.to_json
+
+        # We structure this array of tasks to be an array of hashes so that it matches the structure
+        # returned by the puppetserver API that serves data like this. Structuring the output this way
+        # makes switching between puppetserver and bolt-server easier, which makes changes to switch
+        # to bolt-server smaller/simpler.
+        [200, tasks_response]
+      end
+    end
+
     error 404 do
       err = Bolt::Error.new("Could not find route #{request.path}",
                             'boltserver/not-found')

data/lib/bolt_spec/plans.rb

@@ -206,7 +206,7 @@ module BoltSpec
       Puppet[:tasks] = true
 
       # Ensure logger is initialized with Puppet levels so 'notice' works when running plan specs.
-      Logging.init :debug, :info, :notice, :warn, :error, :fatal, :any
+      Logging.init :trace, :debug, :info, :notice, :warn, :error, :fatal, :any
     end
 
     # Provided as a class so expectations can be placed on it.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.23.0
+  version: 2.24.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -437,6 +437,8 @@ files:
 - bolt-modules/prompt/lib/puppet/functions/prompt.rb
 - bolt-modules/system/lib/puppet/functions/system/env.rb
 - exe/bolt
+- guides/inventory.txt
+- guides/project.txt
 - lib/bolt.rb
 - lib/bolt/analytics.rb
 - lib/bolt/applicator.rb
@@ -498,6 +500,7 @@ files:
 - lib/bolt/plugin/puppetdb.rb
 - lib/bolt/plugin/task.rb
 - lib/bolt/project.rb
+- lib/bolt/project_migrate.rb
 - lib/bolt/puppetdb.rb
 - lib/bolt/puppetdb/client.rb
 - lib/bolt/puppetdb/config.rb