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 11:55:04 +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,56 @@
+# -*- 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 unittest
+import sys
+
+import pytest
+
+if sys.version_info < (2, 7):
+    pytestmark = pytest.mark.skip('Python 2.6 is not supported')
+
+from ansible_collections.community.docker.plugins.module_utils._api.transport.sshconn import SSHSocket, SSHHTTPAdapter
+
+
+class SSHAdapterTest(unittest.TestCase):
+    @staticmethod
+    def test_ssh_hostname_prefix_trim():
+        conn = SSHHTTPAdapter(
+            base_url="ssh://user@hostname:1234", shell_out=True)
+        assert conn.ssh_host == "user@hostname:1234"
+
+    @staticmethod
+    def test_ssh_parse_url():
+        c = SSHSocket(host="user@hostname:1234")
+        assert c.host == "hostname"
+        assert c.port == "1234"
+        assert c.user == "user"
+
+    @staticmethod
+    def test_ssh_parse_hostname_only():
+        c = SSHSocket(host="hostname")
+        assert c.host == "hostname"
+        assert c.port is None
+        assert c.user is None
+
+    @staticmethod
+    def test_ssh_parse_user_and_hostname():
+        c = SSHSocket(host="user@hostname")
+        assert c.host == "hostname"
+        assert c.port is None
+        assert c.user == "user"
+
+    @staticmethod
+    def test_ssh_parse_hostname_and_port():
+        c = SSHSocket(host="hostname:22")
+        assert c.host == "hostname"
+        assert c.port == "22"
+        assert c.user is None
@@ -0,0 +1,95 @@
+# -*- 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 unittest
+import sys
+
+import pytest
+
+if sys.version_info < (2, 7):
+    pytestmark = pytest.mark.skip('Python 2.6 is not supported')
+
+from ansible_collections.community.docker.plugins.module_utils._api.transport import ssladapter
+
+try:
+    from backports.ssl_match_hostname import (
+        match_hostname, CertificateError
+    )
+except ImportError:
+    from ssl import (
+        match_hostname, CertificateError
+    )
+
+try:
+    from ssl import OP_NO_SSLv3, OP_NO_SSLv2, OP_NO_TLSv1
+except ImportError:
+    OP_NO_SSLv2 = 0x1000000
+    OP_NO_SSLv3 = 0x2000000
+    OP_NO_TLSv1 = 0x4000000
+
+
+class SSLAdapterTest(unittest.TestCase):
+    def test_only_uses_tls(self):
+        ssl_context = ssladapter.urllib3.util.ssl_.create_urllib3_context()
+
+        assert ssl_context.options & OP_NO_SSLv3
+        # if OpenSSL is compiled without SSL2 support, OP_NO_SSLv2 will be 0
+        assert not bool(OP_NO_SSLv2) or ssl_context.options & OP_NO_SSLv2
+        assert not ssl_context.options & OP_NO_TLSv1
+
+
+class MatchHostnameTest(unittest.TestCase):
+    cert = {
+        'issuer': (
+            (('countryName', 'US'),),
+            (('stateOrProvinceName', 'California'),),
+            (('localityName', 'San Francisco'),),
+            (('organizationName', 'Docker Inc'),),
+            (('organizationalUnitName', 'Docker-Python'),),
+            (('commonName', 'localhost'),),
+            (('emailAddress', 'info@docker.com'),)
+        ),
+        'notAfter': 'Mar 25 23:08:23 2030 GMT',
+        'notBefore': 'Mar 25 23:08:23 2016 GMT',
+        'serialNumber': 'BD5F894C839C548F',
+        'subject': (
+            (('countryName', 'US'),),
+            (('stateOrProvinceName', 'California'),),
+            (('localityName', 'San Francisco'),),
+            (('organizationName', 'Docker Inc'),),
+            (('organizationalUnitName', 'Docker-Python'),),
+            (('commonName', 'localhost'),),
+            (('emailAddress', 'info@docker.com'),)
+        ),
+        'subjectAltName': (
+            ('DNS', 'localhost'),
+            ('DNS', '*.gensokyo.jp'),
+            ('IP Address', '127.0.0.1'),
+        ),
+        'version': 3
+    }
+
+    def test_match_ip_address_success(self):
+        assert match_hostname(self.cert, '127.0.0.1') is None
+
+    def test_match_localhost_success(self):
+        assert match_hostname(self.cert, 'localhost') is None
+
+    def test_match_dns_success(self):
+        assert match_hostname(self.cert, 'touhou.gensokyo.jp') is None
+
+    def test_match_ip_address_failure(self):
+        with pytest.raises(CertificateError):
+            match_hostname(self.cert, '192.168.0.25')
+
+    def test_match_dns_failure(self):
+        with pytest.raises(CertificateError):
+            match_hostname(self.cert, 'foobar.co.uk')