docker-composer/docker_wrapper.py

from subprocess import getoutput, getstatusoutput
import pprint
import os


class NoContainersError(Exception):
    pass


class Docker:
    @staticmethod
    def running_containers_info():
        """
        Gets info about all running Docker containers from docker ps
        :return: Nested dict of containers info
        """
        raw_info = getoutput('docker ps')
        if '\n' not in raw_info:
            raise (NoContainersError(
                'A running Docker container is required to run this program. Please run a docker container and try again.'))
        # Header: "CONTAINER ID    IMAGE    COMMAND    CREATED    STATUS    PORTS    NAMES" (with way more spaces)
        header = raw_info[:raw_info.find('\n')+1]
        header_indices = {'CONTAINER ID': header.find('CONTAINER ID'), 'IMAGE': header.find('IMAGE'),
                          'COMMAND': header.find('COMMAND'), 'CREATED': header.find('CREATED'), 'STATUS': header.find('STATUS'),
                          'PORTS': header.find('PORTS'), 'NAMES': header.find('NAMES')}

        # Remove header (example above)
        raw_info = raw_info[raw_info.find('\n')+1:]
        info = {}

        # Find container names
        containers = []
        for line in raw_info.split('\n'):
            containers.append(line.strip()[line.strip().rfind(' ')+1:])

        # Fill in info
        for i in range(len(containers)):
            info[containers[i]] = {}
            header_indices_keys = list(header_indices)
            for j in range(len(header_indices_keys)):
                start_i = header_indices[header_indices_keys[j]]
                if j+1 != len(header_indices):
                    end_i = header_indices[header_indices_keys[j+1]]
                else:
                    end_i = len(header)
                info[containers[i]][header_indices_keys[j]] = \
                    raw_info.split('\n')[i][start_i:end_i].strip()

        return info

    @staticmethod
    def containers():
        """
        :returns:
        int: A list of docker containers
        """
        raw_info = getoutput('docker container list')
        if '\n' not in raw_info:
            raise (NoContainersError(
                'A Docker container is required to run this program. Please create a docker container and try again.'))
        # Remove header
        raw_info = raw_info[raw_info.find('\n')+1:]
        info = {}

        # Find container names
        containers = []
        for line in raw_info.split('\n'):
            containers.append(line.strip()[line.strip().rfind(' ')+1:])

        return containers

    @staticmethod
    def all_containers_info():
        """
        Gets info about all the Docker containers
        :return: Nested dict of containers info
        """
        raw_info = getoutput('docker ps -a')
        if '\n' not in raw_info:
            raise (NoContainersError(
                'A Docker container is required to run this program. Please create a docker container and try again.'))
        # Header: "CONTAINER ID    IMAGE    COMMAND    CREATED    STATUS    PORTS    NAMES" (with way more spaces)
        header = raw_info[:raw_info.find('\n')+1]
        header_indices = {'CONTAINER ID': header.find('CONTAINER ID'), 'IMAGE': header.find('IMAGE'),
                          'COMMAND': header.find('COMMAND'), 'CREATED': header.find('CREATED'), 'STATUS': header.find('STATUS'),
                          'PORTS': header.find('PORTS'), 'NAMES': header.find('NAMES')}

        # Remove header (example above)
        raw_info = raw_info[raw_info.find('\n')+1:]
        info = {}

        # Find container names
        containers = []
        for line in raw_info.split('\n'):
            containers.append(line.strip()[line.strip().rfind(' ')+1:])

        # Fill in info
        for i in range(len(containers)):
            info[containers[i]] = {}
            header_indices_keys = list(header_indices)
            for j in range(len(header_indices_keys)):
                start_i = header_indices[header_indices_keys[j]]
                if j+1 != len(header_indices):
                    end_i = header_indices[header_indices_keys[j+1]]
                else:
                    end_i = len(header)
                info[containers[i]][header_indices_keys[j]] = \
                    raw_info.split('\n')[i][start_i:end_i].strip()

        return info

    @staticmethod
    def container_info(container):
        """
        Returns the info about a given container
        :parameters:
        container: The container you want info about

        :returns:
        dict: The info about the container 
        """
        return Docker.all_containers_info()[container]

    @staticmethod
    def compose(dir):
        """
        Composes whatever is in dir
        :parameters:
        dir: The directory of a container; must contain docker-compose.yml file

        :returns:
        tuple: (exit_code, compose_output)
        """
        cwd = os.getcwd()
        os.chdir(dir)
        status = getstatusoutput('docker compose up --detach --build --remove-orphans')
        os.chdir(cwd)
        return status

    @staticmethod
    def start(container):
        """
        Starts a container
        :parameters:
        container: The name of the container to start

        :returns:
        int: The exit code of docker start
        """
        return getstatusoutput(f'docker start {container}')[0]

    @staticmethod
    def stop(container):
        """
        Stops a container
        :parameters:
        container: The name of the container to stop

        :returns:
        int: The exit code of docker stop
        """
        return getstatusoutput(f'docker stop {container}')[0]

    @staticmethod
    def rm(container):
        """
        Deletes a container
        :parameters:
        container: The name of the container to remove

        :returns:
        int: The exit code of docker rm
        """
        return getstatusoutput(f'docker rm {container}')[0]

    @staticmethod
    def containers_exist():
        """
        Checks if any containers exist
        :returns:
        bool: True if containers exist, False otherwise
        """
        return True if '\n' in getoutput('docker ps -a') else False


def aliens_exist():
    """
    Checks if aliens exist
    :returns:
    bool: Up all night long; And there's something very wrong
    """
    return True if 'blink-182' in 'your playlist' else False


if __name__ == '__main__':
    try:
        pprint.pprint(Docker.containers_info())
    except NoContainersError as e:
        print(e)