bolt 3.9.1 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677d817ea21f24c36b06d830a6a4f60cc11a1c288b9bc948ad69ee47f59da4f9
-  data.tar.gz: a5045561603829eda876b5558082ecfa234916393ed4c92e6c5e7851c3cf1f2f
+  metadata.gz: 80a2245a2ac92c15284c4d6206f5480c6cf72033b32b773a98303b634f853e54
+  data.tar.gz: 4a6e868eba652ea23cb8530a135e3187fae81296d63df8bf9b54d5c2117df615
 SHA512:
-  metadata.gz: 111b4df917e7788816f8ccbac0b1f7ed5ecb35af9ddec145aece1aa8ad8dd10c617383ce0b17b5e9146a528ad15e28751771eba0bef1fb08ddcd91c3db200c62
-  data.tar.gz: cea97329b768ee991b0757bd0a4ff7ae28b2f0a68b678989adaee488a4c98d2354c618bc4663be18482088e856307238e7e04ac823b3dd65a95465fc08ed8254
+  metadata.gz: f7373197cc0401a971ff8e68ed70ef31f90d2087d09a5a0a5178124e40d2aae59546db768480fb5ea65f2b2993d60104abcf137df281863ddaf37c69d58365e5
+  data.tar.gz: 338c72c31cc379aaf45adae5a122a2a2e9fe6dede738aec4b46c21b5102d16a00ee5a494514dd80bc9f4fcd922ee08e62164e64d34987d40ad1d7383ff475363

data/Puppetfile

@@ -6,13 +6,13 @@ moduledir File.join(File.dirname(__FILE__), 'modules')
 
 # Core modules used by 'apply'
 mod 'puppetlabs-service', '2.0.0'
-mod 'puppetlabs-puppet_agent', '4.6.1'
+mod 'puppetlabs-puppet_agent', '4.8.0'
 mod 'puppetlabs-facts', '1.4.0'
 
 # Core types and providers for Puppet 6
 mod 'puppetlabs-augeas_core', '1.1.2'
 mod 'puppetlabs-host_core', '1.0.3'
-mod 'puppetlabs-scheduled_task', '3.0.0'
+mod 'puppetlabs-scheduled_task', '3.0.1'
 mod 'puppetlabs-sshkeys_core', '2.2.0'
 mod 'puppetlabs-zfs_core', '1.2.0'
 mod 'puppetlabs-cron_core', '1.0.5'
@@ -29,14 +29,14 @@ mod 'puppetlabs-python_task_helper', '0.5.0'
 mod 'puppetlabs-reboot', '4.0.2'
 mod 'puppetlabs-ruby_task_helper', '0.6.0'
 mod 'puppetlabs-ruby_plugin_helper', '0.2.0'
-mod 'puppetlabs-stdlib', '7.0.1'
+mod 'puppetlabs-stdlib', '7.1.0'
 
 # Plugin modules
 mod 'puppetlabs-aws_inventory', '0.7.0'
 mod 'puppetlabs-azure_inventory', '0.5.0'
 mod 'puppetlabs-gcloud_inventory', '0.3.0'
 mod 'puppetlabs-http_request', '0.2.2'
-mod 'puppetlabs-pkcs7', '0.1.1'
+mod 'puppetlabs-pkcs7', '0.1.2'
 mod 'puppetlabs-secure_env_vars', '0.2.0'
 mod 'puppetlabs-terraform', '0.6.1'
 mod 'puppetlabs-vault', '0.4.0'

data/bolt-modules/log/lib/puppet/functions/log/debug.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'bolt/util/format'
+
+# Log a debugging message.
+#
+# Messages logged at this level typically include detailed information about
+# what a plan is doing. For example, you might log a message at the `debug`
+# level that shows what value is returned from a function invocation.
+#
+# See [Logs](logs.md) for more information about Bolt's log levels.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:'log::debug') do
+  # Log a debugging message.
+  # @param message The message to log.
+  # @example Log a debugging message
+  #   log::debug("Function frogsay returned: ${result}")
+  dispatch :log_debug do
+    param 'Any', :message
+    return_type 'Undef'
+  end
+
+  def log_debug(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+        action: 'log::debug'
+      )
+    end
+
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :log, level: :debug, message: Bolt::Util::Format.stringify(message))
+    end
+
+    nil
+  end
+end

data/bolt-modules/log/lib/puppet/functions/log/error.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'bolt/util/format'
+
+# Log an error message.
+#
+# Messages logged at this level typically indicate that the plan encountered an
+# error that can be recovered from. For example, you might log a message at the
+# `error` level if you want to inform the user an action running on a target
+# failed but that the plan will continue running.
+#
+# See [Logs](logs.md) for more information about Bolt's log levels.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:'log::error') do
+  # Log an error message.
+  # @param message The message to log.
+  # @example Log an error message
+  #   log::error("The HTTP request returned an error, continuing the plan: ${result}")
+  dispatch :log_error do
+    param 'Any', :message
+    return_type 'Undef'
+  end
+
+  def log_error(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+        action: 'log::error'
+      )
+    end
+
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :log, level: :error, message: Bolt::Util::Format.stringify(message))
+    end
+
+    nil
+  end
+end

data/bolt-modules/log/lib/puppet/functions/log/fatal.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'bolt/util/format'
+
+# Log a fatal message.
+#
+# Messages logged at this level indicate that the plan encountered an error that
+# could not be recovered from. For example, you might log a message at the
+# `fatal` level if a service is unavailable and the plan cannot continue running
+# without it.
+#
+# See [Logs](logs.md) for more information about Bolt's log levels.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:'log::fatal') do
+  # Log a fatal message.
+  # @param message The message to log.
+  # @example Log a fatal message
+  #   log::fatal("The service is unavailable, unable to continue running: ${result}")
+  dispatch :log_fatal do
+    param 'Any', :message
+    return_type 'Undef'
+  end
+
+  def log_fatal(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+        action: 'log::fatal'
+      )
+    end
+
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :log, level: :fatal, message: Bolt::Util::Format.stringify(message))
+    end
+
+    nil
+  end
+end

data/bolt-modules/log/lib/puppet/functions/log/info.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'bolt/util/format'
+
+# Log an info message.
+#
+# Messages logged at this level typically include high-level information about
+# what a plan is doing. For example, you might log a message at the `info` level
+# that informs users that the plan is reading a file on disk.
+#
+# See [Logs](logs.md) for more information about Bolt's log levels.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:'log::info') do
+  # Log an info message.
+  # @param message The message to log.
+  # @example Log an info message
+  #   log::info("Reading network device command file ${file}.")
+  dispatch :log_info do
+    param 'Any', :message
+    return_type 'Undef'
+  end
+
+  def log_info(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+        action: 'log::info'
+      )
+    end
+
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :log, level: :info, message: Bolt::Util::Format.stringify(message))
+    end
+
+    nil
+  end
+end

data/bolt-modules/log/lib/puppet/functions/log/trace.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'bolt/util/format'
+
+# Log a trace message.
+#
+# Messages logged at this level typically include the most detailed information
+# about what a plan is doing. For example, you might log a message at the `trace`
+# level that describes how a plan is manipulating data.
+#
+# See [Logs](logs.md) for more information about Bolt's log levels.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:'log::trace') do
+  # Log a trace message.
+  # @param message The message to log.
+  # @example Log a trace message
+  #   log::trace("Creating Target object with data ${data} from file ${file}")
+  dispatch :log_trace do
+    param 'Any', :message
+    return_type 'Undef'
+  end
+
+  def log_trace(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+        action: 'log::trace'
+      )
+    end
+
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :log, level: :trace, message: Bolt::Util::Format.stringify(message))
+    end
+
+    nil
+  end
+end

data/bolt-modules/log/lib/puppet/functions/log/warn.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'bolt/util/format'
+
+# Log a warning message.
+#
+# Messages logged at this level typically include messages about deprecated
+# behavior or potentially harmful situations that might affect the plan run.
+# For example, you might log a message at the `warn` level if you are
+# planning to make a breaking change to your plan in a future release and
+# want to notify users.
+#
+# See [Logs](logs.md) for more information about Bolt's log levels.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:'log::warn') do
+  # Log a warning message.
+  # @param message The message to log.
+  # @example Log a warning message
+  #   log::warn('This plan will no longer install the package in a future release.')
+  dispatch :log_warn do
+    param 'Any', :message
+    return_type 'Undef'
+  end
+
+  def log_warn(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+        action: 'log::warn'
+      )
+    end
+
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :log, level: :warn, message: Bolt::Util::Format.stringify(message))
+    end
+
+    nil
+  end
+end

data/bolt-modules/out/lib/puppet/functions/out/message.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bolt/util/format'
+
 # Output a message for the user.
 #
 # This will print a message to stdout when using the human output format,
@@ -22,55 +24,11 @@ Puppet::Functions.create_function(:'out::message') do
         .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'out::message')
     end
 
-    executor = Puppet.lookup(:bolt_executor)
-    # Send Analytics Report
-    executor.report_function_call(self.class.name)
-
-    executor.publish_event(type: :message, message: stringify(message))
-
-    nil
-  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
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :message, message: Bolt::Util::Format.stringify(message))
     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
+    nil
   end
 end

data/bolt-modules/out/lib/puppet/functions/out/verbose.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bolt/util/format'
+
+# Output a message for the user when running in verbose mode.
+#
+# This will print a message to stdout when using the human output format,
+# and print to stderr when using the json output format.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:'out::verbose') do
+  # @param message The message to output.
+  # @example Print a message
+  #   out::verbose('Something went wrong')
+  dispatch :output_verbose do
+    param 'Any', :message
+    return_type 'Undef'
+  end
+
+  def output_verbose(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue
+        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'out::verbose')
+    end
+
+    Puppet.lookup(:bolt_executor).tap do |executor|
+      executor.report_function_call(self.class.name)
+      executor.publish_event(type: :verbose, message: Bolt::Util::Format.stringify(message))
+    end
+
+    nil
+  end
+end

data/guides/debugging.txt

@@ -0,0 +1,28 @@
+TOPIC
+    debugging
+
+DESCRIPTION
+    When Bolt isn't behaving as expected, there are a few helpful commands and
+    logs that can help identify common issues. The first place to look is in
+    `<PROJECT>/bolt-debug.log`, which contains debug-level logs from the last Bolt
+    run. This log file includes where the Bolt project was loaded from, the
+    location of any configuration or inventory files that were loaded, and the
+    modulepath that modules were loaded from.
+
+    If you're having issues with loading targets or target configuration, you
+    can see the list of resolved Bolt target names by running `bolt inventory
+    show` on *nix systems or `Get-BoltInventory` in PowerShell. To see the
+    resolved configuration for each target, run the command with the `--detail` or
+    `-Detail` options.
+
+    Lastly, if you're having trouble loading Bolt content you can use `bolt
+    module show` on *nix systems or `Get-BoltModule` in PowerShell to see the list
+    of loaded modules, including where they were loaded from. You can also use
+    `bolt task show` or `Get-BoltTask` to list loaded tasks, and `bolt plan show`
+    or `Get-BoltPlan` to list loaded plans.
+
+    Visit the linked documentation for more in-depth troubleshooting help for
+    specific issues.
+
+DOCUMENTATION
+    https://pup.pt/bolt-troubleshooting

data/lib/bolt/applicator.rb

@@ -122,7 +122,13 @@ module Bolt
         logs.each do |log|
           bolt_level = Bolt::Util::PuppetLogLevel::MAPPING[log['level'].to_sym]
           message = log['message'].chomp
-          @logger.send(bolt_level, "#{target.name}: #{message}")
+
+          case bolt_level
+          when :warn
+            handle_warning(target, message)
+          else
+            @logger.send(bolt_level, "#{target.name}: #{message}")
+          end
         end
       end
 
@@ -138,6 +144,22 @@ module Bolt
       result
     end
 
+    # Handles logging Puppet warnings, some of which are suppressable.
+    #
+    # @param target [Bolt::Target] The target the apply ran on.
+    # @param message [String] The log message.
+    #
+    private def handle_warning(target, message)
+      # Messages about exported resource declaration and collection, which are
+      # not supported in manifest blocks.
+      if message.include?(Puppet::Pops::Issues::RT_NO_STORECONFIGS_EXPORT.format) ||
+         message.include?(Puppet::Pops::Issues::RT_NO_STORECONFIGS.format)
+        Bolt::Logger.warn('exported_resources', "#{target.name}: #{message}")
+      else
+        @logger.send(:warn, "#{target.name}: #{message}")
+      end
+    end
+
     def validate_hiera_config(hiera_config)
       if File.exist?(File.path(hiera_config))
         data = File.open(File.path(hiera_config), "r:UTF-8") { |f| YAML.safe_load(f.read, [Symbol]) }