Merge pull request #138 from merkelmarrow/fix/config-cfg-pre-synth-wiring

Wire config.cfg pre_synth entries into hardware builds

Author: quetric

linker/slashkit/core/command_config.py

@@ -19,7 +19,7 @@
 # ##################################################################################################
 from enum import Enum
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Dict, List, Optional, Set
 import re
 import os
 import shutil
@@ -229,13 +229,7 @@ def __init__(self, args: argparse.Namespace):
             self._build_dir.unlink()
         self._build_dir.mkdir(parents=True)
 
-        # Resolve and verify pre-synthesis TCLs (if any)
-        self._pre_synth_tcls: List[Path] = []
-        for path in args.pre_synth_tcls:
-            path: Path = path.expanduser().resolve()
-            if not path.is_file():
-                raise FileNotFoundError(path)
-            self._pre_synth_tcls.append(path)
+        # pre-synth Tcls are resolved below, once the config is parsed.
 
         # Misc. arguments
         self._platform = Platform(args.platform)
@@ -267,6 +261,20 @@ def __init__(self, args: argparse.Namespace):
         self._kernel_instances: List[KernelInstance] = apply_config_to_instances(
             self.configuration, self.kernels)
 
+        # merge config [user_region] pre_synth= entries with the --pre-synth-tcls
+        # flag. config entries source first, then CLI ones, with duplicates
+        # dropped at their first occurrence.
+        self._pre_synth_tcls: List[Path] = []
+        seen: Set[Path] = set()
+        for raw in [*self._configuration.user_region.pre_synth_tcls,
+                    *args.pre_synth_tcls]:
+            path = Path(raw).expanduser().resolve()
+            if not path.is_file():
+                raise FileNotFoundError(path)
+            if path not in seen:
+                seen.add(path)
+                self._pre_synth_tcls.append(path)
+
     @property
     def block_design_ports(self) -> BlockDesignPorts:
         return self._bd_ports

linker/test/core/__init__.py

@@ -0,0 +1,124 @@
+# ##################################################################################################
+#  The MIT License (MIT)
+#  Copyright (c) 2025-2026 Advanced Micro Devices, Inc. All rights reserved.
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+#  and associated documentation files (the "Software"), to deal in the Software without restriction,
+#  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+#  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all copies or
+#  substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# ##################################################################################################
+
+"""Tests for core.command_config — pre-synth Tcl resolution and merging."""
+
+import argparse
+import textwrap
+from pathlib import Path
+from unittest import mock
+
+import pytest
+
+from slashkit.core import command_config
+from slashkit.core.command_config import LinkerConfiguration
+
+_FIXTURE_COMPONENT = (
+    Path(__file__).resolve().parents[1]
+    / "fixtures" / "dma_in" / "hls" / "impl" / "ip" / "component.xml"
+)
+
+
+def _make_args(tmp_path: Path, *, config: Path, cli_pre_synth):
+    vivado = tmp_path / "vivado"
+    vivado.write_text("#!/bin/sh\n")
+    vivado.chmod(0o755)
+    return argparse.Namespace(
+        vivado=vivado,
+        jobs=8,
+        config=config,
+        kernels=[_FIXTURE_COMPONENT],
+        out=tmp_path / "out.vbin",
+        platform="hw",
+        pre_synth_tcls=list(cli_pre_synth),
+        clock_hz=None,
+    )
+
+
+def _build_config(tmp_path: Path, *, config: Path, cli_pre_synth):
+    """Construct a LinkerConfiguration with the heavy, environment-dependent
+    lookups stubbed out, so only the pre-synth resolution/merging is exercised."""
+    args = _make_args(tmp_path, config=config, cli_pre_synth=cli_pre_synth)
+    with mock.patch.object(command_config, "_find_vitis_include",
+                           return_value=tmp_path), \
+            mock.patch.object(command_config, "apply_config_to_instances",
+                              return_value=[]):
+        return LinkerConfiguration(args)
+
+
+def _write_cfg(tmp_path: Path, body: str) -> Path:
+    cfg = tmp_path / "config.cfg"
+    cfg.write_text(textwrap.dedent(body))
+    return cfg
+
+
+def test_config_cfg_pre_synth_reaches_pre_synth_tcls(tmp_path):
+    """[user_region] pre_synth= entries from the config file must be honoured."""
+    a = tmp_path / "a.tcl"
+    a.write_text("# a\n")
+    cfg = _write_cfg(tmp_path, """
+        [connectivity]
+        [user_region]
+        pre_synth=a.tcl
+    """)
+    config = _build_config(tmp_path, config=cfg, cli_pre_synth=[])
+    assert config.pre_synth_tcls == [a.resolve()]
+
+
+def test_config_cfg_and_cli_pre_synth_are_merged_in_order(tmp_path):
+    """Config-declared scripts run first, then CLI ones."""
+    a = tmp_path / "a.tcl"
+    a.write_text("# a\n")
+    b = tmp_path / "b.tcl"
+    b.write_text("# b\n")
+    cli = tmp_path / "cli.tcl"
+    cli.write_text("# cli\n")
+    cfg = _write_cfg(tmp_path, """
+        [connectivity]
+        [user_region]
+        pre_synth=a.tcl
+        pre_synth=b.tcl
+    """)
+    config = _build_config(tmp_path, config=cfg, cli_pre_synth=[cli])
+    assert config.pre_synth_tcls == [a.resolve(), b.resolve(), cli.resolve()]
+
+
+def test_pre_synth_duplicates_are_de_duplicated(tmp_path):
+    """A script named in both the config and on the CLI is sourced once."""
+    a = tmp_path / "a.tcl"
+    a.write_text("# a\n")
+    cfg = _write_cfg(tmp_path, """
+        [connectivity]
+        [user_region]
+        pre_synth=a.tcl
+    """)
+    config = _build_config(tmp_path, config=cfg, cli_pre_synth=[a])
+    assert config.pre_synth_tcls == [a.resolve()]
+
+
+def test_missing_config_cfg_pre_synth_raises(tmp_path):
+    """A non-existent [user_region] pre_synth path fails fast."""
+    cfg = _write_cfg(tmp_path, """
+        [connectivity]
+        [user_region]
+        pre_synth=does_not_exist.tcl
+    """)
+    with pytest.raises(FileNotFoundError):
+        _build_config(tmp_path, config=cfg, cli_pre_synth=[])