feat: add windows icon embedding on executables and add testing for templating

Author: THEGOLDENPRO

pyproject.toml

@@ -15,7 +15,8 @@ suap = "suap.main:app"
 [dependency-groups]
 dev = [
     "ty>=0.0.23",
-    "ruff>=0.15.6"
+    "ruff>=0.15.6",
+    "pytest>=9.0.2",
 ]
 
 [build-system]
@@ -29,4 +30,4 @@ version = { attr = "suap.__version__" }
 include = ["suap*"]
 
 [tool.setuptools.package-data]
-suap = ["templates/*"]
+suap = ["templates/*"]

ruff.toml

@@ -1,3 +1,4 @@
 
 [lint.per-file-ignores]
-"__init__.py" = ["F403"]
+"__init__.py" = ["F403"]
+"tests/*" = ["E712"]

suap/commands/packaging/checks.py

@@ -1,6 +1,7 @@
 import re
 import typer
 import logging
+
 from ...projects import ProjectData
 
 __all__ = ()
@@ -23,9 +24,7 @@ def check_project_data_validity(project_data: ProjectData) -> None:
         raise typer.Exit(1)
 
     if any(char.isupper() for char in project_name):
-        logger.error(
-            "Project name must be all lowercase!"
-        )
+        logger.error("Project name must be all lowercase!")
 
         raise typer.Exit(1)
 

suap/commands/packaging/icons.py

@@ -1,5 +1,4 @@
-from typing import Optional
-
+import typer
 import shutil
 import logging
 from pathlib import Path
@@ -10,7 +9,7 @@
 
 logger = logging.getLogger(__name__)
 
-def get_platform_icon_path(icons_path: Path, platform_format: PlatformFormat) -> Optional[Path]:
+def get_platform_icon_path(icons_path: Path, platform_format: PlatformFormat) -> Path:
     """
     Returns `None` if an icon can't be found / doesn't exist. Otherwise a `Path` is returned.
     """
@@ -42,14 +41,20 @@ def get_platform_icon_path(icons_path: Path, platform_format: PlatformFormat) ->
             )
 
             if platform_format & PlatformFormat.WINDOWS:
-                logger.warning(
-                    "You will MOST LIKELY want a platform specific icon for Windows "\
-                        "(e.g: 'windows.ico') as support for PNGs are a gray area and can cause problems."
+                logger.error(
+                    "Platform specific icon is REQUIRED for WINDOWS platform! A " \
+                    f"'windows.ico' file must be provided in your icons folder ({icons_path})."
                 )
 
+                raise typer.Exit(1)
+
             return original_icon_path
 
-    return None
+    logger.error(
+        "At least an original icon is required in your icons " \
+            f"path at '{icons_path}' (e.g: 'original.png')!"
+    )
+    raise typer.Exit(1)
 
 def format_icon_with_project_name(
     icon_path: Path,

suap/commands/packaging/nsis.py

@@ -6,8 +6,8 @@
 
 from ...mime_type import MimeType
 from ...projects import ProjectData
-from ...formats import make_nsis_installer
 from ...templating import Template, Key
+from ...formats import make_nsis_installer
 
 __all__ = (
     "format_config_and_make_nsis_installer",
@@ -40,33 +40,33 @@ def format_config_and_make_nsis_installer(
 
     semver = project_data.version
 
-    binary_name_key = Key(name = "binary-name", value = binary_name)
+    binary_name_key = Key("binary-name", binary_name)
 
     display_name_key = Key(
         name = "display-name",
         value = display_name if display_name is not None else project_data.name
     )
 
-    icon_file_name_key = Key(name = "icon-file-name", value = icon_path.name)
+    icon_file_name_key = Key("icon-file-name", icon_path.name)
 
     installer_script_string = installer_script_template.format(
         keys = (
             binary_name_key,
-            Key(name = "binary-path", value = str(binary_path.absolute())),
-            Key(name = "binary-dist-path", value = str(binary_dist_path.absolute())),
+            Key("binary-path", str(binary_path.absolute())),
+            Key("binary-dist-path", str(binary_dist_path.absolute())),
 
             display_name_key,
 
-            Key(name = "icon-path", value = str(icon_path.absolute())),
+            Key("icon-path", str(icon_path.absolute())),
             icon_file_name_key,
 
-            Key(name = "project-name", value = project_data.name),
+            Key("project-name", project_data.name),
             Key(
-                name = "project-version",
-                value = f"{semver.major}.{semver.minor}.{semver.patch}" \
+                "project-version",
+                f"{semver.major}.{semver.minor}.{semver.patch}" \
                     f".{semver.prerelease.split('.')[-1] if semver.prerelease is not None else 0}"
             ),
-            Key(name = "project-description", value = project_data.description),
+            Key("project-description", project_data.description),
 
             Key(
                 name = "app-capabilities-macro",
@@ -171,8 +171,4 @@ def generate_app_capabilities_macro(
         f"    {line}" for line in app_capabilities_macro_string.splitlines(keepends = True)
     ])
 
-    logger.debug(
-        f"Generated and formatted app capabilities macro: \n{formatted_macro_string}"
-    )
-
     return formatted_macro_string

suap/commands/packaging/package.py

@@ -73,6 +73,8 @@ def package(
         )
         raise Exit(1)
 
+    # TODO: move this and other processed and 
+    # checked data into some sort of object / class 
     icons_path = Path(icons_config_path)
 
     if not icons_path.exists():
@@ -82,13 +84,6 @@ def package(
 
     platform_icon_path = get_platform_icon_path(icons_path, platform_format)
 
-    if platform_icon_path is None:
-        logger.error(
-            "At least an original icon is required in your icons " \
-                f"path at '{icons_config_path}' (e.g: 'original.png')!"
-        )
-        raise Exit(1)
-
     if project == ProjectType.CARGO:
         projects_config_data: Optional[ConfigProjectData] = config_data.get("project", None)
 
@@ -121,7 +116,12 @@ def package(
             )
             raise Exit(1)
 
-        if not build_cargo_project(toolchain_name, project_data.name):
+        if not build_cargo_project(
+            toolchain_name,
+            project_data.name,
+            platform_icon_path,
+            temp_folder_path
+        ):
             raise Exit(1)
 
         cargo_release_path = Path(f"./target/{toolchain_name}/release")

suap/errors.py

@@ -0,0 +1,16 @@
+__all__ = ()
+
+class SuapError(Exception):
+    message: str
+
+    def __init__(self, message: str):
+        self.message = message
+
+        super().__init__(message)
+
+class TemplateKeysRemainingError(SuapError):
+    def __init__(self, remaining_keys: set[str]):
+        super().__init__(
+            "There are keys defined in the template " \
+                f"that were not formatted! Remaining Keys: {remaining_keys}"
+        )

suap/projects/cargo/building.py

@@ -2,6 +2,7 @@
 
 import os
 import logging
+from pathlib import Path
 from subprocess import check_call, CalledProcessError
 
 from ...platform_format import PlatformFormat
@@ -28,15 +29,28 @@ def get_cargo_toolchain(platform_format: PlatformFormat) -> Optional[str]:
 
     return toolchain_name
 
-def build_cargo_project(toolchain_name: str, cargo_crate_name: str) -> bool:
+def build_cargo_project(
+    toolchain_name: str,
+    cargo_crate_name: str,
+    icon_path: Path,
+    temp_folder_path: Path
+) -> bool:
     logger.debug(f"Invoking 'cargo build' with toolchain '{toolchain_name}'...")
 
     try:
         default_env = os.environ.copy()
-        default_env["RUSTFLAGS"] = "-Awarnings" # hides warnings in console
+
+        rust_flags = ["-Awarnings"] # hides warnings in console
+
+        if toolchain_name == "x86_64-pc-windows-gnu":
+            compiled_resource_path = build_windows_resource_file(icon_path, temp_folder_path)
+
+            rust_flags.extend(["-C", f"link-arg={compiled_resource_path}"])
+
+        default_env["RUSTFLAGS"] = " ".join(rust_flags)
 
         logger.warning(
-            f"RUSTFLAGS are not inherited! 'RUSTFLAGS' will contain -> '{default_env['RUSTFLAGS']}'."
+            f"RUSTFLAGS is NOT inherited! 'RUSTFLAGS' will contain -> '{default_env['RUSTFLAGS']}'."
         )
 
         check_call(
@@ -59,4 +73,42 @@ def build_cargo_project(toolchain_name: str, cargo_crate_name: str) -> bool:
 
         return False
 
-    return True
+    return True
+
+def build_windows_resource_file(icon_path: Path, temp_folder_path: Path) -> Optional[Path]:
+    logger.debug("Building windows resource file...")
+
+    resource_file_path = temp_folder_path.joinpath("resource.rc")
+    compiled_resource_binary_path = temp_folder_path.joinpath("resource.res")
+
+    resource_contents = f"""
+IDI_MYICON ICON "{icon_path.absolute()}"
+"""
+
+    with open(resource_file_path, mode = "w") as file:
+        file.write(resource_contents)
+
+    try:
+        logger.debug(f"Invoking 'x86_64-w64-mingw32-windres' to build '{compiled_resource_binary_path}'...")
+
+        check_call(
+            # now if you're using a distro that doesn't name 
+            # windres as "x86_64-w64-mingw32-windres"... *Eh... your loss...*
+            args = [
+                "x86_64-w64-mingw32-windres",
+                f"{resource_file_path.absolute()}",
+                "-O",
+                "coff",
+                "-o",
+                f"{compiled_resource_binary_path.absolute()}"
+            ]
+        )
+
+    except CalledProcessError as error:
+        logger.error(
+            f"Failed to build windows resource file (resource.res)! Error: {error}"
+        )
+
+        return None
+
+    return compiled_resource_binary_path

suap/templates/test_template.txt

@@ -0,0 +1 @@
+The kitty goes... {suap-insert-meow}! Some weird formatting... {{suap-some-weird-format-1}" {{suap-some-weird-format-1}}} {{suap-some-weird-format-2}} suap-umm

suap/templating.py

@@ -3,6 +3,8 @@
 from pathlib import Path
 from dataclasses import dataclass
 
+from .errors import TemplateKeysRemainingError
+
 __all__ = ()
 
 logger = logging.getLogger(__name__)
@@ -12,13 +14,6 @@ class Key:
     name: str
     value: str
 
-class TemplateKeysRemainingError(Exception):
-    def __init__(self, remaining_keys: set[str]):
-        super().__init__(
-            "There are keys defined in the template " \
-                f"that were not formatted! Remaining Keys: {remaining_keys}"
-        )
-
 class Template():
     def __init__(self, template_name: str):
         self.__template_string = self.__get_template_contents(template_name)
@@ -30,23 +25,22 @@ def __init__(self, template_name: str):
 
         self.__defined_suap_keys: set[str] = set(defined_suap_keys_list)
 
-        print(f"--> {self.__defined_suap_keys}")
-
     def format(self, keys: tuple[Key, ...]) -> str:
         formatted_string = self.__template_string
 
         remaining_keys = self.__defined_suap_keys
 
         for key in keys:
             key_name = key.name
+            key_value = str(key.value)
 
             if key_name in remaining_keys:
-                logger.debug(f"Formatting template key '{key_name}'...")
+                logger.debug(f"Formatting template key '{key_name}' with value '{key_value}'...")
 
                 remaining_keys.remove(key_name)
 
                 formatted_string = formatted_string.replace(
-                    f"{{suap-{key_name}}}", str(key.value)
+                    f"{{suap-{key_name}}}", key_value
                 )
 
         if len(remaining_keys) > 0: