feat: Convert config template to pydantic model

backend/.gitignore

@@ -3,7 +3,6 @@
 
 .idea
 config/*
-!config/config_template.yaml
 .history
 **/__pycache__/
 .vscode

backend/capellacollab/__init__.py

@@ -3,13 +3,8 @@
 
 from importlib import metadata
 
-from capellacollab import config as config_module
-
 try:
     __version__ = metadata.version("capellacollab-backend")
 except metadata.PackageNotFoundError:
     __version__ = "0.0.0+unknown"
 del metadata
-
-
-config_module.validate_schema()

backend/capellacollab/__main__.py

@@ -50,18 +50,18 @@
 handlers: list[logging.Handler] = [
     logging.StreamHandler(),
     core_logging.CustomTimedRotatingFileHandler(
-        str(config["logging"]["logPath"]) + "backend.log"
+        str(config.logging.logPath) + "backend.log"
     ),
 ]
 
 for handler in handlers:
     handler.setFormatter(core_logging.CustomFormatter())
 
-logging.basicConfig(level=config["logging"]["level"], handlers=handlers)
+logging.basicConfig(level=config.logging.level, handlers=handlers)
 
 
 async def startup():
-    migration.migrate_db(engine, config["database"]["url"])
+    migration.migrate_db(engine, config.database.url)
     logging.info("Migrations done - Server is running")
 
     # This is needed to load the Kubernetes configuration at startup

backend/capellacollab/alembic/env.py

@@ -16,7 +16,7 @@
 # access to the values within the .ini file in use.
 config = context.config
 
-logging.basicConfig(level=cfg["logging"]["level"])
+logging.basicConfig(level=cfg.logging.level)
 if os.getenv("ALEMBIC_CONFIGURE_LOGGER", "true") != "false":
     logging.getLogger("capellacollab").setLevel("WARNING")
 
@@ -25,7 +25,7 @@
 # this will overwrite the ini-file sqlalchemy.url path
 # with the path given in the config of the main code
 if not config.get_main_option("sqlalchemy.url"):
-    config.set_main_option("sqlalchemy.url", cfg["database"]["url"])
+    config.set_main_option("sqlalchemy.url", cfg.database.url)
 
 # Import models
 

backend/capellacollab/config/__init__.py

@@ -1,23 +1,18 @@
 # SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
 # SPDX-License-Identifier: Apache-2.0
 
-
 import logging
 
-import jsonschema
-import jsonschema.exceptions
-
-from . import exceptions, loader
+from . import generate, loader, models
 
 log = logging.getLogger(__name__)
-config = loader.load_yaml()
+
+if not loader.does_config_exist():
+    log.warning(
+        "No configuration file found. Generating default configuration at backend/capellacollab/config/config.yaml"
+    )
+    generate.write_config()
 
 
-def validate_schema():
-    config_schema = loader.load_config_schema()
-    try:
-        jsonschema.validate(config, config_schema)
-    except jsonschema.exceptions.ValidationError as error:
-        raise exceptions.InvalidConfigurationError(
-            f"{error.__class__.__name__}: {error.message}",
-        ) from None
+config_data = loader.load_yaml()
+config = models.AppConfig(**config_data)

backend/config/config_template.yaml → backend/capellacollab/config/config.yaml

@@ -4,99 +4,64 @@
 docker:
   registry: k3d-myregistry.localhost:12345
   externalRegistry: docker.io
-
 k8s:
-  # Only required when using operator k8s
-  context: k3d-collab-cluster # Only required, if you'd like to use a local k3d environment
+  context: k3d-collab-cluster
   namespace: collab-sessions
-
-  # apiURL: dummy # Only required when no kubectl context is available
-  # token: dummy # Only required when no kubectl context is available
-
   storageClassName: local-path
   storageAccessMode: ReadWriteOnce
-
   cluster:
     imagePullPolicy: Always
     podSecurityContext:
       runAsUser: 1004370000
       runAsGroup: 1004370000
       fsGroup: 1004370000
       runAsNonRoot: true
-
   promtail:
-    lokiEnabled: True
+    lokiEnabled: true
     lokiUrl: http://localhost:30001/loki/api/v1/push
     lokiUsername: localLokiUser
     lokiPassword: localLokiPassword
     serverPort: 3101
-
+  ingressClassName: traefik
 general:
   host: localhost
   port: 8000
   scheme: http
-  wildcardHost: False
-
+  wildcardHost: false
 extensions:
   guacamole:
     baseURI: http://localhost:8080/guacamole
     publicURI: http://localhost:8080/guacamole
-
     username: guacadmin
     password: guacadmin
-
   jupyter:
     publicURI: http://localhost:8080/jupyter
-
 authentication:
-  provider: oauth # oauth | azure
+  provider: oauth
   jwt:
-    usernameClaim: sub # preferred_username
-
+    usernameClaim: sub
   oauth:
-    # Only required when using provider oauth
     endpoints:
       wellKnown: http://localhost:8083/default/.well-known/openid-configuration
-      tokenIssuance:
-      authorization:
-
+      tokenIssuance: null
+      authorization: null
     audience: default
-
     scopes:
-      - openid
-
+    - openid
     client:
       id: default
-      secret:
-
+      secret: null
     redirectURI: http://localhost:4200/oauth2/callback
-
-  # azure:
-  #   # Only required when using provider azure
-  #   authorizationEndpoint: http://tbd
-
-  #   client:
-  #     id: tbd
-  #     secret: tbd
-
-  #   audience: tbd
-  #   redirectURI: http://localhost:4200/oauth2/callback
-
 pipelines:
   timeout: 60
-
 database:
   url: postgresql://dev:dev@localhost:5432/dev
-
 initial:
   admin: admin
-
 logging:
   level: DEBUG
   logPath: logs/
-
 requests:
   timeout: 2
-
 prometheus:
   url: http://localhost:8080/prometheus/

backend/capellacollab/config/diff.py

@@ -3,12 +3,10 @@
 
 # pylint: disable=bad-builtin
 
-import pathlib
-
 import deepdiff
-import yaml
 
 from . import loader
+from . import models as config_models
 
 
 class bcolors:
@@ -22,16 +20,15 @@ class bcolors:
 
 print("Start comparison of configuration files")
 
-config_template = yaml.safe_load(
-    (
-        pathlib.Path(__file__).parents[2] / "config" / "config_template.yaml"
-    ).open()
-)
+pydantic_config = config_models.AppConfig()
 
 config = loader.load_yaml()
 
 diff = deepdiff.DeepDiff(
-    config, config_template, ignore_order=True, report_repetition=True
+    config,
+    pydantic_config.model_dump(),
+    ignore_order=True,
+    report_repetition=True,
 )
 
 for key, value in (

backend/capellacollab/config/generate.py

@@ -0,0 +1,20 @@
+# SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
+import os
+
+import yaml
+
+from . import models
+
+
+def write_config():
+    current_dir = os.path.dirname(os.path.realpath(__file__))
+    config_path = os.path.join(current_dir, "config.yaml")
+
+    app_config = models.AppConfig()
+    config_dict = app_config.model_dump()
+    yaml_str = yaml.dump(config_dict, sort_keys=False)
+
+    with open(config_path, "w", encoding="utf-8") as yaml_file:
+        yaml_file.write(yaml_str)

backend/capellacollab/config/loader.py

@@ -11,12 +11,14 @@
 from . import exceptions
 
 log = logging.getLogger(__name__)
+CONFIG_FILE_NAME = "config.yaml"
 
 config_locations: list[pathlib.Path] = [
-    pathlib.Path(__file__).parents[2] / "config" / "config.yaml",
+    pathlib.Path(__file__).parents[0] / CONFIG_FILE_NAME,
+    pathlib.Path(__file__).parents[2] / "config" / CONFIG_FILE_NAME,
     pathlib.Path(appdirs.user_config_dir("capellacollab", "db"))
-    / "config.yaml",
-    pathlib.Path("/etc/capellacollab") / "config.yaml",
+    / CONFIG_FILE_NAME,
+    pathlib.Path("/etc/capellacollab") / CONFIG_FILE_NAME,
 ]
 
 config_fallback_locations: list[pathlib.Path] = [
@@ -38,6 +40,18 @@ def construct_mapping(self, node, deep=False):
         return super().construct_mapping(node, deep)
 
 
+def does_config_exist() -> bool:
+    for loc in config_locations:
+        if loc.exists():
+            return True
+
+    for loc in config_fallback_locations:
+        if loc.exists():
+            return True
+
+    return False
+
+
 def load_yaml() -> dict:
     log.debug("Searching for configuration files...")
     for loc in config_locations: