compose-viz/compose_viz/graph.py

from typing import Optional

import graphviz

from compose_viz.models.compose import Compose
from compose_viz.models.port import AppProtocol, Protocol


def apply_vertex_style(type: str) -> dict:
    style = {
        "service": {
            "shape": "component",
        },
        "volume": {
            "shape": "cylinder",
        },
        "network": {
            "shape": "pentagon",
        },
        "port": {
            "shape": "circle",
        },
        "env_file": {
            "shape": "tab",
        },
        "porfile": {
            "shape": "invhouse",
        },
        "cgroup": {
            "shape": "diamond",
        },
        "device": {
            "shape": "box3d",
        },
    }

    return style[type]


def apply_edge_style(type: str) -> dict:
    style = {
        "exposes": {
            "style": "solid",
            "dir": "both",
        },
        "links": {
            "style": "solid",
        },
        "volumes_rw": {
            "style": "dashed",
            "dir": "both",
        },
        "volumes_ro": {
            "style": "dashed",
        },
        "depends_on": {
            "style": "dotted",
        },
        "extends": {
            "dir": "both",
            "arrowhead": "inv",
            "arrowtail": "dot",
        },
        "env_file": {
            "style": "solid",
        },
    }

    return style[type]


class Graph:
    def __init__(self, compose: Compose, filename: str, include_legend: bool) -> None:
        self.dot = graphviz.Digraph()
        self.dot.attr("graph", background="#ffffff", pad="0.5", ratio="fill")
        self.compose = compose
        self.filename = filename

        if include_legend:
            self.dot.attr(rankdir="LR")

            with self.dot.subgraph(name="cluster_edge_") as edge:
                edge.attr(label="Edge")
                edge.node("line_0_l", style="invis")
                edge.node("line_0_r", style="invis")
                edge.edge("line_0_l", "line_0_r", label="exposes", **apply_edge_style("exposes"))

                edge.node("line_1_l", style="invis")
                edge.node("line_1_r", style="invis")
                edge.edge("line_1_l", "line_1_r", label="links", **apply_edge_style("links"))

                edge.node("line_2_l", style="invis")
                edge.node("line_2_r", style="invis")
                edge.edge("line_2_l", "line_2_r", label="volumes_rw", **apply_edge_style("volumes_rw"))

                edge.node("line_3_l", style="invis")
                edge.node("line_3_r", style="invis")
                edge.edge("line_3_l", "line_3_r", label="volumes_ro", **apply_edge_style("volumes_ro"))

                edge.node("line_4_l", style="invis")
                edge.node("line_4_r", style="invis")
                edge.edge("line_4_l", "line_4_r", label="depends_on", **apply_edge_style("depends_on"))

                edge.node("line_5_l", style="invis")
                edge.node("line_5_r", style="invis")
                edge.edge("line_5_l", "line_5_r", label="extends", **apply_edge_style("extends"))

            with self.dot.subgraph(name="cluster_node_") as node:
                node.attr(label="Node")
                node.node("service", shape="component", label="Service\n(image)")
                node.node("volume", shape="cylinder", label="Volume")
                node.node("network", shape="pentagon", label="Network")
                node.node("port", shape="circle", label="Port")
                node.node("env_file", shape="tab", label="Env File")
                node.node("profile", shape="invhouse", label="Profile")
                node.node("cgroup", shape="diamond", label="CGroupe")
                node.node("device", shape="box3d", label="Device")

                node.body.append("{ rank=source;service network env_file cgroup }")

            self.dot.node("inv", style="invis")
            self.dot.edge("inv", "network", style="invis")
            self.dot.edge("port", "line_2_l", style="invis")

    def validate_name(self, name: str) -> str:
        # graphviz does not allow ':' in node name
        transTable = name.maketrans({":": ""})
        return name.translate(transTable)

    def add_vertex(self, name: str, type: str, lable: Optional[str] = None) -> None:
        self.dot.node(self.validate_name(name), lable, **apply_vertex_style(type))

    def add_edge(self, head: str, tail: str, type: str, lable: Optional[str] = None) -> None:
        self.dot.edge(self.validate_name(head), self.validate_name(tail), lable, **apply_edge_style(type))

    def render(self, format: str, cleanup: bool = True) -> None:
        for service in self.compose.services:
            if service.image is not None:
                self.add_vertex(
                    service.name,
                    "service",
                    lable=f"{service.container_name if service.container_name else service.name}\n({service.image})",
                )
            if service.extends is not None:
                self.add_vertex(service.name, "service", lable=f"{service.name}\n")
                self.add_edge(service.extends.service_name, service.name, "extends")
            if service.cgroup_parent is not None:
                self.add_vertex(service.cgroup_parent, "cgroup")
                self.add_edge(service.name, service.cgroup_parent, "links")

            for network in service.networks:
                self.add_vertex(network, "network", lable=f"net:{network}")
                self.add_edge(service.name, network, "links")
            for volume in service.volumes:
                self.add_vertex(volume.source, "volume")
                self.add_edge(
                    service.name,
                    volume.source,
                    "volumes_rw" if "rw" in volume.access_mode else "volumes_ro",
                    lable=volume.target,
                )
            for expose in service.expose:
                self.add_vertex(expose, "port")
                self.add_edge(expose, service.name, "exposes")
            for port in service.ports:
                self.add_vertex(port.host_port, "port", lable=port.host_port)
                self.add_edge(
                    port.host_port,
                    service.name,
                    "links",
                    lable=port.container_port
                    + (("/" + port.protocol) if port.protocol != Protocol.any.value else "")
                    + (("\n(" + port.app_protocol + ")") if port.app_protocol != AppProtocol.na.value else ""),
                )
            for env_file in service.env_file:
                self.add_vertex(env_file, "env_file")
                self.add_edge(env_file, service.name, "env_file")
            for link in service.links:
                if ":" in link:
                    service_name, alias = link.split(":", 1)
                    self.add_edge(service_name, service.name, "links", alias)
                else:
                    self.add_edge(link, service.name, "links")
            for depends_on in service.depends_on:
                self.add_edge(service.name, depends_on, "depends_on")
            for porfile in service.profiles:
                self.add_vertex(porfile, "porfile")
                self.add_edge(service.name, porfile, "links")
            for device in service.devices:
                self.add_vertex(device.host_path, "device")
                self.add_edge(
                    device.host_path, service.name, "exposes", f"{device.container_path}\n({device.cgroup_permissions})"
                )

        self.dot.render(outfile=f"{self.filename}.{format}", format=format, cleanup=cleanup)