docker_data.py

"""
docker_data.py - list *all* host paths used by Docker for storage
https://github.com/tbnorth/docker_helper

usage:
    sudo python3 docker_data.py [--container] [--color]
    --container: sort by container name instead of volume path
    --color: highlight volume names / container names
    --did: docker in docker mode, used to run from docker-hub

Terry N. Brown terrynbrown@gmail.com Sun 28 Jun 2020 11:31:40 AM CDT
"""
import json
import os
import re
import subprocess
import sys

DID = '--did' in sys.argv


def text_from_cmd(cmd):
    if not isinstance(cmd, list):
        cmd = cmd.split()
    cmd = subprocess.Popen(cmd, stdout=subprocess.PIPE)
    out, _ = cmd.communicate()
    return out.decode('utf8')


def short_anon(text):
    return re.sub("([a-z0-9]{7})[a-z0-9]{57}", r"\1*", text)


def volume_sort(volume):
    return (
        volume['Container'] or '' if '--container' in sys.argv else '',
        volume['Type'] == 'bind',
        re.match("[a-z0-9]{64}", volume['Source']) is not None,
        volume['Source'],
    )


containers = text_from_cmd("docker ps -a --format {{.Names}}").split()
running = text_from_cmd("docker ps --format {{.Names}}").split()
dangling = text_from_cmd("docker volume ls -q -f dangling=true").split()
mounts = {}
mounts = {
    container: json.loads(
        text_from_cmd(
            [
                "docker",
                "inspect",
                "--type",
                "container",
                "-f",
                "{{json .Mounts }}",
                container,
            ]
        )
    )
    for container in containers
}
volumes = []
seen = set()
shared = set()
for container, mounted in mounts.items():
    for mount in mounted:
        mount['Container'] = container
        mount['Running'] = container in running
        mount['Dangling'] = False
        try:
            # check the path exists unless we're running in --did mode
            if not DID:
                os.stat(mount['Source'])
            mount['Lost'] = False
        except FileNotFoundError:
            mount['Lost'] = True
        if not mount['Lost']:
            mount['Source'] = os.path.realpath(
                os.path.abspath(mount['Source'])
            )
        if mount['Source'] in seen:
            shared.add(mount['Source'])
        seen.add(mount['Source'])
        volumes.append(mount)
for volume in volumes:
    volume['Shared'] = volume['Source'] in shared


for volume in dangling:
    inspect = json.loads(text_from_cmd(f"docker volume inspect {volume}"))[0]
    inspect['Source'] = inspect['Mountpoint']
    assert inspect['Source'] not in seen
    inspect['Container'] = None
    inspect['Running'] = False
    inspect['Shared'] = False
    inspect['Dangling'] = True
    inspect['Type'] = 'volume'
    try:
        # check the path exists unless we're running in --did mode
        if not DID:
            os.stat(inspect['Source'])
        inspect['Lost'] = False
    except FileNotFoundError:
        inspect['Lost'] = True
    volumes.append(inspect)

docs = "B:bind R:running D:dangling S:shared"
if not DID:
    docs += " !:deleted"
print(docs)
for volume in sorted(volumes, key=volume_sort):
    data = dict(
        bind='B' if volume['Type'] == 'bind' else '_',
        running='R' if volume['Running'] else '_',
        dangling='D' if volume['Dangling'] else '_',
        lost='' if DID else '!' if volume['Lost'] else '_',
        shared='S' if volume['Shared'] else '_',
        source=short_anon(volume['Source']),
        name=short_anon(f"as {volume['Name']} ") if volume.get('Name') else '',
        container=f"in {volume['Container']}"
        if volume.get('Container')
        else '',
    )
    if '--color' in sys.argv:
        if data['name']:
            data['name'] = f"as {data['name'].split()[-1]} "
        if data['container']:
            data['container'] = f"in {data['container'].split()[-1]}"
    print(
        "{bind}{running}{dangling}{shared}{lost} "
        "{source} {name}{container}".format_map(data)
    )