import logging import re from .const import LABEL_VERSION from .container import Container from .container import get_container_name log = logging.getLogger(__name__) # TODO: remove this section when migrate_project_to_labels is removed NAME_RE = re.compile(r'^([^_]+)_([^_]+)_(run_)?(\d+)$') ERROR_MESSAGE_FORMAT = """ Compose found the following containers without labels: {names_list} As of Compose 1.3.0, containers are identified with labels instead of naming convention. If you want to continue using these containers, run: $ docker-compose migrate-to-labels Alternatively, remove them: $ docker rm -f {rm_args} """ ONE_OFF_ADDENDUM_FORMAT = """ You should also remove your one-off containers: $ docker rm -f {rm_args} """ ONE_OFF_ERROR_MESSAGE_FORMAT = """ Compose found the following containers without labels: {names_list} As of Compose 1.3.0, containers are identified with labels instead of naming convention. Remove them before continuing: $ docker rm -f {rm_args} """ def check_for_legacy_containers( client, project, services, allow_one_off=True): """Check if there are containers named using the old naming convention and warn the user that those containers may need to be migrated to using labels, so that compose can find them. """ containers = get_legacy_containers(client, project, services, one_off=False) if containers: one_off_containers = get_legacy_containers(client, project, services, one_off=True) raise LegacyContainersError( [c.name for c in containers], [c.name for c in one_off_containers], ) if not allow_one_off: one_off_containers = get_legacy_containers(client, project, services, one_off=True) if one_off_containers: raise LegacyOneOffContainersError( [c.name for c in one_off_containers], ) class LegacyError(Exception): def __unicode__(self): return self.msg __str__ = __unicode__ class LegacyContainersError(LegacyError): def __init__(self, names, one_off_names): self.names = names self.one_off_names = one_off_names self.msg = ERROR_MESSAGE_FORMAT.format( names_list="\n".join(" {}".format(name) for name in names), rm_args=" ".join(names), ) if one_off_names: self.msg += ONE_OFF_ADDENDUM_FORMAT.format(rm_args=" ".join(one_off_names)) class LegacyOneOffContainersError(LegacyError): def __init__(self, one_off_names): self.one_off_names = one_off_names self.msg = ONE_OFF_ERROR_MESSAGE_FORMAT.format( names_list="\n".join(" {}".format(name) for name in one_off_names), rm_args=" ".join(one_off_names), ) def add_labels(project, container): project_name, service_name, one_off, number = NAME_RE.match(container.name).groups() if project_name != project.name or service_name not in project.service_names: return service = project.get_service(service_name) service.recreate_container(container) def migrate_project_to_labels(project): log.info("Running migration to labels for project %s", project.name) containers = get_legacy_containers( project.client, project.name, project.service_names, one_off=False, ) for container in containers: add_labels(project, container) def get_legacy_containers( client, project, services, one_off=False): return list(_get_legacy_containers_iter( client, project, services, one_off=one_off, )) def _get_legacy_containers_iter( client, project, services, one_off=False): containers = client.containers(all=True) for service in services: for container in containers: if LABEL_VERSION in (container.get('Labels') or {}): continue name = get_container_name(container) if has_container(project, service, name, one_off=one_off): yield Container.from_ps(client, container) def has_container(project, service, name, one_off=False): if not name or not is_valid_name(name, one_off): return False container_project, container_service, _container_number = parse_name(name) return container_project == project and container_service == service def is_valid_name(name, one_off=False): match = NAME_RE.match(name) if match is None: return False if one_off: return match.group(3) == 'run_' else: return match.group(3) is None def parse_name(name): match = NAME_RE.match(name) (project, service_name, _, suffix) = match.groups() return (project, service_name, int(suffix))