Source code for labgrid.resource.docker

Auxiliary classes that assist DockerDriver. Specifically, DockerDaemon
and DockerManager will create the NetworkResource instance that is declared
in the specification (e.g. yaml) of DockerDriver.

import logging
import socket

import attr

from labgrid.util.dict import find_dict
from ..factory import target_factory
from .common import ManagedResource, ResourceManager

[docs]class DockerConstants: """Class constants for handling container cleanup""" DOCKER_LG_CLEANUP_LABEL = "lg_cleanup" # Currently only a single cleanup routine is implemented which removes # all labgrid created containers on each test run. In the future more # sophisticated mechanisms could be implemented by adding # more cleanup types. DOCKER_LG_CLEANUP_TYPE_AUTO = "auto"
[docs]@attr.s(eq=False) class DockerManager(ResourceManager): """The DockerManager is responsible for cleaning up dangling containers and managing the managed NetworkService resources. Different docker daemons for different targets are allowed, but there has to be only one for each target. """
[docs] def __attrs_post_init__(self): super().__attrs_post_init__() self.log = logging.getLogger('DockerManager') self._client = dict() self._docker_daemons_cleaned = list()
[docs] def on_resource_added(self, resource): """If the resource added is a DockerDaemon, make sure this is the only one added for this target. If it is, create a docker client to be used to communicate with the docker daemon. """ import docker # lazy import! if in self._client: raise EnvironmentError( "Only one docker daemon is allowed for each target") self._client[] = \ docker.DockerClient(base_url=resource.docker_daemon_url) self._container_cleanup(self._client[]) resource.avail = True
[docs] def poll(self): """Ask associated DockerDaemon resource to check if associated NetworkService has come up.""" for resource in self.resources: resource.on_poll(self._client[])
def _container_cleanup(self, docker_client): """Fetches a list of containers from the daemon. Each container that has the label DOCKER_LG_CLEANUP_LABEL is removed. This is for cleanup of potential dangling containers left over from earlier test runs. """ if docker_client.api.base_url not in self._docker_daemons_cleaned: container_list = docker_client.api.containers( all=True, filters={"label": DockerConstants.DOCKER_LG_CLEANUP_LABEL}) for container in container_list: if (container['Labels'][DockerConstants.DOCKER_LG_CLEANUP_LABEL] == DockerConstants.DOCKER_LG_CLEANUP_TYPE_AUTO):"Deleting container %s", container['Names'][0]) docker_client.api.remove_container(container['Id'], force=True) self._docker_daemons_cleaned.append(docker_client.api.base_url)
[docs]@target_factory.reg_resource @attr.s(eq=False) class DockerDaemon(ManagedResource): """ A resource identifying a docker daemon """ docker_daemon_url = attr.ib(validator=attr.validators.instance_of(str)) """The docker network service is a managed resource mapping a container name to a network service. """ manager_cls = DockerManager
[docs] def __attrs_post_init__(self): super().__attrs_post_init__() self._nw_services = dict() self.log = logging.getLogger('DockerContainer') self.timeout = 5.0 self.avail = True
[docs] def on_client_bound(self, client): """Each time a docker driver binds to the DockerDaemon resource the docker driver network services list is iterated and for each network service defined a NetworkService resource instance is created with the parameters from the configuration file. """ for network_service in client.network_services: # IP address is not yet known at this point network_service["address"] = "" if 'name' in network_service: service_name = network_service["name"] else: service_name = "NetworkService" nw_service = target_factory.make_resource(, "NetworkService", service_name, network_service) if client.container_name not in self._nw_services: self._nw_services[client.container_name] = list() self._nw_services[client.container_name].append(nw_service)
[docs] def on_poll(self, docker_client): """Check if associated NetworkService has come up.""" self._update_resource(docker_client)
def _update_resource(self, docker_client): """Update resource takes a docker client and uses this to lookup a container by name. If the container exists the IP address is looked up by inspecting the docker container. If an IP address is found the address is filled in the NetworkService base class and the resource is identified as available. :param docker_client: The docker client to use for lookup """ for container_name, nw_service_list in self._nw_services.items(): for nw_service in nw_service_list: if nw_service.address == "": container = docker_client.api.containers( filters={"name": "/" + container_name}) self.log.debug("Containers found %s", container) if container: nw_service.address = find_dict( d=container[0]['NetworkSettings'], key='IPAddress') if (nw_service.address != "" and self._socket_connect(nw_service.address, nw_service.port)): nw_service.avail = True else: nw_service.avail = False @staticmethod def _socket_connect(address, port): """ Try to do a socket connect :param address: The ip address to connect to :param port: The port to connect to :return: True on successful connection, False if failed """ try: s = socket.create_connection((address, port)) except Exception: return False s.shutdown(socket.SHUT_RDWR) s.close() return True