.github/workflows/ci.yml

@@ -20,15 +20,27 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y graphviz
 
+      - name: Validate Test Files
+        run: |
+          docker compose -f tests/ymls/builds/docker-compose.yml config -q
+          docker compose -f tests/ymls/depends_on/docker-compose.yml config -q
+          docker compose -f tests/ymls/extends/docker-compose.yml config -q
+          docker compose -f tests/ymls/links/docker-compose.yml config -q
+          docker compose -f tests/ymls/networks/docker-compose.yml config -q
+          docker compose -f tests/ymls/ports/docker-compose.yml config -q
+          docker compose -f tests/ymls/volumes/docker-compose.yml config -q
+          docker compose -f examples/full-stack-node-app/docker-compose.yml config -q
+          docker compose -f examples/non-normative/docker-compose.yml config -q
+
       - name: Setup Python 3.10.4
         uses: actions/setup-python@v3
         with:
           python-version: '3.10.4'
 
       - name: Setup Poetry
-        uses: abatilo/actions-poetry@v3
+        uses: Gr1N/setup-poetry@v7
         with:
-          poetry-version: 1.8.2
+          poetry-version: 1.1.7
 
       - name: Install Dependencies
         run: |

.github/workflows/release-docker-image.yml

@@ -1,39 +0,0 @@
-name: Release Docker Image
-
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  docker:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-      -
-        name: Login to DockerHub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Extract Tag Version
-        id: tag_version
-        run: |
-          echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/v}
-
-      -
-        name: Build and push
-        uses: docker/build-push-action@v3
-        with:
-          push: true
-          tags: |
-            ${{ secrets.DOCKERHUB_USERNAME }}/compose-viz:latest
-            ${{ secrets.DOCKERHUB_USERNAME }}/compose-viz:${{ steps.tag_version.outputs.VERSION }}
-          cache-from: type=registry,ref=${{ secrets.DOCKERHUB_USERNAME }}/compose-viz:buildcache
-          cache-to: type=registry,ref=${{ secrets.DOCKERHUB_USERNAME }}/compose-viz:buildcache,mode=max

.github/workflows/release-tagged-version.yml

@@ -32,9 +32,9 @@ jobs:
           python-version: '3.10.4'
 
       - name: Setup Poetry
-        uses: abatilo/actions-poetry@v3
+        uses: Gr1N/setup-poetry@v7
         with:
-          poetry-version: 1.8.2
+          poetry-version: 1.1.7
       - run: |
           poetry install --no-root
           poetry build
@@ -46,5 +46,4 @@ jobs:
           prerelease: false
           files: |
             LICENSE
-            Dockerfile
             dist/**

.github/workflows/update-submodules.yml

@@ -1,79 +0,0 @@
-name: Update Submodules
-
-on:
-  push:
-    branches: [ dev ]
-  schedule:
-    - cron: '0 0 * * *'
-
-jobs:
-  check_submodules:
-    name: Check Submodules
-    runs-on: ubuntu-latest
-    outputs:
-      has_changes: ${{ steps.check.outputs.has_changes }}
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-
-      - name: Create new branch and push changes
-        run: |
-          git submodule update --remote
-
-      - name: Check for changes
-        id: check
-        run: |
-          git diff --quiet || echo "::set-output name=has_changes::true"
-
-  update_submodules:
-    name: Update Submodules
-    runs-on: ubuntu-latest
-    needs: [check_submodules]
-    if: needs.check_submodules.outputs.has_changes == 'true'
-    steps:
-
-      - name: Setup Python 3.10.4
-        uses: actions/setup-python@v3
-        with:
-          python-version: '3.10.4'
-
-      - name: Setup Poetry
-        uses: abatilo/actions-poetry@v3
-        with:
-          poetry-version: 1.8.2
-
-      - name: Install Dependencies
-        run: |
-          poetry install --no-root
-
-      - name: Update Submodule
-        run: |
-          datamodel-codegen --input ./compose-spec/schema/compose-spec.json --output-model-type pydantic_v2.BaseModel --field-constraints --output ./compose_viz/spec/compose_spec.py
-          poetry run python ./update-submodules.py
-
-      - name: Execute pre-commit
-        continue-on-error: true
-        run: |
-          poetry run python -m pre_commit run --all-files
-
-      - name: Push changes
-        run: |
-          git config user.name github-actions
-          git config user.email github-actions@github.com
-          git checkout -b $GITHUB_RUN_ID
-          git commit -am "chore: update submodules"
-          git push --set-upstream origin $GITHUB_RUN_ID
-
-      - name: File PR
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            await github.rest.pulls.create({
-              owner: '${{ github.repository_owner }}',
-              repo: 'compose-viz',
-              head: process.env.GITHUB_RUN_ID,
-              base: 'main',
-              title: `chore: update submodules (${process.env.GITHUB_RUN_ID})`,
-              body: `Please add the version tag to trigger the release.`,
-            });

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "compose-spec"]
-	path = compose-spec
-	url = https://github.com/compose-spec/compose-spec.git

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
           args:
             - "--max-line-length=120"
     - repo: https://github.com/pycqa/isort
-      rev: 5.12.0
+      rev: 5.10.1
       hooks:
         - id: isort
     - repo: https://github.com/psf/black

Dockerfile

@@ -1,35 +0,0 @@
-FROM python:alpine3.16 as builder
-
-COPY ./ /compose-viz/
-
-RUN \
-    apk update && \
-    pip install --upgrade pip
-
-RUN \
-    apk add binutils alpine-sdk libffi-dev
-
-RUN \
-    pip install poetry && \
-    pip install pyinstaller
-
-RUN \
-    cd /compose-viz && \
-    poetry config virtualenvs.create false && \
-    poetry install --no-root
-
-RUN \
-    cd /compose-viz && \
-    pyinstaller --onefile --name cpv ./compose_viz/__main__.py
-
-FROM alpine:3.16 as release
-
-COPY --from=builder /compose-viz/dist/cpv /usr/local/bin/cpv
-
-RUN \
-    apk add --no-cache graphviz ttf-droid
-
-VOLUME [ "/in" ]
-WORKDIR "/in"
-
-ENTRYPOINT [ "cpv" ]

README.md

@@ -56,7 +56,7 @@
 
 ## About The Project
 
-`compose-viz` is a compose file visualization tool that follows [compose-spec](https://github.com/compose-spec/compose-spec/blob/master/spec.md) and allows you to gernerate graph in several formats.
+`compose-viz` is a compose file visualization tool that supports [compose-spec](https://github.com/compose-spec/compose-spec/blob/master/spec.md) and allows you to gernerate graph in [DOT](https://graphviz.org/doc/info/lang.html) format or `.png`.
 
 If you are looking for a compose file vizualization tool, and you are using one of the [compose-spec](https://github.com/compose-spec/compose-spec/blob/master/spec.md) implementations (e.g. [docker-compose](https://github.com/docker/compose)/[podman-compose](https://github.com/containers/podman-compose)), then `compose-viz` is a great choice for you. 
 
@@ -70,46 +70,30 @@ If you are looking for a compose file vizualization tool, and you are using one
 
 #### Graphviz
 
-You need to install [Graphviz](https://graphviz.org/download/) to generate graphs.
+If you want to generate PNG (which is the default option), you need to install [Graphviz](https://graphviz.org/download/).
 
 ### Installation
 
 #### Using `pip`
 
-```
+`pip install compose-viz`
-pip install compose-viz
-```
 
 #### Using `.whl`
 
 See [releases](https://github.com/compose-viz/compose-viz/releases).
 
-#### Docker Image
-
-See [wst24365888/compose-viz](https://hub.docker.com/r/wst24365888/compose-viz/tags).
-
 ### Example
 
-This example yml is from [docker compose beginner tutorial](https://github.com/docker/labs/blob/master/beginner/chapters/votingapp.md).
-
 ```bash
-cd examples/voting-app/
+cd examples/full-stack-node-app/
-
+cpv docker-compose.yml
-# using python script
-cpv -m svg docker-compose.yml
-
-# using docker image
-docker run --rm -it -v $(pwd):/in wst24365888/compose-viz -m svg docker-compose.yml
-
-# using docker image in powershell
-docker run --rm -it -v ${pwd}:/in wst24365888/compose-viz -m svg docker-compose.yml
 ```
 
 And this is what the result looks like:
 
-![compose-viz.svg](https://github.com/compose-viz/compose-viz/blob/main/examples/voting-app/compose-viz.svg)
+![compose-viz.png](https://github.com/compose-viz/compose-viz/blob/main/examples/full-stack-node-app/compose-viz.png)
 
-Check out the result [here](https://github.com/compose-viz/compose-viz/blob/main/examples/voting-app).
+Check out the result [here](https://github.com/compose-viz/compose-viz/blob/main/examples/full-stack-node-app/compose-viz.png).
 
 ### Usage
 
@@ -118,11 +102,9 @@ Check out the result [here](https://github.com/compose-viz/compose-viz/blob/main
 ### Options
 
 | Option                   | Description                                                                    |
-| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ------------------------ | ------------------------------------------------------------------------------ |
-| `-o, --output-filename FILENAME`  | Output filename for the generated visualization file. [default: compose-viz]                                                                                                        |
+| `-o, --output-path`      | Output path for the generated visualization file. [default: ./compose-viz.png] |
-| `-m, --format FORMAT`             | Output format for the generated visualization file. See [supported formats](https://github.com/compose-viz/compose-viz/blob/main/compose_viz/models/viz_formats.py). [default: png] |
+| `-m, --format [PNG,DOT]` | Output format for the generated visualization file. [default: PNG]             |
-| `-r, --root-service SERVICE_NAME` | Root of the service tree (convenient for large compose yamls)                                                                                                                       |
-| `-l, --legend`                    | Include a legend in the visualization.                                                                                                                                              |
 | `-v, --version`          | Show the version of compose-viz.                                               |
 | `--help`                 | Show help and exit.                                                            |
 
@@ -178,7 +160,7 @@ for more information.
 
 - HSING-HAN, WU (Xyphuz)
   - Mail me: xyphuzwu@gmail.com
-  - About me: <https://www.xyphuz.com>
+  - About me: <https://about.xyphuz.com>
   - GitHub: <https://github.com/wst24365888>
 
 ### Project Link

compose-spec

@@ -1 +0,0 @@
-Subproject commit c9480da2ad9670c2e99126f4aad8f1ffbf6d4a9a

compose_viz/__init__.py

@@ -1,2 +1,2 @@
 __app_name__ = "compose_viz"
-__version__ = "0.3.2"
+__version__ = "0.1.1"

compose_viz/cli.py

@@ -1,12 +1,18 @@
+from enum import Enum
 from typing import Optional
 
 import typer
 
 from compose_viz import __app_name__, __version__
 from compose_viz.graph import Graph
-from compose_viz.models.viz_formats import VizFormats
 from compose_viz.parser import Parser
 
+
+class VisualizationFormats(str, Enum):
+    png = "PNG"
+    dot = "DOT"
+
+
 app = typer.Typer(
     invoke_without_command=True,
     no_args_is_help=True,
@@ -24,30 +30,18 @@ def _version_callback(value: bool) -> None:
 @app.callback()
 def compose_viz(
     input_path: str,
-    output_filename: str = typer.Option(
+    output_path: str = typer.Option(
-        "compose-viz",
+        "./compose-viz.png",
-        "--output-filename",
+        "--output-path",
         "-o",
-        help="Output filename for the generated visualization file.",
+        help="Output path for the generated visualization file.",
     ),
-    format: VizFormats = typer.Option(
+    format: VisualizationFormats = typer.Option(
-        "png",
+        "PNG",
         "--format",
         "-m",
         help="Output format for the generated visualization file.",
     ),
-    root_service: str = typer.Option(
-        None,
-        "--root-service",
-        "-r",
-        help="Root of the service tree (convenient for large compose yamls)",
-    ),
-    include_legend: bool = typer.Option(
-        False,
-        "--legend",
-        "-l",
-        help="Include a legend in the visualization.",
-    ),
     _: Optional[bool] = typer.Option(
         None,
         "--version",
@@ -58,12 +52,12 @@ def compose_viz(
     ),
 ) -> None:
     parser = Parser()
-    compose = parser.parse(input_path, root_service=root_service)
+    compose = parser.parse(input_path)
 
     if compose:
         typer.echo(f"Successfully parsed {input_path}")
 
-    Graph(compose, output_filename, include_legend).render(format)
+    Graph(compose, output_path).render(format)
 
     raise typer.Exit()
 

compose_viz/compose.py

@@ -1,6 +1,6 @@
 from typing import List
 
-from compose_viz.models.service import Service
+from compose_viz.service import Service
 
 
 class Compose:

compose_viz/graph.py

@@ -2,17 +2,16 @@ from typing import Optional
 
 import graphviz
 
-from compose_viz.models.compose import Compose
+from compose_viz.compose import Compose
-from compose_viz.models.port import AppProtocol, Protocol
 
 
-def apply_vertex_style(type: str) -> dict:
+def apply_vertex_style(type) -> dict:
     style = {
         "service": {
             "shape": "component",
         },
         "volume": {
-            "shape": "cylinder",
+            "shape": "folder",
         },
         "network": {
             "shape": "pentagon",
@@ -20,39 +19,24 @@ def apply_vertex_style(type: str) -> dict:
         "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:
+def apply_edge_style(type) -> dict:
     style = {
-        "exposes": {
+        "ports": {
             "style": "solid",
             "dir": "both",
         },
         "links": {
             "style": "solid",
         },
-        "volumes_rw": {
+        "volumes": {
             "style": "dashed",
             "dir": "both",
         },
-        "volumes_ro": {
-            "style": "dashed",
-        },
         "depends_on": {
             "style": "dotted",
         },
@@ -61,67 +45,18 @@ def apply_edge_style(type: str) -> dict:
             "arrowhead": "inv",
             "arrowtail": "dot",
         },
-        "env_file": {
-            "style": "solid",
-        },
     }
 
     return style[type]
 
 
 class Graph:
-    def __init__(self, compose: Compose, filename: str, include_legend: bool) -> None:
+    def __init__(self, compose: Compose, filename: str) -> 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({":": ""})
@@ -136,45 +71,19 @@ class Graph:
     def render(self, format: str, cleanup: bool = True) -> None:
         for service in self.compose.services:
             if service.image is not None:
-                self.add_vertex(
+                self.add_vertex(service.name, "service", lable=f"{service.name}\n({service.image})")
-                    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(
+                self.add_edge(service.name, volume.source, "volumes", lable=volume.target)
-                    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(
+                self.add_edge(port.host_port, service.name, "ports", lable=port.container_port)
-                    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)
@@ -183,13 +92,5 @@ class Graph:
                     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)
+        self.dot.render(outfile=self.filename, format=format, cleanup=cleanup)

compose_viz/models/device.py

@@ -1,20 +0,0 @@
-from typing import Optional
-
-
-class Device:
-    def __init__(self, host_path: str, container_path: str, cgroup_permissions: Optional[str] = None):
-        self._host_path = host_path
-        self._container_path = container_path
-        self._cgroup_permissions = cgroup_permissions
-
-    @property
-    def host_path(self):
-        return self._host_path
-
-    @property
-    def container_path(self):
-        return self._container_path
-
-    @property
-    def cgroup_permissions(self):
-        return self._cgroup_permissions

compose_viz/models/port.py

@@ -1,46 +0,0 @@
-from enum import Enum
-
-
-class Protocol(str, Enum):
-    tcp = "tcp"
-    udp = "udp"
-    any = "any"
-
-
-class AppProtocol(str, Enum):
-    rest = "REST"
-    mqtt = "MQTT"
-    wbsock = "WebSocket"
-    http = "http"
-    https = "https"
-    na = "NA"
-
-
-class Port:
-    def __init__(
-        self,
-        host_port: str,
-        container_port: str,
-        protocol: Protocol = Protocol.any,
-        app_protocol: AppProtocol = AppProtocol.na,
-    ):
-        self._host_port = host_port
-        self._container_port = container_port
-        self._protocol = protocol
-        self._app_protocol = app_protocol
-
-    @property
-    def host_port(self):
-        return self._host_port
-
-    @property
-    def container_port(self):
-        return self._container_port
-
-    @property
-    def protocol(self):
-        return self._protocol
-
-    @property
-    def app_protocol(self):
-        return self._app_protocol

compose_viz/models/viz_formats.py

@@ -1,45 +0,0 @@
-from enum import Enum
-
-
-class VizFormats(str, Enum):
-    png = "png"
-    dot = "dot"
-    jpeg = "jpeg"
-    json = "json"
-    svg = "svg"
-
-    bmp = "bmp"
-    canon = "canon"
-    cmap = "cmap"
-    cmapx = "cmapx"
-    cmapx_np = "cmapx_np"
-    dot_json = "dot_json"
-    emf = "emf"
-    emfplus = "emfplus"
-    eps = "eps"
-    fig = "fig"
-    gif = "gif"
-    gv = "gv"
-    imap = "imap"
-    imap_np = "imap_np"
-    ismap = "ismap"
-    jpe = "jpe"
-    jpg = "jpg"
-    json0 = "json0"
-    metafile = "metafile"
-    mp = "mp"
-    pdf = "pdf"
-    pic = "pic"
-    plain = "plain"
-    plain_ext = "plain-ext"
-    pov = "pov"
-    ps = "ps"
-    ps2 = "ps2"
-    tif = "tif"
-    tiff = "tiff"
-    tk = "tk"
-    vml = "vml"
-    xdot = "xdot"
-    xdot1_2 = "xdot1.2"
-    xdot1_4 = "xdot1.4"
-    xdot_json = "xdot_json"

compose_viz/parser.py

@@ -1,177 +1,195 @@
 import re
-from typing import Any, Dict, List, Optional, Union
+from typing import Dict, List, Optional
 
-from pydantic_yaml import parse_yaml_raw_as
+from ruamel.yaml import YAML
 
-import compose_viz.spec.compose_spec as spec
+from compose_viz.compose import Compose, Service
-from compose_viz.models.compose import Compose, Service
+from compose_viz.extends import Extends
-from compose_viz.models.device import Device
+from compose_viz.port import Port, Protocol
-from compose_viz.models.extends import Extends
+from compose_viz.volume import Volume, VolumeType
-from compose_viz.models.port import AppProtocol, Port, Protocol
-from compose_viz.models.volume import Volume, VolumeType
 
 
 class Parser:
     def __init__(self):
         pass
 
-    @staticmethod
+    def parse(self, file_path: str) -> Compose:
-    def _unwrap_depends_on(data_depends_on: Union[spec.ListOfStrings, Dict[Any, spec.DependsOn], None]) -> List[str]:
+        # load the yaml file
-        service_depends_on = []
+        with open(file_path, "r") as f:
-        if type(data_depends_on) is spec.ListOfStrings:
-            service_depends_on = data_depends_on.root
-        elif type(data_depends_on) is dict:
-            for depends_on in data_depends_on.keys():
-                service_depends_on.append(str(depends_on))
-        return service_depends_on
-
-    @staticmethod
-    def compile_dependencies(service_name: str, services: Dict[Any, spec.Service], file_path: str) -> List[str]:
-        assert service_name in services, f"Service '{service_name}' not found in given compose file: '{file_path}'"
-
-        dependencies = []
-        for dependency in Parser._unwrap_depends_on(services[service_name].depends_on):
-            if dependency:
-                dependencies.append(dependency)
-                dependencies.extend(Parser.compile_dependencies(dependency, services, file_path))
-        return dependencies
-
-    def parse(self, file_path: str, root_service: Optional[str] = None) -> Compose:
-        compose_data: spec.ComposeSpecification
-
             try:
-            with open(file_path, "r") as file:
+                yaml = YAML(typ="safe", pure=True)
-                file_content = file.read()
+                yaml_data = yaml.load(f)
-            compose_data = parse_yaml_raw_as(spec.ComposeSpecification, file_content)
             except Exception as e:
                 raise RuntimeError(f"Error parsing file '{file_path}': {e}")
+        # validate the yaml file
+        if not yaml_data:
+            raise RuntimeError("Empty yaml file, aborting.")
+        if not yaml_data.get("services"):
+            raise RuntimeError("No services found, aborting.")
 
+        # parse services data into Service objects
+        services = self.parse_service_data(yaml_data["services"])
+
+        # create Compose object
+        compose = Compose(services)
+
+        return compose
+
+    def parse_service_data(self, services_yaml_data: Dict[str, dict]) -> List[Service]:
         services: List[Service] = []
-
+        for service, service_name in zip(services_yaml_data.values(), services_yaml_data.keys()):
-        assert compose_data.services is not None, "No services found, aborting."
-
-        root_dependencies: List[str] = []
-        if root_service:
-            root_dependencies = Parser.compile_dependencies(root_service, compose_data.services, file_path)
-            root_dependencies.append(root_service)
-            root_dependencies = list(set(root_dependencies))
-
-        for service_name, service_data in compose_data.services.items():
-            service_name = str(service_name)
-            if root_service and service_name not in root_dependencies:
-                continue
 
             service_image: Optional[str] = None
-            if service_data.build is not None:
+            if service.get("build"):
-                if type(service_data.build) is str:
+                if type(service["build"]) is str:
-                    service_image = f"build from '{service_data.build}'"
+                    service_image = f"build from '{service['build']}'"
-                elif type(service_data.build) is spec.Build:
+                elif type(service["build"]) is dict:
-                    if service_data.build.context is not None and service_data.build.dockerfile is not None:
+                    if service["build"].get("context") and service["build"].get("dockerfile"):
                         service_image = (
-                            f"build from '{service_data.build.context}' using '{service_data.build.dockerfile}'"
+                            f"build from '{service['build']['context']}' using '{service['build']['dockerfile']}'"
                         )
-                    elif service_data.build.context is not None:
+                    elif service["build"].get("context"):
-                        service_image = f"build from '{service_data.build.context}'"
+                        service_image = f"build from '{service['build']['context']}'"
-            if service_data.image is not None:
+            if service.get("image"):
-                if service_image is not None:
+                if service_image:
-                    service_image += ", image: " + service_data.image
+                    service_image += ", image: " + service["image"]
                 else:
-                    service_image = service_data.image
+                    service_image = service["image"]
 
             service_networks: List[str] = []
-            if service_data.networks is not None:
+            if service.get("networks"):
-                if type(service_data.networks) is spec.ListOfStrings:
+                if type(service["networks"]) is list:
-                    service_networks = service_data.networks.root
+                    service_networks = service["networks"]
-                elif type(service_data.networks) is dict:
+                elif type(service["networks"]) is dict:
-                    service_networks = list(service_data.networks.keys())
+                    service_networks = list(service["networks"].keys())
 
             service_extends: Optional[Extends] = None
-            if service_data.extends is not None:
+            if service.get("extends"):
-                # https://github.com/compose-spec/compose-spec/blob/master/spec.md#extends
+                assert type(service["extends"]) is dict, "Invalid extends format, aborting."
-                # The value of the extends key MUST be a dictionary.
+                assert service["extends"]["service"], "Missing extends service, aborting."
-                assert type(service_data.extends) is spec.Extends
+                extend_service_name = str(service["extends"]["service"])
-                service_extends = Extends(
+
-                    service_name=service_data.extends.service, from_file=service_data.extends.file
+                extend_from_file: Optional[str] = None
-                )
+                if service["extends"].get("file"):
+                    assert service["extends"]["file"], "Missing extends file, aborting."
+                    extend_from_file = str(service["extends"]["file"])
+
+                service_extends = Extends(service_name=extend_service_name, from_file=extend_from_file)
 
             service_ports: List[Port] = []
-            if service_data.ports is not None:
+            if service.get("ports"):
-                for port_data in service_data.ports:
+                assert type(service["ports"]) is list
-                    host_ip: Optional[str] = None
+                for port_data in service["ports"]:
-                    host_port: Optional[str] = None
+                    if type(port_data) is dict:
-                    container_port: Optional[str] = None
+                        # define a nested function to limit variable scope
-                    protocol: Optional[str] = None
+                        def long_syntax():
-                    app_protocol: Optional[str] = None
+                            assert type(port_data) is dict
+                            assert port_data["target"]
 
-                    if type(port_data) is float:
+                            container_port: str = str(port_data["target"])
-                        container_port = str(int(port_data))
+                            host_port: str = ""
-                        host_port = f"0.0.0.0:{container_port}"
+                            protocol: Protocol = Protocol.any
-                    elif type(port_data) is str:
-                        regex = r"((?P<host_ip>\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:|(\$\{([^}]+)\}):)|:|)?((?P<host_port>\d+(\-\d+)?):)?((?P<container_port>\d+(\-\d+)?))?(/(?P<protocol>\w+))?"  # noqa: E501
-                        match = re.match(regex, port_data)
 
-                        if match:
+                            if port_data.get("published"):
-                            host_ip = match.group("host_ip")
+                                host_port = str(port_data["published"])
-                            host_port = match.group("host_port")
-                            container_port = match.group("container_port")
-                            protocol = match.group("protocol")
-
-                            assert container_port, "Invalid port format, aborting."
-
-                            if container_port is not None and host_port is None:
-                                host_port = container_port
-
-                            if host_ip is not None:
-                                host_port = f"{host_ip}{host_port}"
                             else:
-                                host_port = f"0.0.0.0:{host_port}"
-                    elif type(port_data) is spec.Ports:
-                        assert port_data.target is not None, "Invalid port format, aborting."
-
-                        if type(port_data.published) is str or type(port_data.published) is int:
-                            host_port = str(port_data.published)
-
-                        if type(port_data.target) is int:
-                            container_port = str(port_data.target)
-
-                        host_ip = port_data.host_ip
-                        protocol = port_data.protocol
-                        app_protocol = port_data.app_protocol
-
-                        if container_port is not None and host_port is None:
                                 host_port = container_port
 
-                        if host_ip is not None:
+                            if port_data.get("host_ip"):
+                                host_ip = str(port_data["host_ip"])
                                 host_port = f"{host_ip}:{host_port}"
                             else:
                                 host_port = f"0.0.0.0:{host_port}"
 
-                    assert host_port is not None, "Error while parsing port, aborting."
+                            if port_data.get("protocol"):
-                    assert container_port is not None, "Error while parsing port, aborting."
+                                protocol = Protocol[str(port_data["protocol"])]
 
-                    if protocol is None:
+                            assert host_port, "Error parsing port, aborting."
-                        protocol = "any"
-
-                    if app_protocol is None:
-                        app_protocol = "na"
 
+                            service_ports.append(
+                                Port(
+                                    host_port=host_port,
+                                    container_port=container_port,
+                                    protocol=protocol,
+                                )
+                            )
+
+                        long_syntax()
+                    elif type(port_data) is str:
+                        # ports that needs to parse using regex:
+                        #     - "3000"
+                        #     - "3000-3005"
+                        #     - "8000:8000"
+                        #     - "9090-9091:8080-8081"
+                        #     - "49100:22"
+                        #     - "127.0.0.1:8001:8001"
+                        #     - "127.0.0.1:5000-5010:5000-5010"
+                        #     - "6060:6060/udp"
+
+                        def short_syntax():
+                            assert type(port_data) is str
+                            regex = r"(?P<host_ip>\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}:)?((?P<host_port>\d+(\-\d+)?):)?((?P<container_port>\d+(\-\d+)?))?(/(?P<protocol>\w+))?"  # noqa: E501
+                            match = re.match(regex, port_data)
+                            if match:
+                                host_ip: Optional[str] = match.group("host_ip")
+                                host_port: Optional[str] = match.group("host_port")
+                                container_port: Optional[str] = match.group("container_port")
+                                protocol: Optional[str] = match.group("protocol")
+
+                                assert container_port, "Invalid port format, aborting."
+
+                                if container_port and not host_port:
+                                    host_port = container_port
+
+                                if host_ip:
+                                    host_port = f"{host_ip}{host_port}"
+                                else:
+                                    host_port = f"0.0.0.0:{host_port}"
+
+                                assert host_port, "Error while parsing port, aborting."
+
+                                if protocol:
                                     service_ports.append(
                                         Port(
                                             host_port=host_port,
                                             container_port=container_port,
                                             protocol=Protocol[protocol],
-                            app_protocol=AppProtocol[app_protocol],
                                         )
                                     )
+                                else:
+                                    service_ports.append(
+                                        Port(
+                                            host_port=host_port,
+                                            container_port=container_port,
+                                        )
+                                    )
+
+                        short_syntax()
 
             service_depends_on: List[str] = []
-            if service_data.depends_on is not None:
+            if service.get("depends_on"):
-                service_depends_on = Parser._unwrap_depends_on(service_data.depends_on)
+                if type(service["depends_on"]) is list:
+                    for depends_on in service["depends_on"]:
+                        service_depends_on.append(str(depends_on))
+                elif type(service["depends_on"]) is dict:
+                    service_depends_on = list(service["depends_on"].keys())
 
             service_volumes: List[Volume] = []
-            if service_data.volumes is not None:
+            if service.get("volumes"):
-                for volume_data in service_data.volumes:
+                assert type(service["volumes"]) is list
-                    if type(volume_data) is str:
+                for volume_data in service["volumes"]:
+                    if type(volume_data) is dict:
+                        assert volume_data["source"] and volume_data["target"], "Invalid volume input, aborting."
+
+                        volume_source: str = str(volume_data["source"])
+                        volume_target: str = str(volume_data["target"])
+                        volume_type: VolumeType = VolumeType.volume
+
+                        if volume_data.get("type"):
+                            volume_type = VolumeType[str(volume_data["type"])]
+
+                        service_volumes.append(Volume(source=volume_source, target=volume_target, type=volume_type))
+                    elif type(volume_data) is str:
                         assert ":" in volume_data, "Invalid volume input, aborting."
 
                         spilt_data = volume_data.split(":")
@@ -179,82 +197,12 @@ class Parser:
                             service_volumes.append(Volume(source=spilt_data[0], target=spilt_data[1]))
                         elif len(spilt_data) == 3:
                             service_volumes.append(
-                                Volume(
+                                Volume(source=spilt_data[0], target=spilt_data[1], access_mode=spilt_data[2])
-                                    source=spilt_data[0],
-                                    target=spilt_data[1],
-                                    access_mode=spilt_data[2],
-                                )
-                            )
-                    elif type(volume_data) is spec.Volumes:
-                        assert volume_data.target is not None, "Invalid volume input, aborting."
-
-                        # https://github.com/compose-spec/compose-spec/blob/master/spec.md#long-syntax-4
-                        # `volume_data.source` is not applicable for a tmpfs mount.
-                        if volume_data.source is None:
-                            volume_data.source = volume_data.target
-
-                        assert volume_data.source is not None
-
-                        service_volumes.append(
-                            Volume(
-                                source=volume_data.source,
-                                target=volume_data.target,
-                                type=VolumeType[volume_data.type],
-                            )
                             )
 
             service_links: List[str] = []
-            if service_data.links is not None:
+            if service.get("links"):
-                service_links = service_data.links
+                service_links = service["links"]
-
-            cgroup_parent: Optional[str] = None
-            if service_data.cgroup_parent is not None:
-                cgroup_parent = service_data.cgroup_parent
-
-            container_name: Optional[str] = None
-            if service_data.container_name is not None:
-                container_name = service_data.container_name
-
-            env_file: List[str] = []
-            if service_data.env_file is not None:
-                if type(service_data.env_file.root) is str:
-                    env_file = [service_data.env_file.root]
-                elif type(service_data.env_file.root) is list:
-                    for env_file_data in service_data.env_file.root:
-                        if type(env_file_data) is str:
-                            env_file.append(env_file_data)
-                        elif type(env_file_data) is spec.EnvFilePath:
-                            env_file.append(env_file_data.path)
-                else:
-                    print(f"Invalid env_file data: {service_data.env_file.root}")
-
-            expose: List[str] = []
-            if service_data.expose is not None:
-                for port in service_data.expose:
-                    expose.append(str(port))
-
-            profiles: List[str] = []
-            if service_data.profiles is not None:
-                if type(service_data.profiles) is spec.ListOfStrings:
-                    profiles = service_data.profiles.root
-
-            devices: List[Device] = []
-            if service_data.devices is not None:
-                for device_data in service_data.devices:
-                    if type(device_data) is str:
-                        assert ":" in device_data, "Invalid volume input, aborting."
-
-                        spilt_data = device_data.split(":")
-                        if len(spilt_data) == 2:
-                            devices.append(Device(host_path=spilt_data[0], container_path=spilt_data[1]))
-                        elif len(spilt_data) == 3:
-                            devices.append(
-                                Device(
-                                    host_path=spilt_data[0],
-                                    container_path=spilt_data[1],
-                                    cgroup_permissions=spilt_data[2],
-                                )
-                            )
 
             services.append(
                 Service(
@@ -266,13 +214,16 @@ class Parser:
                     depends_on=service_depends_on,
                     volumes=service_volumes,
                     links=service_links,
-                    cgroup_parent=cgroup_parent,
-                    container_name=container_name,
-                    env_file=env_file,
-                    expose=expose,
-                    profiles=profiles,
-                    devices=devices,
                 )
             )
+            # Service print debug
+            # print("--------------------")
+            # print("Service name: {}".format(service_name))
+            # print("image: {}".format(service_image))
+            # print("networks: {}".format(service_networks))
+            # print("image: {}".format(service_image))
+            # print("extends: {}".format(service_extends))
+            # print("ports: {}".format(service_ports))
+            # print("depends: {}".format(service_depends_on))
 
-        return Compose(services=services)
+        return services

compose_viz/port.py

@@ -0,0 +1,26 @@
+from enum import Enum
+
+
+class Protocol(str, Enum):
+    tcp = "tcp"
+    udp = "udp"
+    any = "any"
+
+
+class Port:
+    def __init__(self, host_port: str, container_port: str, protocol: Protocol = Protocol.any):
+        self._host_port = host_port
+        self._container_port = container_port
+        self._protocol = protocol
+
+    @property
+    def host_port(self):
+        return self._host_port
+
+    @property
+    def container_port(self):
+        return self._container_port
+
+    @property
+    def protocol(self):
+        return self._protocol

compose_viz/service.py

@@ -1,9 +1,8 @@
 from typing import List, Optional
 
-from compose_viz.models.device import Device
+from compose_viz.extends import Extends
-from compose_viz.models.extends import Extends
+from compose_viz.port import Port
-from compose_viz.models.port import Port
+from compose_viz.volume import Volume
-from compose_viz.models.volume import Volume
 
 
 class Service:
@@ -17,12 +16,6 @@ class Service:
         depends_on: List[str] = [],
         links: List[str] = [],
         extends: Optional[Extends] = None,
-        cgroup_parent: Optional[str] = None,
-        container_name: Optional[str] = None,
-        devices: List[Device] = [],
-        env_file: List[str] = [],
-        expose: List[str] = [],
-        profiles: List[str] = [],
     ) -> None:
         self._name = name
         self._image = image
@@ -32,12 +25,6 @@ class Service:
         self._depends_on = depends_on
         self._links = links
         self._extends = extends
-        self._cgroup_parent = cgroup_parent
-        self._container_name = container_name
-        self._devices = devices
-        self._env_file = env_file
-        self._expose = expose
-        self._profiles = profiles
 
     @property
     def name(self):
@@ -70,27 +57,3 @@ class Service:
     @property
     def extends(self):
         return self._extends
-
-    @property
-    def cgroup_parent(self):
-        return self._cgroup_parent
-
-    @property
-    def container_name(self):
-        return self._container_name
-
-    @property
-    def devices(self):
-        return self._devices
-
-    @property
-    def env_file(self):
-        return self._env_file
-
-    @property
-    def expose(self):
-        return self._expose
-
-    @property
-    def profiles(self):
-        return self._profiles

compose_viz/spec/compose_spec.py

@@ -1,620 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  compose-spec.json
-#   timestamp: 2024-04-27T08:31:04+00:00
-
-from __future__ import annotations
-
-from enum import Enum
-from typing import Any, Dict, List, Optional, Union
-
-from pydantic import BaseModel, ConfigDict, Field, RootModel
-
-
-class Cgroup(Enum):
-    host = "host"
-    private = "private"
-
-
-class CredentialSpec(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    config: Optional[str] = None
-    file: Optional[str] = None
-    registry: Optional[str] = None
-
-
-class Condition(Enum):
-    service_started = "service_started"
-    service_healthy = "service_healthy"
-    service_completed_successfully = "service_completed_successfully"
-
-
-class DependsOn(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    restart: Optional[bool] = None
-    required: Optional[bool] = True
-    condition: Condition
-
-
-class Extends(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    service: str
-    file: Optional[str] = None
-
-
-class Logging(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    driver: Optional[str] = None
-    options: Optional[Dict[str, Optional[Union[str, float]]]] = None
-
-
-class Ports(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    name: Optional[str] = None
-    mode: Optional[str] = None
-    host_ip: Optional[str] = None
-    target: Optional[int] = None
-    published: Optional[Union[str, int]] = None
-    protocol: Optional[str] = None
-    app_protocol: Optional[str] = None
-
-
-class PullPolicy(Enum):
-    always = "always"
-    never = "never"
-    if_not_present = "if_not_present"
-    build = "build"
-    missing = "missing"
-
-
-class Selinux(Enum):
-    z = "z"
-    Z = "Z"
-
-
-class Bind(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    propagation: Optional[str] = None
-    create_host_path: Optional[bool] = None
-    selinux: Optional[Selinux] = None
-
-
-class AdditionalVolumeOption(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    nocopy: Optional[bool] = None
-    subpath: Optional[str] = None
-
-
-class Size(RootModel[int]):
-    root: int = Field(..., ge=0)
-
-
-class Tmpfs(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    size: Optional[Union[Size, str]] = None
-    mode: Optional[float] = None
-
-
-class Volumes(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    type: str
-    source: Optional[str] = None
-    target: Optional[str] = None
-    read_only: Optional[bool] = None
-    consistency: Optional[str] = None
-    bind: Optional[Bind] = None
-    volume: Optional[AdditionalVolumeOption] = None
-    tmpfs: Optional[Tmpfs] = None
-
-
-class Healthcheck(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    disable: Optional[bool] = None
-    interval: Optional[str] = None
-    retries: Optional[float] = None
-    test: Optional[Union[str, List[str]]] = None
-    timeout: Optional[str] = None
-    start_period: Optional[str] = None
-    start_interval: Optional[str] = None
-
-
-class Action(Enum):
-    rebuild = "rebuild"
-    sync = "sync"
-    sync_restart = "sync+restart"
-
-
-class WatchItem(BaseModel):
-    ignore: Optional[List[str]] = None
-    path: str
-    action: Action
-    target: Optional[str] = None
-
-
-class Development(BaseModel):
-    watch: Optional[List[WatchItem]] = None
-
-
-class Order(Enum):
-    start_first = "start-first"
-    stop_first = "stop-first"
-
-
-class RollbackConfig(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    parallelism: Optional[int] = None
-    delay: Optional[str] = None
-    failure_action: Optional[str] = None
-    monitor: Optional[str] = None
-    max_failure_ratio: Optional[float] = None
-    order: Optional[Order] = None
-
-
-class UpdateConfig(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    parallelism: Optional[int] = None
-    delay: Optional[str] = None
-    failure_action: Optional[str] = None
-    monitor: Optional[str] = None
-    max_failure_ratio: Optional[float] = None
-    order: Optional[Order] = None
-
-
-class Limits(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    cpus: Optional[Union[float, str]] = None
-    memory: Optional[str] = None
-    pids: Optional[int] = None
-
-
-class RestartPolicy(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    condition: Optional[str] = None
-    delay: Optional[str] = None
-    max_attempts: Optional[int] = None
-    window: Optional[str] = None
-
-
-class Preference(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    spread: Optional[str] = None
-
-
-class Placement(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    constraints: Optional[List[str]] = None
-    preferences: Optional[List[Preference]] = None
-    max_replicas_per_node: Optional[int] = None
-
-
-class DiscreteResourceSpec(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    kind: Optional[str] = None
-    value: Optional[float] = None
-
-
-class GenericResource(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    discrete_resource_spec: Optional[DiscreteResourceSpec] = None
-
-
-class GenericResources(RootModel[List[GenericResource]]):
-    root: List[GenericResource]
-
-
-class ConfigItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    subnet: Optional[str] = None
-    ip_range: Optional[str] = None
-    gateway: Optional[str] = None
-    aux_addresses: Optional[Dict[str, str]] = None
-
-
-class Ipam(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    driver: Optional[str] = None
-    config: Optional[List[ConfigItem]] = None
-    options: Optional[Dict[str, str]] = None
-
-
-class ExternalVolumeNetwork(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    name: Optional[str] = None
-
-
-class ExternalConfig(BaseModel):
-    name: Optional[str] = None
-
-
-class Command(RootModel[Optional[Union[str, List[str]]]]):
-    root: Optional[Union[str, List[str]]]
-
-
-class EnvFilePath(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    path: str
-    required: Optional[bool] = True
-
-
-class EnvFile(RootModel[Union[str, List[Union[str, EnvFilePath]]]]):
-    root: Union[str, List[Union[str, EnvFilePath]]]
-
-
-class ListOfStrings(RootModel[List[str]]):
-    root: List[str]
-
-
-class ListOrDict1(RootModel[List[Any]]):
-    root: List[Any]
-
-
-class ListOrDict(RootModel[Union[Dict[str, Optional[Union[str, float, bool]]], ListOrDict1]]):
-    root: Union[Dict[str, Optional[Union[str, float, bool]]], ListOrDict1]
-
-
-class BlkioLimit(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    path: Optional[str] = None
-    rate: Optional[Union[int, str]] = None
-
-
-class BlkioWeight(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    path: Optional[str] = None
-    weight: Optional[int] = None
-
-
-class ServiceConfigOrSecret1(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    source: Optional[str] = None
-    target: Optional[str] = None
-    uid: Optional[str] = None
-    gid: Optional[str] = None
-    mode: Optional[float] = None
-
-
-class ServiceConfigOrSecret(RootModel[List[Union[str, ServiceConfigOrSecret1]]]):
-    root: List[Union[str, ServiceConfigOrSecret1]]
-
-
-class Ulimits1(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    hard: int
-    soft: int
-
-
-class Ulimits(RootModel[Dict[str, Union[int, Ulimits1]]]):
-    root: Dict[str, Union[int, Ulimits1]]
-
-
-class Constraints(RootModel[Any]):
-    root: Any
-
-
-class Build(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    context: Optional[str] = None
-    dockerfile: Optional[str] = None
-    dockerfile_inline: Optional[str] = None
-    entitlements: Optional[List[str]] = None
-    args: Optional[ListOrDict] = None
-    ssh: Optional[ListOrDict] = None
-    labels: Optional[ListOrDict] = None
-    cache_from: Optional[List[str]] = None
-    cache_to: Optional[List[str]] = None
-    no_cache: Optional[bool] = None
-    additional_contexts: Optional[ListOrDict] = None
-    network: Optional[str] = None
-    pull: Optional[bool] = None
-    target: Optional[str] = None
-    shm_size: Optional[Union[int, str]] = None
-    extra_hosts: Optional[ListOrDict] = None
-    isolation: Optional[str] = None
-    privileged: Optional[bool] = None
-    secrets: Optional[ServiceConfigOrSecret] = None
-    tags: Optional[List[str]] = None
-    ulimits: Optional[Ulimits] = None
-    platforms: Optional[List[str]] = None
-
-
-class BlkioConfig(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    device_read_bps: Optional[List[BlkioLimit]] = None
-    device_read_iops: Optional[List[BlkioLimit]] = None
-    device_write_bps: Optional[List[BlkioLimit]] = None
-    device_write_iops: Optional[List[BlkioLimit]] = None
-    weight: Optional[int] = None
-    weight_device: Optional[List[BlkioWeight]] = None
-
-
-class Networks(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    aliases: Optional[ListOfStrings] = None
-    ipv4_address: Optional[str] = None
-    ipv6_address: Optional[str] = None
-    link_local_ips: Optional[ListOfStrings] = None
-    mac_address: Optional[str] = None
-    priority: Optional[float] = None
-
-
-class Device(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    capabilities: Optional[ListOfStrings] = None
-    count: Optional[Union[str, int]] = None
-    device_ids: Optional[ListOfStrings] = None
-    driver: Optional[str] = None
-    options: Optional[ListOrDict] = None
-
-
-class Devices(RootModel[List[Device]]):
-    root: List[Device]
-
-
-class Network(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    name: Optional[str] = None
-    driver: Optional[str] = None
-    driver_opts: Optional[Dict[str, Union[str, float]]] = None
-    ipam: Optional[Ipam] = None
-    external: Optional[ExternalVolumeNetwork] = None
-    internal: Optional[bool] = None
-    enable_ipv6: Optional[bool] = None
-    attachable: Optional[bool] = None
-    labels: Optional[ListOrDict] = None
-
-
-class Volume(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    name: Optional[str] = None
-    driver: Optional[str] = None
-    driver_opts: Optional[Dict[str, Union[str, float]]] = None
-    external: Optional[ExternalVolumeNetwork] = None
-    labels: Optional[ListOrDict] = None
-
-
-class Secret(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    name: Optional[str] = None
-    environment: Optional[str] = None
-    file: Optional[str] = None
-    external: Optional[ExternalConfig] = None
-    labels: Optional[ListOrDict] = None
-    driver: Optional[str] = None
-    driver_opts: Optional[Dict[str, Union[str, float]]] = None
-    template_driver: Optional[str] = None
-
-
-class Config(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    name: Optional[str] = None
-    content: Optional[str] = None
-    environment: Optional[str] = None
-    file: Optional[str] = None
-    external: Optional[ExternalConfig] = None
-    labels: Optional[ListOrDict] = None
-    template_driver: Optional[str] = None
-
-
-class StringOrList(RootModel[Union[str, ListOfStrings]]):
-    root: Union[str, ListOfStrings]
-
-
-class Reservations(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    cpus: Optional[Union[float, str]] = None
-    memory: Optional[str] = None
-    generic_resources: Optional[GenericResources] = None
-    devices: Optional[Devices] = None
-
-
-class Resources(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    limits: Optional[Limits] = None
-    reservations: Optional[Reservations] = None
-
-
-class Deployment(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    mode: Optional[str] = None
-    endpoint_mode: Optional[str] = None
-    replicas: Optional[int] = None
-    labels: Optional[ListOrDict] = None
-    rollback_config: Optional[RollbackConfig] = None
-    update_config: Optional[UpdateConfig] = None
-    resources: Optional[Resources] = None
-    restart_policy: Optional[RestartPolicy] = None
-    placement: Optional[Placement] = None
-
-
-class Include1(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    path: Optional[StringOrList] = None
-    env_file: Optional[StringOrList] = None
-    project_directory: Optional[str] = None
-
-
-class Include(RootModel[Union[str, Include1]]):
-    root: Union[str, Include1]
-
-
-class Service(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    develop: Optional[Development] = None
-    deploy: Optional[Deployment] = None
-    annotations: Optional[ListOrDict] = None
-    attach: Optional[bool] = None
-    build: Optional[Union[str, Build]] = None
-    blkio_config: Optional[BlkioConfig] = None
-    cap_add: Optional[List[str]] = None
-    cap_drop: Optional[List[str]] = None
-    cgroup: Optional[Cgroup] = None
-    cgroup_parent: Optional[str] = None
-    command: Optional[Command] = None
-    configs: Optional[ServiceConfigOrSecret] = None
-    container_name: Optional[str] = None
-    cpu_count: Optional[int] = Field(None, ge=0)
-    cpu_percent: Optional[int] = Field(None, ge=0, le=100)
-    cpu_shares: Optional[Union[float, str]] = None
-    cpu_quota: Optional[Union[float, str]] = None
-    cpu_period: Optional[Union[float, str]] = None
-    cpu_rt_period: Optional[Union[float, str]] = None
-    cpu_rt_runtime: Optional[Union[float, str]] = None
-    cpus: Optional[Union[float, str]] = None
-    cpuset: Optional[str] = None
-    credential_spec: Optional[CredentialSpec] = None
-    depends_on: Optional[Union[ListOfStrings, Dict[str, DependsOn]]] = None
-    device_cgroup_rules: Optional[ListOfStrings] = None
-    devices: Optional[List[str]] = None
-    dns: Optional[StringOrList] = None
-    dns_opt: Optional[List[str]] = None
-    dns_search: Optional[StringOrList] = None
-    domainname: Optional[str] = None
-    entrypoint: Optional[Command] = None
-    env_file: Optional[EnvFile] = None
-    environment: Optional[ListOrDict] = None
-    expose: Optional[List[Union[str, float]]] = None
-    extends: Optional[Union[str, Extends]] = None
-    external_links: Optional[List[str]] = None
-    extra_hosts: Optional[ListOrDict] = None
-    group_add: Optional[List[Union[str, float]]] = None
-    healthcheck: Optional[Healthcheck] = None
-    hostname: Optional[str] = None
-    image: Optional[str] = None
-    init: Optional[bool] = None
-    ipc: Optional[str] = None
-    isolation: Optional[str] = None
-    labels: Optional[ListOrDict] = None
-    links: Optional[List[str]] = None
-    logging: Optional[Logging] = None
-    mac_address: Optional[str] = None
-    mem_limit: Optional[Union[float, str]] = None
-    mem_reservation: Optional[Union[str, int]] = None
-    mem_swappiness: Optional[int] = None
-    memswap_limit: Optional[Union[float, str]] = None
-    network_mode: Optional[str] = None
-    networks: Optional[Union[ListOfStrings, Dict[str, Optional[Networks]]]] = None
-    oom_kill_disable: Optional[bool] = None
-    oom_score_adj: Optional[int] = Field(None, ge=-1000, le=1000)
-    pid: Optional[str] = None
-    pids_limit: Optional[Union[float, str]] = None
-    platform: Optional[str] = None
-    ports: Optional[List[Union[float, str, Ports]]] = None
-    privileged: Optional[bool] = None
-    profiles: Optional[ListOfStrings] = None
-    pull_policy: Optional[PullPolicy] = None
-    read_only: Optional[bool] = None
-    restart: Optional[str] = None
-    runtime: Optional[str] = None
-    scale: Optional[int] = None
-    security_opt: Optional[List[str]] = None
-    shm_size: Optional[Union[float, str]] = None
-    secrets: Optional[ServiceConfigOrSecret] = None
-    sysctls: Optional[ListOrDict] = None
-    stdin_open: Optional[bool] = None
-    stop_grace_period: Optional[str] = None
-    stop_signal: Optional[str] = None
-    storage_opt: Optional[Dict[str, Any]] = None
-    tmpfs: Optional[StringOrList] = None
-    tty: Optional[bool] = None
-    ulimits: Optional[Ulimits] = None
-    user: Optional[str] = None
-    uts: Optional[str] = None
-    userns_mode: Optional[str] = None
-    volumes: Optional[List[Union[str, Volumes]]] = None
-    volumes_from: Optional[List[str]] = None
-    working_dir: Optional[str] = None
-
-
-class ComposeSpecification(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    version: Optional[str] = Field(None, description="declared for backward compatibility, ignored.")
-    name: Optional[str] = Field(
-        None,
-        description="define the Compose project name, until user defines one explicitly.",
-        pattern="^[a-z0-9][a-z0-9_-]*$",
-    )
-    include: Optional[List[Include]] = Field(None, description="compose sub-projects to be included.")
-    services: Optional[Dict[str, Service]] = None
-    networks: Optional[Dict[str, Optional[Network]]] = None
-    volumes: Optional[Dict[str, Optional[Volume]]] = None
-    secrets: Optional[Dict[str, Secret]] = None
-    configs: Optional[Dict[str, Config]] = None

examples/non-normative/docker-compose.yml

@@ -6,19 +6,10 @@ services:
       - back-tier
 
   monitoring:
-    env_file:
-        - a.env
-        - b.env
-    container_name: monitoring-server
     image: awesome/monitoring
     networks:
       - admin
-    expose:
+
-      - 1234
-    profiles:
-      - tools
-      - foo
-    cgroup_parent: awesome-parent
 
   backend:
     networks:
@@ -42,23 +33,11 @@ services:
     extends:
       service: frontend
     ports:
-      - name: web-secured
+      - "8000:5010"
-        target: 443
-        host_ip: 127.0.0.1
-        published: "8083-9000"
-        protocol: tcp
-        app_protocol: wbsock
-        mode : host
     links:
       - "db:database"
-    cgroup_parent: awesome-parent
   db:
     image: postgres
-    profiles:
-      - foo
-    devices:
-      - "/dev/ttyUSB2:/dev/ttyUSB3"
-      - "/dev/sda:/dev/xvda:rwm"
 
 networks:
   front-tier:

examples/voting-app/compose-viz.svg

@@ -1,208 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
- "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 3.0.0 (20220226.1711)
- -->
-<!-- Pages: 1 -->
-<svg width="1049pt" height="520pt"
- viewBox="0.00 0.00 1049.25 519.98" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(36 483.98)">
-<polygon fill="white" stroke="transparent" points="-36,36 -36,-483.98 1013.25,-483.98 1013.25,36 -36,36"/>
-<!-- redis -->
-<g id="node1" class="node">
-<title>redis</title>
-<polygon fill="none" stroke="black" points="243.25,-125 155.25,-125 155.25,-121 151.25,-121 151.25,-117 155.25,-117 155.25,-95 151.25,-95 151.25,-91 155.25,-91 155.25,-87 243.25,-87 243.25,-125"/>
-<polyline fill="none" stroke="black" points="155.25,-121 159.25,-121 159.25,-117 155.25,-117 "/>
-<polyline fill="none" stroke="black" points="155.25,-95 159.25,-95 159.25,-91 155.25,-91 "/>
-<text text-anchor="middle" x="199.25" y="-109.8" font-family="Times New Roman,serif" font-size="14.00">redis</text>
-<text text-anchor="middle" x="199.25" y="-94.8" font-family="Times New Roman,serif" font-size="14.00">(redis:alpine)</text>
-</g>
-<!-- frontend -->
-<g id="node2" class="node">
-<title>frontend</title>
-<polygon fill="none" stroke="black" points="338.11,-23.56 271.25,-36 204.38,-23.56 229.92,-3.44 312.57,-3.44 338.11,-23.56"/>
-<text text-anchor="middle" x="271.25" y="-14.3" font-family="Times New Roman,serif" font-size="14.00">net:frontend</text>
-</g>
-<!-- redis&#45;&gt;frontend -->
-<g id="edge1" class="edge">
-<title>redis&#45;&gt;frontend</title>
-<path fill="none" stroke="black" d="M214.51,-86.76C225.56,-73.57 240.55,-55.67 252.34,-41.58"/>
-<polygon fill="black" stroke="black" points="255.13,-43.7 258.87,-33.78 249.76,-39.2 255.13,-43.7"/>
-</g>
-<!-- 0.0.0.06379 -->
-<g id="node3" class="node">
-<title>0.0.0.06379</title>
-<ellipse fill="none" stroke="black" cx="55.25" cy="-231.25" rx="55.49" ry="55.49"/>
-<text text-anchor="middle" x="55.25" y="-227.55" font-family="Times New Roman,serif" font-size="14.00">0.0.0.0:6379</text>
-</g>
-<!-- 0.0.0.06379&#45;&gt;redis -->
-<g id="edge2" class="edge">
-<title>0.0.0.06379&#45;&gt;redis</title>
-<path fill="none" stroke="black" d="M96.9,-194.6C120.47,-174.43 149.35,-149.71 170.41,-131.68"/>
-<polygon fill="black" stroke="black" points="172.75,-134.28 178.07,-125.12 168.2,-128.96 172.75,-134.28"/>
-<text text-anchor="middle" x="171.25" y="-146.8" font-family="Times New Roman,serif" font-size="14.00">6379</text>
-</g>
-<!-- db -->
-<g id="node4" class="node">
-<title>db</title>
-<polygon fill="none" stroke="black" points="711.25,-125 617.25,-125 617.25,-121 613.25,-121 613.25,-117 617.25,-117 617.25,-95 613.25,-95 613.25,-91 617.25,-91 617.25,-87 711.25,-87 711.25,-125"/>
-<polyline fill="none" stroke="black" points="617.25,-121 621.25,-121 621.25,-117 617.25,-117 "/>
-<polyline fill="none" stroke="black" points="617.25,-95 621.25,-95 621.25,-91 617.25,-91 "/>
-<text text-anchor="middle" x="664.25" y="-109.8" font-family="Times New Roman,serif" font-size="14.00">db</text>
-<text text-anchor="middle" x="664.25" y="-94.8" font-family="Times New Roman,serif" font-size="14.00">(postgres:9.4)</text>
-</g>
-<!-- backend -->
-<g id="node5" class="node">
-<title>backend</title>
-<polygon fill="none" stroke="black" points="624.11,-23.56 557.25,-36 490.38,-23.56 515.92,-3.44 598.57,-3.44 624.11,-23.56"/>
-<text text-anchor="middle" x="557.25" y="-14.3" font-family="Times New Roman,serif" font-size="14.00">net:backend</text>
-</g>
-<!-- db&#45;&gt;backend -->
-<g id="edge3" class="edge">
-<title>db&#45;&gt;backend</title>
-<path fill="none" stroke="black" d="M642.99,-86.82C631.36,-76.97 616.63,-64.67 603.25,-54 597.1,-49.1 590.4,-43.91 584.07,-39.08"/>
-<polygon fill="black" stroke="black" points="585.83,-36.03 575.75,-32.77 581.6,-41.6 585.83,-36.03"/>
-</g>
-<!-- db&#45;data -->
-<g id="node6" class="node">
-<title>db&#45;data</title>
-<path fill="none" stroke="black" d="M700.75,-32.73C700.75,-34.53 687.52,-36 671.25,-36 654.97,-36 641.75,-34.53 641.75,-32.73 641.75,-32.73 641.75,-3.27 641.75,-3.27 641.75,-1.47 654.97,0 671.25,0 687.52,0 700.75,-1.47 700.75,-3.27 700.75,-3.27 700.75,-32.73 700.75,-32.73"/>
-<path fill="none" stroke="black" d="M700.75,-32.73C700.75,-30.92 687.52,-29.45 671.25,-29.45 654.97,-29.45 641.75,-30.92 641.75,-32.73"/>
-<text text-anchor="middle" x="671.25" y="-14.3" font-family="Times New Roman,serif" font-size="14.00">db&#45;data</text>
-</g>
-<!-- db&#45;&gt;db&#45;data -->
-<g id="edge4" class="edge">
-<title>db&#45;&gt;db&#45;data</title>
-<path fill="none" stroke="black" stroke-dasharray="5,2" d="M666.56,-76.58C667.35,-66.83 668.24,-55.95 669.02,-46.3"/>
-<polygon fill="black" stroke="black" points="663.05,-76.51 665.73,-86.76 670.03,-77.08 663.05,-76.51"/>
-<polygon fill="black" stroke="black" points="672.54,-46.29 669.86,-36.04 665.56,-45.73 672.54,-46.29"/>
-<text text-anchor="middle" x="733.25" y="-57.8" font-family="Times New Roman,serif" font-size="14.00">/var/lib/postgresql/data</text>
-</g>
-<!-- vote -->
-<g id="node7" class="node">
-<title>vote</title>
-<polygon fill="none" stroke="black" points="413.75,-250.25 128.75,-250.25 128.75,-246.25 124.75,-246.25 124.75,-242.25 128.75,-242.25 128.75,-220.25 124.75,-220.25 124.75,-216.25 128.75,-216.25 128.75,-212.25 413.75,-212.25 413.75,-250.25"/>
-<polyline fill="none" stroke="black" points="128.75,-246.25 132.75,-246.25 132.75,-242.25 128.75,-242.25 "/>
-<polyline fill="none" stroke="black" points="128.75,-220.25 132.75,-220.25 132.75,-216.25 128.75,-216.25 "/>
-<text text-anchor="middle" x="271.25" y="-235.05" font-family="Times New Roman,serif" font-size="14.00">vote</text>
-<text text-anchor="middle" x="271.25" y="-220.05" font-family="Times New Roman,serif" font-size="14.00">(dockersamples/examplevotingapp_vote:before)</text>
-</g>
-<!-- vote&#45;&gt;redis -->
-<g id="edge7" class="edge">
-<title>vote&#45;&gt;redis</title>
-<path fill="none" stroke="black" stroke-dasharray="1,5" d="M260.62,-212.06C248.6,-191.49 228.91,-157.78 215.08,-134.1"/>
-<polygon fill="black" stroke="black" points="217.98,-132.13 209.91,-125.26 211.93,-135.66 217.98,-132.13"/>
-</g>
-<!-- vote&#45;&gt;frontend -->
-<g id="edge5" class="edge">
-<title>vote&#45;&gt;frontend</title>
-<path fill="none" stroke="black" d="M271.25,-212.23C271.25,-175.17 271.25,-90.15 271.25,-46.29"/>
-<polygon fill="black" stroke="black" points="274.75,-46.08 271.25,-36.08 267.75,-46.08 274.75,-46.08"/>
-</g>
-<!-- 0.0.0.05000 -->
-<g id="node8" class="node">
-<title>0.0.0.05000</title>
-<ellipse fill="none" stroke="black" cx="271.25" cy="-392.74" rx="55.49" ry="55.49"/>
-<text text-anchor="middle" x="271.25" y="-389.04" font-family="Times New Roman,serif" font-size="14.00">0.0.0.0:5000</text>
-</g>
-<!-- 0.0.0.05000&#45;&gt;vote -->
-<g id="edge6" class="edge">
-<title>0.0.0.05000&#45;&gt;vote</title>
-<path fill="none" stroke="black" d="M271.25,-337.29C271.25,-311.63 271.25,-282.06 271.25,-260.85"/>
-<polygon fill="black" stroke="black" points="274.75,-260.58 271.25,-250.58 267.75,-260.58 274.75,-260.58"/>
-<text text-anchor="middle" x="278.25" y="-308.29" font-family="Times New Roman,serif" font-size="14.00">80</text>
-</g>
-<!-- result -->
-<g id="node9" class="node">
-<title>result</title>
-<polygon fill="none" stroke="black" points="759.75,-250.25 468.75,-250.25 468.75,-246.25 464.75,-246.25 464.75,-242.25 468.75,-242.25 468.75,-220.25 464.75,-220.25 464.75,-216.25 468.75,-216.25 468.75,-212.25 759.75,-212.25 759.75,-250.25"/>
-<polyline fill="none" stroke="black" points="468.75,-246.25 472.75,-246.25 472.75,-242.25 468.75,-242.25 "/>
-<polyline fill="none" stroke="black" points="468.75,-220.25 472.75,-220.25 472.75,-216.25 468.75,-216.25 "/>
-<text text-anchor="middle" x="614.25" y="-235.05" font-family="Times New Roman,serif" font-size="14.00">result</text>
-<text text-anchor="middle" x="614.25" y="-220.05" font-family="Times New Roman,serif" font-size="14.00">(dockersamples/examplevotingapp_result:before)</text>
-</g>
-<!-- result&#45;&gt;db -->
-<g id="edge10" class="edge">
-<title>result&#45;&gt;db</title>
-<path fill="none" stroke="black" stroke-dasharray="1,5" d="M621.62,-212.06C629.89,-191.67 643.4,-158.37 652.99,-134.73"/>
-<polygon fill="black" stroke="black" points="656.32,-135.84 656.84,-125.26 649.83,-133.21 656.32,-135.84"/>
-</g>
-<!-- result&#45;&gt;backend -->
-<g id="edge8" class="edge">
-<title>result&#45;&gt;backend</title>
-<path fill="none" stroke="black" d="M609.39,-212.23C599.29,-174.81 576,-88.52 564.27,-45.04"/>
-<polygon fill="black" stroke="black" points="567.6,-43.95 561.62,-35.21 560.84,-45.78 567.6,-43.95"/>
-</g>
-<!-- 0.0.0.05001 -->
-<g id="node10" class="node">
-<title>0.0.0.05001</title>
-<ellipse fill="none" stroke="black" cx="614.25" cy="-392.74" rx="55.49" ry="55.49"/>
-<text text-anchor="middle" x="614.25" y="-389.04" font-family="Times New Roman,serif" font-size="14.00">0.0.0.0:5001</text>
-</g>
-<!-- 0.0.0.05001&#45;&gt;result -->
-<g id="edge9" class="edge">
-<title>0.0.0.05001&#45;&gt;result</title>
-<path fill="none" stroke="black" d="M614.25,-337.29C614.25,-311.63 614.25,-282.06 614.25,-260.85"/>
-<polygon fill="black" stroke="black" points="617.75,-260.58 614.25,-250.58 610.75,-260.58 617.75,-260.58"/>
-<text text-anchor="middle" x="621.25" y="-308.29" font-family="Times New Roman,serif" font-size="14.00">80</text>
-</g>
-<!-- worker -->
-<g id="node11" class="node">
-<title>worker</title>
-<polygon fill="none" stroke="black" points="560.75,-125 299.75,-125 299.75,-121 295.75,-121 295.75,-117 299.75,-117 299.75,-95 295.75,-95 295.75,-91 299.75,-91 299.75,-87 560.75,-87 560.75,-125"/>
-<polyline fill="none" stroke="black" points="299.75,-121 303.75,-121 303.75,-117 299.75,-117 "/>
-<polyline fill="none" stroke="black" points="299.75,-95 303.75,-95 303.75,-91 299.75,-91 "/>
-<text text-anchor="middle" x="430.25" y="-109.8" font-family="Times New Roman,serif" font-size="14.00">worker</text>
-<text text-anchor="middle" x="430.25" y="-94.8" font-family="Times New Roman,serif" font-size="14.00">(dockersamples/examplevotingapp_worker)</text>
-</g>
-<!-- worker&#45;&gt;frontend -->
-<g id="edge11" class="edge">
-<title>worker&#45;&gt;frontend</title>
-<path fill="none" stroke="black" d="M396.91,-86.97C369.54,-72.17 331,-51.32 303.84,-36.63"/>
-<polygon fill="black" stroke="black" points="305.2,-33.39 294.74,-31.71 301.87,-39.54 305.2,-33.39"/>
-</g>
-<!-- worker&#45;&gt;backend -->
-<g id="edge12" class="edge">
-<title>worker&#45;&gt;backend</title>
-<path fill="none" stroke="black" d="M456.87,-86.97C477.96,-72.69 507.37,-52.77 528.9,-38.19"/>
-<polygon fill="black" stroke="black" points="530.99,-41 537.31,-32.5 527.07,-35.21 530.99,-41"/>
-</g>
-<!-- visualizer -->
-<g id="node12" class="node">
-<title>visualizer</title>
-<polygon fill="none" stroke="black" points="942.25,-250.25 778.25,-250.25 778.25,-246.25 774.25,-246.25 774.25,-242.25 778.25,-242.25 778.25,-220.25 774.25,-220.25 774.25,-216.25 778.25,-216.25 778.25,-212.25 942.25,-212.25 942.25,-250.25"/>
-<polyline fill="none" stroke="black" points="778.25,-246.25 782.25,-246.25 782.25,-242.25 778.25,-242.25 "/>
-<polyline fill="none" stroke="black" points="778.25,-220.25 782.25,-220.25 782.25,-216.25 778.25,-216.25 "/>
-<text text-anchor="middle" x="860.25" y="-235.05" font-family="Times New Roman,serif" font-size="14.00">visualizer</text>
-<text text-anchor="middle" x="860.25" y="-220.05" font-family="Times New Roman,serif" font-size="14.00">(dockersamples/visualizer)</text>
-</g>
-<!-- /var/run/docker.sock -->
-<g id="node13" class="node">
-<title>/var/run/docker.sock</title>
-<path fill="none" stroke="black" d="M926.75,-120.73C926.75,-122.53 896.94,-124 860.25,-124 823.55,-124 793.75,-122.53 793.75,-120.73 793.75,-120.73 793.75,-91.27 793.75,-91.27 793.75,-89.47 823.55,-88 860.25,-88 896.94,-88 926.75,-89.47 926.75,-91.27 926.75,-91.27 926.75,-120.73 926.75,-120.73"/>
-<path fill="none" stroke="black" d="M926.75,-120.73C926.75,-118.92 896.94,-117.45 860.25,-117.45 823.55,-117.45 793.75,-118.92 793.75,-120.73"/>
-<text text-anchor="middle" x="860.25" y="-102.3" font-family="Times New Roman,serif" font-size="14.00">/var/run/docker.sock</text>
-</g>
-<!-- visualizer&#45;&gt;/var/run/docker.sock -->
-<g id="edge13" class="edge">
-<title>visualizer&#45;&gt;/var/run/docker.sock</title>
-<path fill="none" stroke="black" stroke-dasharray="5,2" d="M860.25,-201.78C860.25,-181.41 860.25,-154.15 860.25,-134.1"/>
-<polygon fill="black" stroke="black" points="856.75,-202.06 860.25,-212.06 863.75,-202.06 856.75,-202.06"/>
-<polygon fill="black" stroke="black" points="863.75,-134.07 860.25,-124.07 856.75,-134.07 863.75,-134.07"/>
-<text text-anchor="middle" x="918.75" y="-146.8" font-family="Times New Roman,serif" font-size="14.00">/var/run/docker.sock</text>
-</g>
-<!-- 0.0.0.08080 -->
-<g id="node14" class="node">
-<title>0.0.0.08080</title>
-<ellipse fill="none" stroke="black" cx="860.25" cy="-392.74" rx="55.49" ry="55.49"/>
-<text text-anchor="middle" x="860.25" y="-389.04" font-family="Times New Roman,serif" font-size="14.00">0.0.0.0:8080</text>
-</g>
-<!-- 0.0.0.08080&#45;&gt;visualizer -->
-<g id="edge14" class="edge">
-<title>0.0.0.08080&#45;&gt;visualizer</title>
-<path fill="none" stroke="black" d="M860.25,-337.29C860.25,-311.63 860.25,-282.06 860.25,-260.85"/>
-<polygon fill="black" stroke="black" points="863.75,-260.58 860.25,-250.58 856.75,-260.58 863.75,-260.58"/>
-<text text-anchor="middle" x="874.25" y="-308.29" font-family="Times New Roman,serif" font-size="14.00">8080</text>
-</g>
-</g>
-</svg>

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "compose-viz"
-version = "0.3.2"
+version = "0.1.1"
-description = "A compose file visualization tool that supports compose-spec and allows you to gernerate graph in several formats."
+description = "A compose file visualization tool that supports compose-spec and allows you to gernerate graph in DOT format or PNG."
 authors = ["Xyphuz Wu <xyphuzwu@gmail.com>"]
 readme = "README.md"
 license = "MIT"
@@ -14,15 +14,15 @@ include = [
 [tool.poetry.dependencies]
 python = "^3.9"
 typer = "^0.4.1"
+PyYAML = "^6.0"
 graphviz = "^0.20"
-pydantic-yaml = "^1.3.0"
+"ruamel.yaml" = "^0.17.21"
 
-[tool.poetry.group.dev.dependencies]
+[tool.poetry.dev-dependencies]
-pytest = "^8.1.2"
+pytest = "^7.1.2"
-pre-commit = "^3.7.0"
+pre-commit = "^2.19.0"
-coverage = "^7.5.0"
+coverage = "^6.3.3"
-pytest-cov = "^5.0.0"
+pytest-cov = "^3.0.0"
-datamodel-code-generator = "^0.25.6"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
@@ -30,7 +30,3 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.scripts]
 cpv = "compose_viz.cli:start_cli"
-
-[tool.coverage.run]
-source = ["compose_viz"]
-omit = ["compose_viz/spec/*"]

tests/test_cli.py

@@ -12,31 +12,23 @@ runner = CliRunner()
     "test_file_path",
     [
         "tests/ymls/builds/docker-compose.yml",
-        "tests/ymls/cgroup_parent/docker-compose.yml",
-        "tests/ymls/container_name/docker-compose.yml",
         "tests/ymls/depends_on/docker-compose.yml",
-        "tests/ymls/devices/docker-compose.yml",
-        "tests/ymls/env_file/docker-compose.yml",
-        "tests/ymls/expose/docker-compose.yml",
         "tests/ymls/extends/docker-compose.yml",
         "tests/ymls/links/docker-compose.yml",
         "tests/ymls/networks/docker-compose.yml",
         "tests/ymls/ports/docker-compose.yml",
-        "tests/ymls/profiles/docker-compose.yml",
         "tests/ymls/volumes/docker-compose.yml",
         "examples/full-stack-node-app/docker-compose.yml",
         "examples/non-normative/docker-compose.yml",
-        "examples/voting-app/docker-compose.yml",
     ],
 )
 def test_cli(test_file_path: str) -> None:
     input_path = f"{test_file_path}"
-    output_filename = "compose-viz-test"
+    output_path = "compose-viz-test.png"
-    default_format = "png"
+    result = runner.invoke(cli.app, ["-o", output_path, input_path])
-    result = runner.invoke(cli.app, ["-o", output_filename, input_path])
 
     assert result.exit_code == 0
     assert f"Successfully parsed {input_path}\n" in result.stdout
-    assert os.path.exists(f"{output_filename}.{default_format}")
+    assert os.path.exists(output_path)
 
-    os.remove(f"{output_filename}.{default_format}")
+    os.remove(output_path)

tests/test_devices.py

@@ -1,22 +0,0 @@
-from compose_viz.models.device import Device
-
-
-def test_device_init_normal() -> None:
-    try:
-        d = Device(host_path="/dev/ttyUSB0", container_path="/dev/ttyUSB1")
-
-        assert d.host_path == "/dev/ttyUSB0"
-        assert d.container_path == "/dev/ttyUSB1"
-    except Exception as e:
-        assert False, e
-
-
-def test_device_with_cgroup_permissions() -> None:
-    try:
-        d = Device(host_path="/dev/sda1", container_path="/dev/xvda", cgroup_permissions="rwm")
-
-        assert d.host_path == "/dev/sda1"
-        assert d.container_path == "/dev/xvda"
-        assert d.cgroup_permissions == "rwm"
-    except Exception as e:
-        assert False, e

tests/test_extends.py

@@ -1,6 +1,6 @@
 import pytest
 
-from compose_viz.models.extends import Extends
+from compose_viz.extends import Extends
 
 
 def test_extend_init_normal() -> None:

tests/test_parse_file.py

@@ -1,12 +1,11 @@
 import pytest
 
-from compose_viz.models.compose import Compose
+from compose_viz.compose import Compose
-from compose_viz.models.device import Device
+from compose_viz.extends import Extends
-from compose_viz.models.extends import Extends
-from compose_viz.models.port import Port, Protocol
-from compose_viz.models.service import Service
-from compose_viz.models.volume import Volume, VolumeType
 from compose_viz.parser import Parser
+from compose_viz.port import Port, Protocol
+from compose_viz.service import Service
+from compose_viz.volume import Volume, VolumeType
 
 
 @pytest.mark.parametrize(
@@ -172,14 +171,6 @@ from compose_viz.parser import Parser
                                 container_port="6060",
                                 protocol=Protocol.udp,
                             ),
-                            Port(
-                                host_port="0.0.0.0:7777",
-                                container_port="7777",
-                            ),
-                            Port(
-                                host_port="${BIND_IP:-127.0.0.1}:8080",
-                                container_port="8080",
-                            ),
                             Port(
                                 host_port="127.0.0.1:8080",
                                 container_port="80",
@@ -236,134 +227,6 @@ from compose_viz.parser import Parser
                             ),
                         ],
                     ),
-                    Service(
-                        name="tmp",
-                        image="awesome/nginx",
-                        volumes=[
-                            Volume(
-                                source="/app",
-                                target="/app",
-                                type=VolumeType.tmpfs,
-                            ),
-                        ],
-                    ),
-                ],
-            ),
-        ),
-        (
-            "cgroup_parent/docker-compose",
-            Compose(
-                services=[
-                    Service(
-                        name="frontend",
-                        image="awesome/frontend",
-                        cgroup_parent="system",
-                    ),
-                ],
-            ),
-        ),
-        (
-            "container_name/docker-compose",
-            Compose(
-                services=[
-                    Service(
-                        name="frontend",
-                        image="awesome/frontend",
-                        container_name="myfrontend",
-                    ),
-                ],
-            ),
-        ),
-        (
-            "env_file/docker-compose",
-            Compose(
-                services=[
-                    Service(
-                        name="frontend",
-                        image="awesome/frontend",
-                        env_file=["a.env"],
-                    ),
-                    Service(
-                        name="backend",
-                        image="awesome/backend",
-                        env_file=["b.env"],
-                    ),
-                    Service(
-                        name="db",
-                        image="awesome/db",
-                        env_file=["c.env", "d.env"],
-                    ),
-                ],
-            ),
-        ),
-        (
-            "expose/docker-compose",
-            Compose(
-                services=[
-                    Service(
-                        name="frontend",
-                        image="awesome/frontend",
-                        expose=["27118"],
-                    ),
-                    Service(
-                        name="backend",
-                        image="awesome/backend",
-                        expose=["27017", "27018"],
-                    ),
-                ],
-            ),
-        ),
-        (
-            "profiles/docker-compose",
-            Compose(
-                services=[
-                    Service(
-                        name="frontend",
-                        image="awesome/frontend",
-                        profiles=["frontend"],
-                    ),
-                    Service(
-                        name="phpmyadmin",
-                        image="phpmyadmin",
-                        profiles=["debug"],
-                    ),
-                    Service(
-                        name="db",
-                        image="awesome/db",
-                        profiles=["db", "sql"],
-                    ),
-                ],
-            ),
-        ),
-        (
-            "devices/docker-compose",
-            Compose(
-                services=[
-                    Service(
-                        name="frontend",
-                        image="awesome/frontend",
-                        devices=[
-                            Device(
-                                host_path="/dev/ttyUSB0",
-                                container_path="/dev/ttyUSB1",
-                            )
-                        ],
-                    ),
-                    Service(
-                        name="backend",
-                        image="awesome/backend",
-                        devices=[
-                            Device(
-                                host_path="/dev/ttyUSB2",
-                                container_path="/dev/ttyUSB3",
-                            ),
-                            Device(
-                                host_path="/dev/sda",
-                                container_path="/dev/xvda",
-                                cgroup_permissions="rwm",
-                            ),
-                        ],
-                    ),
                 ],
             ),
         ),
@@ -401,16 +264,3 @@ def test_parse_file(test_file_path: str, expected: Compose) -> None:
         if (actual_service.extends is not None) and (expected_service.extends is not None):
             assert actual_service.extends.service_name == expected_service.extends.service_name
             assert actual_service.extends.from_file == expected_service.extends.from_file
-
-        assert actual_service.cgroup_parent == expected_service.cgroup_parent
-        assert actual_service.container_name == expected_service.container_name
-
-        assert actual_service.expose == expected_service.expose
-        assert actual_service.env_file == expected_service.env_file
-        assert actual_service.profiles == expected_service.profiles
-
-        assert len(actual_service.devices) == len(expected_service.devices)
-        for actual_device, expected_device in zip(actual_service.devices, expected_service.devices):
-            assert actual_device.host_path == expected_device.host_path
-            assert actual_device.container_path == expected_device.container_path
-            assert actual_device.cgroup_permissions == expected_device.cgroup_permissions

tests/test_parser.py

@@ -3,16 +3,16 @@ import pytest
 from compose_viz.parser import Parser
 
 
-def test_parser_invalid_yaml() -> None:
+def test_parser_error_parsing_file() -> None:
     with pytest.raises(RuntimeError, match=r"Error parsing file 'tests/ymls/others/invalid.yml'.*"):
         Parser().parse("tests/ymls/others/invalid.yml")
 
 
-def test_parser_empty_yaml() -> None:
+def test_parser_invalid_yaml() -> None:
-    with pytest.raises(RuntimeError, match=r"Error parsing file 'tests/ymls/others/empty.yml'.*"):
+    with pytest.raises(RuntimeError, match=r"Empty yaml file, aborting."):
         Parser().parse("tests/ymls/others/empty.yml")
 
 
 def test_parser_no_services_found() -> None:
-    with pytest.raises(AssertionError, match=r"No services found, aborting."):
+    with pytest.raises(RuntimeError, match=r"No services found, aborting."):
         Parser().parse("tests/ymls/others/no-services.yml")

tests/test_port.py

@@ -1,4 +1,4 @@
-from compose_viz.models.port import Port, Protocol
+from compose_viz.port import Port, Protocol
 
 
 def test_port_init_normal() -> None:

tests/test_root_service.py

@@ -1,32 +0,0 @@
-import os
-
-from typer.testing import CliRunner
-
-from compose_viz import cli
-
-runner = CliRunner()
-
-
-def test_root_service() -> None:
-    input_path = "examples/voting-app/docker-compose.yml"
-    output_filename = "compose-viz-test"
-    default_format = "png"
-    result = runner.invoke(cli.app, ["-r", "vote", "-o", output_filename, input_path])
-
-    assert result.exit_code == 0
-    assert f"Successfully parsed {input_path}\n" in result.stdout
-    assert os.path.exists(f"{output_filename}.{default_format}")
-
-    os.remove(f"{output_filename}.{default_format}")
-
-
-def test_root_service_key_error() -> None:
-    input_path = "examples/voting-app/docker-compose.yml"
-    output_filename = "compose-viz-test"
-    default_format = "png"
-    result = runner.invoke(cli.app, ["-r", "not_exist_service", "-o", output_filename, input_path])
-
-    assert result.exit_code == 1
-    assert result.exception is not None
-    assert result.exception.args[0] == f"Service 'not_exist_service' not found in given compose file: '{input_path}'"
-    assert not os.path.exists(f"{output_filename}.{default_format}")

tests/test_volume.py

@@ -1,4 +1,4 @@
-from compose_viz.models.volume import Volume, VolumeType
+from compose_viz.volume import Volume, VolumeType
 
 
 def test_volume_init_normal() -> None:

tests/ymls/cgroup_parent/docker-compose.yml

@@ -1,6 +0,0 @@
-version: "3.9"
-
-services:
-  frontend:
-    image: awesome/frontend
-    cgroup_parent: "system"

tests/ymls/container_name/docker-compose.yml

@@ -1,6 +0,0 @@
-version: "3.9"
-
-services:
-  frontend:
-    image: awesome/frontend
-    container_name: "myfrontend"

tests/ymls/devices/docker-compose.yml

@@ -1,12 +0,0 @@
-version: "3.9"
-
-services:
-  frontend:
-    image: awesome/frontend
-    devices:
-      - "/dev/ttyUSB0:/dev/ttyUSB1"
-  backend:
-    image: awesome/backend
-    devices:
-      - "/dev/ttyUSB2:/dev/ttyUSB3"
-      - "/dev/sda:/dev/xvda:rwm"

tests/ymls/env_file/docker-compose.yml

@@ -1,15 +0,0 @@
-version: "3.9"
-
-services:
-  frontend:
-    image: awesome/frontend
-    env_file: a.env
-  backend:
-    image: awesome/backend
-    env_file:
-      - b.env
-  db:
-    image: awesome/db
-    env_file:
-      - c.env
-      - d.env

tests/ymls/expose/docker-compose.yml

@@ -1,12 +0,0 @@
-version: "3.9"
-
-services:
-  frontend:
-    image: awesome/frontend
-    expose:
-      - "27118"
-  backend:
-    image: awesome/backend
-    expose:
-      - "27017"
-      - "27018"

tests/ymls/others/no-services.yml

@@ -1 +1,3 @@
-version: "A docker-compose file without services."
+what-is-this:
+  - "a yaml file without services"
+  - "test purpose"

tests/ymls/ports/docker-compose.yml

@@ -11,8 +11,6 @@ services:
       - "127.0.0.1:8001:8001"
       - "127.0.0.1:5000-5010:5000-5010"
       - "6060:6060/udp"
-      - ":7777"
-      - "${BIND_IP:-127.0.0.1}:8080:8080"
       - target: 80
         host_ip: 127.0.0.1
         published: 8080

tests/ymls/profiles/docker-compose.yml

@@ -1,14 +0,0 @@
-version: "3.9"
-services:
-  frontend:
-    image: awesome/frontend
-    profiles: ["frontend"]
-  phpmyadmin:
-    image: phpmyadmin
-    profiles:
-      - debug
-  db:
-    image: awesome/db
-    profiles:
-      - db
-      - sql

tests/ymls/volumes/docker-compose.yml

@@ -17,11 +17,6 @@ services:
       service: common
     volumes:
       - cli-volume:/var/lib/backup/data:ro
-  tmp:
-    image: awesome/nginx
-    volumes:
-      - type: tmpfs
-        target: /app
 
 volumes:
   common-volume:

update-submodules.py

@@ -1,54 +0,0 @@
-import re
-
-
-def revise_naming_convention():
-    name_mapping = {
-        "EnvFile1": "EnvFilePath",
-        "Volume1": "AdditionalVolumeOption",
-        "External": "ExternalVolumeNetwork",
-        "External2": "ExternalConfig",
-    }
-
-    spec_content: str
-    with open("./compose_viz/spec/compose_spec.py", "r+") as spec_file:
-        spec_content: str = spec_file.read()
-
-        for origin_name, new_name in name_mapping.items():
-            spec_content = re.sub(rf"\b{origin_name}\b", new_name, spec_content)
-
-        spec_file.seek(0)
-        spec_file.write(spec_content)
-
-    print("Revised naming convention successfully!")
-
-
-def update_version_number():
-    new_version_number: str
-    with open("./compose_viz/__init__.py", "r+") as init_file:
-        init_content: str = init_file.read()
-
-        version_number = init_content.split(" ")[-1].replace('"', "").strip()
-        major, minor, patch = version_number.split(".")
-        new_version_number = f"{major}.{minor}.{int(patch) + 1}"
-
-        init_file.seek(0)
-        init_file.write(
-            f"""__app_name__ = "compose_viz"
-__version__ = "{new_version_number}"
-"""
-        )
-
-    with open("./pyproject.toml", "r+") as pyproject_file:
-        pyproject_content: str = pyproject_file.read()
-
-        pyproject_content = pyproject_content.replace(version_number, new_version_number)
-
-        pyproject_file.seek(0)
-        pyproject_file.write(pyproject_content)
-
-    print(f"Version number updated to {new_version_number} successfully!")
-
-
-if __name__ == "__main__":
-    revise_naming_convention()
-    update_version_number()