PKBzJҰ dockerctx.py""" A context manager for a docker container. """ from __future__ import division, print_function import socket from contextlib import contextmanager import uuid import logging import time import typing import docker __version__ = '2017.3.7' __all__ = ['new_container'] logger = logging.getLogger('dockerctx') @contextmanager def new_container( image_name, new_container_name=lambda: uuid.uuid4().hex, ports=None, ready_test=None, docker_api_version='auto', **kwargs): """Start a docker container, and kill+remove when done. :param new_container_name: The container name. By default, a UUID will be used. If a callable, the result must be a str. :type new_container_name: str | callable :param ports: The list of port mappings to configure on the docker container. The format is the same as that used in the `docker` package, e.g. `ports={'5432/tcp': 60011}` :type ports: typing.Dict[str, int] :param ready_test: A function to run to verify whether the container is "ready" (in some sense) before yielding the container back to the caller. An example of such a test is the `accepting_connections` function in the this module, which will try repeatedly to connect to a socket, until either successfuly, or a max timeout is reached. Use functools.partial to wrap up the args. :type ready_test: typing.Callable[[], bool] :param kwargs: These extra keyword arguments will be passed through to the `client.containers.run()` call. One of the more commons ones is to pass a custom command through. """ _ = new_container_name name = str(_() if callable(_) else _) client = docker.from_env(version=docker_api_version) logger.info('New postgres container: %s', name) container = client.containers.run(image_name, name=name, detach=True, ports=ports, **kwargs) try: logger.info('Waiting for postgres to be ready') if ready_test and not ready_test(): raise ConnectionError( 'Container {} not ready fast enough.'.format(name) ) yield container finally: logger.info('Stopping container %s', name) # TODO: container.stop() does not seem to work here (e.g. for postgres) container.kill() logger.info('Removing container %s', name) container.remove() def accepting_connections(host, port, timeout=20): """Try to make a socket connection to `(host, port)` I'll try every 200 ms, and eventually give up after `timeout`. :type host: str :type port: int :type timeout: int :return: True for successful connection, False otherwise :rtype: bool """ t0 = time.time() while time.time() - t0 < timeout: try: # s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s = socket.create_connection((host, port)) logger.debug('Connected!') s.close() return True except socket.error as ex: logger.debug("Connection failed with errno %s: %s", ex.errno, ex.strerror) time.sleep(0.2) return False def pg_ready(host, port, dbuser='postgres', dbname='postgres', timeout=20, poll_freq=0.2): """Wait until a postgres instance is ready to receive connections. .. note:: This requires psycopg2 to be installed. :type host: str :type port: int :type timeout: float :type poll_freq: float """ import psycopg2 t0 = time.time() while time.time() - t0 < timeout: try: conn = psycopg2.connect( "host={host} port={port} user={dbuser} " "dbname={dbname}".format(**vars()) ) logger.debug('Connected successfully.') conn.close() return True except psycopg2.OperationalError as ex: logger.debug("Connection failed: {0}".format(ex)); time.sleep(poll_freq) logger.error('Postgres readiness check timed out.') return False @contextmanager def session_scope(session_cls): """Provide a transactional scope around a series of operations. .. note:: This requires SQLAlchemy to be installed. :type: sqlalchemy.orm.Session """ session = session_cls() try: logger.debug('Yielding session') yield session logger.debug('Committing session') session.commit() except: logger.exception('Error detected, rolling back session') session.rollback() raise finally: logger.debug('Closing session') session.close() def get_open_port(): """Return a currently-unused local network TCP port number This is extremely handy when running unit tests because you may not always be able to get the port of your choice, especially in a continuous-integration context. :return: TCP port number :rtype: int """ s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s.bind(('', 0)) # Using zero means the OS assigns one address_info = s.getsockname() port = int(address_info[1]) s.close() return port PK!H|&Ub"dockerctx-2017.3.7.dist-info/WHEEL HM K-*ϳR03rOK-J,/RH,Q034 /, (-JLR()*M ILR(4KM̫#DPK!H# %dockerctx-2017.3.7.dist-info/METADATAVQo6~ׯ+d6芩3РE`I%Pb#*IEݑl'yÐǻ}(GR^'oK` !߼z.9NE]Nr>8h+4PjbThNuG-P9t>_IWuYf3|\,~?/UڤQԘpNU5N!Ť?X֣V`\I}_lUA:']!Q~'Z=ݯFh΅ZutbVH{79uzapHʱ\fFvʅ.mt;i}m ~,u떂y߻/'o(ڢG(!%BPAGh0ud:ΠB];W#dFJ(8ta %B^kt"X}Yfy\Uz#RJgAIb풎$|$AaX>mV(:S։-șU=?B+[oة3Nem ׍a2'6N厊0zK(>4 ;1t\<3[h c`n9%@cNPݬ*yg &}РP&Qn?›X,ew~Ld6~& u Y>iA<{0O~SxTO3SQq +>XV9ӈgc(2읔%^g^27" l\i]C:wDaGhԁID]V9eM>cLʟ36|Icg m2i Iq 륍妬69 ,B HG|'&DDͯSnI6"[ڱԚĥ֤g5=&YmTX@բR; Rg)|^ Jg6yh$F-hryZبXx zD2@=>r둻#4xukp͠(Fki>(zȷ>L`Em0yWFZtLj](egK6c'&] `<:Y/ԫ7v4|a[7z1^|ڲRHWqk9} PK!H1"#dockerctx-2017.3.7.dist-info/RECORD}KR0}HӒH0))vLӻbwzU?, t}0|#D֊Kpzsܴ*d 6jM,q6jGPk=[Q!̊Hjb6݊Oa|}19wq"q1ThEZNG$R*5<׃.ft 6PKBzJҰ dockerctx.pyPK!H|&Ub"dockerctx-2017.3.7.dist-info/WHEELPK!H# %odockerctx-2017.3.7.dist-info/METADATAPK!H1"#Odockerctx-2017.3.7.dist-info/RECORDPK.Z