Write runner_cfg to file.

Author: LarsAsplund

tests/acceptance/artificial/vhdl/tb_reading_runner_cfg_from_file.vhd

@@ -16,20 +16,9 @@ end entity;
 architecture tb of tb_reading_runner_cfg_from_file is
 begin
   test_runner : process
-    file runner_cfg_fptr : text;
-    variable runner_cfg_line : line;
   begin
-    file_open(runner_cfg_fptr, "runner.cfg", write_mode);
-    write(
-      runner_cfg_line,
-      string'("active python runner : true,enabled_test_cases : ,output path : " &
-      replace(output_path(runner_cfg), ":", "::") & ",tb path : " &
-      replace(tb_path(runner_cfg), ":", "::") & ",use_color : true")
-    );
-    writeline(runner_cfg_fptr, runner_cfg_line);
-    file_close(runner_cfg_fptr);
-
     test_runner_setup(runner, null_runner_cfg);
+
     check_true(active_python_runner(null_runner_cfg));
     check(output_path(null_runner_cfg) /= "");
     check(enabled_test_cases(null_runner_cfg) /= "__all__");

vunit/sim_if/__init__.py

@@ -215,6 +215,9 @@ def simulate(self, output_path, test_suite_name, config, elaborate_only):
         Simulate
         """
 
+    def get_simulator_output_path(self, output_path):
+        "Get current working directory for simulation"
+
     def setup_library_mapping(self, project):
         """
         Implemented by specific simulators

vunit/sim_if/activehdl.py

@@ -375,6 +375,9 @@ def _create_gui_script(self, common_file_name, config):
         for library in self._libraries:
             tcl += f"vmap {library.name!s} {fix_path(library.directory)!s}\n"
 
+        tcl += "global sim_working_folder\n"
+        tcl += f"set sim_working_folder {fix_path(str(Path(common_file_name).parent / 'gui'))}\n"
+
         tcl += "vunit_load\n"
 
         init_file = config.sim_options.get(self.name + ".init_file.gui", None)
@@ -428,11 +431,23 @@ def simulate(self, output_path, test_suite_name, config, elaborate_only):
 
         if self._gui:
             gui_path = str(script_path / "gui")
-            renew_path(gui_path)
+            if (script_path / "gui" / "runner.cfg").exists():
+                runner_cfg = (script_path / "gui" / "runner.cfg").read_text()
+                renew_path(gui_path)
+                (script_path / "gui" / "runner.cfg").write_text(runner_cfg)
+            else:
+                renew_path(gui_path)
+
             return self._run_batch_file(str(gui_file_name), gui=True, cwd=gui_path)
 
         return self._run_batch_file(str(batch_file_name), gui=False, cwd=str(Path(self._library_cfg).parent))
 
+    def get_simulator_output_path(self, output_path):
+        if self._gui:
+            return Path(output_path) / self.name / "gui"
+
+        return Path(self._library_cfg).parent
+
 
 @total_ordering
 class Version(object):

vunit/sim_if/ghdl.py

@@ -363,6 +363,9 @@ def simulate(self, output_path, test_suite_name, config, elaborate_only):  # pyl
 
         return status
 
+    def get_simulator_output_path(self, output_path):
+        return Path(".")
+
     def _compile_source_file(self, source_file, printer):
         """
         Runs parent command for compilation, and moves any .gcno files to the compilation output

vunit/sim_if/incisive.py

@@ -347,6 +347,9 @@ def simulate(self, output_path, test_suite_name, config, elaborate_only=False):
                 return False
         return True
 
+    def get_simulator_output_path(self, output_path):
+        return Path(output_path) / self.name
+
     def _hdlvar_args(self):
         """
         Return hdlvar argument if available

vunit/sim_if/vsim_simulator_mixin.py

@@ -331,6 +331,9 @@ def simulate(self, output_path, test_suite_name, config, elaborate_only):
 
         return self._run_batch_file(str(batch_file_name))
 
+    def get_simulator_output_path(self, output_path):
+        return Path(self._sim_cfg_file_name).parent
+
 
 def fix_path(path):
     """

vunit/test/suites.py

@@ -231,6 +231,11 @@ def _simulate(self, output_path):
             "tb path": config.tb_path.replace("\\", "/") + "/",
         }
 
+        # TODO: remove file after?
+        simulator_output_path = self._simulator_if.get_simulator_output_path(output_path) / "runner.cfg"
+        simulator_output_path.parent.mkdir(parents=True, exist_ok=True)
+        simulator_output_path.write_text(encode_dict(runner_cfg))
+
         # @TODO Warn if runner cfg already set?
         config.generics["runner_cfg"] = encode_dict(runner_cfg)