Vendor API connection code from Docker SDK for Python (#398)

* Vendor parts of the Docker SDK for Python This is a combination of the latest git version (https://github.com/docker/docker-py/tree/a48a5a9647761406d66e8271f19fab7fa0c5f582) and the version before Python 2.7 support was removed (https://github.com/docker/docker-py/tree/650aad3a5fb84059b392ad450f760ed08143ae3f), including some modifications to work with Ansible module_utils's system (i.e. third-party imports are guarded, and errors are reported during runtime through a new exception MissingRequirementException). * Create module_utils and plugin_utils for working with the vendored code. The delete call cannot be called delete() since that method already exists from requests. * Vendor more code from Docker SDK for Python. * Adjust code from common module_utils. * Add unit tests from Docker SDK for Python. * Make test compile with Python 2.6, but skip them on Python 2.6. * Skip test that requires a network server. * Add changelog. * Update changelogs/fragments/398-docker-api.yml Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com> * Minimum API version is 1.25. Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
2026-07-29 03:46:55 +00:00 · 2022-07-02 16:40:44 +02:00
parent 21d112bddb
commit 4d508b4c37
51 changed files with 9422 additions and 1 deletions
@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+# This code is part of the Ansible collection community.docker, but is an independent component.
+# This particular file, and this file only, is based on the Docker SDK for Python (https://github.com/docker/docker-py/)
+#
+# Copyright (c) 2016-2022 Docker, Inc.
+#
+# It is licensed under the Apache 2.0 license (see Apache-2.0.txt in this collection)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import traceback
+
+from ansible.module_utils.six import PY2
+
+
+REQUESTS_IMPORT_ERROR = None
+URLLIB3_IMPORT_ERROR = None
+BACKPORTS_SSL_MATCH_HOSTNAME_IMPORT_ERROR = None
+
+
+try:
+    from requests import Session
+    from requests.adapters import HTTPAdapter
+    from requests.exceptions import HTTPError, InvalidSchema
+except ImportError:
+    REQUESTS_IMPORT_ERROR = traceback.format_exc()
+
+    class Session(object):
+        __attrs__ = []
+
+    class HTTPAdapter(object):
+        __attrs__ = []
+
+    class HTTPError(Exception):
+        pass
+
+    class InvalidSchema(Exception):
+        pass
+
+
+try:
+    from requests.packages import urllib3
+except ImportError:
+    try:
+        import urllib3
+    except ImportError:
+        URLLIB3_IMPORT_ERROR = traceback.format_exc()
+
+        class _HTTPConnectionPool(object):
+            pass
+
+        class FakeURLLIB3(object):
+            def __init__(self):
+                self._collections = self
+                self.poolmanager = self
+                self.connection = self
+                self.connectionpool = self
+
+                self.RecentlyUsedContainer = object()
+                self.PoolManager = object()
+                self.match_hostname = object()
+                self.HTTPConnectionPool = _HTTPConnectionPool
+
+        urllib3 = FakeURLLIB3()
+
+
+# Monkey-patching match_hostname with a version that supports
+# IP-address checking. Not necessary for Python 3.5 and above
+if PY2:
+    try:
+        from backports.ssl_match_hostname import match_hostname
+        urllib3.connection.match_hostname = match_hostname
+    except ImportError:
+        BACKPORTS_SSL_MATCH_HOSTNAME_IMPORT_ERROR = traceback.format_exc()
+
+
+def fail_on_missing_imports():
+    if REQUESTS_IMPORT_ERROR is not None:
+        from .errors import MissingRequirementException
+
+        raise MissingRequirementException(
+            'You have to install requests',
+            'requests', REQUESTS_IMPORT_ERROR)
+    if URLLIB3_IMPORT_ERROR is not None:
+        from .errors import MissingRequirementException
+
+        raise MissingRequirementException(
+            'You have to install urllib3',
+            'urllib3', URLLIB3_IMPORT_ERROR)
+    if BACKPORTS_SSL_MATCH_HOSTNAME_IMPORT_ERROR is not None:
+        from .errors import MissingRequirementException
+
+        raise MissingRequirementException(
+            'You have to install backports.ssl-match-hostname',
+            'backports.ssl-match-hostname', BACKPORTS_SSL_MATCH_HOSTNAME_IMPORT_ERROR)