Hand tested the command actually finish on the first error

Author: KelvinChung2000

FABulous/FABulous_CLI/FABulous_CLI.py

@@ -221,7 +221,7 @@ def onecmd(
         except Exception:
             logger.debug(traceback.format_exc())
             self.exit_code = 1
-            if not self.interactive:
+            if self.interactive:
                 return False
             else:
                 return not self.force
@@ -757,17 +757,18 @@ def do_place_and_route(self, args):
                     "--log",
                     f"{self.projectDir}/{parent}/{log_file}",
                 ]
-                try:
-                    sp.run(
-                        " ".join(runCmd),
-                        stdout=sys.stdout,
-                        stderr=sp.STDOUT,
-                        check=True,
-                        shell=True,
+                result = sp.run(
+                    " ".join(runCmd),
+                    stdout=sys.stdout,
+                    stderr=sp.STDOUT,
+                    check=True,
+                    shell=True,
+                )
+                if result.returncode != 0:
+                    logger.opt(exception=CommandError()).error(
+                        "Nextpnr failed. Please check the logs for more details."
                     )
-                except sp.CalledProcessError as e:
-                    logger.opt(exception=e).error("Placement and Routing failed.")
-
+                    return
             else:
                 logger.opt(exception=FileNotFoundError()).error(
                     f'Cannot find file "{json_file}" in path "./{parent}/", which is generated by running Yosys with Nextpnr backend (e.g. synthesis).'
@@ -865,6 +866,7 @@ def do_run_simulation(self, args):
         if bitstreamPath.suffix != ".bin":
             logger.error("No bitstream file specified.")
             return
+
         if not bitstreamPath.exists():
             logger.opt(exception=FileNotFoundError()).error(
                 f"Cannot find {bitstreamPath} file which is generated by running gen_bitStream_binary. Potentially the bitstream generation failed."
@@ -894,27 +896,28 @@ def do_run_simulation(self, args):
         iverilog = check_if_application_exists(
             os.getenv("FAB_IVERILOG_PATH", "iverilog")
         )
-        try:
-            runCmd = [
-                f"{iverilog}",
-                "-D",
-                f"{defined_option}",
-                "-s",
-                f"{topModuleTB}",
-                "-o",
-                f"{buildDir}/{vvpFile}",
-                *file_list,
-                f"{bitstreamPath.parent}/{designFile}",
-                f"{testPath}/{testBench}",
-            ]
-            if self.verbose or self.debug:
-                logger.info(f"Running simulation with {args.format} format")
-                logger.info(f"Running command: {' '.join(runCmd)}")
-            sp.run(runCmd, check=True)
+        runCmd = [
+            f"{iverilog}",
+            "-D",
+            f"{defined_option}",
+            "-s",
+            f"{topModuleTB}",
+            "-o",
+            f"{buildDir}/{vvpFile}",
+            *file_list,
+            f"{bitstreamPath.parent}/{designFile}",
+            f"{testPath}/{testBench}",
+        ]
+        if self.verbose or self.debug:
+            logger.info(f"Running simulation with {args.format} format")
+            logger.info(f"Running command: {' '.join(runCmd)}")
 
-        except sp.CalledProcessError as e:
-            remove_dir(buildDir)
-            logger.opt(exception=e).error("Simulation failed")
+        result = sp.run(runCmd, check=True)
+        if result.returncode != 0:
+            logger.opt(exception=CommandError()).error(
+                "Simulation failed. Please check the logs for more details."
+            )
+            return
 
         # bitstream hex file is used for simulation so it'll be created in the test directory
         bitstreamHexPath = (buildDir.parent / bitstreamPath.stem).with_suffix(".hex")
@@ -931,16 +934,18 @@ def do_run_simulation(self, args):
         if waveform_format == "fst":
             vvpArgs.append("-fst")
 
-        try:
-            runCmd = [f"{vvp}", f"{buildDir}/{vvpFile}"]
-            runCmd.extend(vvpArgs)
-            if self.verbose or self.debug:
-                logger.info(f"Running command: {' '.join(runCmd)}")
-            sp.run(runCmd, check=True)
-            remove_dir(buildDir)
-        except sp.CalledProcessError as e:
-            remove_dir(buildDir)
-            logger.opt(exception=e).error("Simulation failed")
+        runCmd = [f"{vvp}", f"{buildDir}/{vvpFile}"]
+        runCmd.extend(vvpArgs)
+        if self.verbose or self.debug:
+            logger.info(f"Running command: {' '.join(runCmd)}")
+
+        result = sp.run(runCmd, check=True)
+        remove_dir(buildDir)
+        if result.returncode != 0:
+            logger.opt(exception=CommandError()).error(
+                "Simulation failed. Please check the logs for more details."
+            )
+            return
 
         logger.info("Simulation finished")
 
@@ -976,12 +981,14 @@ def do_run_FABulous_bitstream(self, args):
             do_synth_args += f" -extra-plib {primsLib}"
         else:
             logger.info("No external primsLib found.")
+
         self.onecmd_plus_hooks(f"synthesis {do_synth_args}")
         if self.exit_code != 0:
             logger.opt(exception=CommandError()).error(
                 "Synthesis failed. Please check the logs for more details."
             )
             return
+
         self.onecmd_plus_hooks(f"place_and_route {json_file_path}")
         if self.exit_code != 0:
             logger.opt(exception=CommandError()).error(
@@ -1026,6 +1033,11 @@ def do_run_script(self, args):
         with open(args.file, "r") as f:
             for i in f.readlines():
                 self.onecmd_plus_hooks(i.strip())
+                if self.exit_code != 0:
+                    logger.opt(exception=CommandError()).error(
+                        f"Script execution failed at line: {i.strip()}"
+                    )
+                    return
 
         logger.info("Script executed")
 

FABulous/FABulous_CLI/cmd_synthesis.py

@@ -2,6 +2,7 @@
 import subprocess as sp
 from pathlib import Path
 
+from FABulous.custom_exception import CommandError
 from cmd2 import Cmd, Cmd2ArgumentParser, with_argparser, with_category
 from loguru import logger
 
@@ -290,8 +291,10 @@ def do_synthesis(self, args):
         *[str(i) for i in paths],
     ]
     logger.debug(f"{runCmd}")
-    try:
-        sp.run(runCmd, check=True)
-        logger.info("Synthesis completed")
-    except sp.CalledProcessError:
-        logger.error("Synthesis failed")
+    result = sp.run(runCmd, check=True)
+
+    if result.returncode != 0:
+        logger.opt(exception=CommandError()).error(
+            "Synthesis failed with non-zero return code."
+        )
+    logger.info("Synthesis command executed successfully.")

FABulous/FABulous_CLI/helper.py

@@ -50,13 +50,16 @@ def custom_format_function(record):
 
     # Add logger to write logs to stdout using the custom formatter
     if log_file != Path():
-        logger.add(log_file, format=custom_format_function, level=log_level_to_set)
+        logger.add(
+            log_file, format=custom_format_function, level=log_level_to_set, catch=False
+        )
     else:
         logger.add(
             sys.stdout,
             format=custom_format_function,
             level=log_level_to_set,
             colorize=True,
+            catch=False,
         )
 
 

tests/CLI_test/test_CLI.py

@@ -1,10 +1,7 @@
 from pathlib import Path
-import subprocess
-import pytest
-from FABulous.FABulous_CLI.FABulous_CLI import FABulous_CLI
+
 from tests.conftest import (
     TILE,
-    normalize,
     normalize_and_check_for_errors,
     run_cmd,
 )
@@ -100,7 +97,7 @@ def test_gen_model_npnr(cli, caplog):
 
 def test_run_FABulous_bitstream(cli, caplog, mocker):
     """Test the run_FABulous_bitstream command"""
-    m = mocker.patch("subprocess.run", return_value=None)
+    m = mocker.patch("subprocess.run", side_effect=RuntimeError("Mocked error"))
     run_cmd(cli, "run_FABulous_fabric")
     Path(cli.projectDir / "user_design" / "sequential_16bit_en.json").touch()
     Path(cli.projectDir / "user_design" / "sequential_16bit_en.fasm").touch()
@@ -112,7 +109,7 @@ def test_run_FABulous_bitstream(cli, caplog, mocker):
 
 def test_run_simulation(cli, caplog, mocker):
     """Test running simulation"""
-    m = mocker.patch("subprocess.run", return_value=None)
+    m = mocker.patch("subprocess.run", side_effect=RuntimeError("Mocked error"))
     run_cmd(cli, "run_FABulous_fabric")
     Path(cli.projectDir / "user_design" / "sequential_16bit_en.json").touch()
     Path(cli.projectDir / "user_design" / "sequential_16bit_en.fasm").touch()
@@ -137,10 +134,8 @@ def test_run_tcl(cli, caplog, tmp_path):
     assert "TCL script executed" in log[-1]
 
 
-def test_multi_command_stop(cli, caplog, monkeypatch):
-    monkeypatch.setattr(
-        subprocess, "run", lambda: False, raising=ValueError("Command failed")
-    )
+def test_multi_command_stop(cli, mocker):
+    m = mocker.patch("subprocess.run", side_effect=RuntimeError("Mocked error"))
     run_cmd(cli, "run_FABulous_bitstream ./user_design/sequential_16bit_en.v")
-    log = normalize(caplog.text)
-    assert "ERROR" in log[-2]
+
+    m.assert_called_once()