mirror of
https://github.com/ansible-collections/community.docker.git
synced 2025-12-16 11:58:43 +00:00
4d508b4c37
* Vendor parts of the Docker SDK for Python This is a combination of the latest git version (a48a5a9647) and the version before Python 2.7 support was removed (650aad3a5f), 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>
123 lines
4.3 KiB
Python
123 lines
4.3 KiB
Python
# -*- 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 socket
|
|
|
|
from ansible.module_utils.six import PY2
|
|
from ansible.module_utils.six.moves import http_client as httplib
|
|
|
|
from .basehttpadapter import BaseHTTPAdapter
|
|
from .. import constants
|
|
|
|
from .._import_helper import HTTPAdapter, urllib3
|
|
|
|
|
|
RecentlyUsedContainer = urllib3._collections.RecentlyUsedContainer
|
|
|
|
|
|
class UnixHTTPResponse(httplib.HTTPResponse, object):
|
|
def __init__(self, sock, *args, **kwargs):
|
|
disable_buffering = kwargs.pop('disable_buffering', False)
|
|
if PY2:
|
|
# FIXME: We may need to disable buffering on Py3 as well,
|
|
# but there's no clear way to do it at the moment. See:
|
|
# https://github.com/docker/docker-py/issues/1799
|
|
kwargs['buffering'] = not disable_buffering
|
|
super(UnixHTTPResponse, self).__init__(sock, *args, **kwargs)
|
|
|
|
|
|
class UnixHTTPConnection(httplib.HTTPConnection, object):
|
|
|
|
def __init__(self, base_url, unix_socket, timeout=60):
|
|
super(UnixHTTPConnection, self).__init__(
|
|
'localhost', timeout=timeout
|
|
)
|
|
self.base_url = base_url
|
|
self.unix_socket = unix_socket
|
|
self.timeout = timeout
|
|
self.disable_buffering = False
|
|
|
|
def connect(self):
|
|
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
|
sock.settimeout(self.timeout)
|
|
sock.connect(self.unix_socket)
|
|
self.sock = sock
|
|
|
|
def putheader(self, header, *values):
|
|
super(UnixHTTPConnection, self).putheader(header, *values)
|
|
if header == 'Connection' and 'Upgrade' in values:
|
|
self.disable_buffering = True
|
|
|
|
def response_class(self, sock, *args, **kwargs):
|
|
if self.disable_buffering:
|
|
kwargs['disable_buffering'] = True
|
|
|
|
return UnixHTTPResponse(sock, *args, **kwargs)
|
|
|
|
|
|
class UnixHTTPConnectionPool(urllib3.connectionpool.HTTPConnectionPool):
|
|
def __init__(self, base_url, socket_path, timeout=60, maxsize=10):
|
|
super(UnixHTTPConnectionPool, self).__init__(
|
|
'localhost', timeout=timeout, maxsize=maxsize
|
|
)
|
|
self.base_url = base_url
|
|
self.socket_path = socket_path
|
|
self.timeout = timeout
|
|
|
|
def _new_conn(self):
|
|
return UnixHTTPConnection(
|
|
self.base_url, self.socket_path, self.timeout
|
|
)
|
|
|
|
|
|
class UnixHTTPAdapter(BaseHTTPAdapter):
|
|
|
|
__attrs__ = HTTPAdapter.__attrs__ + ['pools',
|
|
'socket_path',
|
|
'timeout',
|
|
'max_pool_size']
|
|
|
|
def __init__(self, socket_url, timeout=60,
|
|
pool_connections=constants.DEFAULT_NUM_POOLS,
|
|
max_pool_size=constants.DEFAULT_MAX_POOL_SIZE):
|
|
socket_path = socket_url.replace('http+unix://', '')
|
|
if not socket_path.startswith('/'):
|
|
socket_path = '/' + socket_path
|
|
self.socket_path = socket_path
|
|
self.timeout = timeout
|
|
self.max_pool_size = max_pool_size
|
|
self.pools = RecentlyUsedContainer(
|
|
pool_connections, dispose_func=lambda p: p.close()
|
|
)
|
|
super(UnixHTTPAdapter, self).__init__()
|
|
|
|
def get_connection(self, url, proxies=None):
|
|
with self.pools.lock:
|
|
pool = self.pools.get(url)
|
|
if pool:
|
|
return pool
|
|
|
|
pool = UnixHTTPConnectionPool(
|
|
url, self.socket_path, self.timeout,
|
|
maxsize=self.max_pool_size
|
|
)
|
|
self.pools[url] = pool
|
|
|
|
return pool
|
|
|
|
def request_url(self, request, proxies):
|
|
# The select_proxy utility in requests errors out when the provided URL
|
|
# doesn't have a hostname, like is the case when using a UNIX socket.
|
|
# Since proxies are an irrelevant notion in the case of UNIX sockets
|
|
# anyway, we simply return the path URL directly.
|
|
# See also: https://github.com/docker/docker-py/issues/811
|
|
return request.path_url
|