Merge pull request #420 from aclist/chore/update-tests

chore: update tests

dzgui/config/freedesktop.py

@@ -21,7 +21,7 @@ def write_desktop_file(exe_path: Path) -> Path:
     Terminal=false
     Exec={exe_path}
     Name=DZGUI
-    Comment=dzgui
+    Comment=DayZ server browser and mod manager
     Icon={icon}
     Categories=Game"""
 

dzgui/model/proxy_model.py

@@ -259,7 +259,7 @@ class ProxyModelManager:
     def set_cache(self, filters: tuple[str], filtered_rows: list[tuple]) -> None:
         self.filter_cache[filters] = filtered_rows
 
-    @deprecated("Currently unused")
+    # @deprecated("Currently unused")
     # def convert_model_to_list(self, model: "FastInsertListStore") -> list:
     #    return [[el for el in row] for row in model]
 

dzgui/strings/offline.py

@@ -1,4 +1,7 @@
 heading = "Play offline"
+heading_disclaimer = (
+    "Not all mod combinations will function offline. Use at your own discretion."
+)
 
 mission_button = "Select mission folder"
 mission_frame = "Mission"

dzgui/util/redact.py

@@ -4,8 +4,9 @@ from typing import Literal
 
 api_filter = r"(.*&key=)([^&]*)(.*)"
 home_filter = r"(/home/)([^\s'\/]*)(.*)"
+user_filter = r"(.*Steam/userdata/)([^/]*)(.*)"
 REDACTED = r"\1REDACTED\3"
-REDACTION_PATTERNS = [api_filter, home_filter]
+REDACTION_PATTERNS = [api_filter, home_filter, user_filter]
 
 
 def redact_home(text: str) -> str:

dzgui/views/components/buttons.py

@@ -1,4 +1,4 @@
-from typing import Callable, Self, TYPE_CHECKING, Union
+from typing import Callable, Literal, Self, TYPE_CHECKING, Union
 
 from dzgui.util.clip import copy_clipboard
 from dzgui.util.format import pluralize
@@ -66,6 +66,15 @@ class IconButton(Gtk.Button):
         # self.set_image_position(Gtk.PositionType.RIGHT)
         self.set_focus_on_click(False)
 
+    def swap_icon(self, icon: str) -> None:
+        start = self.icon.get_margin_start()
+        end = self.icon.get_margin_end()
+        alt_icon = Icon(icon, margin_start=start, margin_end=end)
+        self.set_image(alt_icon)
+
+    def revert_icon(self) -> None:
+        self.set_image(self.icon)
+
 
 class IconTextButton(IconButton):
     def __init__(
@@ -96,11 +105,18 @@ class ClipboardButton(IconTextButton):
         self.controller = controller
         self.connect("clicked", self._on_button_clicked, func)
 
+        # TODO: strings
         self.set_tooltip_text("Copy to clipboard")
 
     def _on_button_clicked(self, button: Self, func: Callable) -> None:
+        def revert() -> Literal[False]:
+            self.revert_icon()
+            return False
+
+        self.swap_icon("object-select-symbolic")
         data = func()
         copy_clipboard(data)
+        GLib.timeout_add(600, revert)
 
 
 # TODO: determine when controller would be passed to this button or drop
@@ -108,6 +124,7 @@ class CopyIpButton(ClipboardButton):
     def __init__(self, controller: Union["Controller", None], func: Callable) -> None:
         super().__init__(controller, func)
 
+        # TODO: strings
         self.set_tooltip_text("Copy IP to clipboard")
 
 

dzgui/views/components/entry.py

@@ -162,7 +162,8 @@ class APIEntry(Gtk.Box):
         self.entry.connect("icon-release", self._on_icon_release)
         self.entry.connect("activate", self._on_field_activated)
 
-        self.submit = Gtk.Button(label="Submit")
+        # TODO: strings
+        self.submit = Gtk.Button(label="Validate")
         self.submit.set_sensitive(False)
         self.submit.connect("clicked", self._on_submit)
 

dzgui/views/components/eventbox.py

@@ -30,6 +30,9 @@ class InfoEventBox(Gtk.EventBox):
         self.connect("leave-notify-event", self._on_leave_tooltip)
         self.add(box)
 
+    def set_icon_yalign(self, offset: float) -> None:
+        self.icon.set_property("yalign", offset)
+
     def _on_enter_tooltip(
         self, eventbox: Gtk.EventBox, eventcrossing: Gdk.EventCrossing
     ) -> None:

dzgui/views/components/right_panel.py

@@ -131,6 +131,7 @@ class RightPanel(Gtk.Box):
             return
         self.copying = True
         version = self.version_label.get_text()
+        # TODO: strings
         self.version_label.set_text("Copied!")
         copy_clipboard(version)
         GLib.timeout_add_seconds(1, revert)

dzgui/views/dialogs/boot.py

@@ -41,7 +41,7 @@ class BootDialog(Gtk.Dialog):
     def __init__(self, parent: "BootWindow", xdg: "Xdg", version: str) -> None:
         super().__init__(
             title=dialog_header,
-            parent=parent,
+            transient_for=parent,
             modal=True,
         )
 

dzgui/views/dialogs/filepicker.py

@@ -13,7 +13,7 @@ class FilePicker(Gtk.FileChooserDialog):
         super().__init__(
             title=picker.title,
             action=Gtk.FileChooserAction.SAVE,
-            parent=parent,
+            transient_for=parent,
             resizable=True,
         )
         self.add_buttons("_Cancel", Gtk.ResponseType.CANCEL)

dzgui/views/dialogs/wizard.py

@@ -50,6 +50,13 @@ class PageNum(Enum):
     FINAL = 8
 
 
+class OptionalPageMixin:
+    """Marks optional pages as advanceable"""
+
+    def _on_map(self, page: "ScrolledWizardPage") -> None:
+        EMITTER.emit("step_complete")
+
+
 class DescriptionArea(Gtk.Box):
     def __init__(self, text: str):
         super().__init__(orientation=Gtk.Orientation.VERTICAL)
@@ -91,6 +98,7 @@ class ScrolledWizardPage(Gtk.ScrolledWindow):
             margin_top=50,
             spacing=20,
         )
+
         self.add(self.box)
         self.prog = Progress()
         self.box.pack_end(self.prog, expand=False, fill=False, padding=0)
@@ -215,7 +223,7 @@ class APIValidationPage(ScrolledWizardPage):
         self.spinner.stop()
 
 
-class BMValidationPage(APIValidationPage):
+class BMValidationPage(OptionalPageMixin, APIValidationPage):  # type: ignore
     def __init__(self) -> None:
         super().__init__(
             enum=PageNum.BM_API,
@@ -224,6 +232,7 @@ class BMValidationPage(APIValidationPage):
             link=BM_API_SETUP,
             func=self._validate,
         )
+        self.connect("map", self._on_map)
 
     @call_on_thread("", show_dialog=False)
     def _validate(self, key: str) -> None:
@@ -445,6 +454,7 @@ class Assistant(Gtk.Assistant):
         else:
             self.set_default_size(1500, 900)
 
+        self.is_binary = False if os.getenv("PYAPP") is None else True
         self.config_path = XDG.config
 
         self.config_values: dict[str, Any] = config_boilerplate
@@ -485,7 +495,7 @@ class Assistant(Gtk.Assistant):
             ):
                 continue
             # NOTE: disabled for now on system-provided packages
-            if isinstance(page, ShortcutCreationPage) and os.getenv("PYAPP") is None:
+            if isinstance(page, ShortcutCreationPage) and not self.is_binary:
                 continue
             self._add_page(page, page.get_page_type())
 
@@ -500,32 +510,33 @@ class Assistant(Gtk.Assistant):
 
     def _advance_page(self, index: int) -> int:
         page = self.get_nth_page(index)
-        # TODO: use enums/isinstance
         match page:
-            case self.page1:
+            case IntroductionPage():
                 pass
-            case self.page2:
-                if self.page2.is_migrated():
+            case ConfigMigrationPage():
+                if page.is_migrated():
                     steam_path = lookup(self.config_path, Preferences.DEFAULT)
                     self.page7.set_steam_path(steam_path)
-                    return self.get_n_pages() - 2
-            case self.page3:
+                    offset = 1 if not self.is_binary else 2
+                    self.setup_complete = True
+                    return self.get_n_pages() - offset
+            case SteamPathPage():
                 self.config_values["default_steam_path"] = page.get_path_from_radio()
-            case self.page4:
+            case SteamValidationPage():
                 self.config_values["steam_api"] = page.get_api_key()
-            case self.page5:
+            case BMValidationPage():
                 self.config_values["bm_api"] = page.get_api_key()
+            case PreferencesPage():
                 # NOTE: collects config values before advancing to last page
-            case self.page6:
                 name, use_miles, client = self.page6.get_prefs()
                 self.config_values["name"] = name
                 self.config_values["use_miles"] = use_miles
                 self.config_values["client"] = client
                 self.write_config()
                 self.page7.set_steam_path(self.config_values["default_steam_path"])
-            case self.page7:
-                self.page7.create_shortcuts()
                 self.setup_complete = True
+            case ShortcutCreationPage():
+                page.create_shortcuts()
             case _:
                 raise AttributeError("Trying to advance a non-canonical page")
         return index + 1
@@ -569,11 +580,7 @@ class Assistant(Gtk.Assistant):
         bar.set_fraction(fraction)
         bar.set_text(f"{page_num}/{total}")
 
-        # NOTE: disable forward action
-        # TODO: use page enums
-        if page == self.page5:
-            return
-        if page != self.page1:
+        if not isinstance(page, IntroductionPage):
             EMITTER.emit("step_pending")
 
 
@@ -600,7 +607,7 @@ class CheckboxWithLabel(Gtk.Box):
         self.button.set_active(state)
 
 
-class ShortcutCreationPage(ScrolledWizardPage):
+class ShortcutCreationPage(OptionalPageMixin, ScrolledWizardPage):  # type: ignore
     def __init__(self, shortcut: Path) -> None:
         super().__init__(
             enum=PageNum.SHORTCUTS,
@@ -643,9 +650,6 @@ class ShortcutCreationPage(ScrolledWizardPage):
             self.desktop_checkbox.set_active(state)
         self.desktop_checkbox.set_sensitive(state)
 
-    def _on_map(self, page: "ScrolledWizardPage") -> None:
-        EMITTER.emit("step_complete")
-
     def set_steam_path(self, path: Path) -> None:
         self.steam_path = path
 

dzgui/views/pages/offline.py

@@ -41,9 +41,18 @@ class FolderError(Enum):
     FOLDER_CHANGED = 3
 
 
-class PageHeading(Gtk.Label):
-    def __init__(self, label: str) -> None:
-        super().__init__(label=label, halign=Gtk.Align.CENTER)
+class PageHeading(Gtk.Box):
+    def __init__(self, label: str, controller: "Controller") -> None:
+        super().__init__(
+            halign=Gtk.Align.CENTER, orientation=Gtk.Orientation.HORIZONTAL
+        )
+
+        self.label = Gtk.Label(label=label)
+        self.eb = InfoEventBox(offline.heading_disclaimer, controller)
+        self.eb.set_icon_yalign(0.7)
+
+        for el in self.label, self.eb:
+            self.add(el)
 
         css.add_class(self, "page-heading")
 
@@ -434,7 +443,8 @@ class OfflineLoader(Gtk.Box):
         self.emitter = controller.get_emitter()
         self.offline_man = OfflineManager(controller)
 
-        self.add(PageHeading(offline.heading))
+        heading = PageHeading(offline.heading, controller)
+        self.add(heading)
 
         self.local_frame = ModFrame(self, controller, offline.local_frame)
         self.custom_frame = CustomModFrame(self, controller, offline.custom_frame)

dzgui/views/trees/tree_base.py

@@ -1,7 +1,6 @@
 import logging
 
 from typing import Any, Optional, TYPE_CHECKING
-from warnings import deprecated
 
 from dzgui.const.constants import APP_NAME, SEPARATOR
 from dzgui.util.keys import is_ctrl_mask, is_navkey
@@ -173,7 +172,7 @@ class TreeView(CursorMixin, Gtk.TreeView):  # type: ignore
         (model, pathlist) = sels
         return (model, pathlist)
 
-    @deprecated("Currently unused")
+    # @deprecated("Currently unused")
     # def get_mpath(self) -> Optional[Gtk.TreePath]:
     #    (model, pathlist) = self.get_model_and_pathlist()
     #    if len(pathlist) < 1:
@@ -195,7 +194,7 @@ class TreeView(CursorMixin, Gtk.TreeView):  # type: ignore
             return True
         return False
 
-    @deprecated("unused")
+    # @deprecated("unused")
     # def get_selected_row(self) -> Optional[Gtk.TreeModelRow]:
     #    ind = self.get_selected_row_index()
     #    model = self.get_model()

dzgui/views/trees/tree_log.py

@@ -53,7 +53,7 @@ class LogTreeView(ContextMixin, TreeView):  # type: ignore
         model = ModelFactory().new_model_from_logfile(filepath)
         _filter = model.filter_new()
         _filter.set_visible_func(self._filter_rows)
-        sortable = Gtk.TreeModelSort(_filter)
+        sortable = Gtk.TreeModelSort.new_with_model(_filter)
         self.set_model(sortable)
         _filter.refilter()
         path = Gtk.TreePath.new_from_indices([0])

pyproject.toml

@@ -4,7 +4,7 @@ description = "DayZ server browser and mod manager for Linux"
 authors = [
     {name = "aclist"}
 ]
-version = "7.0.0b19"
+version = "7.0.0b20"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]
 readme = "README.md"
@@ -107,11 +107,13 @@ config-settings-package = { pygobject-stubs = { config = "Gtk3,Gdk3,Soup2" } }
 
 [tool.pytest.ini_options]
 markers = [
+    "apitest: checks remote endpoints",
     "config: config file keys/values",
+    "realconfig: depends on actual generated local config file",
     "mods: tests mod metadata/link creation",
     "pefile: validate PE files",
     "post_install: requires a completed installation",
     "redact: log redaction mechanisms",
     "slow: long-running tests",
-    "webtest: checks remote endpoints"
+    "webtest: depends on remote endpoint",
 ]

tests/test_config.py

@@ -7,13 +7,12 @@ from dzgui.config.xdg import get_xdg_paths, parse_filepaths
 from dzgui.config import convert
 from tests.fixtures import fixture_path
 
-pytestmark = pytest.mark.config
-
 
 @pytest.fixture
 def legacy_config():
     return fixture_path("dztuirc_1")
 
+
 @pytest.fixture
 def unset_values():
     return fixture_path("dztuirc_3")
@@ -38,6 +37,7 @@ def keys():
 
 # TODO: use a static fixture instead of system config
 @pytest.fixture
+@pytest.mark.realconfig
 def config():
     paths = get_xdg_paths()
     xdg = parse_filepaths(paths)
@@ -45,18 +45,21 @@ def config():
 
 
 @pytest.mark.post_install
+@pytest.mark.realconfig
 def test_invalid_config_value(config):
     with pytest.raises(Exception):
         assert config["foo"] is None
 
 
 @pytest.mark.post_install
+@pytest.mark.realconfig
 def test_default_config_values(keys, config):
     for key in keys:
         assert config[key] is not None
 
 
 @pytest.mark.post_install
+@pytest.mark.realconfig
 def test_contains_invalid_values(keys, config):
     for key in config:
         assert key in keys
@@ -91,6 +94,7 @@ def test_key_conversion(legacy_config):
     for key in keys:
         assert key not in j
 
+
 def test_missing_values(unset_values):
     j = convert.rc2json(unset_values)
     j = json.loads(j)

tests/test_log_redaction.py

@@ -37,6 +37,14 @@ class RecordsListHandler(logging.Handler):
             "Error in directory: '/home/SENSITIVE_USERNAME'",
             "Error in directory: '/home/REDACTED'",
         ),
+        (
+            "User directory: /home/user/.local/share/Steam/userdata/999999/grid",
+            "User directory: /home/REDACTED/.local/share/Steam/userdata/REDACTED/grid",
+        ),
+        (
+            "User directory: /drive/.local/share/Steam/userdata/999999",
+            "User directory: /drive/.local/share/Steam/userdata/REDACTED",
+        ),
     ],
 )
 def test_log_redaction(log_error: str, expect: str) -> None:

tests/test_remote_api.py

@@ -13,13 +13,17 @@ def config():
     xdg = parse_filepaths(paths)
     return get_config(xdg.config)
 
+
 def test_ipdb():
     assert probe.test_ipdb()
 
+
 def test_steam(config):
     key = config["steam_api"]
     assert probe.test_steam_api(key)
 
+
 def test_bm(config):
+    # NOTE: see ticket #417; expected to return False
     key = config["bm_api"]
-    assert probe.test_bm_api(key)
+    assert probe.test_bm_api(key) is False

tests/test_shortcuts.py

@@ -38,14 +38,14 @@ def dummy_app() -> None:
     return d
 
 
-def test_wrap_exe(dummy_app) -> None:
+def test_wrap_exe(dummy_app: dict[str, str]) -> None:
     s = Shortcuts(Path(""))
     s.add_shortcut(*dummy_app.values())
     assert s.shortcuts["shortcuts"]["0"]["Exe"][0] == '"'
     assert s.shortcuts["shortcuts"]["0"]["Exe"][-1] == '"'
 
 
-def test_add_shortcut(dummy_app) -> None:
+def test_add_shortcut(dummy_app: dict[str, str]) -> None:
     s = Shortcuts(Path(""))
     s.add_shortcut(*dummy_app.values())
     new = s.shortcuts["shortcuts"]
@@ -56,7 +56,7 @@ def test_add_shortcut(dummy_app) -> None:
         assert new[ind][k] == v
 
 
-def test_save_shortcut(dummy_app) -> None:
+def test_save_shortcut(dummy_app: dict[str, str]) -> None:
     s = Shortcuts(Path(""))
     s.add_shortcut(*dummy_app.values())
     with tempfile.NamedTemporaryFile() as f:
@@ -65,3 +65,27 @@ def test_save_shortcut(dummy_app) -> None:
         s.save_shortcuts()
         s._load_shortcuts(tmp)
         assert len(s.shortcuts["shortcuts"]) == 1
+
+
+def test_shortcut_crc(dummy_app: dict[str, str]) -> None:
+    s = Shortcuts(Path(""))
+    s.add_shortcut(*dummy_app.values())
+    for key in s.shortcuts["shortcuts"].keys():
+        entry = s.shortcuts["shortcuts"][key]
+        name = entry["AppName"]
+        exe = entry["Exe"]
+        uid = name + exe
+        bpid = s.gen_bpid(uid)
+        assert entry["appid"] & 0xFFFFFFFF == bpid
+
+
+def test_reverse_crc(dummy_app: dict[str, str]) -> None:
+    s = Shortcuts(Path(""))
+    s.add_shortcut(*dummy_app.values())
+    for key in s.shortcuts["shortcuts"].keys():
+        entry = s.shortcuts["shortcuts"][key]
+        name = entry["AppName"]
+        exe = entry["Exe"]
+        uid = name + exe
+        bpid = s.gen_bpid(uid)
+        assert s.find_appname_by_unsigned_id(bpid) == name