summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDavid Schmitt <david.schmitt@puppet.com>2016-07-18 13:27:49 +0100
committerGitHub <noreply@github.com>2016-07-18 13:27:49 +0100
commit01bc41e73621fa07d0b14b3b3fa8a75e666a7df5 (patch)
tree82a2087cd945247dfadee41dcd8f8cd5bec84ab6 /lib
parent9224143da2195c57ce814e837f722348c2038ecb (diff)
parent72d23659513517389880ba13663a1d6380d538ca (diff)
Merge pull request #617 from tphoney/add_deprecate_function
(MODULES-3529) add deprecation function
Diffstat (limited to 'lib')
-rw-r--r--lib/puppet/functions/deprecation.rb21
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/puppet/functions/deprecation.rb b/lib/puppet/functions/deprecation.rb
new file mode 100644
index 0000000..3b84ae5
--- /dev/null
+++ b/lib/puppet/functions/deprecation.rb
@@ -0,0 +1,21 @@
+# 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)
+ # depending on configuration setting of strict
+ case Puppet.settings[:strict]
+ when :off
+ # do nothing
+ when :error
+ fail("deprecation. #{key}. #{message}")
+ else
+ Puppet.warn_once('deprecation', key, message)
+ end
+ end
+end