.github/workflows/ci.yml

@@ -26,9 +26,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.2.1
 
       - name: Install Dependencies
         run: |

.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.2.1
       - run: |
           poetry install --no-root
           poetry build

.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

README.md

@@ -122,7 +122,6 @@ Check out the result [here](https://github.com/compose-viz/compose-viz/blob/main
 | `-o, --output-filename FILENAME`  | Output filename for the generated visualization file. [default: compose-viz]                                                                                                        |
 | `-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] |
 | `-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.                                                                                                                                                                 |
 

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.3.1"

compose_viz/cli.py

@@ -42,12 +42,6 @@ def compose_viz(
         "-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",
@@ -63,7 +57,7 @@ def compose_viz(
     if compose:
         typer.echo(f"Successfully parsed {input_path}")
 
-    Graph(compose, output_filename, include_legend).render(format)
+    Graph(compose, output_filename).render(format)
 
     raise typer.Exit()
 

compose_viz/graph.py

@@ -3,7 +3,6 @@ from typing import Optional
 import graphviz
 
 from compose_viz.models.compose import Compose
-from compose_viz.models.port import AppProtocol, Protocol
 
 
 def apply_vertex_style(type: str) -> dict:
@@ -70,58 +69,12 @@ def apply_edge_style(type: str) -> dict:
 
 
 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({":": ""})
@@ -164,14 +117,7 @@ class Graph:
                 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, "links", 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")

compose_viz/models/port.py

@@ -7,27 +7,11 @@ class Protocol(str, Enum):
     any = "any"
 
 
-class AppProtocol(str, Enum):
-    rest = "REST"
-    mqtt = "MQTT"
-    wbsock = "WebSocket"
-    http = "http"
-    https = "https"
-    na = "NA"
-
-
 class Port:
-    def __init__(
+    def __init__(self, host_port: str, container_port: str, protocol: Protocol = Protocol.any):
-        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):
@@ -40,7 +24,3 @@ class Port:
     @property
     def protocol(self):
         return self._protocol
-
-    @property
-    def app_protocol(self):
-        return self._app_protocol

compose_viz/parser.py

@@ -1,13 +1,13 @@
 import re
 from typing import Any, Dict, List, Optional, Union
 
-from pydantic_yaml import parse_yaml_raw_as
+from pydantic import ValidationError
 
 import compose_viz.spec.compose_spec as spec
 from compose_viz.models.compose import Compose, Service
 from compose_viz.models.device import Device
 from compose_viz.models.extends import Extends
-from compose_viz.models.port import AppProtocol, Port, Protocol
+from compose_viz.models.port import Port, Protocol
 from compose_viz.models.volume import Volume, VolumeType
 
 
@@ -19,7 +19,7 @@ class Parser:
     def _unwrap_depends_on(data_depends_on: Union[spec.ListOfStrings, Dict[Any, spec.DependsOn], None]) -> List[str]:
         service_depends_on = []
         if type(data_depends_on) is spec.ListOfStrings:
-            service_depends_on = data_depends_on.root
+            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))
@@ -40,10 +40,8 @@ class Parser:
         compose_data: spec.ComposeSpecification
 
         try:
-            with open(file_path, "r") as file:
+            compose_data = spec.ComposeSpecification.parse_file(file_path)
-                file_content = file.read()
+        except ValidationError as e:
-            compose_data = parse_yaml_raw_as(spec.ComposeSpecification, file_content)
-        except Exception as e:
             raise RuntimeError(f"Error parsing file '{file_path}': {e}")
 
         services: List[Service] = []
@@ -65,7 +63,7 @@ class Parser:
             if service_data.build is not None:
                 if type(service_data.build) is str:
                     service_image = f"build from '{service_data.build}'"
-                elif type(service_data.build) is spec.Build:
+                elif type(service_data.build) is spec.BuildItem:
                     if service_data.build.context is not None and service_data.build.dockerfile is not None:
                         service_image = (
                             f"build from '{service_data.build.context}' using '{service_data.build.dockerfile}'"
@@ -81,7 +79,7 @@ class Parser:
             service_networks: List[str] = []
             if service_data.networks is not None:
                 if type(service_data.networks) is spec.ListOfStrings:
-                    service_networks = service_data.networks.root
+                    service_networks = service_data.networks.__root__
                 elif type(service_data.networks) is dict:
                     service_networks = list(service_data.networks.keys())
 
@@ -89,7 +87,7 @@ class Parser:
             if service_data.extends is not None:
                 # https://github.com/compose-spec/compose-spec/blob/master/spec.md#extends
                 # The value of the extends key MUST be a dictionary.
-                assert type(service_data.extends) is spec.Extends
+                assert type(service_data.extends) is spec.Extend
                 service_extends = Extends(
                     service_name=service_data.extends.service, from_file=service_data.extends.file
                 )
@@ -101,13 +99,12 @@ class Parser:
                     host_port: Optional[str] = None
                     container_port: Optional[str] = None
                     protocol: Optional[str] = None
-                    app_protocol: Optional[str] = None
 
                     if type(port_data) is float:
                         container_port = str(int(port_data))
                         host_port = f"0.0.0.0:{container_port}"
                     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
+                        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:
@@ -125,18 +122,20 @@ class Parser:
                                 host_port = f"{host_ip}{host_port}"
                             else:
                                 host_port = f"0.0.0.0:{host_port}"
-                    elif type(port_data) is spec.Ports:
+                    elif type(port_data) is spec.Port:
                         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:
+                        # ruamel.yaml does not parse port as int
-                            host_port = str(port_data.published)
+                        assert type(port_data.published) is not int
+
+                        if type(port_data.published) is str:
+                            host_port = 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
@@ -152,15 +151,11 @@ class Parser:
                     if protocol is None:
                         protocol = "any"
 
-                    if app_protocol is None:
-                        app_protocol = "na"
-
                     service_ports.append(
                         Port(
                             host_port=host_port,
                             container_port=container_port,
                             protocol=Protocol[protocol],
-                            app_protocol=AppProtocol[app_protocol],
                         )
                     )
 
@@ -185,7 +180,7 @@ class Parser:
                                     access_mode=spilt_data[2],
                                 )
                             )
-                    elif type(volume_data) is spec.Volumes:
+                    elif type(volume_data) is spec.ServiceVolume:
                         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
@@ -217,16 +212,11 @@ class Parser:
 
             env_file: List[str] = []
             if service_data.env_file is not None:
-                if type(service_data.env_file.root) is str:
+                if type(service_data.env_file) is spec.StringOrList:
-                    env_file = [service_data.env_file.root]
+                    if type(service_data.env_file.__root__) is spec.ListOfStrings:
-                elif type(service_data.env_file.root) is list:
+                        env_file = service_data.env_file.__root__.__root__
-                    for env_file_data in service_data.env_file.root:
+                    elif type(service_data.env_file.__root__) is str:
-                        if type(env_file_data) is str:
+                        env_file.append(service_data.env_file.__root__)
-                            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:
@@ -236,7 +226,7 @@ class Parser:
             profiles: List[str] = []
             if service_data.profiles is not None:
                 if type(service_data.profiles) is spec.ListOfStrings:
-                    profiles = service_data.profiles.root
+                    profiles = service_data.profiles.__root__
 
             devices: List[Device] = []
             if service_data.devices is not None:

compose_viz/spec/compose-spec.json

@@ -0,0 +1,820 @@
+{
+  "$schema": "http://json-schema.org/draft/2019-09/schema#",
+  "id": "compose_spec.json",
+  "type": "object",
+  "title": "Compose Specification",
+  "description": "The Compose file is a YAML file defining a multi-containers based application.",
+
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "declared for backward compatibility, ignored."
+    },
+
+    "name": {
+      "type": "string",
+      "pattern": "^[a-z0-9][a-z0-9_-]*$",
+      "description": "define the Compose project name, until user defines one explicitly."
+    },
+
+    "services": {
+      "id": "#/properties/services",
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9._-]+$": {
+          "$ref": "#/definitions/service"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "networks": {
+      "id": "#/properties/networks",
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9._-]+$": {
+          "$ref": "#/definitions/network"
+        }
+      }
+    },
+
+    "volumes": {
+      "id": "#/properties/volumes",
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9._-]+$": {
+          "$ref": "#/definitions/volume"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "secrets": {
+      "id": "#/properties/secrets",
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9._-]+$": {
+          "$ref": "#/definitions/secret"
+        }
+      },
+      "additionalProperties": false
+    },
+
+    "configs": {
+      "id": "#/properties/configs",
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9._-]+$": {
+          "$ref": "#/definitions/config"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+
+  "patternProperties": {"^x-": {}},
+  "additionalProperties": false,
+
+  "definitions": {
+
+    "service": {
+      "id": "#/definitions/service",
+      "type": "object",
+
+      "properties": {
+        "deploy": {"$ref": "#/definitions/deployment"},
+        "build": {
+          "oneOf": [
+            {"type": "string"},
+            {
+              "type": "object",
+              "properties": {
+                "context": {"type": "string"},
+                "dockerfile": {"type": "string"},
+                "dockerfile_inline": {"type": "string"},
+                "args": {"$ref": "#/definitions/list_or_dict"},
+                "ssh": {"$ref": "#/definitions/list_or_dict"},
+                "labels": {"$ref": "#/definitions/list_or_dict"},
+                "cache_from": {"type": "array", "items": {"type": "string"}},
+                "cache_to": {"type": "array", "items": {"type": "string"}},
+                "no_cache": {"type": "boolean"},
+                "additional_contexts": {"$ref": "#/definitions/list_or_dict"},
+                "network": {"type": "string"},
+                "pull": {"type": "boolean"},
+                "target": {"type": "string"},
+                "shm_size": {"type": ["integer", "string"]},
+                "extra_hosts": {"$ref": "#/definitions/list_or_dict"},
+                "isolation": {"type": "string"},
+                "privileged": {"type": "boolean"},
+                "secrets": {"$ref": "#/definitions/service_config_or_secret"},
+                "tags": {"type": "array", "items": {"type": "string"}},
+                "platforms": {"type": "array", "items": {"type": "string"}}
+              },
+              "additionalProperties": false,
+              "patternProperties": {"^x-": {}}
+            }
+          ]
+        },
+        "blkio_config": {
+          "type": "object",
+          "properties": {
+            "device_read_bps": {
+              "type": "array",
+              "items": {"$ref": "#/definitions/blkio_limit"}
+            },
+            "device_read_iops": {
+              "type": "array",
+              "items": {"$ref": "#/definitions/blkio_limit"}
+            },
+            "device_write_bps": {
+              "type": "array",
+              "items": {"$ref": "#/definitions/blkio_limit"}
+            },
+            "device_write_iops": {
+              "type": "array",
+              "items": {"$ref": "#/definitions/blkio_limit"}
+            },
+            "weight": {"type": "integer"},
+            "weight_device": {
+              "type": "array",
+              "items": {"$ref": "#/definitions/blkio_weight"}
+            }
+          },
+          "additionalProperties": false
+        },
+        "cap_add": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "cap_drop": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "cgroup": {"type": "string", "enum": ["host", "private"]},
+        "cgroup_parent": {"type": "string"},
+        "command": {"$ref": "#/definitions/command"},
+        "configs": {"$ref": "#/definitions/service_config_or_secret"},
+        "container_name": {"type": "string"},
+        "cpu_count": {"type": "integer", "minimum": 0},
+        "cpu_percent": {"type": "integer", "minimum": 0, "maximum": 100},
+        "cpu_shares": {"type": ["number", "string"]},
+        "cpu_quota": {"type": ["number", "string"]},
+        "cpu_period": {"type": ["number", "string"]},
+        "cpu_rt_period": {"type": ["number", "string"]},
+        "cpu_rt_runtime": {"type": ["number", "string"]},
+        "cpus": {"type": ["number", "string"]},
+        "cpuset": {"type": "string"},
+        "credential_spec": {
+          "type": "object",
+          "properties": {
+            "config": {"type": "string"},
+            "file": {"type": "string"},
+            "registry": {"type": "string"}
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "depends_on": {
+          "oneOf": [
+            {"$ref": "#/definitions/list_of_strings"},
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "patternProperties": {
+                "^[a-zA-Z0-9._-]+$": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "properties": {
+                    "restart": {"type": "boolean"},
+                    "condition": {
+                      "type": "string",
+                      "enum": ["service_started", "service_healthy", "service_completed_successfully"]
+                    }
+                  },
+                  "required": ["condition"]
+                }
+              }
+            }
+          ]
+        },
+        "device_cgroup_rules": {"$ref": "#/definitions/list_of_strings"},
+        "devices": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "dns": {"$ref": "#/definitions/string_or_list"},
+        "dns_opt": {"type": "array","items": {"type": "string"}, "uniqueItems": true},
+        "dns_search": {"$ref": "#/definitions/string_or_list"},
+        "domainname": {"type": "string"},
+        "entrypoint": {"$ref": "#/definitions/command"},
+        "env_file": {"$ref": "#/definitions/string_or_list"},
+        "environment": {"$ref": "#/definitions/list_or_dict"},
+
+        "expose": {
+          "type": "array",
+          "items": {
+            "type": ["string", "number"],
+            "format": "expose"
+          },
+          "uniqueItems": true
+        },
+        "extends": {
+          "oneOf": [
+            {"type": "string"},
+            {
+              "type": "object",
+
+              "properties": {
+                "service": {"type": "string"},
+                "file": {"type": "string"}
+              },
+              "required": ["service"],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "external_links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "extra_hosts": {"$ref": "#/definitions/list_or_dict"},
+        "group_add": {
+          "type": "array",
+          "items": {
+            "type": ["string", "number"]
+          },
+          "uniqueItems": true
+        },
+        "healthcheck": {"$ref": "#/definitions/healthcheck"},
+        "hostname": {"type": "string"},
+        "image": {"type": "string"},
+        "init": {"type": "boolean"},
+        "ipc": {"type": "string"},
+        "isolation": {"type": "string"},
+        "labels": {"$ref": "#/definitions/list_or_dict"},
+        "links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "logging": {
+          "type": "object",
+
+          "properties": {
+            "driver": {"type": "string"},
+            "options": {
+              "type": "object",
+              "patternProperties": {
+                "^.+$": {"type": ["string", "number", "null"]}
+              }
+            }
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "mac_address": {"type": "string"},
+        "mem_limit": {"type": ["number", "string"]},
+        "mem_reservation": {"type": ["string", "integer"]},
+        "mem_swappiness": {"type": "integer"},
+        "memswap_limit": {"type": ["number", "string"]},
+        "network_mode": {"type": "string"},
+        "networks": {
+          "oneOf": [
+            {"$ref": "#/definitions/list_of_strings"},
+            {
+              "type": "object",
+              "patternProperties": {
+                "^[a-zA-Z0-9._-]+$": {
+                  "oneOf": [
+                    {
+                      "type": "object",
+                      "properties": {
+                        "aliases": {"$ref": "#/definitions/list_of_strings"},
+                        "ipv4_address": {"type": "string"},
+                        "ipv6_address": {"type": "string"},
+                        "link_local_ips": {"$ref": "#/definitions/list_of_strings"},
+                        "priority": {"type": "number"}
+                      },
+                      "additionalProperties": false,
+                      "patternProperties": {"^x-": {}}
+                    },
+                    {"type": "null"}
+                  ]
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        },
+        "oom_kill_disable": {"type": "boolean"},
+        "oom_score_adj": {"type": "integer", "minimum": -1000, "maximum": 1000},
+        "pid": {"type": ["string", "null"]},
+        "pids_limit": {"type": ["number", "string"]},
+        "platform": {"type": "string"},
+        "ports": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {"type": "number", "format": "ports"},
+              {"type": "string", "format": "ports"},
+              {
+                "type": "object",
+                "properties": {
+                  "mode": {"type": "string"},
+                  "host_ip": {"type": "string"},
+                  "target": {"type": "integer"},
+                  "published": {"type": ["string", "integer"]},
+                  "protocol": {"type": "string"}
+                },
+                "additionalProperties": false,
+                "patternProperties": {"^x-": {}}
+              }
+            ]
+          },
+          "uniqueItems": true
+        },
+        "privileged": {"type": "boolean"},
+        "profiles": {"$ref": "#/definitions/list_of_strings"},
+        "pull_policy": {"type": "string", "enum": [
+          "always", "never", "if_not_present", "build", "missing"
+        ]},
+        "read_only": {"type": "boolean"},
+        "restart": {"type": "string"},
+        "runtime": {
+          "type": "string"
+        },
+        "scale": {
+          "type": "integer"
+        },
+        "security_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
+        "shm_size": {"type": ["number", "string"]},
+        "secrets": {"$ref": "#/definitions/service_config_or_secret"},
+        "sysctls": {"$ref": "#/definitions/list_or_dict"},
+        "stdin_open": {"type": "boolean"},
+        "stop_grace_period": {"type": "string", "format": "duration"},
+        "stop_signal": {"type": "string"},
+        "storage_opt": {"type": "object"},
+        "tmpfs": {"$ref": "#/definitions/string_or_list"},
+        "tty": {"type": "boolean"},
+        "ulimits": {
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]+$": {
+              "oneOf": [
+                {"type": "integer"},
+                {
+                  "type": "object",
+                  "properties": {
+                    "hard": {"type": "integer"},
+                    "soft": {"type": "integer"}
+                  },
+                  "required": ["soft", "hard"],
+                  "additionalProperties": false,
+                  "patternProperties": {"^x-": {}}
+                }
+              ]
+            }
+          }
+        },
+        "user": {"type": "string"},
+        "uts": {"type": "string"},
+        "userns_mode": {"type": "string"},
+        "volumes": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {"type": "string"},
+              {
+                "type": "object",
+                "required": ["type"],
+                "properties": {
+                  "type": {"type": "string"},
+                  "source": {"type": "string"},
+                  "target": {"type": "string"},
+                  "read_only": {"type": "boolean"},
+                  "consistency": {"type": "string"},
+                  "bind": {
+                    "type": "object",
+                    "properties": {
+                      "propagation": {"type": "string"},
+                      "create_host_path": {"type": "boolean"},
+                      "selinux": {"type": "string", "enum": ["z", "Z"]}
+                    },
+                    "additionalProperties": false,
+                    "patternProperties": {"^x-": {}}
+                  },
+                  "volume": {
+                    "type": "object",
+                    "properties": {
+                      "nocopy": {"type": "boolean"}
+                    },
+                    "additionalProperties": false,
+                    "patternProperties": {"^x-": {}}
+                  },
+                  "tmpfs": {
+                    "type": "object",
+                    "properties": {
+                      "size": {
+                        "oneOf": [
+                          {"type": "integer", "minimum": 0},
+                          {"type": "string"}
+                        ]
+                      },
+                      "mode": {"type": "number"}
+                    },
+                    "additionalProperties": false,
+                    "patternProperties": {"^x-": {}}
+                  }
+                },
+                "additionalProperties": false,
+                "patternProperties": {"^x-": {}}
+              }
+            ]
+          },
+          "uniqueItems": true
+        },
+        "volumes_from": {
+          "type": "array",
+          "items": {"type": "string"},
+          "uniqueItems": true
+        },
+        "working_dir": {"type": "string"}
+      },
+      "patternProperties": {"^x-": {}},
+      "additionalProperties": false
+    },
+
+    "healthcheck": {
+      "id": "#/definitions/healthcheck",
+      "type": "object",
+      "properties": {
+        "disable": {"type": "boolean"},
+        "interval": {"type": "string", "format": "duration"},
+        "retries": {"type": "number"},
+        "test": {
+          "oneOf": [
+            {"type": "string"},
+            {"type": "array", "items": {"type": "string"}}
+          ]
+        },
+        "timeout": {"type": "string", "format": "duration"},
+        "start_period": {"type": "string", "format": "duration"}
+      },
+      "additionalProperties": false,
+      "patternProperties": {"^x-": {}}
+    },
+    "deployment": {
+      "id": "#/definitions/deployment",
+      "type": ["object", "null"],
+      "properties": {
+        "mode": {"type": "string"},
+        "endpoint_mode": {"type": "string"},
+        "replicas": {"type": "integer"},
+        "labels": {"$ref": "#/definitions/list_or_dict"},
+        "rollback_config": {
+          "type": "object",
+          "properties": {
+            "parallelism": {"type": "integer"},
+            "delay": {"type": "string", "format": "duration"},
+            "failure_action": {"type": "string"},
+            "monitor": {"type": "string", "format": "duration"},
+            "max_failure_ratio": {"type": "number"},
+            "order": {"type": "string", "enum": [
+              "start-first", "stop-first"
+            ]}
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "update_config": {
+          "type": "object",
+          "properties": {
+            "parallelism": {"type": "integer"},
+            "delay": {"type": "string", "format": "duration"},
+            "failure_action": {"type": "string"},
+            "monitor": {"type": "string", "format": "duration"},
+            "max_failure_ratio": {"type": "number"},
+            "order": {"type": "string", "enum": [
+              "start-first", "stop-first"
+            ]}
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "resources": {
+          "type": "object",
+          "properties": {
+            "limits": {
+              "type": "object",
+              "properties": {
+                "cpus": {"type": ["number", "string"]},
+                "memory": {"type": "string"},
+                "pids": {"type": "integer"}
+              },
+              "additionalProperties": false,
+              "patternProperties": {"^x-": {}}
+            },
+            "reservations": {
+              "type": "object",
+              "properties": {
+                "cpus": {"type": ["number", "string"]},
+                "memory": {"type": "string"},
+                "generic_resources": {"$ref": "#/definitions/generic_resources"},
+                "devices": {"$ref": "#/definitions/devices"}
+              },
+              "additionalProperties": false,
+              "patternProperties": {"^x-": {}}
+            }
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "restart_policy": {
+          "type": "object",
+          "properties": {
+            "condition": {"type": "string"},
+            "delay": {"type": "string", "format": "duration"},
+            "max_attempts": {"type": "integer"},
+            "window": {"type": "string", "format": "duration"}
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "placement": {
+          "type": "object",
+          "properties": {
+            "constraints": {"type": "array", "items": {"type": "string"}},
+            "preferences": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "spread": {"type": "string"}
+                },
+                "additionalProperties": false,
+                "patternProperties": {"^x-": {}}
+              }
+            },
+            "max_replicas_per_node": {"type": "integer"}
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        }
+      },
+      "additionalProperties": false,
+      "patternProperties": {"^x-": {}}
+    },
+
+    "generic_resources": {
+      "id": "#/definitions/generic_resources",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "discrete_resource_spec": {
+            "type": "object",
+            "properties": {
+              "kind": {"type": "string"},
+              "value": {"type": "number"}
+            },
+            "additionalProperties": false,
+            "patternProperties": {"^x-": {}}
+          }
+        },
+        "additionalProperties": false,
+        "patternProperties": {"^x-": {}}
+      }
+    },
+
+    "devices": {
+      "id": "#/definitions/devices",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+            "capabilities": {"$ref": "#/definitions/list_of_strings"},
+            "count": {"type": ["string", "integer"]},
+            "device_ids": {"$ref": "#/definitions/list_of_strings"},
+            "driver":{"type": "string"},
+            "options":{"$ref": "#/definitions/list_or_dict"}
+          },
+        "additionalProperties": false,
+        "patternProperties": {"^x-": {}}
+      }
+    },
+
+    "network": {
+      "id": "#/definitions/network",
+      "type": ["object", "null"],
+      "properties": {
+        "name": {"type": "string"},
+        "driver": {"type": "string"},
+        "driver_opts": {
+          "type": "object",
+          "patternProperties": {
+            "^.+$": {"type": ["string", "number"]}
+          }
+        },
+        "ipam": {
+          "type": "object",
+          "properties": {
+            "driver": {"type": "string"},
+            "config": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "subnet": {"type": "string", "format": "subnet_ip_address"},
+                  "ip_range": {"type": "string"},
+                  "gateway": {"type": "string"},
+                  "aux_addresses": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "patternProperties": {"^.+$": {"type": "string"}}
+                  }
+                },
+                "additionalProperties": false,
+                "patternProperties": {"^x-": {}}
+              }
+            },
+            "options": {
+              "type": "object",
+              "additionalProperties": false,
+              "patternProperties": {"^.+$": {"type": "string"}}
+            }
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "external": {
+          "type": ["boolean", "object"],
+          "properties": {
+            "name": {
+              "deprecated": true,
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "internal": {"type": "boolean"},
+        "enable_ipv6": {"type": "boolean"},
+        "attachable": {"type": "boolean"},
+        "labels": {"$ref": "#/definitions/list_or_dict"}
+      },
+      "additionalProperties": false,
+      "patternProperties": {"^x-": {}}
+    },
+
+    "volume": {
+      "id": "#/definitions/volume",
+      "type": ["object", "null"],
+      "properties": {
+        "name": {"type": "string"},
+        "driver": {"type": "string"},
+        "driver_opts": {
+          "type": "object",
+          "patternProperties": {
+            "^.+$": {"type": ["string", "number"]}
+          }
+        },
+        "external": {
+          "type": ["boolean", "object"],
+          "properties": {
+            "name": {
+              "deprecated": true,
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "patternProperties": {"^x-": {}}
+        },
+        "labels": {"$ref": "#/definitions/list_or_dict"}
+      },
+      "additionalProperties": false,
+      "patternProperties": {"^x-": {}}
+    },
+
+    "secret": {
+      "id": "#/definitions/secret",
+      "type": "object",
+      "properties": {
+        "name": {"type": "string"},
+        "environment": {"type": "string"},
+        "file": {"type": "string"},
+        "external": {
+          "type": ["boolean", "object"],
+          "properties": {
+            "name": {"type": "string"}
+          }
+        },
+        "labels": {"$ref": "#/definitions/list_or_dict"},
+        "driver": {"type": "string"},
+        "driver_opts": {
+          "type": "object",
+          "patternProperties": {
+            "^.+$": {"type": ["string", "number"]}
+          }
+        },
+        "template_driver": {"type": "string"}
+      },
+      "additionalProperties": false,
+      "patternProperties": {"^x-": {}}
+    },
+
+    "config": {
+      "id": "#/definitions/config",
+      "type": "object",
+      "properties": {
+        "name": {"type": "string"},
+        "file": {"type": "string"},
+        "external": {
+          "type": ["boolean", "object"],
+          "properties": {
+            "name": {
+              "deprecated": true,
+              "type": "string"
+            }
+          }
+        },
+        "labels": {"$ref": "#/definitions/list_or_dict"},
+        "template_driver": {"type": "string"}
+      },
+      "additionalProperties": false,
+      "patternProperties": {"^x-": {}}
+    },
+
+    "command": {
+      "oneOf": [
+        {"type": "null"},
+        {"type": "string"},
+        {"type": "array","items": {"type": "string"}}
+      ]
+    },
+
+    "string_or_list": {
+      "oneOf": [
+        {"type": "string"},
+        {"$ref": "#/definitions/list_of_strings"}
+      ]
+    },
+
+    "list_of_strings": {
+      "type": "array",
+      "items": {"type": "string"},
+      "uniqueItems": true
+    },
+
+    "list_or_dict": {
+      "oneOf": [
+        {
+          "type": "object",
+          "patternProperties": {
+            ".+": {
+              "type": ["string", "number", "boolean", "null"]
+            }
+          },
+          "additionalProperties": false
+        },
+        {"type": "array", "items": {"type": "string"}, "uniqueItems": true}
+      ]
+    },
+
+    "blkio_limit": {
+      "type": "object",
+      "properties": {
+        "path": {"type": "string"},
+        "rate": {"type": ["integer", "string"]}
+      },
+      "additionalProperties": false
+    },
+    "blkio_weight": {
+      "type": "object",
+      "properties": {
+        "path": {"type": "string"},
+        "weight": {"type": "integer"}
+      },
+      "additionalProperties": false
+    },
+
+    "service_config_or_secret": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {"type": "string"},
+          {
+            "type": "object",
+            "properties": {
+              "source": {"type": "string"},
+              "target": {"type": "string"},
+              "uid": {"type": "string"},
+              "gid": {"type": "string"},
+              "mode": {"type": "number"}
+            },
+            "additionalProperties": false,
+            "patternProperties": {"^x-": {}}
+          }
+        ]
+      }
+    },
+
+    "constraints": {
+      "service": {
+        "id": "#/definitions/constraints/service",
+        "anyOf": [
+          {"required": ["build"]},
+          {"required": ["image"]}
+        ],
+        "properties": {
+          "build": {
+            "required": ["context"]
+          }
+        }
+      }
+    }
+  }
+}

compose_viz/spec/compose_spec.py

@@ -1,74 +1,71 @@
 # generated by datamodel-codegen:
 #   filename:  compose-spec.json
-#   timestamp: 2024-04-27T08:31:04+00:00
+#   timestamp: 2023-05-03T07:42:00+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
+from pydantic import Extra, Field, conint, constr
+from pydantic_yaml import YamlModel, YamlStrEnum
 
 
-class Cgroup(Enum):
+class Cgroup(YamlStrEnum):
     host = "host"
     private = "private"
 
 
-class CredentialSpec(BaseModel):
+class CredentialSpec(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     config: Optional[str] = None
     file: Optional[str] = None
     registry: Optional[str] = None
 
 
-class Condition(Enum):
+class Condition(YamlStrEnum):
     service_started = "service_started"
     service_healthy = "service_healthy"
     service_completed_successfully = "service_completed_successfully"
 
 
-class DependsOn(BaseModel):
+class DependsOn(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     restart: Optional[bool] = None
-    required: Optional[bool] = True
     condition: Condition
 
 
-class Extends(BaseModel):
+class Extend(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     service: str
     file: Optional[str] = None
 
 
-class Logging(BaseModel):
+class Logging(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     driver: Optional[str] = None
-    options: Optional[Dict[str, Optional[Union[str, float]]]] = None
+    options: Optional[Dict[constr(regex=r"^.+$"), Optional[Union[str, float]]]] = None  # type: ignore  # noqa: F722
 
 
-class Ports(BaseModel):
+class Port(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
-    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):
+class PullPolicy(YamlStrEnum):
     always = "always"
     never = "never"
     if_not_present = "if_not_present"
@@ -76,44 +73,47 @@ class PullPolicy(Enum):
     missing = "missing"
 
 
-class Selinux(Enum):
+class Ulimit(YamlModel):
+    class Config:
+        extra = Extra.allow
+
+    hard: int
+    soft: int
+
+
+class Selinux(YamlStrEnum):
     z = "z"
     Z = "Z"
 
 
-class Bind(BaseModel):
+class Bind(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     propagation: Optional[str] = None
     create_host_path: Optional[bool] = None
     selinux: Optional[Selinux] = None
 
 
-class AdditionalVolumeOption(BaseModel):
+class AdditionalVolumeOption(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     nocopy: Optional[bool] = None
-    subpath: Optional[str] = None
 
 
-class Size(RootModel[int]):
+class Tmpfs(YamlModel):
-    root: int = Field(..., ge=0)
+    class Config:
+        extra = Extra.allow
 
-
+    size: Optional[Union[conint(ge=0), str]] = None  # type: ignore
-class Tmpfs(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    size: Optional[Union[Size, str]] = None
     mode: Optional[float] = None
 
 
-class Volumes(BaseModel):
+class ServiceVolume(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     type: str
     source: Optional[str] = None
     target: Optional[str] = None
@@ -124,45 +124,27 @@ class Volumes(BaseModel):
     tmpfs: Optional[Tmpfs] = None
 
 
-class Healthcheck(BaseModel):
+class Healthcheck(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     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):
+class Order(YamlStrEnum):
-    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):
+class RollbackConfig(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     parallelism: Optional[int] = None
     delay: Optional[str] = None
     failure_action: Optional[str] = None
@@ -171,150 +153,157 @@ class RollbackConfig(BaseModel):
     order: Optional[Order] = None
 
 
-class UpdateConfig(BaseModel):
+class ConfigOrder(YamlStrEnum):
-    model_config = ConfigDict(
+    start_first = "start-first"
-        extra="forbid",
+    stop_first = "stop-first"
-    )
+
+
+class UpdateConfig(YamlModel):
+    class Config:
+        extra = Extra.allow
+
     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
+    order: Optional[ConfigOrder] = None
 
 
-class Limits(BaseModel):
+class Limits(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     cpus: Optional[Union[float, str]] = None
     memory: Optional[str] = None
     pids: Optional[int] = None
 
 
-class RestartPolicy(BaseModel):
+class RestartPolicy(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     condition: Optional[str] = None
     delay: Optional[str] = None
     max_attempts: Optional[int] = None
     window: Optional[str] = None
 
 
-class Preference(BaseModel):
+class Preference(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     spread: Optional[str] = None
 
 
-class Placement(BaseModel):
+class Placement(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     constraints: Optional[List[str]] = None
     preferences: Optional[List[Preference]] = None
     max_replicas_per_node: Optional[int] = None
 
 
-class DiscreteResourceSpec(BaseModel):
+class DiscreteResourceSpec(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     kind: Optional[str] = None
     value: Optional[float] = None
 
 
-class GenericResource(BaseModel):
+class GenericResource(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     discrete_resource_spec: Optional[DiscreteResourceSpec] = None
 
 
-class GenericResources(RootModel[List[GenericResource]]):
+class GenericResources(YamlModel):
-    root: List[GenericResource]
+    class Config:
+        extra = Extra.allow
+
+    __root__: List[GenericResource]
 
 
-class ConfigItem(BaseModel):
+class ConfigItem(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     subnet: Optional[str] = None
     ip_range: Optional[str] = None
     gateway: Optional[str] = None
-    aux_addresses: Optional[Dict[str, str]] = None
+    aux_addresses: Optional[Dict[constr(regex=r"^.+$"), str]] = None  # type: ignore  # noqa: F722
 
 
-class Ipam(BaseModel):
+class Ipam(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     driver: Optional[str] = None
     config: Optional[List[ConfigItem]] = None
-    options: Optional[Dict[str, str]] = None
+    options: Optional[Dict[constr(regex=r"^.+$"), str]] = None  # type: ignore  # noqa: F722
 
 
-class ExternalVolumeNetwork(BaseModel):
+class ExternalNetwork(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     name: Optional[str] = None
 
 
-class ExternalConfig(BaseModel):
+class ExternalVolume(YamlModel):
+    class Config:
+        extra = Extra.allow
+
     name: Optional[str] = None
 
 
-class Command(RootModel[Optional[Union[str, List[str]]]]):
+class ExternalSecret(YamlModel):
-    root: Optional[Union[str, List[str]]]
+    name: Optional[str] = None
 
 
-class EnvFilePath(BaseModel):
+class ExternalConfig(YamlModel):
-    model_config = ConfigDict(
+    name: Optional[str] = None
-        extra="forbid",
-    )
-    path: str
-    required: Optional[bool] = True
 
 
-class EnvFile(RootModel[Union[str, List[Union[str, EnvFilePath]]]]):
+class ListOfStrings(YamlModel):
-    root: Union[str, List[Union[str, EnvFilePath]]]
+    class Config:
+        extra = Extra.allow
+
+    __root__: List[str] = Field(..., unique_items=True)
 
 
-class ListOfStrings(RootModel[List[str]]):
+class ListOrDict(YamlModel):
-    root: List[str]
+    class Config:
+        extra = Extra.allow
+
+    __root__: Union[
+        Dict[constr(regex=r".+"), Optional[Union[str, float, bool]]], List[str]  # type: ignore  # noqa: F722
+    ]
 
 
-class ListOrDict1(RootModel[List[Any]]):
+class BlkioLimit(YamlModel):
-    root: List[Any]
+    class Config:
+        extra = Extra.allow
 
-
-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):
+class BlkioWeight(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     path: Optional[str] = None
     weight: Optional[int] = None
 
 
-class ServiceConfigOrSecret1(BaseModel):
+class ServiceConfigOrSecretItem(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     source: Optional[str] = None
     target: Optional[str] = None
     uid: Optional[str] = None
@@ -322,34 +311,27 @@ class ServiceConfigOrSecret1(BaseModel):
     mode: Optional[float] = None
 
 
-class ServiceConfigOrSecret(RootModel[List[Union[str, ServiceConfigOrSecret1]]]):
+class ServiceConfigOrSecret(YamlModel):
-    root: List[Union[str, ServiceConfigOrSecret1]]
+    class Config:
+        extra = Extra.allow
+
+    __root__: List[Union[str, ServiceConfigOrSecretItem]]
 
 
-class Ulimits1(BaseModel):
+class Constraints(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
-    hard: int
+    __root__: Any
-    soft: int
 
 
-class Ulimits(RootModel[Dict[str, Union[int, Ulimits1]]]):
+class BuildItem(YamlModel):
-    root: Dict[str, Union[int, Ulimits1]]
+    class Config:
+        extra = Extra.allow
 
-
-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
@@ -366,14 +348,13 @@ class Build(BaseModel):
     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):
+class BlkioConfig(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     device_read_bps: Optional[List[BlkioLimit]] = None
     device_read_iops: Optional[List[BlkioLimit]] = None
     device_write_bps: Optional[List[BlkioLimit]] = None
@@ -382,22 +363,21 @@ class BlkioConfig(BaseModel):
     weight_device: Optional[List[BlkioWeight]] = None
 
 
-class Networks(BaseModel):
+class ServiceNetwork(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     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):
+class Device(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     capabilities: Optional[ListOfStrings] = None
     count: Optional[Union[str, int]] = None
     device_ids: Optional[ListOfStrings] = None
@@ -405,89 +385,93 @@ class Device(BaseModel):
     options: Optional[ListOrDict] = None
 
 
-class Devices(RootModel[List[Device]]):
+class Devices(YamlModel):
-    root: List[Device]
+    class Config:
+        extra = Extra.allow
+
+    __root__: List[Device]
 
 
-class Network(BaseModel):
+class Network(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     name: Optional[str] = None
     driver: Optional[str] = None
-    driver_opts: Optional[Dict[str, Union[str, float]]] = None
+    driver_opts: Optional[Dict[constr(regex=r"^.+$"), Union[str, float]]] = None  # type: ignore  # noqa: F722
     ipam: Optional[Ipam] = None
-    external: Optional[ExternalVolumeNetwork] = None
+    external: Optional[bool | ExternalNetwork] = None
     internal: Optional[bool] = None
     enable_ipv6: Optional[bool] = None
     attachable: Optional[bool] = None
     labels: Optional[ListOrDict] = None
 
 
-class Volume(BaseModel):
+class Volume(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     name: Optional[str] = None
     driver: Optional[str] = None
-    driver_opts: Optional[Dict[str, Union[str, float]]] = None
+    driver_opts: Optional[Dict[constr(regex=r"^.+$"), Union[str, float]]] = None  # type: ignore  # noqa: F722
-    external: Optional[ExternalVolumeNetwork] = None
+    external: Optional[ExternalVolume] = None
     labels: Optional[ListOrDict] = None
 
 
-class Secret(BaseModel):
+class Secret(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     name: Optional[str] = None
     environment: Optional[str] = None
     file: Optional[str] = None
-    external: Optional[ExternalConfig] = None
+    external: Optional[ExternalSecret] = None
     labels: Optional[ListOrDict] = None
     driver: Optional[str] = None
-    driver_opts: Optional[Dict[str, Union[str, float]]] = None
+    driver_opts: Optional[Dict[constr(regex=r"^.+$"), Union[str, float]]] = None  # type: ignore  # noqa: F722
     template_driver: Optional[str] = None
 
 
-class Config(BaseModel):
+class Config(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     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]]):
+class StringOrList(YamlModel):
-    root: Union[str, ListOfStrings]
+    class Config:
+        extra = Extra.allow
+
+    __root__: Union[str, ListOfStrings]
 
 
-class Reservations(BaseModel):
+class Reservations(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     cpus: Optional[Union[float, str]] = None
     memory: Optional[str] = None
     generic_resources: Optional[GenericResources] = None
     devices: Optional[Devices] = None
 
 
-class Resources(BaseModel):
+class Resources(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     limits: Optional[Limits] = None
     reservations: Optional[Reservations] = None
 
 
-class Deployment(BaseModel):
+class Deployment(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     mode: Optional[str] = None
     endpoint_mode: Optional[str] = None
     replicas: Optional[int] = None
@@ -499,38 +483,22 @@ class Deployment(BaseModel):
     placement: Optional[Placement] = None
 
 
-class Include1(BaseModel):
+class Service(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
-    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
+    build: Optional[Union[str, BuildItem]] = None
-    attach: Optional[bool] = None
-    build: Optional[Union[str, Build]] = None
     blkio_config: Optional[BlkioConfig] = None
-    cap_add: Optional[List[str]] = None
+    cap_add: Optional[List[str]] = Field(None, unique_items=True)
-    cap_drop: Optional[List[str]] = None
+    cap_drop: Optional[List[str]] = Field(None, unique_items=True)
     cgroup: Optional[Cgroup] = None
     cgroup_parent: Optional[str] = None
-    command: Optional[Command] = None
+    command: Optional[Union[str, List[str]]] = None
     configs: Optional[ServiceConfigOrSecret] = None
     container_name: Optional[str] = None
-    cpu_count: Optional[int] = Field(None, ge=0)
+    cpu_count: Optional[conint(ge=0)] = None  # type: ignore
-    cpu_percent: Optional[int] = Field(None, ge=0, le=100)
+    cpu_percent: Optional[conint(ge=0, le=100)] = None  # type: ignore
     cpu_shares: Optional[Union[float, str]] = None
     cpu_quota: Optional[Union[float, str]] = None
     cpu_period: Optional[Union[float, str]] = None
@@ -539,21 +507,23 @@ class Service(BaseModel):
     cpus: Optional[Union[float, str]] = None
     cpuset: Optional[str] = None
     credential_spec: Optional[CredentialSpec] = None
-    depends_on: Optional[Union[ListOfStrings, Dict[str, DependsOn]]] = None
+    depends_on: Optional[
+        Union[ListOfStrings, Dict[constr(regex=r"^[a-zA-Z0-9._-]+$"), DependsOn]]  # type: ignore  # noqa: F722, E501
+    ] = None
     device_cgroup_rules: Optional[ListOfStrings] = None
-    devices: Optional[List[str]] = None
+    devices: Optional[List[str]] = Field(None, unique_items=True)
     dns: Optional[StringOrList] = None
-    dns_opt: Optional[List[str]] = None
+    dns_opt: Optional[List[str]] = Field(None, unique_items=True)
     dns_search: Optional[StringOrList] = None
     domainname: Optional[str] = None
-    entrypoint: Optional[Command] = None
+    entrypoint: Optional[Union[str, List[str]]] = None
-    env_file: Optional[EnvFile] = None
+    env_file: Optional[StringOrList] = None
     environment: Optional[ListOrDict] = None
-    expose: Optional[List[Union[str, float]]] = None
+    expose: Optional[List[Union[str, float]]] = Field(None, unique_items=True)
-    extends: Optional[Union[str, Extends]] = None
+    extends: Optional[Union[str, Extend]] = None
-    external_links: Optional[List[str]] = None
+    external_links: Optional[List[str]] = Field(None, unique_items=True)
     extra_hosts: Optional[ListOrDict] = None
-    group_add: Optional[List[Union[str, float]]] = None
+    group_add: Optional[List[Union[str, float]]] = Field(None, unique_items=True)
     healthcheck: Optional[Healthcheck] = None
     hostname: Optional[str] = None
     image: Optional[str] = None
@@ -561,7 +531,7 @@ class Service(BaseModel):
     ipc: Optional[str] = None
     isolation: Optional[str] = None
     labels: Optional[ListOrDict] = None
-    links: Optional[List[str]] = None
+    links: Optional[List[str]] = Field(None, unique_items=True)
     logging: Optional[Logging] = None
     mac_address: Optional[str] = None
     mem_limit: Optional[Union[float, str]] = None
@@ -569,13 +539,17 @@ class Service(BaseModel):
     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
+    networks: Optional[
+        Union[
+            ListOfStrings, Dict[constr(regex=r"^[a-zA-Z0-9._-]+$"), Optional[ServiceNetwork]]  # type: ignore  # noqa: F722, E501
+        ]
+    ] = None
     oom_kill_disable: Optional[bool] = None
-    oom_score_adj: Optional[int] = Field(None, ge=-1000, le=1000)
+    oom_score_adj: Optional[conint(ge=-1000, le=1000)] = None  # type: ignore
     pid: Optional[str] = None
     pids_limit: Optional[Union[float, str]] = None
     platform: Optional[str] = None
-    ports: Optional[List[Union[float, str, Ports]]] = None
+    ports: Optional[List[Union[float, str, Port]]] = Field(None, unique_items=True)
     privileged: Optional[bool] = None
     profiles: Optional[ListOfStrings] = None
     pull_policy: Optional[PullPolicy] = None
@@ -583,7 +557,7 @@ class Service(BaseModel):
     restart: Optional[str] = None
     runtime: Optional[str] = None
     scale: Optional[int] = None
-    security_opt: Optional[List[str]] = None
+    security_opt: Optional[List[str]] = Field(None, unique_items=True)
     shm_size: Optional[Union[float, str]] = None
     secrets: Optional[ServiceConfigOrSecret] = None
     sysctls: Optional[ListOrDict] = None
@@ -593,28 +567,26 @@ class Service(BaseModel):
     storage_opt: Optional[Dict[str, Any]] = None
     tmpfs: Optional[StringOrList] = None
     tty: Optional[bool] = None
-    ulimits: Optional[Ulimits] = None
+    ulimits: Optional[Dict[constr(regex=r"^[a-z]+$"), Union[int, Ulimit]]] = None  # type: ignore  # noqa: F722
     user: Optional[str] = None
     uts: Optional[str] = None
     userns_mode: Optional[str] = None
-    volumes: Optional[List[Union[str, Volumes]]] = None
+    volumes: Optional[List[Union[str, ServiceVolume]]] = Field(None, unique_items=True)
-    volumes_from: Optional[List[str]] = None
+    volumes_from: Optional[List[str]] = Field(None, unique_items=True)
     working_dir: Optional[str] = None
 
 
-class ComposeSpecification(BaseModel):
+class ComposeSpecification(YamlModel):
-    model_config = ConfigDict(
+    class Config:
-        extra="forbid",
+        extra = Extra.allow
-    )
+
     version: Optional[str] = Field(None, description="declared for backward compatibility, ignored.")
-    name: Optional[str] = Field(
+    name: Optional[constr(regex=r"^[a-z0-9][a-z0-9_-]*$")] = Field(  # type: ignore  # noqa: F722
         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[constr(regex=r"^[a-zA-Z0-9._-]+$"), Service]] = None  # type: ignore  # noqa: F722
-    services: Optional[Dict[str, Service]] = None
+    networks: Optional[Dict[constr(regex=r"^[a-zA-Z0-9._-]+$"), Optional[Network]]] = None  # type: ignore  # noqa: F722
-    networks: Optional[Dict[str, Optional[Network]]] = None
+    volumes: Optional[Dict[constr(regex=r"^[a-zA-Z0-9._-]+$"), Optional[Volume]]] = None  # type: ignore  # noqa: F722
-    volumes: Optional[Dict[str, Optional[Volume]]] = None
+    secrets: Optional[Dict[constr(regex=r"^[a-zA-Z0-9._-]+$"), Secret]] = None  # type: ignore  # noqa: F722
-    secrets: Optional[Dict[str, Secret]] = None
+    configs: Optional[Dict[constr(regex=r"^[a-zA-Z0-9._-]+$"), Config]] = None  # type: ignore  # noqa: F722
-    configs: Optional[Dict[str, Config]] = None

examples/non-normative/docker-compose.yml

@@ -42,13 +42,7 @@ 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

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "compose-viz"
-version = "0.3.2"
+version = "0.3.1"
 description = "A compose file visualization tool that supports compose-spec and allows you to gernerate graph in several formats."
 authors = ["Xyphuz Wu <xyphuzwu@gmail.com>"]
 readme = "README.md"
@@ -14,15 +14,16 @@ 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"
+pydantic-yaml = "^0.7.0"
 
-[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 = "^4.0.0"
-datamodel-code-generator = "^0.25.6"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/test_parse_file.py

@@ -176,10 +176,6 @@ from compose_viz.parser import Parser
                                 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",

tests/ymls/networks/docker-compose.yml

@@ -26,3 +26,5 @@ networks:
   front-tier:
   back-tier:
   admin:
+  traefik-public:
+    external: true

tests/ymls/ports/docker-compose.yml

@@ -12,7 +12,6 @@ services:
       - "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

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()