refactor: type parameterized test cases

Author: trin94

build-aux/test_pyside_project_build.py

@@ -4,33 +4,41 @@
 
 import hashlib
 import inspect
+from collections.abc import Callable
+from typing import NamedTuple
 
 import pyside_project_build  # type: ignore[missing-import]
 import pytest
 
 
+class SourcePinCase(NamedTuple):
+    name: str
+    func: Callable[..., object]
+    pinned_hash: str
+
+
 @pytest.mark.parametrize(
     ("name", "func", "pinned_hash"),
     [
-        (
-            "Project._qml_module_check",
-            pyside_project_build.pyside_project.Project._qml_module_check,
-            "0aec984c4c00256f274b2a7a123cc55dd503461d9f112f6d8430e75f93e0a613",
+        SourcePinCase(
+            name="Project._qml_module_check",
+            func=pyside_project_build.pyside_project.Project._qml_module_check,
+            pinned_hash="0aec984c4c00256f274b2a7a123cc55dd503461d9f112f6d8430e75f93e0a613",
         ),
-        (
-            "Project.build",
-            pyside_project_build.pyside_project.Project.build,
-            "7642952562d17d841c337e4944a3cfca7a977ddd8b8a5e4308bbc5a8e61d3ad0",
+        SourcePinCase(
+            name="Project.build",
+            func=pyside_project_build.pyside_project.Project.build,
+            pinned_hash="7642952562d17d841c337e4944a3cfca7a977ddd8b8a5e4308bbc5a8e61d3ad0",
         ),
-        (
-            "Project._regenerate_qmldir",
-            pyside_project_build.pyside_project.Project._regenerate_qmldir,
-            "3fe6797508f30f66e8c4e389c86ac4a7da31925d8a4c5f2b56e418b72b944618",
+        SourcePinCase(
+            name="Project._regenerate_qmldir",
+            func=pyside_project_build.pyside_project.Project._regenerate_qmldir,
+            pinned_hash="3fe6797508f30f66e8c4e389c86ac4a7da31925d8a4c5f2b56e418b72b944618",
         ),
-        (
-            "check_qml_decorators",
-            pyside_project_build.project_data.check_qml_decorators,
-            "31d1377f384619cfb4be8efbad805ff4cb1e7524f3750823382c0c1187bc7a7a",
+        SourcePinCase(
+            name="check_qml_decorators",
+            func=pyside_project_build.project_data.check_qml_decorators,
+            pinned_hash="31d1377f384619cfb4be8efbad805ff4cb1e7524f3750823382c0c1187bc7a7a",
         ),
     ],
 )

test/appearance/services/test_color_scheme.py

@@ -2,15 +2,20 @@
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 
+from typing import NamedTuple
+
 import inject
 import pytest
 
 from mpvqc.appearance.services import (
     AppearanceSettingsService,
+    ColorScheme,
+    ColorSchemePreference,
     ColorSchemeService,
     Dark,
     FollowSystem,
     Light,
+    SystemColorScheme,
     Unknown,
 )
 
@@ -28,12 +33,17 @@ def bind_settings(binder: inject.Binder):
     common_bindings_with(bind_settings)
 
 
+class SystemAnswerCase(NamedTuple):
+    system_color_scheme: SystemColorScheme
+    expected: ColorScheme
+
+
 @pytest.mark.parametrize(
     ("system_color_scheme", "expected"),
     [
-        (LIGHT, LIGHT),
-        (DARK, DARK),
-        (UNKNOWN, LIGHT),
+        SystemAnswerCase(system_color_scheme=LIGHT, expected=LIGHT),
+        SystemAnswerCase(system_color_scheme=DARK, expected=DARK),
+        SystemAnswerCase(system_color_scheme=UNKNOWN, expected=LIGHT),
     ],
     ids=["light", "dark", "unknown-is-light"],
 )
@@ -46,13 +56,40 @@ def test_following_the_system_takes_the_system_answer(make_style_hints, system_c
     assert style_hints.calls == ["unset"]
 
 
+class ExplicitPreferenceCase(NamedTuple):
+    preference: ColorSchemePreference
+    system_color_scheme: SystemColorScheme
+    expected: ColorScheme
+    expected_call: str
+
+
 @pytest.mark.parametrize(
     ("preference", "system_color_scheme", "expected", "expected_call"),
     [
-        (LIGHT, DARK, LIGHT, "set Light"),
-        (LIGHT, UNKNOWN, LIGHT, "set Light"),
-        (DARK, LIGHT, DARK, "set Dark"),
-        (DARK, UNKNOWN, DARK, "set Dark"),
+        ExplicitPreferenceCase(
+            preference=LIGHT,
+            system_color_scheme=DARK,
+            expected=LIGHT,
+            expected_call="set Light",
+        ),
+        ExplicitPreferenceCase(
+            preference=LIGHT,
+            system_color_scheme=UNKNOWN,
+            expected=LIGHT,
+            expected_call="set Light",
+        ),
+        ExplicitPreferenceCase(
+            preference=DARK,
+            system_color_scheme=LIGHT,
+            expected=DARK,
+            expected_call="set Dark",
+        ),
+        ExplicitPreferenceCase(
+            preference=DARK,
+            system_color_scheme=UNKNOWN,
+            expected=DARK,
+            expected_call="set Dark",
+        ),
     ],
     ids=["light-over-dark", "light-over-unknown", "dark-over-light", "dark-over-unknown"],
 )
@@ -68,11 +105,17 @@ def test_explicit_preference_ignores_the_system_and_pushes_into_qt(
     assert style_hints.calls == [expected_call]
 
 
+class SystemFlipCase(NamedTuple):
+    starts_at: SystemColorScheme
+    flips_to: SystemColorScheme
+    expected: ColorScheme
+
+
 @pytest.mark.parametrize(
     ("starts_at", "flips_to", "expected"),
     [
-        (LIGHT, DARK, DARK),
-        (DARK, UNKNOWN, LIGHT),
+        SystemFlipCase(starts_at=LIGHT, flips_to=DARK, expected=DARK),
+        SystemFlipCase(starts_at=DARK, flips_to=UNKNOWN, expected=LIGHT),
     ],
     ids=["light-to-dark", "dark-to-unknown-is-light"],
 )

test/appearance/services/test_palette_catalog.py

@@ -4,13 +4,15 @@
 
 import json
 from dataclasses import asdict
+from typing import NamedTuple
 
 import pytest
 from PySide6.QtGui import QColor
 
 from mpvqc.appearance.services import (
     AccentColor,
     AppearancePreference,
+    ColorScheme,
     Dark,
     FollowSystem,
     Light,
@@ -61,23 +63,33 @@ def fake_catalog(catalog_with, make_palette_family_data):
     return catalog_with(light, dark)
 
 
+class DefaultAccentCase(NamedTuple):
+    color_scheme: ColorScheme
+    default_accent_color: str
+
+
 @pytest.mark.parametrize(
     ("color_scheme", "default_accent_color"),
     [
-        (Light(), "#l2"),
-        (Dark(), "#d1"),
+        DefaultAccentCase(color_scheme=Light(), default_accent_color="#l2"),
+        DefaultAccentCase(color_scheme=Dark(), default_accent_color="#d1"),
     ],
     ids=["light", "dark"],
 )
 def test_lookup_by_color_scheme_returns_the_family_tagged_with_it(fake_catalog, color_scheme, default_accent_color):
     assert fake_catalog.palette_family_for(color_scheme).default_accent_color == AccentColor(default_accent_color)
 
 
+class PreviewColorCase(NamedTuple):
+    color_scheme: ColorScheme
+    preview_color: str
+
+
 @pytest.mark.parametrize(
     ("color_scheme", "preview_color"),
     [
-        (Light(), "#f0f0f0"),
-        (Dark(), "#101010"),
+        PreviewColorCase(color_scheme=Light(), preview_color="#f0f0f0"),
+        PreviewColorCase(color_scheme=Dark(), preview_color="#101010"),
     ],
     ids=["light", "dark"],
 )
@@ -139,8 +151,8 @@ def test_the_first_family_tagged_with_a_scheme_wins(catalog_with, make_palette_f
 @pytest.mark.parametrize(
     ("color_scheme", "preview_color"),
     [
-        (Light(), "#f5f2fa"),
-        (Dark(), "#121318"),
+        PreviewColorCase(color_scheme=Light(), preview_color="#f5f2fa"),
+        PreviewColorCase(color_scheme=Dark(), preview_color="#121318"),
     ],
     ids=["light", "dark"],
 )

test/appearance/services/test_schemes.py

@@ -2,13 +2,18 @@
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 
+from typing import NamedTuple
+
 import pytest
 
 from mpvqc.appearance.services import (
     COLOR_SCHEME_PREFERENCES,
+    ColorScheme,
+    ColorSchemePreference,
     Dark,
     FollowSystem,
     Light,
+    SystemColorScheme,
     Unknown,
     default_color_scheme_preference,
     format_color_scheme,
@@ -25,18 +30,24 @@
 UNKNOWN = Unknown()
 
 
+class ResolveCase(NamedTuple):
+    preference: ColorSchemePreference
+    system_color_scheme: SystemColorScheme
+    expected: ColorScheme
+
+
 @pytest.mark.parametrize(
     ("preference", "system_color_scheme", "expected"),
     [
-        (LIGHT, LIGHT, LIGHT),
-        (LIGHT, DARK, LIGHT),
-        (LIGHT, UNKNOWN, LIGHT),
-        (DARK, LIGHT, DARK),
-        (DARK, DARK, DARK),
-        (DARK, UNKNOWN, DARK),
-        (SYSTEM, LIGHT, LIGHT),
-        (SYSTEM, DARK, DARK),
-        (SYSTEM, UNKNOWN, LIGHT),
+        ResolveCase(preference=LIGHT, system_color_scheme=LIGHT, expected=LIGHT),
+        ResolveCase(preference=LIGHT, system_color_scheme=DARK, expected=LIGHT),
+        ResolveCase(preference=LIGHT, system_color_scheme=UNKNOWN, expected=LIGHT),
+        ResolveCase(preference=DARK, system_color_scheme=LIGHT, expected=DARK),
+        ResolveCase(preference=DARK, system_color_scheme=DARK, expected=DARK),
+        ResolveCase(preference=DARK, system_color_scheme=UNKNOWN, expected=DARK),
+        ResolveCase(preference=SYSTEM, system_color_scheme=LIGHT, expected=LIGHT),
+        ResolveCase(preference=SYSTEM, system_color_scheme=DARK, expected=DARK),
+        ResolveCase(preference=SYSTEM, system_color_scheme=UNKNOWN, expected=LIGHT),
     ],
     ids=[
         "light-over-light",

test/appearance/viewmodels/test_dialog.py

@@ -261,12 +261,19 @@ def test_an_accent_write_for_the_other_scheme_emits_nothing(make_view_model, app
     assert accent_spy.count() == 0
 
 
+class PreferenceWriteCase(NamedTuple):
+    text: str
+    preference: ColorSchemePreference
+    expected_index: int
+    expected_accent_count: int
+
+
 @pytest.mark.parametrize(
     ("text", "preference", "expected_index", "expected_accent_count"),
     [
-        ("system", SYSTEM, 0, 0),
-        ("light", LIGHT, 1, 2),
-        ("dark", DARK, 2, 3),
+        PreferenceWriteCase(text="system", preference=SYSTEM, expected_index=0, expected_accent_count=0),
+        PreferenceWriteCase(text="light", preference=LIGHT, expected_index=1, expected_accent_count=2),
+        PreferenceWriteCase(text="dark", preference=DARK, expected_index=2, expected_accent_count=3),
     ],
 )
 def test_set_color_scheme_preference_writes_the_setting(

test/appearance/viewmodels/test_palette.py

@@ -13,6 +13,7 @@
     AccentColor,
     AppearancePreference,
     AppearanceSettingsService,
+    ColorScheme,
     ColorSchemePreference,
     ColorSchemeService,
     Dark,
@@ -21,6 +22,7 @@
     NoPreference,
     Palette,
     PaletteCatalogService,
+    SystemColorScheme,
     Unknown,
 )
 from mpvqc.appearance.viewmodels import (
@@ -195,12 +197,17 @@ def _assert_renders(view_model, palette: Palette, *, is_dark: bool) -> None:
     assert view_model.palette.rowSelectedText == palette.row_selected_text
 
 
+class DesktopSchemeCase(NamedTuple):
+    desktop_reports: SystemColorScheme
+    expected_color_scheme: ColorScheme
+
+
 @pytest.mark.parametrize(
     ("desktop_reports", "expected_color_scheme"),
     [
-        (LIGHT, LIGHT),
-        (DARK, DARK),
-        (UNKNOWN, LIGHT),
+        DesktopSchemeCase(desktop_reports=LIGHT, expected_color_scheme=LIGHT),
+        DesktopSchemeCase(desktop_reports=DARK, expected_color_scheme=DARK),
+        DesktopSchemeCase(desktop_reports=UNKNOWN, expected_color_scheme=LIGHT),
     ],
     ids=["light", "dark", "unknown-is-light"],
 )

test/comments/models/test_store.py

@@ -100,34 +100,10 @@ class _MoveReplaceCase(NamedTuple):
 
 
 _MOVE_REPLACE_CASES = [
-    _MoveReplaceCase(
-        name="up",
-        src=3,
-        dst=0,
-        destination_child=0,
-        order=["NEW", "C0", "C1", "C2", "C4"],
-    ),
-    _MoveReplaceCase(
-        name="down",
-        src=1,
-        dst=4,
-        destination_child=5,
-        order=["C0", "C2", "C3", "C4", "NEW"],
-    ),
-    _MoveReplaceCase(
-        name="adjacent up",
-        src=2,
-        dst=1,
-        destination_child=1,
-        order=["C0", "NEW", "C1", "C3", "C4"],
-    ),
-    _MoveReplaceCase(
-        name="adjacent down",
-        src=1,
-        dst=2,
-        destination_child=3,
-        order=["C0", "C2", "NEW", "C3", "C4"],
-    ),
+    _MoveReplaceCase(name="up", src=3, dst=0, destination_child=0, order=["NEW", "C0", "C1", "C2", "C4"]),
+    _MoveReplaceCase(name="down", src=1, dst=4, destination_child=5, order=["C0", "C2", "C3", "C4", "NEW"]),
+    _MoveReplaceCase(name="adjacent up", src=2, dst=1, destination_child=1, order=["C0", "NEW", "C1", "C3", "C4"]),
+    _MoveReplaceCase(name="adjacent down", src=1, dst=2, destination_child=3, order=["C0", "C2", "NEW", "C3", "C4"]),
 ]