Fix broken output and add DRY_RUN for debugging

Author: jacob-hughes

artefacts.py

@@ -10,6 +10,8 @@
 
 from util import command_runner
 
+DRY_RUN = os.getenv("DRY_RUN", False)
+
 BIN_DIR = Path("artefacts/bin").resolve()
 LIB_DIR = Path("artefacts/lib").resolve()
 BUILD_DIR = Path("artefacts/build").resolve()
@@ -170,7 +172,7 @@ class Crate(Artefact):
     def cargo_toml(self):
         return f"{self.src}/Cargo.toml"
 
-    @command_runner(description="Building")
+    @command_runner(description="Building", dry_run=DRY_RUN)
     def _cargo_build(self):
         return [
             "cargo",
@@ -267,7 +269,7 @@ def path(self) -> Path:
     def installed(self) -> bool:
         return self.path.exists()
 
-    @command_runner(description="Building")
+    @command_runner(dry_run=DRY_RUN)
     def _xpy_install(self):
         return [
             f"{self.src}/x.py",

util.py

@@ -55,12 +55,13 @@ def __init__(self, desc, output):
 
 
 def command_runner(
-    description=None,
+    description="",
     write_progress=True,
     unit="objects",
     steps=None,
     verbose=False,
     allow_failure=True,
+    dry_run=False,
 ):
 
     def decorator(method):
@@ -70,7 +71,10 @@ def wrapper(self, *args, **kwargs):
             cmd = method(self, *args, **kwargs)
             desc = f"{description} {self.name}"
             with _temp_log_format(logger):
-                logger.info(f"\n[RUNNING COMMAND]\n")
+                if dry_run:
+                    logger.info(f"\n[DRY RUN]\n")
+                else:
+                    logger.info(f"\n[RUNNING COMMAND]\n")
                 if hasattr(self, "env"):
                     for key, value in self.env.items():
                         logging.info(f"{key}={value}")
@@ -87,6 +91,9 @@ def wrapper(self, *args, **kwargs):
                 else "{desc}:{percentage:3.0f}%"
             )
 
+            if dry_run:
+                return wrapper
+
             with subprocess.Popen(
                 cmd,
                 stdout=subprocess.PIPE,
@@ -113,8 +120,6 @@ def wrapper(self, *args, **kwargs):
                         pbar.update(1)
                         update_timer(1)
             pbar.close()
-            if write_progress:
-                tqdm.write(f"✔ {desc}")
             if not allow_failure and proc.returncode != 0:
                 raise CommandError(desc, "\n".join(buffer))