Build: fail gracefully

Author: howetuft

build-system/luxmake/__main__.py

@@ -7,10 +7,9 @@
 It is intended to get the same behaviour between Windows and *nix os
 """
 
-import logging
 import argparse
 
-from .utils import logger
+from .utils import set_logger_verbose
 from .deps import deps
 from .presets import list_presets
 from .config import config
@@ -22,10 +21,6 @@
 
 def main():
     """Entry point."""
-    # Set-up logger
-    logger.setLevel(logging.INFO)
-    logging.basicConfig(level=logging.INFO)
-
     # Get command-line parameters
     parser = argparse.ArgumentParser(
         prog="make",
@@ -65,7 +60,7 @@ def main():
     parser_wheel = subparsers.add_parser("wheel-test")
     parser_wheel.set_defaults(func=make_wheel)
 
-    # Win wheel recomposing
+    # Windows wheel recomposing
     parser_wheel = subparsers.add_parser("win-recompose")
     parser_wheel.add_argument("wheel")
     parser_wheel.set_defaults(func=win_recompose)
@@ -80,8 +75,7 @@ def main():
 
     args = parser.parse_args()
     if args.verbose:
-        logger.setLevel(logging.DEBUG)
-        logger.debug("Verbose mode")
+        set_logger_verbose()
     args.func(args)
 
 

build-system/luxmake/build.py

@@ -4,9 +4,8 @@
 
 """Build and install commands."""
 
-import sys
 from .constants import INSTALL_DIR, BUILD_TYPE, BUILD_DIR
-from .utils import run_cmake, logger
+from .utils import run_cmake, fail
 from .presets import get_presets, PresetType
 
 
@@ -60,22 +59,11 @@ def _get_preset_from_build_type(
     try:
         preset = _PRESETS[build_type]
     except KeyError:
-        logger.error(
-            "Unknown build type '%s'",
+        fail(
+            "Unknown build type '%s'. Valid values (case sensitive) are: '%s'",
             build_type,
-        )
-        logger.error(
-            "Valid values (case sensitive) are: %s",
             _PRESETS.keys(),
         )
-        sys.exit(1)
     if preset not in (presets := get_presets(PresetType.BUILD)):
-        logger.error(
-            "Preset '%s' missing",
-            preset,
-        )
-        logger.error(
-            "Available presets: %s",
-            presets,
-        )
+        fail("Preset '%s' missing. Available presets: '%s'", preset, presets)
     return preset

build-system/luxmake/clear.py

@@ -51,6 +51,7 @@ def clear(
                 ignore_errors=True,
             )
         except FileNotFoundError:
+            # Do not fail if not found
             logger.debug(
                 "'%s' not found",
                 directory,

build-system/luxmake/deps.py

@@ -6,40 +6,23 @@
 
 import os
 import tempfile
-from urllib.request import (
-    urlretrieve,
-)
-from urllib.parse import (
-    urlparse,
-)
-from pathlib import (
-    Path,
-)
-from zipfile import (
-    ZipFile,
-)
+from urllib.request import urlretrieve
+from urllib.parse import urlparse
+from pathlib import Path
+from zipfile import ZipFile
 import subprocess
-import logging
 import shutil
 import argparse
 import json
 import platform
-import sys
-from functools import (
-    cache,
-)
-from dataclasses import (
-    dataclass,
-)
+from functools import cache
 
 
 from .constants import BINARY_DIR
+from .utils import logger, fail, Colors, set_logger_verbose
 
 CONAN_ALL_PACKAGES = '"*"'
 
-
-logger = logging.getLogger("LuxCore Dependencies")
-
 CONAN_ENV = {}
 
 URL_SUFFIXES = {
@@ -50,21 +33,6 @@
 }
 
 
-@dataclass
-class Colors:
-    """Colors for terminal output."""
-
-    HEADER = "\033[95m"
-    OKBLUE = "\033[94m"
-    OKCYAN = "\033[96m"
-    OKGREEN = "\033[92m"
-    WARNING = "\033[93m"
-    FAIL = "\033[91m"
-    ENDC = "\033[0m"
-    BOLD = "\033[1m"
-    UNDERLINE = "\033[4m"
-
-
 def find_platform():
     """Find current platform."""
     system = platform.system()
@@ -118,8 +86,7 @@ def ensure_conan_app():
     """Ensure Conan is installed."""
     logger.info("Looking for conan")
     if not (res := shutil.which("conan")):
-        logger.error("Conan not found!")
-        sys.exit(1)
+        fail("Conan not found!")
     logger.info(
         "Conan found: '%s'",
         res,
@@ -151,10 +118,7 @@ def run_conan(
         **kwargs,
     )
     if res.returncode:
-        logger.error("Error while executing conan")
-        print(res.stdout)
-        print(res.stderr)
-        sys.exit(1)
+        fail("Error while executing conan:\n%s\n%s", res.stdout, res.stderr)
     return res
 
 
@@ -275,10 +239,7 @@ def conan_home():
         check=False,
     )
     if res.returncode:
-        logger.error("Error while executing conan")
-        print(res.stdout)
-        print(res.stderr)
-        sys.exit(1)
+        fail("Error while executing conan:\n%s\n%s", res.stdout, res.stderr)
     return Path(res.stdout.strip())
 
 
@@ -309,8 +270,6 @@ def main(
     )
 
     # Set-up logger
-    logger.setLevel(logging.INFO)
-    logging.basicConfig(level=logging.INFO)
     msg = f"{Colors.OKBLUE}BEGIN{Colors.ENDC}"
     logger.info(msg)
 
@@ -358,7 +317,7 @@ def main(
     else:
         args = parser.parse_args(call_args)
     if args.verbose:
-        logger.setLevel(logging.DEBUG)
+        set_logger_verbose()
     if args.output:
         output_dir = args.output
 
@@ -374,7 +333,7 @@ def main(
                 "CONAN_HOME": str(_conan_home),
                 "GCC_VERSION": str(settings["Build"]["gcc"]),
                 "CXX_VERSION": str(settings["Build"]["cxx"]),
-                "BUILD_TYPE": "Release",  # TODO Command line parameter
+                "BUILD_TYPE": "Release",
             }
         )
 

build-system/luxmake/utils.py

@@ -9,9 +9,39 @@
 import logging
 import shutil
 import subprocess
+from dataclasses import dataclass
 
 # Logger
-logger = logging.getLogger("LuxCore Build")
+logger = logging.getLogger("LuxCore")
+
+
+def set_logger_verbose():
+    """Set logger in verbose mode (show debug messages)."""
+    logger.setLevel(logging.DEBUG)
+    logger.debug("Verbose mode")
+
+
+def fail(*args):
+    """Fails gracefully."""
+    print(end=Colors.FAIL, flush=True)
+    logger.error(*args)
+    print(end=Colors.ENDC, flush=True)
+    sys.exit(1)
+
+
+@dataclass
+class Colors:
+    """Colors for terminal output."""
+
+    HEADER = "\033[95m"
+    OKBLUE = "\033[94m"
+    OKCYAN = "\033[96m"
+    OKGREEN = "\033[92m"
+    WARNING = "\033[93m"
+    FAIL = "\033[91m"
+    ENDC = "\033[0m"
+    BOLD = "\033[1m"
+    UNDERLINE = "\033[4m"
 
 
 # Cmake
@@ -20,8 +50,7 @@ def ensure_cmake_app():
     """Ensure cmake is installed."""
     logger.debug("Looking for cmake")
     if not (res := shutil.which("cmake")):
-        logger.error("CMake not found!")
-        sys.exit(1)
+        fail("CMake not found!")
     logger.debug(
         "CMake found: '%s'",
         res,
@@ -44,10 +73,7 @@ def run_cmake(
         **kwargs,
     )
     if res.returncode:
-        logger.error("Error while executing cmake")
-        print(res.stdout)
-        print(res.stderr)
-        sys.exit(1)
+        fail("Error while executing cmake:\n%s\n%s", res.stdout, res.stderr)
     return res
 
 
@@ -66,8 +92,7 @@ def unpack(path, dest):
             args, text=True, stderr=subprocess.STDOUT
         )
     except subprocess.CalledProcessError as err:
-        logger.error(err.output)
-        sys.exit(1)
+        fail(err.output)
     logger.info(output)
 
 
@@ -86,6 +111,11 @@ def pack(directory, dest_dir):
             args, text=True, stderr=subprocess.STDOUT
         )
     except subprocess.CalledProcessError as err:
-        logger.error(err.output)
-        sys.exit(1)
+        fail(err.output)
     logger.info(output)
+
+
+# Initialization
+# Set-up logger
+logger.setLevel(logging.INFO)
+logging.basicConfig(level=logging.INFO)

build-system/luxmake/wheel.py

@@ -14,7 +14,7 @@
 from pathlib import Path
 
 from .constants import SOURCE_DIR, INSTALL_DIR, BINARY_DIR, WHEELHOUSE_DIR
-from .utils import logger, pack
+from .utils import logger, pack, fail
 from .build import build_and_install
 from .windows import win_recompose
 
@@ -43,8 +43,7 @@ def _compute_platform_tag():
         return "macosx_14_2"
 
     # Failed:
-    logger.error("Unknown platform/system: '%s' / '%s'", platform, machine)
-    sys.exit(1)
+    return fail("Unknown platform/system: '%s' / '%s'", platform, machine)
 
 
 def _get_lib_paths():
@@ -144,8 +143,7 @@ def make_wheel(args):
         try:
             result = subprocess.check_output(cmd, text=True)
         except subprocess.CalledProcessError as err:
-            logger.error(err)
-            sys.exit(1)
+            fail(err)
         logger.info(result)
 
         # And, for Windows, recompose

build-system/luxmake/windows.py

@@ -13,11 +13,11 @@
 import argparse
 import tempfile
 import shutil
-import sys
 
 from wheel.wheelfile import WheelFile
 
-from .utils import pack, unpack, logger
+from .utils import pack, unpack, logger, fail
+
 
 def _rename(basepath, org, dest):
     """Rename wheel component."""
@@ -27,8 +27,7 @@ def _rename(basepath, org, dest):
             basepath / "pyluxcore.libs" / dest,
         )
     except FileNotFoundError:
-        logger.error("Missing file in wheel: '%s'", org)
-        sys.exit(1)
+        fail("Missing file in wheel: '%s'", org)
 
 
 def win_recompose(args):
@@ -71,6 +70,6 @@ def win_recompose(args):
     # Parse arguments
     parser = argparse.ArgumentParser()
     parser.add_argument("wheelpath", type=Path)
-    args = parser.parse_args()
+    main_args = parser.parse_args()
 
-    recompose(args.wheelpath)
+    win_recompose(main_args)