diff --git a/lib/ansible/plugins/cache/__init__.py b/lib/ansible/plugins/cache/__init__.py
index 2a129e922a0..c288da0a565 100644
--- a/lib/ansible/plugins/cache/__init__.py
+++ b/lib/ansible/plugins/cache/__init__.py
@@ -17,11 +17,17 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
+import os
+import time
+import errno
+from abc import ABCMeta, abstractmethod
from collections import MutableMapping
from ansible import constants as C
+from ansible.compat.six import with_metaclass
from ansible.errors import AnsibleError
from ansible.plugins import cache_loader
+from ansible.module_utils._text import to_bytes
try:
from __main__ import display
@@ -30,6 +36,207 @@ except ImportError:
display = Display()
+
+class BaseCacheModule(with_metaclass(ABCMeta, object)):
+
+ # Backwards compat only. Just import the global display instead
+ _display = display
+
+ @abstractmethod
+ def get(self, key):
+ pass
+
+ @abstractmethod
+ def set(self, key, value):
+ pass
+
+ @abstractmethod
+ def keys(self):
+ pass
+
+ @abstractmethod
+ def contains(self, key):
+ pass
+
+ @abstractmethod
+ def delete(self, key):
+ pass
+
+ @abstractmethod
+ def flush(self):
+ pass
+
+ @abstractmethod
+ def copy(self):
+ pass
+
+
+class BaseFileCacheModule(BaseCacheModule):
+ """
+ A caching module backed by file based storage.
+ """
+ def __init__(self, *args, **kwargs):
+
+ self.plugin_name = self.__module__.split('.')[-1]
+ self._timeout = float(C.CACHE_PLUGIN_TIMEOUT)
+ self._cache = {}
+ self._cache_dir = None
+
+ if C.CACHE_PLUGIN_CONNECTION:
+ # expects a dir path
+ self._cache_dir = os.path.expanduser(os.path.expandvars(C.CACHE_PLUGIN_CONNECTION))
+
+ if not self._cache_dir:
+ raise AnsibleError("error, '%s' cache plugin requires the 'fact_caching_connection' config option"
+ " to be set (to a writeable directory path)" % self.plugin_name)
+
+ if not os.path.exists(self._cache_dir):
+ try:
+ os.makedirs(self._cache_dir)
+ except (OSError,IOError) as e:
+ raise AnsibleError("error in '%s' cache plugin while trying to create cache dir %s : %s" % (self.plugin_name, self._cache_dir, to_bytes(e)))
+ else:
+ for x in (os.R_OK, os.W_OK, os.X_OK):
+ if not os.access(self._cache_dir, x):
+ raise AnsibleError("error in '%s' cache, configured path (%s) does not have necessary permissions (rwx), disabling plugin" % (
+ self.plugin_name, self._cache_dir))
+
+ def get(self, key):
+ """ This checks the in memory cache first as the fact was not expired at 'gather time'
+ and it would be problematic if the key did expire after some long running tasks and
+ user gets 'undefined' error in the same play """
+
+ if key in self._cache:
+ return self._cache.get(key)
+
+ if self.has_expired(key) or key == "":
+ raise KeyError
+
+ cachefile = "%s/%s" % (self._cache_dir, key)
+ try:
+ try:
+ value = self._load(cachefile)
+ self._cache[key] = value
+ return value
+ except ValueError as e:
+ display.warning("error in '%s' cache plugin while trying to read %s : %s."
+ " Most likely a corrupt file, so erasing and failing." % (self.plugin_name, cachefile, to_bytes(e)))
+ self.delete(key)
+ raise AnsibleError("The cache file %s was corrupt, or did not otherwise contain valid data."
+ " It has been removed, so you can re-run your command now." % cachefile)
+ except (OSError,IOError) as e:
+ display.warning("error in '%s' cache plugin while trying to read %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
+ raise KeyError
+ except Exception as e:
+ raise AnsibleError("Error while decoding the cache file %s: %s" % (cachefile, to_bytes(e)))
+
+ def set(self, key, value):
+
+ self._cache[key] = value
+
+ cachefile = "%s/%s" % (self._cache_dir, key)
+ try:
+ self._dump(value, cachefile)
+ except (OSError,IOError) as e:
+ display.warning("error in '%s' cache plugin while trying to write to %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
+
+ def has_expired(self, key):
+
+ if self._timeout == 0:
+ return False
+
+ cachefile = "%s/%s" % (self._cache_dir, key)
+ try:
+ st = os.stat(cachefile)
+ except (OSError,IOError) as e:
+ if e.errno == errno.ENOENT:
+ return False
+ else:
+ display.warning("error in '%s' cache plugin while trying to stat %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
+ return False
+
+ if time.time() - st.st_mtime <= self._timeout:
+ return False
+
+ if key in self._cache:
+ del self._cache[key]
+ return True
+
+ def keys(self):
+ keys = []
+ for k in os.listdir(self._cache_dir):
+ if not (k.startswith('.') or self.has_expired(k)):
+ keys.append(k)
+ return keys
+
+ def contains(self, key):
+ cachefile = "%s/%s" % (self._cache_dir, key)
+
+ if key in self._cache:
+ return True
+
+ if self.has_expired(key):
+ return False
+ try:
+ os.stat(cachefile)
+ return True
+ except (OSError,IOError) as e:
+ if e.errno == errno.ENOENT:
+ return False
+ else:
+ display.warning("error in '%s' cache plugin while trying to stat %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
+ pass
+
+ def delete(self, key):
+ try:
+ del self._cache[key]
+ except KeyError:
+ pass
+ try:
+ os.remove("%s/%s" % (self._cache_dir, key))
+ except (OSError, IOError):
+ pass #TODO: only pass on non existing?
+
+ def flush(self):
+ self._cache = {}
+ for key in self.keys():
+ self.delete(key)
+
+ def copy(self):
+ ret = dict()
+ for key in self.keys():
+ ret[key] = self.get(key)
+ return ret
+
+ @abstractmethod
+ def _load(self, filepath):
+ """
+ Read data from a filepath and return it as a value
+
+ :arg filepath: The filepath to read from.
+ :returns: The value stored in the filepath
+
+ This method reads from the file on disk and takes care of any parsing
+ and transformation of the data before returning it. The value
+ returned should be what Ansible would expect if it were uncached data.
+
+ .. note:: Filehandles have advantages but calling code doesn't know
+ whether this file is text or binary, should be decoded, or accessed via
+ a library function. Therefore the API uses a filepath and opens
+ the file inside of the method.
+ """
+ pass
+
+ @abstractmethod
+ def _dump(self, value, filepath):
+ """
+ Write data to a filepath
+
+ :arg value: The value to store
+ :arg filepath: The filepath to store it at
+ """
+ pass
+
class FactCache(MutableMapping):
def __init__(self, *args, **kwargs):
diff --git a/lib/ansible/plugins/cache/base.py b/lib/ansible/plugins/cache/base.py
index 79be3d9d942..6c2901f737a 100644
--- a/lib/ansible/plugins/cache/base.py
+++ b/lib/ansible/plugins/cache/base.py
@@ -1,4 +1,4 @@
-# (c) 2014, Brian Coca, Josh Drake, et al
+# (c) 2017, ansible by Red Hat
#
# This file is part of Ansible
#
@@ -14,222 +14,9 @@
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
-
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
-import os
-import time
-import errno
-from abc import ABCMeta, abstractmethod
+# moved actual classes to __init__ kept here for backward compat with 3rd parties
+from ansible.plugins.cache import BaseCacheModule, BaseFileCacheModule
-from ansible import constants as C
-from ansible.compat.six import with_metaclass
-from ansible.errors import AnsibleError
-from ansible.module_utils._text import to_bytes
-
-try:
- from __main__ import display
-except ImportError:
- from ansible.utils.display import Display
- display = Display()
-
-class BaseCacheModule(with_metaclass(ABCMeta, object)):
-
- # Backwards compat only. Just import the global display instead
- _display = display
-
- @abstractmethod
- def get(self, key):
- pass
-
- @abstractmethod
- def set(self, key, value):
- pass
-
- @abstractmethod
- def keys(self):
- pass
-
- @abstractmethod
- def contains(self, key):
- pass
-
- @abstractmethod
- def delete(self, key):
- pass
-
- @abstractmethod
- def flush(self):
- pass
-
- @abstractmethod
- def copy(self):
- pass
-
-
-class BaseFileCacheModule(BaseCacheModule):
- """
- A caching module backed by file based storage.
- """
- def __init__(self, *args, **kwargs):
-
- self.plugin_name = self.__module__.split('.')[-1]
- self._timeout = float(C.CACHE_PLUGIN_TIMEOUT)
- self._cache = {}
- self._cache_dir = None
-
- if C.CACHE_PLUGIN_CONNECTION:
- # expects a dir path
- self._cache_dir = os.path.expanduser(os.path.expandvars(C.CACHE_PLUGIN_CONNECTION))
-
- if not self._cache_dir:
- raise AnsibleError("error, '%s' cache plugin requires the 'fact_caching_connection' config option"
- " to be set (to a writeable directory path)" % self.plugin_name)
-
- if not os.path.exists(self._cache_dir):
- try:
- os.makedirs(self._cache_dir)
- except (OSError,IOError) as e:
- raise AnsibleError("error in '%s' cache plugin while trying to create cache dir %s : %s" % (self.plugin_name, self._cache_dir, to_bytes(e)))
- else:
- for x in (os.R_OK, os.W_OK, os.X_OK):
- if not os.access(self._cache_dir, x):
- raise AnsibleError("error in '%s' cache, configured path (%s) does not have necessary permissions (rwx), disabling plugin" % (
- self.plugin_name, self._cache_dir))
-
- def get(self, key):
- """ This checks the in memory cache first as the fact was not expired at 'gather time'
- and it would be problematic if the key did expire after some long running tasks and
- user gets 'undefined' error in the same play """
-
- if key in self._cache:
- return self._cache.get(key)
-
- if self.has_expired(key) or key == "":
- raise KeyError
-
- cachefile = "%s/%s" % (self._cache_dir, key)
- try:
- try:
- value = self._load(cachefile)
- self._cache[key] = value
- return value
- except ValueError as e:
- display.warning("error in '%s' cache plugin while trying to read %s : %s."
- " Most likely a corrupt file, so erasing and failing." % (self.plugin_name, cachefile, to_bytes(e)))
- self.delete(key)
- raise AnsibleError("The cache file %s was corrupt, or did not otherwise contain valid data."
- " It has been removed, so you can re-run your command now." % cachefile)
- except (OSError,IOError) as e:
- display.warning("error in '%s' cache plugin while trying to read %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
- raise KeyError
- except Exception as e:
- raise AnsibleError("Error while decoding the cache file %s: %s" % (cachefile, to_bytes(e)))
-
- def set(self, key, value):
-
- self._cache[key] = value
-
- cachefile = "%s/%s" % (self._cache_dir, key)
- try:
- self._dump(value, cachefile)
- except (OSError,IOError) as e:
- display.warning("error in '%s' cache plugin while trying to write to %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
-
- def has_expired(self, key):
-
- if self._timeout == 0:
- return False
-
- cachefile = "%s/%s" % (self._cache_dir, key)
- try:
- st = os.stat(cachefile)
- except (OSError,IOError) as e:
- if e.errno == errno.ENOENT:
- return False
- else:
- display.warning("error in '%s' cache plugin while trying to stat %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
- return False
-
- if time.time() - st.st_mtime <= self._timeout:
- return False
-
- if key in self._cache:
- del self._cache[key]
- return True
-
- def keys(self):
- keys = []
- for k in os.listdir(self._cache_dir):
- if not (k.startswith('.') or self.has_expired(k)):
- keys.append(k)
- return keys
-
- def contains(self, key):
- cachefile = "%s/%s" % (self._cache_dir, key)
-
- if key in self._cache:
- return True
-
- if self.has_expired(key):
- return False
- try:
- os.stat(cachefile)
- return True
- except (OSError,IOError) as e:
- if e.errno == errno.ENOENT:
- return False
- else:
- display.warning("error in '%s' cache plugin while trying to stat %s : %s" % (self.plugin_name, cachefile, to_bytes(e)))
- pass
-
- def delete(self, key):
- try:
- del self._cache[key]
- except KeyError:
- pass
- try:
- os.remove("%s/%s" % (self._cache_dir, key))
- except (OSError, IOError):
- pass #TODO: only pass on non existing?
-
- def flush(self):
- self._cache = {}
- for key in self.keys():
- self.delete(key)
-
- def copy(self):
- ret = dict()
- for key in self.keys():
- ret[key] = self.get(key)
- return ret
-
- @abstractmethod
- def _load(self, filepath):
- """
- Read data from a filepath and return it as a value
-
- :arg filepath: The filepath to read from.
- :returns: The value stored in the filepath
-
- This method reads from the file on disk and takes care of any parsing
- and transformation of the data before returning it. The value
- returned should be what Ansible would expect if it were uncached data.
-
- .. note:: Filehandles have advantages but calling code doesn't know
- whether this file is text or binary, should be decoded, or accessed via
- a library function. Therefore the API uses a filepath and opens
- the file inside of the method.
- """
- pass
-
- @abstractmethod
- def _dump(self, value, filepath):
- """
- Write data to a filepath
-
- :arg value: The value to store
- :arg filepath: The filepath to store it at
- """
- pass
diff --git a/lib/ansible/plugins/cache/jsonfile.py b/lib/ansible/plugins/cache/jsonfile.py
index eb8c2afbd3b..a82d7e9470a 100644
--- a/lib/ansible/plugins/cache/jsonfile.py
+++ b/lib/ansible/plugins/cache/jsonfile.py
@@ -27,7 +27,7 @@ except ImportError:
import json
from ansible.parsing.utils.jsonify import jsonify
-from ansible.plugins.cache.base import BaseFileCacheModule
+from ansible.plugins.cache import BaseFileCacheModule
class CacheModule(BaseFileCacheModule):
"""
diff --git a/lib/ansible/plugins/cache/memcached.py b/lib/ansible/plugins/cache/memcached.py
index 210d462d419..9d2bb0a86df 100644
--- a/lib/ansible/plugins/cache/memcached.py
+++ b/lib/ansible/plugins/cache/memcached.py
@@ -25,7 +25,7 @@ from itertools import chain
from ansible import constants as C
from ansible.errors import AnsibleError
-from ansible.plugins.cache.base import BaseCacheModule
+from ansible.plugins.cache import BaseCacheModule
try:
import memcache
diff --git a/lib/ansible/plugins/cache/memory.py b/lib/ansible/plugins/cache/memory.py
index 417ef20e0ed..ad58a974839 100644
--- a/lib/ansible/plugins/cache/memory.py
+++ b/lib/ansible/plugins/cache/memory.py
@@ -17,7 +17,7 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
-from ansible.plugins.cache.base import BaseCacheModule
+from ansible.plugins.cache import BaseCacheModule
class CacheModule(BaseCacheModule):
diff --git a/lib/ansible/plugins/cache/pickle.py b/lib/ansible/plugins/cache/pickle.py
index bea44248ea7..a8018ee1961 100644
--- a/lib/ansible/plugins/cache/pickle.py
+++ b/lib/ansible/plugins/cache/pickle.py
@@ -24,7 +24,7 @@ try:
except ImportError:
import pickle
-from ansible.plugins.cache.base import BaseFileCacheModule
+from ansible.plugins.cache import BaseFileCacheModule
class CacheModule(BaseFileCacheModule):
"""
diff --git a/lib/ansible/plugins/cache/redis.py b/lib/ansible/plugins/cache/redis.py
index facd44bf257..99ae07170d6 100644
--- a/lib/ansible/plugins/cache/redis.py
+++ b/lib/ansible/plugins/cache/redis.py
@@ -23,7 +23,7 @@ import json
from ansible import constants as C
from ansible.errors import AnsibleError
-from ansible.plugins.cache.base import BaseCacheModule
+from ansible.plugins.cache import BaseCacheModule
try:
from redis import StrictRedis
diff --git a/lib/ansible/plugins/cache/yaml.py b/lib/ansible/plugins/cache/yaml.py
index a00eb8482d8..e02a652b882 100644
--- a/lib/ansible/plugins/cache/yaml.py
+++ b/lib/ansible/plugins/cache/yaml.py
@@ -26,7 +26,7 @@ import yaml
from ansible.parsing.yaml.loader import AnsibleLoader
from ansible.parsing.yaml.dumper import AnsibleDumper
-from ansible.plugins.cache.base import BaseFileCacheModule
+from ansible.plugins.cache import BaseFileCacheModule
class CacheModule(BaseFileCacheModule):
"""