From 68e3ff80a789472316abc85ee0a5a24d525650fc Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Tue, 17 Apr 2018 10:29:24 -0500 Subject: [PATCH] Error if docker and docker-py are simultaneously (#38884) * Error if docker and docker-py are simultaneously installed over top of each other. Fixes #36125 * Remove duplicate installed --- lib/ansible/module_utils/docker_common.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/lib/ansible/module_utils/docker_common.py b/lib/ansible/module_utils/docker_common.py index 76a07a22c01..eb00d28a0d7 100644 --- a/lib/ansible/module_utils/docker_common.py +++ b/lib/ansible/module_utils/docker_common.py @@ -56,6 +56,25 @@ except ImportError as exc: HAS_DOCKER_ERROR = str(exc) HAS_DOCKER_PY = False + +# The next 2 imports ``docker.models`` and ``docker.ssladapter`` are used +# to ensure the user does not have both ``docker`` and ``docker-py`` modules +# installed, as they utilize the same namespace are are incompatible +try: + # docker + import docker.models + HAS_DOCKER_MODELS = True +except ImportError: + HAS_DOCKER_MODELS = False + +try: + # docker-py + import docker.ssladapter + HAS_DOCKER_SSLADAPTER = True +except ImportError: + HAS_DOCKER_SSLADAPTER = False + + DEFAULT_DOCKER_HOST = 'unix://var/run/docker.sock' DEFAULT_TLS = False DEFAULT_TLS_VERIFY = False @@ -144,6 +163,10 @@ class AnsibleDockerClient(Client): required_together=required_together_params, required_if=required_if) + if HAS_DOCKER_MODELS and HAS_DOCKER_SSLADAPTER: + self.fail("Cannot have both the docker-py and docker python modules installed together as they use the same namespace and " + "cause a corrupt installation. Please uninstall both packages, and re-install only the docker-py or docker python module") + if not HAS_DOCKER_PY: self.fail("Failed to import docker-py - %s. Try `pip install docker-py`" % HAS_DOCKER_ERROR)