PK;xL?cpytest_docker_tools/__init__.py''' An opionated set of helpers for defining Docker integration test environments with py.test fixtures. ''' from .factories import build, container, fetch, network, volume __version__ = '0.0.5' __all__ = [ 'build', 'container', 'fetch', 'network', 'volume', ] PKlL&pytest_docker_tools/builder.pyimport textwrap import pytest from .templates import find_fixtures_in_params, resolve_fixtures_in_params def build_fixture_function(callable, kwargs): name = callable.__name__ docstring = getattr(callable, '__doc__', '').format(**kwargs) fixtures = find_fixtures_in_params(kwargs).union(set(('request', 'docker_client'))) fixtures_str = ','.join(fixtures) template = textwrap.dedent(f''' def {name}({fixtures_str}): \'\'\' {docstring} \'\'\' real_kwargs = resolve_fixtures_in_params(request, kwargs) return _{name}(request, docker_client, **real_kwargs) ''') globals = { 'resolve_fixtures_in_params': resolve_fixtures_in_params, f'_{name}': callable, 'kwargs': kwargs, } exec(template, globals) return globals[name] def fixture_factory(scope='function'): def inner(callable): def factory(*, scope='function', **kwargs): fixture_factory = build_fixture_function(callable, kwargs) pytest.fixture(scope=scope)(fixture_factory) return fixture_factory factory.__name__ = callable.__name__ factory.__doc__ = getattr(callable, '__doc__', '') return factory return inner PKwlL)\\pytest_docker_tools/plugin.pyimport docker import pytest from .wrappers import Container @pytest.fixture(scope='session') def docker_client(request): ''' A Docker client configured from environment variables ''' return docker.from_env() @pytest.hookimpl(tryfirst=True, hookwrapper=True) def pytest_runtest_makereport(item, call): ''' This hook allows Docker containers to contribute their logs to the py.test report. ''' outcome = yield rep = outcome.get_result() if not rep.failed: return if 'request' in item.funcargs: for name, fixturedef in item.funcargs['request']._fixture_defs.items(): fixture = fixturedef.cached_result[0] if isinstance(fixture, Container): rep.sections.append(( name + ': ' + fixture.name, fixture.logs(), )) else: for name, fixture in item.funcargs.items(): if isinstance(fixture, Container): rep.sections.append(( name + ': ' + fixture.name, fixture.logs(), )) PKZLs~33 pytest_docker_tools/templates.py''' # Template handling Fixture factories can take static strings: ```python redis = container( image='redis:latest', ) ``` But that is not useful when building multiple containers that need to reference one another or you need to parameterize the fixture. This module provides two facilities: The ability to reference fixtures using python string template notation and the ability to know what fixtures this will fetch in at test collection (and generation) time. For example: ``` def test_simple_resolve(request): # These are parameters declared at import time - they can be reevaluated in the context of multiple tests kwargs = { 'somekey': ['{pytestconfig.getoption("verbose")}'], } # This can be used in a fixture factory to fill in the templates resolved = resolve_fixtures_in_params(request, kwargs) # And then the test can access them pytestconfig = request.getfixturevalue('pytestconfig') assert resolved['somekey'][0] == str(pytestconfig.getoption("verbose")) } ``` In order to make fixtures generated by a fixture factory more seamless we need to know a fixtures dependencies at collection time. We have a helper to find them: def test_simple_find(): # These are parameters declared at import time - they can be reevaluated in the context of multiple tests kwargs = { 'somekey': ['{pytestconfig.getoption("verbose")}'], } dependencies = find_fixtures_in_params(kwargs) assert dependencies = set('pytestconfig') ''' import inspect from string import Formatter __all__ = [ 'find_fixtures_in_params', 'resolve_fixtures_in_params', ] class FixtureFormatter(Formatter): def __init__(self, request): self.request = request def get_value(self, key, args, kwargs): return self.request.getfixturevalue(key) class Renderer(object): def __init__(self, request): self.request = request def visit_value(self, val): if isinstance(val, str): return FixtureFormatter(self.request).format(val) elif callable(val): return val(*[self.request.getfixturevalue(f) for f in inspect.getargspec(val)[0]]) return val def visit_list(self, val): return [self.visit(v) for v in val] def visit_dict(self, mapping): return {self.visit(k): self.visit(v) for (k, v) in mapping.items()} def visit(self, value): if isinstance(value, dict): return self.visit_dict(value) elif isinstance(value, list): return self.visit_list(value) elif value: return self.visit_value(value) class FixtureFinder(object): def visit_value(self, val): if isinstance(val, str): for literal_text, format_spec, conversion, _ in Formatter().parse(val): if format_spec: yield format_spec.split('.')[0].split('[')[0] elif callable(val): yield from inspect.getargspec(val)[0] def visit_list(self, val): for v in val: yield from self.visit(v) def visit_dict(self, mapping): for k, v in mapping.items(): yield from self.visit(k) yield from self.visit(v) def visit(self, value): if isinstance(value, dict): yield from self.visit_dict(value) elif isinstance(value, list): yield from self.visit_list(value) elif value: yield from self.visit_value(value) def find_fixtures_in_params(value): ''' Walk an object and identify fixtures references in templates in strings. ''' finder = FixtureFinder() return set(finder.visit(value)) def resolve_fixtures_in_params(request, value): ''' Walk an object and resolve fixture values referenced in template strings. ''' renderer = Renderer(request) return renderer.visit(value) PK(LL`͵pytest_docker_tools/utils.pyimport sys import time def wait_for_callable(message, callable, timeout=30): ''' Runs a callable once a second until it returns True or we hit the timeout. ''' sys.stdout.write(message) try: for i in range(timeout): sys.stdout.write('.') sys.stdout.flush() if callable(): return time.sleep(1) finally: sys.stdout.write('\n') raise RuntimeError('Timeout exceeded') PK\L)pytest_docker_tools/factories/__init__.pyfrom .build import build from .container import container from .fetch import fetch from .network import network from .volume import volume __all__ = [ 'build', 'container', 'fetch', 'network', 'volume', ] PK nL""&pytest_docker_tools/factories/build.pyimport sys from pytest_docker_tools.builder import fixture_factory @fixture_factory(scope='session') def build(request, docker_client, **kwargs): ''' Docker image: built from "{path}" ''' sys.stdout.write(f'Building {kwargs["path"]}') try: image, logs = docker_client.images.build(**kwargs) for line in logs: sys.stdout.write('.') sys.stdout.flush() finally: sys.stdout.write('\n') # request.addfinalizer(lambda: docker_client.images.remove(image.id)) return image PKlL_pס*pytest_docker_tools/factories/container.pyfrom pytest_docker_tools.builder import fixture_factory from pytest_docker_tools.utils import wait_for_callable from pytest_docker_tools.wrappers import Container @fixture_factory() def container(request, docker_client, **kwargs): ''' Docker container: image={image} ''' kwargs.update({'detach': True}) raw_container = docker_client.containers.run(**kwargs) request.addfinalizer(lambda: raw_container.remove(force=True) and raw_container.wait(timeout=10)) container = Container(raw_container) wait_for_callable( f'Waiting for container to be ready', lambda: container.reload() or container.ready(), ) return container PK{tLRS&pytest_docker_tools/factories/fetch.pyimport sys from pytest_docker_tools.builder import fixture_factory @fixture_factory(scope='session') def fetch(request, docker_client, **kwargs): ''' Docker image: Fetched from {repository} ''' sys.stdout.write(f'Fetching {kwargs["repository"]}\n') image = docker_client.images.pull(**kwargs) # request.addfinalizer(lambda: docker_client.images.remove(image.id)) return image PKWoLtgd(pytest_docker_tools/factories/network.pyimport uuid from pytest_docker_tools.builder import fixture_factory @fixture_factory() def network(request, docker_client, **kwargs): ''' Docker network ''' name = kwargs.pop('name', 'pytest-{uuid}').format(uuid=str(uuid.uuid4())) print(f'Creating network {name}') network = docker_client.networks.create(name, **kwargs) request.addfinalizer(lambda: network.remove()) return network PKHoLBS'pytest_docker_tools/factories/volume.pyimport uuid from pytest_docker_tools.builder import fixture_factory @fixture_factory() def volume(request, docker_client, **kwargs): ''' Docker volume ''' name = kwargs.pop('name', 'pytest-{uuid}').format(uuid=str(uuid.uuid4())) print(f'Creating volume {name}') volume = docker_client.volumes.create(name, **kwargs) request.addfinalizer(lambda: volume.remove(True)) return volume PK(LL'kBB(pytest_docker_tools/wrappers/__init__.pyfrom .container import Container __all__ = [ 'Container', ] PKL*)pytest_docker_tools/wrappers/container.py''' This module contains a wrapper that adds some helpers to a Docker Container object that are useful for integration testing. ''' import io import tarfile class _Map(object): def __init__(self, container): self._container = container def values(self): return [self[k] for k in self.keys()] def items(self): return [(k, self[k]) for k in self.keys()] def __iter__(self): return iter(self.keys()) class IpMap(_Map): @property def primary(self): return next(iter(self.values())) def keys(self): return self._container.attrs['NetworkSettings']['Networks'].keys() def __getitem__(self, key): if not isinstance(key, str): key = key.name networks = self._container.attrs['NetworkSettings']['Networks'] if key not in networks: raise KeyError(f'Unknown network: {key}') return networks[key]['IPAddress'] class PortMap(_Map): def __init__(self, container): self._container = container def keys(self): return self._container.attrs['NetworkSettings']['Ports'].keys() def __getitem__(self, key): ports = self._container.attrs['NetworkSettings']['Ports'] if key not in ports: raise KeyError(f'Unknown port: {key}') if not ports[key]: return [] return [int(p['HostPort']) for p in ports[key]] class Container(object): def __init__(self, container): self._container = container self.ips = IpMap(container) self.ports = PortMap(container) def ready(self): if self.status == 'exited': raise RuntimeError(f'Container {self.name} has already exited before we noticed it was ready') if self.status != 'running': return False networks = self._container.attrs['NetworkSettings']['Networks'] for name, network in networks.items(): if not network['IPAddress']: return False # If a user has exposed a port then wait for LISTEN socket to show up in netstat ports = self._container.attrs['NetworkSettings']['Ports'] for port, listeners in ports.items(): if not listeners: continue port, proto = port.split('/') assert proto in ('tcp', 'udp') if proto == 'tcp' and port not in self.get_open_tcp_ports(): return False if proto == 'udp' and port not in self.get_open_udp_ports(): return False return True @property def attrs(self): return self._container.attrs @property def id(self): return self._container.id @property def name(self): return self._container.name @property def env(self): kv_pairs = map(lambda v: v.split('=', 1), self._container.attrs['Config']['Env']) return {k: v for k, v in kv_pairs} @property def status(self): return self._container.status def reload(self): return self._container.reload() def kill(self, signal=None): return self._container.kill(signal) def remove(self, *args, **kwargs): raise RuntimeError('Do not remove this container manually. It will be removed automatically by py.test after the test finishes.') def logs(self): return self._container.logs().decode('utf-8') def get_files(self, path): ''' Retrieve files from a container at a given path. This is meant for extracting log files from a container where it is not using the docker logging capabilities. ''' archive_iter, _ = self._container.get_archive(path) archive_stream = io.BytesIO() [archive_stream.write(chunk) for chunk in archive_iter] archive_stream.seek(0) archive = tarfile.TarFile(fileobj=archive_stream) files = {} for info in archive.getmembers(): if not info.isfile(): continue reader = archive.extractfile(info.name) files[info.name] = reader.read().decode('utf-8') return files def get_open_tcp_ports(self): ''' Gets all TCP sockets in the LISTEN state ''' netstat = self._container.exec_run('cat /proc/net/tcp')[1].decode('utf-8').strip() ports = [] for line in netstat.split('\n'): # Not interested in empty lines if not line: continue line = line.split() # Only interested in listen sockets if line[3] != '0A': continue ports.append(str(int(line[1].split(':', 1)[1], 16))) return ports def get_open_udp_ports(self): ''' Gets all UDP sockets in the LISTEN state ''' netstat = self._container.exec_run('cat /proc/net/udp')[1].decode('utf-8').strip() ports = [] for line in netstat.split('\n'): # Not interested in empty lines if not line: continue line = line.split() # Only interested in listen sockets if line[3] != '0A': continue ports.append(str(int(line[1].split(':', 1)[1], 16))) return ports PK!HG^(44pytest_docker_tools-0.0.5.dist-info/entry_points.txt.,I-.14JON-/)#䔦gqqPK!HNO)pytest_docker_tools-0.0.5.dist-info/WHEEL HM K-*ϳR03rOK-J,/RH,zd&Y)r$[)T&UrPK!H3N,pytest_docker_tools-0.0.5.dist-info/METADATA\oGE'ƁT dtX9[4Ɏ3 |}UCR~I6gə~TWj~gF0UmT$OʜrӘNٍAhv'_6|\n+u>NH#=Sf(ydY6pQ^]]w5p^{v3i1(Y #p@ح݆0zelsoĦяG~3?!8tο|ﮯχjx}5MK+% @gY@%lM-[sQ3+A"7Z\8{زN6|=|I ,ۗ8@)ƭH(qp&qԼhx% ˷g4fݲP ͡Ȱχ1L5äh|[bȎ!ƚ$js cEVjJDW("sMYY[|#jDDb$%әw$ьB9 ZYFw({?bÈBLM|;4}ݼI4F@3sp~ k/3tMS\\f*QVczVW uI"W_3t `?+3^"Urwt7یf Wtc.xD{0Hqz*eE._a[E~V,J3 qxuv#S$aC4d1y[!rnXVy95Pg~!z?;jrm2( STx4+؞ߺ,(</L;3(h0𞝩pd1 ,Z<6kn󵘺{E ^іuՁxp@G'+6vŐ OۆqsQ8N^0ruQzT`a[&jo 0*!d "#E@ 7"ˀ3&&<C.K}Z>j-mY0rO`nS/7'2@Fv!"Sr02uME:oاAfSF!Ttz<(8,`8! rpBR"p#ųg<$/Q.qHCbweP+wO.9JAA釅n  7Q`n|rǖ~I~%Ҥ;;.3يsL` e{"D {8%gW#`C.ڼ?a^tj,acgjQgAȦ8[69됯z*>v/>*{H!.슔6ʏS< %!Bgz fx ~} ؟p~]5SNPn*޹J&_36.\e3*I{seV\d׵$n_~:]t!&9ZQm+v:6!X.LW]% ^>VH^HGm|  ATᴻ@5s3 Ɗv4L`=uzɣ_Wܺ~%%h )VS[gݮJ W]s!t[7P9噄{D+E jc㹚S/T'k&SϦhk|\N_22T{($v p̌#.Eժh8m6Ēy9ߘi⎗߼cg+=pmd!!ޱ27B(>H_; fOy(3vFF@c.и*HeKM\;>ʋ|LMb8r  J@:pyOEK4嶖2ߨ+L;:?JXu.igl)e,@ҳgHUYB=t?86S|}N9QkC yz|'GBC/2jС]Kx?9濳 9c7I<خs(@"NJF JAd[n8Ze:n_jڃTz vw\tKQ5]* `~YϳR_f;` 92N#>=3WXjrf;#ӲKJ^- Gȹd}ԷTp˅~7 sU'kUo 8h.xݦ9QsVӷ,ɻާjߞV<}־K,H`t6"8 JQiħ?RTڙ[]_DPG %jq}O.H|4]OSk¯Uyo$6M\B/ZIl-: J·f=EM9tV;din 3?zjC"NryLd-J<76U)7΢Rm;WiQ#aҚƋQن<,A:}Qº|aXbzj%^cѕ]o]dfIQH]syǧ1I4NVGq8k槔@j,g/&  89= vgMR( q7^@e:~Na)]V2?#sդ5>ȓ [i&M~qZ5|lD ꄞ۶eϻ;6 ZE{D+mq)Q'5BEWBW_6soڒ%'j&φhpytest_docker_tools-0.0.5.dist-info/entry_points.txtPK!HNO)>pytest_docker_tools-0.0.5.dist-info/WHEELPK!H3N,G?pytest_docker_tools-0.0.5.dist-info/METADATAPK!H-*LUpytest_docker_tools-0.0.5.dist-info/RECORDPKX