Sha256: b42398d62d0816e4c4952fd8f4696c0dc8e59c9115082f2eecec5eca1bc92e6b

Contents?: true

Size: 862 Bytes

Versions: 5

Compression:

Stored size: 862 Bytes

Contents

# frozen_string_literal: true

# Output a message for the user.
#
# This will print a message to stdout when using the human output format.
#
# **NOTE:** Not available in apply block
Puppet::Functions.create_function(:'out::message') do
  # Output a message.
  # @param message The message to output.
  # @example Print a message
  #   out::message('Something went wrong')
  dispatch :output_message do
    param 'String', :message
    return_type 'Undef'
  end

  def output_message(message)
    unless Puppet[:tasks]
      raise Puppet::ParseErrorWithIssue
        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'out::message')
    end

    executor = Puppet.lookup(:bolt_executor)
    executor.report_function_call(self.class.name)
    executor.publish_event(type: :message, message: message)

    nil
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
bolt-1.26.0 bolt-modules/out/lib/puppet/functions/out/message.rb
bolt-1.25.0 bolt-modules/out/lib/puppet/functions/out/message.rb
bolt-1.24.0 bolt-modules/out/lib/puppet/functions/out/message.rb
bolt-1.23.0 bolt-modules/out/lib/puppet/functions/out/message.rb
bolt-1.22.0 bolt-modules/out/lib/puppet/functions/out/message.rb