From 8efc42d9933ceff17f637fcb9bcbee5f070607db Mon Sep 17 00:00:00 2001 From: Alejandro Guirao Date: Mon, 13 Jul 2015 10:31:35 +0200 Subject: [PATCH 1/3] Add shelvefile lookup plugin --- lib/ansible/plugins/lookup/shelvefile.py | 81 ++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 lib/ansible/plugins/lookup/shelvefile.py diff --git a/lib/ansible/plugins/lookup/shelvefile.py b/lib/ansible/plugins/lookup/shelvefile.py new file mode 100644 index 00000000000..5d27222c829 --- /dev/null +++ b/lib/ansible/plugins/lookup/shelvefile.py @@ -0,0 +1,81 @@ +# (c) 2015, Alejandro Guirao +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . + +import shelve +import os +from ansible import utils, errors + +class LookupModule(object): + + def __init__(self, basedir=None, **kwargs): + self.basedir = basedir + + def read_shelve(self, shelve_filename, key): + """ + Read the value of "key" from a shelve file + """ + d = shelve.open(shelve_filename) + res = d.get(key, None) + d.close() + return res + + def run(self, terms, inject=None, **kwargs): + + terms = utils.listify_lookup_plugin_terms(terms, self.basedir, inject) + ret = [] + + if not isinstance(terms, list): + terms = [ terms ] + + for term in terms: + playbook_path = None + relative_path = None + paramvals = {"file": None, "key": None} + params = term.split() + + try: + for param in params: + name, value = param.split('=') + assert(name in paramvals) + paramvals[name] = value + + except (ValueError, AssertionError), e: + # In case "file" or "key" are not present + raise errors.AnsibleError(e) + + file = paramvals['file'] + key = paramvals['key'] + basedir_path = utils.path_dwim(self.basedir, file) + + # Search also in the role/files directory and in the playbook directory + if '_original_file' in inject: + relative_path = utils.path_dwim_relative(inject['_original_file'], 'files', file, self.basedir, check=False) + if 'playbook_dir' in inject: + playbook_path = os.path.join(inject['playbook_dir'], file) + + for path in (basedir_path, relative_path, playbook_path): + if path and os.path.exists(path): + res = self.read_shelve(path, key) + if res is None: + raise errors.AnsibleError("Key %s not found in shelve file %s" % (key, file)) + # Convert the value read to string + ret.append(str(res)) + break + else: + raise errors.AnsibleError("Could not locate shelve file in lookup: %s" % file) + + return ret From 6e99023c84e20d1de97187597e40e610705adf77 Mon Sep 17 00:00:00 2001 From: Alejandro Guirao Date: Mon, 13 Jul 2015 15:37:27 +0200 Subject: [PATCH 2/3] Changed to support Ansible v2 --- lib/ansible/plugins/lookup/shelvefile.py | 32 +++++++++++++----------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/lib/ansible/plugins/lookup/shelvefile.py b/lib/ansible/plugins/lookup/shelvefile.py index 5d27222c829..1e02cd30ec0 100644 --- a/lib/ansible/plugins/lookup/shelvefile.py +++ b/lib/ansible/plugins/lookup/shelvefile.py @@ -14,12 +14,16 @@ # # You should have received a copy of the GNU General Public License # along with Ansible. If not, see . +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type import shelve import os -from ansible import utils, errors -class LookupModule(object): +from ansible.errors import AnsibleError +from ansible.plugins.lookup import LookupBase + +class LookupModule(LookupBase): def __init__(self, basedir=None, **kwargs): self.basedir = basedir @@ -33,17 +37,17 @@ class LookupModule(object): d.close() return res - def run(self, terms, inject=None, **kwargs): - - terms = utils.listify_lookup_plugin_terms(terms, self.basedir, inject) - ret = [] + def run(self, terms, variables=None, **kwargs): if not isinstance(terms, list): terms = [ terms ] + ret = [] + for term in terms: playbook_path = None relative_path = None + paramvals = {"file": None, "key": None} params = term.split() @@ -55,27 +59,27 @@ class LookupModule(object): except (ValueError, AssertionError), e: # In case "file" or "key" are not present - raise errors.AnsibleError(e) + raise AnsibleError(e) file = paramvals['file'] key = paramvals['key'] - basedir_path = utils.path_dwim(self.basedir, file) + basedir_path = self._loader.path_dwim(file) # Search also in the role/files directory and in the playbook directory - if '_original_file' in inject: - relative_path = utils.path_dwim_relative(inject['_original_file'], 'files', file, self.basedir, check=False) - if 'playbook_dir' in inject: - playbook_path = os.path.join(inject['playbook_dir'], file) + if 'role_path' in variables: + relative_path = self._loader.path_dwim_relative(variables['role_path'], 'files', file) + if 'playbook_dir' in variables: + playbook_path = self._loader.path_dwim_relative(variables['playbook_dir'],'files', file) for path in (basedir_path, relative_path, playbook_path): if path and os.path.exists(path): res = self.read_shelve(path, key) if res is None: - raise errors.AnsibleError("Key %s not found in shelve file %s" % (key, file)) + raise AnsibleError("Key %s not found in shelve file %s" % (key, file)) # Convert the value read to string ret.append(str(res)) break else: - raise errors.AnsibleError("Could not locate shelve file in lookup: %s" % file) + raise AnsibleError("Could not locate shelve file in lookup: %s" % file) return ret From 587a6cb44c3b5412061ec1764e43539b2dd7b0c4 Mon Sep 17 00:00:00 2001 From: Alejandro Guirao Date: Mon, 13 Jul 2015 15:48:23 +0200 Subject: [PATCH 3/3] Remove v1 code --- lib/ansible/plugins/lookup/shelvefile.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/ansible/plugins/lookup/shelvefile.py b/lib/ansible/plugins/lookup/shelvefile.py index 1e02cd30ec0..89e393694b3 100644 --- a/lib/ansible/plugins/lookup/shelvefile.py +++ b/lib/ansible/plugins/lookup/shelvefile.py @@ -25,8 +25,6 @@ from ansible.plugins.lookup import LookupBase class LookupModule(LookupBase): - def __init__(self, basedir=None, **kwargs): - self.basedir = basedir def read_shelve(self, shelve_filename, key): """