Add convenience function for plugin namespace

Plugins can use get_plugin_config() which will search in a plugin
namespace. For example:

[plugin "hipchat"]
authtoken = 123token

- Updated hipchat plugin to use get_plugin_config()
- Updated stash plugin to use get_plugin_config()
- Backwards compatibility is kept by falling back to the old
  configuration setting if the new one is not found.
- Warning is displayed if the old configuration method is used.

Change-Id: I7cff063e2d179a5d9a3f221c85de6864382bc477
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

1 files changed, 15 insertions, 0 deletions

diff --git a/jenkins_jobs/config.py b/jenkins_jobs/config.py
index a22c48af..19d13b82 100644
--- a/jenkins_jobs/config.py
+++ b/jenkins_jobs/config.py
@@ -310,3 +310,18 @@ class JJBConfig(object):
                            " the " + section + " section, blank default" +
                            " value will be applied:\n{0}".format(e))
         return result
+
+    def get_plugin_config(self, plugin, key):
+        value = self.get_module_config('plugin "{}"'.format(plugin), key)
+
+        # Backwards compatibility for users who have not switched to the new
+        # plugin configuration format in their config. This code should be
+        # removed in future versions of JJB after 2.0.
+        if not value:
+            value = self.get_module_config(plugin, key)
+            logger.warning(
+                "Defining plugin configuration using [" + plugin + "] is"
+                " deprecated. The recommended way to define plugins now is by"
+                " configuring [plugin \"" + plugin + "\"]")
+
+        return value