fix: [config] add explicit relative path field to the config loading

The rel_path is a calculated field that is critical to determining where
files are placed and found in the scratch dir and also the reports dir.
At the moment the field is not created until the flow objects are
created. Which means that the saved config doesn't have the information
unless it's overridden in the config itself.

This commit moves the calculated field out of the flow base class init
into the config loading stage where it is saved the filesystem in the
scratch dir along with the rest of the loaded config. Which means it can
be used to navigate the scratch dir after a run.

Signed-off-by: James McCorrie <james.mccorrie@lowrisc.org>

Author: machshev

src/dvsim/project.py

@@ -32,6 +32,9 @@ class FlowConfig(BaseModel):
     flow: str
     name: str
 
+    self_dir: Path
+    rel_path: Path
+
 
 class TopFlowConfig(BaseModel):
     """Flow configuration data."""
@@ -42,6 +45,9 @@ class TopFlowConfig(BaseModel):
     project: str
     revision: str
 
+    self_dir: Path
+    rel_path: Path
+
     cfgs: Mapping[Path, FlowConfig]
 
 
@@ -209,6 +215,13 @@ def _load_flow_config(
         cfg["tool"] = args.tool
 
     if "cfgs" in cfg:
+        # add any missing rel_path fields
+        for child_cfg in cfg["cfgs"].values():
+            if "rel_path" not in child_cfg:
+                child_cfg["rel_path"] = child_cfg["self_dir"].relative_to(
+                    root_path,
+                )
+
         return TopFlowConfig.model_validate(cfg)
 
     return FlowConfig.model_validate(cfg)

tests/test_project.py

@@ -29,6 +29,8 @@
                 "config": {
                     "flow": "flow",
                     "name": "name",
+                    "self_dir": Path("self_dir"),
+                    "rel_path": Path("rel_path"),
                 },
             },
             FlowConfig,