testsAndMisc/python_pkg/app_icons/tests/test_generate.py

"""Tests for app_icons.generate."""

from __future__ import annotations

import math
from typing import TYPE_CHECKING
from unittest.mock import MagicMock, patch

from python_pkg.app_icons import generate, style
from python_pkg.app_icons.apps import AppIcon

if TYPE_CHECKING:
    from pathlib import Path

MOD = "python_pkg.app_icons.generate"


def _app(tmp_path: Path, *, linux: bool = False) -> AppIcon:
    return AppIcon(
        key="demo",
        repo=tmp_path / "demo",
        accent="#26A69A",
        glyph="barbell",
        icon_name="demo",
        linux=linux,
    )


class TestWriteAssets:
    @patch(f"{MOD}.render.rasterise")
    @patch(f"{MOD}.render.centre_offset", return_value=(1.0, 2.0))
    def test_writes_three_svg_png_pairs(
        self, mock_offset: MagicMock, raster: MagicMock, tmp_path: Path
    ) -> None:
        written = generate.write_assets(_app(tmp_path))
        stems = sorted({path.stem for path in written})
        assert stems == ["icon", "icon_foreground", "icon_monochrome"]
        assert len(written) == 6
        assert raster.call_count == 3

    @patch(f"{MOD}.render.rasterise")
    @patch(f"{MOD}.render.centre_offset", return_value=(0.0, 0.0))
    def test_only_the_base_layer_has_the_field(
        self, mock_offset: MagicMock, mock_raster: MagicMock, tmp_path: Path
    ) -> None:
        app = _app(tmp_path)
        generate.write_assets(app)
        base = (app.asset_dir / "icon.svg").read_text(encoding="utf-8")
        foreground = (app.asset_dir / "icon_foreground.svg").read_text(encoding="utf-8")
        assert style.BACKGROUND in base
        assert style.BACKGROUND not in foreground

    @patch(f"{MOD}.render.rasterise")
    @patch(f"{MOD}.render.centre_offset", return_value=(0.0, 0.0))
    def test_monochrome_layer_is_white(
        self, mock_offset: MagicMock, mock_raster: MagicMock, tmp_path: Path
    ) -> None:
        app = _app(tmp_path)
        generate.write_assets(app)
        mono = (app.asset_dir / "icon_monochrome.svg").read_text(encoding="utf-8")
        assert f'stroke="{style.MONOCHROME}"' in mono
        assert app.accent not in mono


class TestWriteLinuxIcons:
    @patch(f"{MOD}.render.rasterise")
    @patch(f"{MOD}.render.centre_offset", return_value=(0.0, 0.0))
    def test_one_png_per_hicolor_size(
        self, mock_offset: MagicMock, raster: MagicMock, tmp_path: Path
    ) -> None:
        written = generate.write_linux_icons(_app(tmp_path, linux=True), tmp_path / "h")
        assert len(written) == len(style.LINUX_ICON_SIZES)
        assert raster.call_count == len(style.LINUX_ICON_SIZES)
        assert written[0] == tmp_path / "h" / "16" / "demo.png"


class TestWriteWebIcons:
    @patch(f"{MOD}.render.rasterise")
    @patch(f"{MOD}.render.centre_offset", return_value=(0.0, 0.0))
    def test_replaces_the_flutter_web_template_icons(
        self, mock_offset: MagicMock, raster: MagicMock, tmp_path: Path
    ) -> None:
        app = _app(tmp_path)
        written = generate.write_web_icons(app)
        assert [path.relative_to(app.web_dir).as_posix() for path in written] == [
            "favicon.png",
            "icons/Icon-192.png",
            "icons/Icon-512.png",
            "icons/Icon-maskable-192.png",
            "icons/Icon-maskable-512.png",
        ]
        assert [call.args[2] for call in raster.call_args_list] == [
            32,
            192,
            512,
            192,
            512,
        ]
        assert style.BACKGROUND in raster.call_args.args[0]

    def test_safe_box_fits_the_maskable_safe_zone(self) -> None:
        """The safe box's corners sit inside the maskable circle, so no clip."""
        half_diagonal = style.SAFE_BOX / 2 * math.sqrt(2)
        assert half_diagonal <= generate.MASKABLE_SAFE_RADIUS * style.CANVAS


def _write_pubspec(app: AppIcon, *, background: str = "#1B1D21") -> Path:
    app.repo.mkdir(parents=True, exist_ok=True)
    pubspec = app.repo / "pubspec.yaml"
    pubspec.write_text(
        "flutter_launcher_icons:\n"
        '  image_path: "assets/icon/icon.png"\n'
        f'  adaptive_icon_background: "{background}"\n'
        '  adaptive_icon_foreground: "assets/icon/icon_foreground.png"\n',
        encoding="utf-8",
    )
    return pubspec


class TestSyncPubspecBackground:
    def test_rewrites_a_stale_background(self, tmp_path: Path) -> None:
        app = _app(tmp_path)
        pubspec = _write_pubspec(app, background="#1B1D21")
        changed = generate.sync_pubspec_background(app)
        assert changed is True
        assert f'adaptive_icon_background: "{style.BACKGROUND}"' in pubspec.read_text(
            encoding="utf-8"
        )

    def test_leaves_other_lines_untouched(self, tmp_path: Path) -> None:
        app = _app(tmp_path)
        pubspec = _write_pubspec(app, background="#1B1D21")
        before = pubspec.read_text(encoding="utf-8")
        generate.sync_pubspec_background(app)
        after = pubspec.read_text(encoding="utf-8")
        assert before.splitlines()[0] == after.splitlines()[0]
        assert 'adaptive_icon_foreground: "assets/icon/icon_foreground.png"' in after

    def test_no_op_when_already_current(self, tmp_path: Path) -> None:
        app = _app(tmp_path)
        pubspec = _write_pubspec(app, background=style.BACKGROUND)
        before_mtime = pubspec.stat().st_mtime_ns
        changed = generate.sync_pubspec_background(app)
        assert changed is False
        assert pubspec.stat().st_mtime_ns == before_mtime


class TestRunFlutterLauncherIcons:
    @patch(f"{MOD}.subprocess.run")
    @patch(f"{MOD}.render.resolve_tool", return_value="/usr/bin/dart")
    def test_invokes_dart_in_the_repo(
        self, mock_tool: MagicMock, run: MagicMock, tmp_path: Path
    ) -> None:
        app = _app(tmp_path)
        _write_pubspec(app)
        generate.run_flutter_launcher_icons(app)
        assert run.call_args.args[0] == [
            "/usr/bin/dart",
            "run",
            "flutter_launcher_icons",
        ]
        assert run.call_args.kwargs["cwd"] == app.repo

    @patch(f"{MOD}.subprocess.run")
    @patch(f"{MOD}.render.resolve_tool", return_value="/usr/bin/dart")
    def test_syncs_pubspec_background_before_invoking_dart(
        self, mock_tool: MagicMock, run: MagicMock, tmp_path: Path
    ) -> None:
        app = _app(tmp_path)
        pubspec = _write_pubspec(app, background="#1B1D21")
        generate.run_flutter_launcher_icons(app)
        assert f'adaptive_icon_background: "{style.BACKGROUND}"' in pubspec.read_text(
            encoding="utf-8"
        )