feat(conf): centralise config management (#464)

Author: Shillaker

boaviztapi/__init__.py

@@ -1,10 +1,9 @@
 import os
 import sys
-from pathlib import Path
 
-import yaml
+from boaviztapi.utils.config import config
 
-data_dir_test = os.path.join(os.path.dirname(__file__), "../tests/data")
+data_dir_test = os.path.join(os.path.dirname(__file__), "..", "tests", "data")
 data_dir_prod = os.path.join(os.path.dirname(__file__), "data")
 
 # Use test data if using pytest, and not running E2E tests
@@ -13,5 +12,4 @@
 else:
     data_dir = data_dir_prod
 
-config_file = os.path.join(data_dir, "config.yml")
-config = yaml.safe_load(Path(config_file).read_text())
+__all__ = ["config", "data_dir", "data_dir_test", "data_dir_prod"]

boaviztapi/data/config.yml

@@ -20,7 +20,7 @@ class CPU(ComponentDTO):
 
 
 def mapper_cpu(
-    cpu_dto: CPU, archetype=get_component_archetype(config["default_cpu"], "cpu")
+    cpu_dto: CPU, archetype=get_component_archetype(config.default_cpu, "cpu")
 ) -> ComponentCPU:
     cpu_component = ComponentCPU(archetype=archetype)
     cpu_component.usage = mapper_usage(

boaviztapi/dto/component/cpu.py

@@ -18,7 +18,7 @@ class Disk(ComponentDTO):
 
 
 def mapper_ssd(
-    disk_dto: Disk, archetype=get_component_archetype(config["default_ssd"], "ssd")
+    disk_dto: Disk, archetype=get_component_archetype(config.default_ssd, "ssd")
 ) -> ComponentSSD:
     disk_component = ComponentSSD(archetype=archetype)
     disk_component.usage = mapper_usage(
@@ -44,7 +44,7 @@ def mapper_ssd(
 
 
 def mapper_hdd(
-    disk_dto: Disk, archetype=get_component_archetype(config["default_hdd"], "hdd")
+    disk_dto: Disk, archetype=get_component_archetype(config.default_hdd, "hdd")
 ) -> ComponentHDD:
     disk_component = ComponentHDD(archetype=archetype)
     disk_component.usage = mapper_usage(

boaviztapi/dto/component/disk.py

@@ -23,7 +23,7 @@ class GPU(ComponentDTO):
 
 
 def mapper_gpu(
-    gpu_dto: GPU, archetype=get_component_archetype(config["default_gpu"], "gpu")
+    gpu_dto: GPU, archetype=get_component_archetype(config.default_gpu, "gpu")
 ) -> ComponentGPU:
     gpu_component = ComponentGPU(archetype=archetype)
 

boaviztapi/dto/component/gpu.py

@@ -25,7 +25,7 @@ class Case(ComponentDTO):
 
 def mapper_power_supply(
     power_supply_dto: PowerSupply,
-    archetype=get_component_archetype(config["default_power_supply"], "power_supply"),
+    archetype=get_component_archetype(config.default_power_supply, "power_supply"),
 ) -> ComponentPowerSupply:
     power_supply_component = ComponentPowerSupply(archetype=archetype)
     power_supply_component.usage = mapper_usage(
@@ -52,7 +52,7 @@ def mapper_motherboard(motherboard_dto: Motherboard) -> ComponentMotherboard:
 
 
 def mapper_case(
-    case_dto: Case, archetype=get_component_archetype(config["default_case"], "case")
+    case_dto: Case, archetype=get_component_archetype(config.default_case, "case")
 ) -> ComponentCase:
     case_component = ComponentCase(archetype=archetype)
     case_component.usage = mapper_usage(

boaviztapi/dto/component/other.py

@@ -26,7 +26,7 @@ class RAM(ComponentDTO):
 
 
 def mapper_ram(
-    ram_dto: RAM, archetype=get_component_archetype(config["default_ram"], "ram")
+    ram_dto: RAM, archetype=get_component_archetype(config.default_ram, "ram")
 ) -> ComponentRAM:
     ram_component = ComponentRAM(archetype=archetype)
     ram_component.usage = mapper_usage(

boaviztapi/dto/component/ram.py

@@ -48,7 +48,7 @@ class Server(DeviceDTO):
 
 
 def mapper_server(
-    server_dto: Server, archetype=get_server_archetype(config["default_server"])
+    server_dto: Server, archetype=get_server_archetype(config.default_server)
 ) -> DeviceServer:
     server_model = DeviceServer(archetype=archetype)
 
@@ -93,7 +93,7 @@ class Cloud(Server):
 def mapper_cloud_instance(
     cloud_dto: Cloud,
     archetype=get_cloud_instance_archetype(
-        config["default_cloud_instance"], config["default_cloud_provider"]
+        config.default_cloud_instance, config.default_cloud_provider
     ),
 ) -> ServiceCloudInstance:
     if (

boaviztapi/dto/device/device.py

@@ -65,8 +65,7 @@ def _reset_usage_dto_if_matches_config_defaults(usage_dto: Usage):
     """Reset usage_dto fields to None if they match the config default values."""
     if (
         usage_dto.usage_location
-        and usage_dto.usage_location.strip().upper()
-        == config["default_location"].upper()
+        and usage_dto.usage_location.strip().upper() == config.default_location.upper()
     ):
         usage_dto.usage_location = None
 
@@ -115,7 +114,7 @@ def mapper_usage(usage_dto: Usage, archetype=None) -> ModelUsage:
 
 def mapper_usage_server(
     usage_dto: UsageServer,
-    archetype=get_server_archetype(config["default_server"]).get("USAGE"),
+    archetype=get_server_archetype(config.default_server).get("USAGE"),
 ) -> ModelUsageServer:
     usage_model_server = ModelUsageServer(archetype=archetype)
     _reset_usage_dto_if_matches_config_defaults(usage_dto)
@@ -159,7 +158,7 @@ def mapper_usage_server(
 def mapper_usage_cloud(
     usage_dto: UsageCloud,
     archetype=get_cloud_instance_archetype(
-        config["default_cloud_instance"], config["default_cloud_provider"]
+        config.default_cloud_instance, config.default_cloud_provider
     ).get("USAGE"),
 ) -> ModelUsageCloud:
     usage_model_cloud = ModelUsageCloud(archetype=archetype)

boaviztapi/dto/usage/usage.py

@@ -1,4 +1,3 @@
-import json
 import logging
 
 import anyio
@@ -17,6 +16,7 @@
 import threading
 import uvicorn
 
+from boaviztapi import config
 from boaviztapi.routers.component_router import component_router
 from boaviztapi.routers.consumption_profile_router import consumption_profile
 from boaviztapi.routers.iot_router import iot
@@ -57,7 +57,7 @@ async def lifespan(app: FastAPI):
 version = get_version_from_pyproject()
 _logger = logging.getLogger(__name__)
 
-origins = json.loads(os.getenv("ALLOWED_ORIGINS", '["*"]'))
+origins = config.allowed_origins
 
 
 # Ensure that even an uncaught exception includes CORS headers.
@@ -103,7 +103,8 @@ async def catch_exceptions_middleware(request: Request, call_next):
 
 @app.get("/", response_class=HTMLResponse)
 async def welcome_page():
-    html_content = """
+    html_content = (
+        """
     <html>
         <head>
             <title>BOAVIZTAPI</title>
@@ -131,7 +132,9 @@ async def welcome_page():
             %s
         </body>
     </html>
-    """ % os.getenv("SPECIAL_MESSAGE", "")
+    """
+        % config.special_message
+    )
     return HTMLResponse(content=html_content, status_code=200)