PKbrLNpytest_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.8' __all__ = [ 'build', 'container', 'fetch', 'network', 'volume', ] PK*rLWHpytest_docker_tools/builder.pyimport textwrap from .templates import find_fixtures_in_params, resolve_fixtures_in_params def build_fixture_function(callable, scope, 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''' import pytest @pytest.fixture(scope=scope) 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, 'scope': scope, } exec(template, globals) return globals[name] def fixture_factory(scope='function'): def inner(callable): def factory(*, scope=scope, **kwargs): return build_fixture_function(callable, scope, kwargs) factory.__name__ = callable.__name__ factory.__doc__ = getattr(callable, '__doc__', '') return factory return inner PKnL]%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' not in item.funcargs: return for name, fixturedef in item.funcargs['request']._fixture_defs.items(): if not hasattr(fixturedef, 'cached_result'): continue fixture = fixturedef.cached_result[0] if isinstance(fixture, Container): rep.sections.append(( name + ': ' + fixture.name, fixture.logs(), )) PKnLs~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) PKnL`͵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') PKnL./pytest_docker_tools/contexts/scratch/Dockerfile# For volume seeding we want a near-empty volune, You can't 'docker create scratch' # and you can have an iamge with just `FROM scratch`. FROM scratch CMD ["/bin/sh"] PKnL)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', ] PKnLk H&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}" ''' # The docker build command now defaults to --rm=true, but docker-py doesnt # Let's do what docker build does by default kwargs.setdefault('rm', True) 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 PKnL_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 PKnLRS&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 PKnLtgd(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 PKnLw'pytest_docker_tools/factories/volume.pyimport io import os import tarfile import uuid from pytest_docker_tools.builder import fixture_factory def _populate_volume(docker_client, volume, seeds): fp = io.BytesIO() tf = tarfile.open(mode="w:gz", fileobj=fp) for path, contents in seeds.items(): ti = tarfile.TarInfo(path) if contents is None: ti.type = tarfile.DIRTYPE tf.addfile(ti) else: ti.size = len(contents) tf.addfile(ti, io.BytesIO(contents)) tf.close() fp.seek(0) image, logs = docker_client.images.build( path=os.path.join(os.path.dirname(__file__), '..', 'contexts/scratch'), rm=True, ) list(logs) container = docker_client.containers.create( image=image.id, volumes={ f'{volume.name}': {'bind': '/data'}, }, ) try: container.put_archive('/data', fp) finally: container.remove(force=True) @fixture_factory() def volume(request, docker_client, **kwargs): ''' Docker volume ''' name = kwargs.pop('name', 'pytest-{uuid}').format(uuid=str(uuid.uuid4())) seeds = kwargs.pop('initial_content', {}) print(f'Creating volume {name}') volume = docker_client.volumes.create(name, **kwargs) request.addfinalizer(lambda: volume.remove(True)) if seeds: _populate_volume(docker_client, volume, seeds) return volume PKnL'kBB(pytest_docker_tools/wrappers/__init__.pyfrom .container import Container __all__ = [ 'Container', ] PKnL ~)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(): files[info.name] = None continue reader = archive.extractfile(info.name) files[info.name] = reader.read() return files def get_text(self, path): text = {} for path, bytes in self.get_files(path): if bytes is None: text[path] = None continue text[path] = bytes.decode('utf-8') 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.8.dist-info/entry_points.txt.,I-.14JON-/)#䔦gqqPK!HNO)pytest_docker_tools-0.0.8.dist-info/WHEEL HM K-*ϳR03rOK-J,/RH,zd&Y)r$[)T&UrPK!H8/R,pytest_docker_tools-0.0.8.dist-info/METADATA\isG_Qbla71挮: .m5}(}_fVUW u3Y)&]GVV/4:֍>TuR$:<ՙ9U1u3ٕMQ7;{mj}sUx4IK4WR'y/M%ycnE,IUɛZf#~3O^7mehCR/@۲ip4_g'WB| 4?Nf&鿞鳟fYT2WuU'&Iz~hnh$LW<_=gwoL=spr]bƼnXd\(iEVkuǖ> *ˈ}uhj,D>B;*+轷^\󲬊kz4E1oV2i%xF}px~ AfǨI8I|*4QvmKѪ6jU% xݴ,d&3J*_Բfb%]IIexJ1JPuV\IH[E"-ѥma-ЩR3NrU蚚%M@}gC)$ȩB]`UdI+tYS&UMI7&h@)X6Eg:MjYIUU1QkVjU9 2KèqMj>-Teذd"fSeӔŤyM /ubM[lBZ#n Th<kp&{ޑN2%1mu.&׆ɼ2V;63-F6*M0VÚlZݰ J\ц n*/9͏K.ETs$1X3-4Tպ¡]l3N, =#1 0vD34-V5"mhG+D0fƜf~¤͓Ek7"`efUS3 t{  fFz$X\eWEFI[={m&WX4$bqik`[vכl/W&뱘3i1(+u<ZՇnCtxг$QE?zh~B?y'T OMoij]&ˏY:(7/ac`:$ѽfVEn,\8{%eUB2l_dpOD FS?9#eGëGee0\!?0-`vGB)7>d#>fǼ6 ֢"l5 #;/VkfKVz cEVjJH+`O^h;XgW{9¦,FϊNuUnusB k<"-+9RIqct/S e D;i ^=EB3jlMݍwY(vGD_d-Gx~4TϮ\>z9<֧"$:'D`< [v2XK+uIn7oAMM; F1 b^Ku?^[tASm4aauN/ "G6B3lm1Af_%w|m o]:GɡN].t/ĴX\hW|Kd2cH<&Hfr<H;OZ!"ob:h\< 2L8HĄpl㣐ޡ~V/.\ƥA%QV4AWR<Hyԁfyo9-(!{4!I@ ;pyՅ`Xdy ^blعg'aUAB iXUL\#Jʱ(J89aޖ,&I'&0qlfAv¿>?1o q^n}eȊD١ZӹنK9`%բy-9֓ah/"3gEikg;vc!%luo:cyt)<9564b8qM]jJ 1eD1pG]^.Hd^[ lAtRj}:4R[8t_V:#ي;;"paHݩitOS '|C%rr|)=#6%} ЀɸC: t^uRr+j^ tx)%_Jw]Z]0PB(>%'3|% $ Wjs*p1qKBJ˞\=F/eݡ%z1GF@9 ;7/p~lKXf(d䖳Ѷ\lֶH&nɞ-m ~!78 lIZN~]>F=6l|XuAȻi[sHe6o=#N6v*upQSz,sLsL{I>'UNcA RҊan)~ _RXtFRӭ-v=N7(hOsXr5\8ZL SHjK[q/ LbQ;6go‰*(C-GIfjQr dl= Y#׉9 )bY[\,ۣc.!\{M7]9 .'׀p='vXEa:2?7[y}vTXGDY0UdV{\===M f9^jm]hw}b4EeQYFlxNBdCdSDt;zt÷~@?It{/C++#/.t֜rȅ8g[U!qҸq*!Nxbo%o|pcU/U*iyt:AwZ.8_TUn&zTjvsj9i-vmcW}nFCdoXmZJOVƟA$:[LD|vӟfXJƳ"뷟wۄߎUbH9@.YnC=t+w5|ۦS|V9R?+C{|'B(_/d x)ѣz?cx?9_؆v FK ]ۼ$g_29)Hf,JQ7cbbZ,Ff>sS-uY;~Jo:.d؟Ԥ78 y6Rt[So17 CB@,`!+"ԽPKvyP߰N;N*~LC\|]m")$^30EDyܕǑlżOfƝ[epB+Ũl s+f~y}=S'*aYUNSGAd!"jW'XiP9hU&Ε0L@gNi~4As"3+a.ڍ}iZQЇjB`X,̆14bEM쇸2X^;B43w~fgj'`Wt $/.[*Ա=;)RNǑ`3&8R_U ׾;R=f]#W7v r?b cy:IڒùJFmJyR^A˕WOuyɂ[DP 槩| HDR:!ASu1O7T* ӌ>\'brЄ9ş:iP؞Dy:]ȃ,uy^fUvD˿?t+&i3f'j-NC3]=g`\2|ߢ U*ܿN \S0 s)K4-~LM9#8pzv-fU_5@+'tP, )EBَK8 ,YRȞ3氻<ufk5݅V-ďPKbrLNpytest_docker_tools/__init__.pyPK*rLWH[pytest_docker_tools/builder.pyPKnL]%\pytest_docker_tools/plugin.pyPKnLs~33 ; pytest_docker_tools/templates.pyPKnL`͵pytest_docker_tools/utils.pyPKnL./pytest_docker_tools/contexts/scratch/DockerfilePKnL)pytest_docker_tools/factories/__init__.pyPKnLk H&pytest_docker_tools/factories/build.pyPKnL_pס* pytest_docker_tools/factories/container.pyPKnLRS&#pytest_docker_tools/factories/fetch.pyPKnLtgd(%pytest_docker_tools/factories/network.pyPKnLw''pytest_docker_tools/factories/volume.pyPKnL'kBB(S-pytest_docker_tools/wrappers/__init__.pyPKnL ~)-pytest_docker_tools/wrappers/container.pyPK!HG^(44Cpytest_docker_tools-0.0.8.dist-info/entry_points.txtPK!HNO)^Dpytest_docker_tools-0.0.8.dist-info/WHEELPK!H8/R,Dpytest_docker_tools-0.0.8.dist-info/METADATAPK!HsBou*l\pytest_docker_tools-0.0.8.dist-info/RECORDPK#`