From 72d23659513517389880ba13663a1d6380d538ca Mon Sep 17 00:00:00 2001
From: tphoney <tp@puppet.com>
Date: Tue, 5 Jul 2016 09:56:42 +0100
Subject: (MODULES-3529)add deprecation function
---
lib/puppet/functions/deprecation.rb | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
create mode 100644 lib/puppet/functions/deprecation.rb
(limited to 'lib')
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
--
cgit v1.2.3