diff options
Diffstat (limited to 'code/environments/production/modules/stdlib/lib/puppet/functions/deprecation.rb')
-rw-r--r-- | code/environments/production/modules/stdlib/lib/puppet/functions/deprecation.rb | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/code/environments/production/modules/stdlib/lib/puppet/functions/deprecation.rb b/code/environments/production/modules/stdlib/lib/puppet/functions/deprecation.rb new file mode 100644 index 0000000..af6109d --- /dev/null +++ b/code/environments/production/modules/stdlib/lib/puppet/functions/deprecation.rb @@ -0,0 +1,32 @@ +# Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. +# The msg is the message text including any positional information that is formatted by the user/caller of the method. +# It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), +# :off (no message / error is displayed) and :warning (default, outputs a warning) *Type*: String, String. +# + +Puppet::Functions.create_function(:deprecation) do + dispatch :deprecation do + param 'String', :key + param 'String', :message + end + + def deprecation(key, message) + if defined? Puppet::Pops::PuppetStack.stacktrace + stacktrace = Puppet::Pops::PuppetStack.stacktrace() + file = stacktrace[0] + line = stacktrace[1] + message = "#{message} at #{file}:#{line}" + end + # depending on configuration setting of strict + case Puppet.settings[:strict] + when :off # rubocop:disable Lint/EmptyWhen : Is required to prevent false errors + # do nothing + when :error + raise("deprecation. #{key}. #{message}") + else + unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false' + Puppet.deprecation_warning(message, key) + end + end + end +end |