Compare commits

..
Author SHA1 Message Date
aclist 45c412e1ad change: make reference to snap more generic 2026-11-17 03:12:05 +09:00
aclist a32c99b3eb feat: support Ubuntu Snap path 2026-11-17 02:22:59 +09:00
aclist da474e274f chore: update tests 2026-11-17 01:45:26 +09:00
aclist d694aa56e8 chore: clear typehinting errors 2026-11-17 01:44:23 +09:00
aclist 6adecbedaa fix: parse custom xdg path correctly 2026-11-17 01:44:12 +09:00
aclist e935276e32 Merge pull request #542 from aclist/chore/test-typehints
Mirror to Codeberg / mirror-to-codeberg (push) Canceled after 0s
chore: typehint tests
2026-11-12 07:47:03 +09:00
aclist 047b9dbbf6 Merge branch 'chore/test-typehints' of github.com:aclist/dzgui into chore/test-typehints 2026-11-12 07:45:36 +09:00
aclist d5c9f24ad5 chore: clear typehinting errors 2026-11-12 07:45:24 +09:00
aclist f486cc506f chore: clear typehinting errors 2026-11-12 07:44:34 +09:00
aclist 307792ba5b chore: drop unused import 2026-11-12 07:11:20 +09:00
aclist f7d95d5407 chore: clear typehinting errors 2026-11-12 07:10:27 +09:00
aclist 8b09622fe5 Merge branch 'dzgui7' into chore/test-typehints 2026-11-12 06:21:45 +09:00
aclist 7f6d61083c Merge pull request #541 from aclist/docs/7.0.0-spec
docs: update to DZGUI 7 spec
2026-11-12 06:20:56 +09:00
aclist 3e7b49203a chore: add mark to test 2026-11-12 06:20:16 +09:00
aclist 269ef18a48 Merge pull request #540 from aclist/drop/unused-imports-2
drop: unused imports-2
2026-11-12 06:18:37 +09:00
aclist 8aaa806cd3 chore: drop unused docs pages
Mirror to Codeberg / mirror-to-codeberg (push) Canceled after 0s
2026-11-12 06:11:48 +09:00
aclist e4dc545038 fix: URLs 2026-11-12 06:10:00 +09:00
aclist e29433b388 chore: typehint tests 2026-11-12 05:10:02 +09:00
aclist 439109d11d docs: update to DZGUI 7 spec 2026-11-12 02:07:49 +09:00
46 changed files with 426 additions and 464 deletions

No files matched your search

+8 -9
View File
@@ -1,11 +1,11 @@
Submitting a ticket
==========================
Tickets are tracked at the `DZGUI issue tracker <https://github.com/aclist/dztui/issues>`_.
Tickets are tracked at the `DZGUI issue tracker <https://github.com/aclist/dzgui/issues>`_.
You will need to `register for a GitHub account <https://github.com/signup>`_ in order to submit one.
If have checked the :doc:`kb` and `closed issues <https://github.com/aclist/dztui/issues?q=is%3Aissue+is%3Aclosed>`_ area and did not find a solution, three ticket types are provided for your
If have checked the :doc:`kb` and `closed issues <https://github.com/aclist/dzgui/issues?q=is%3Aissue+is%3Aclosed>`_ area and did not find a solution, three ticket types are provided for your
convenience:
- **Bug report**: for unexpected, breaking behavior in the application
@@ -20,18 +20,17 @@ Below are some examples of how to format a constructive report that will ensure
A non-actionable report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Subject: add button
Subject: BUG: add button
hi, you must add a button to show how long I have to wait to join a full server, the app is useless without this...do your job, guys!!! ;-)
This report exhibits a number of problems:
- Vague title and summary: in addition to being unclear, this will slow down filing the incoming report.
- Problem space is poorly defined: it is not clear where the issue lies, where the feature is supposed to be implemented, nor why.
- Lack of context: the feature may already exist, but there is not enough information to go on. Alternatively, the feature may be technically impossible to implement, but there is not enough
information to go on.
- Incorrect report type: this is a feature request filed as a bug report.
- Vague title and summary: this will slow down filing the incoming report.
- Problem space is poorly defined: it is not clear where the issue lies, where the feature is supposed to be implemented, nor why.
- Lack of context: the feature may already exist, but there is not enough information to go on. Alternatively, the feature may be technically impossible to implement.
- Unprofessional tone: the message is disrespectful towards project members and inserts the user's subjective opinion.
An actionable report
@@ -42,7 +41,7 @@ An actionable report
This occurs specifically on version 5.5.0-beta.2 if the setting ALLOW_MULTI is set to ON. I was able to reproduce it using the following steps:
Distribution: Fedora
- Ensure that ALLOW_MULTI is set to ON
- Open the application and immediately navigate to the Server Browser
- Uses the Ctrl-click binding to select multiple rows in the table
@@ -56,5 +55,5 @@ This report is actionable because it is objective, specific, and detailed:
- The subject is clearly defined: specific details ensure it will be filed in a timely manner.
- Scope is explicit: the specific version, settings, and conditions under which the problem occur were given.
- Ample context: the user gave steps to reproduce the problem and clarified each one.
- Courteous tone: the user interacted with project members in a professional manner.
- Supporting information: the user provided a crash dump to expedite resolution of the issue.
- Courteous tone: the user interacted with project members in a professional manner.
+3 -3
View File
@@ -15,7 +15,7 @@ author = 'aclist'
extensions = []
templates_path = ['_templates']
exclude_patterns = []
exclude_patterns = [] # type: ignore[var-annotated]
@@ -36,5 +36,5 @@ html_show_copyright = False
html_show_sourcelink = False
today_fmt = "%Y-%m-%d"
release = "6.x.x - 7.x.x"
version = "6.x.x - 7.x.x"
release = "7.x.x"
version = "7.x.x"
+5 -10
View File
@@ -1,19 +1,14 @@
Developers
===========
This project is open source under the GPLv3 license. You can find the source code on
`GitHub <https://github.com/aclist/dztui>`_. If you wish to contribute to
`GitHub <https://github.com/aclist/dzgui>`_. If you wish to contribute to
development, you will find further help in the
`CONTRIBUTING.md <https://github.com/aclist/dztui/blob/main/CONTRIBUTING.md>`_
`CONTRIBUTING.md <https://github.com/aclist/dzgui/blob/dzgui7/CONTRIBUTING.md>`_
file.
All contributors are expected to act in accordance with the project's
`code of conduct <https://github.com/aclist/dztui/blob/main/CODE_OF_CONDUCT.md>`_,
`code of conduct <https://github.com/aclist/dzgui/blob/dzgui7/CODE_OF_CONDUCT.md>`_,
and follow the project's standards and guidelines.
To install DZGUI and related dependencies for linting, testing, and version control,
invoke the command ``uv pip install .[dev]``.
After this process, install the applicable pre-commit hooks by invoking the command ``pre-commit install``.
These pre-commit hooks enforce code checks that prevent making commits unless the relevant tests pass.
Detailed instructions on setting up a build environment and installing DZGUI from source code
can be found in the `DEVELOPERS.md <https://github.com/aclist/dzgui/blob/dzgui7/DEVELOPERS.md>`_ file.
-110
View File
@@ -1,110 +0,0 @@
Installation (DZGUI 6 legacy)
==================
Basic runtime dependencies
---------------------------------
If not already installed, the below can be found in your system’s package manager.
If any dependencies are missing when the application starts, it will warn you, so you need not take any preemptive measures here.
- curl
- jq
- steam
- wmctrl or xdotool
- zenity
.. note::
All dependencies are installed out of the box on Steam Deck.
UI dependencies (Python and PyGObject)
---------------------------------------
.. important::
As of version 6.0.0, you must have a valid Python 3.13 and matching PyGObject environment.
Depending on your distribution, this may require additional manual intervention.
Arch Linux (vanilla variants)
^^^^^^^^^^^^^^^^^^^^^^
You will need the ``python3.13`` package, if it is not already installed.
Install the following build dependencies:
.. code:: console
sudo pacman -S cmake gcc pkgconf python-cairo
.. include:: venv.rst
CachyOS (Arch)
^^^^^^^^^^^^^^^^^^^^^^^
Refer to the build instructions for Arch Linux first.
The ``python3.13`` package is not available on CachyOS, so it is recommended to
use ``uv`` to manage Python versions.
.. code:: console
sudo pacman -S uv
.. include:: venv.rst
Manjaro 26 (Arch)
^^^^^^^^^^^^^^^^^^^^^^^
If Python 3.13 is not already available out of the box, refer to the build instructions for :ref:`Arch Linux (vanilla variants)`.
Debian 13 variants
^^^^^^^^^^^^^^^^^^^^^^^
Python 3.13 and PyGObject are available out of the box. No additional steps are necessary.
You can proceed to the :ref:`Installscript`.
Fedora 43 variants
^^^^^^^^^^^^^^^^^^^^^^^
Fedora 43 ships with a newer version of Python (3.14), so you must set up Python 3.13 in its own
virtual environment (venv) to prevent it from conflicting with the system package.
Install the following build dependencies:
.. code:: console
sudo dnf install cairo cairo-devel cairo-gobject-devel gcc python3.13 python3.13-devel
.. include:: venv.rst
Ubuntu 24 variants
^^^^^^^^^^^^^^^^^^^^^^
Ubuntu ships with an older version of Python (3.12). You must install additional dependencies.
Add the PPA below to add Python 3.13 to your sources:
.. code:: console
sudo add-apt-repository ppa:deadsnakes/ppa
Install the following build dependencies:
.. code:: console
sudo apt install python3.13 python3.13-venv python3.13-dev build-essential python3-gi-cairo pkg-config libgirepository-2.0-dev libcairo2-dev
.. include:: venv.rst
Installscript
-----------------------
Invoke the command below from a terminal. This script fetches the main DZGUI script from the repository,
makes it executable, and launches DZGUI's first-time setup. After running this installscript, you will
have the file ``dzgui.sh`` wherever you invoked the command.
.. code:: console
curl -s "https://codeberg.org/aclist/dztui/raw/branch/dzgui/install.sh" | bash
nixOS installation
----------------------
Two packages are independently maintained by other contributors. Each takes a slightly different approach.
nixOS packages are standalone and do not require cloning the git repository.
- https://github.com/lelgenio/dzgui-nix
- https://github.com/jiriks74/dzgui.flake
Next steps
---------------
Proceed to the :doc:`setup` section for setup instructions.
-33
View File
@@ -1,33 +0,0 @@
Installation (DZGUI 7 beta)
==================
In order to make the first-time setup experience easier for end-users, DZGUI 7 no longer requires
the tool to be installed from source code into a working Python environment. All necessary dependencies and the
runtime environment are built-in.
Turnkey installer
------------------------
- Visit the project's `Releases page <https://github.com/aclist/dztui/releases/latest>`_.
- Extract the DZGUI tarball from the top of the **Assets** list.
- From a terminal, run the command ``./dzgui`` or double click on the extracted file in
a file explorer.
- Once the setup wizard opens, follow the steps at the bottom of this page.
UI dependencies (Python and PyGObject)
---------------------------------------
On most major distributions, GObject introspection libraries should be available by default.
If you receive an error about a missing ``libgirepository-2.0`` dependency, install it via your system's package manager.
On Debian-based distributions (Ubuntu, etc.), this package is not explicitly installed on the system.
You can install it via the following set of commands:
.. code:: console
sudo apt update
sudo apt install libgirepository-2.0-0
Next steps
---------------
Proceed to the :doc:`setup` section for setup instructions.
+12
View File
@@ -0,0 +1,12 @@
Command line launch flags
==========================
When run from the terminal, DZGUI provides several flags:
``-d, --debug``: enable developer debugging features. This does not add hidden or extra functionality; it merely enables developers to track deprecation warnings and see values stored in memory.
End-users will gain no benefit from using this flag.
``-m, --map``: check and update system map count value. Unnecessary on most modern systems. If your system does not meet the threshold, the DZGUI setup wizard will prompt you to use this flag.
``-u, --uninstall``: uninstall: granular selection of which state/configuration files to remove.
``-v, --version``: displays the DZGUI version.
+3 -3
View File
@@ -15,8 +15,8 @@ A DayZ server browser/mod manager for Linux. Used to list official and community
Source code:
- `GitHub <https://www.github.com/aclist/dztui>`_
- `Codeberg (mirror) <https://codeberg.org/aclist/dztui>`_
- `GitHub <https://www.github.com/aclist/dzgui>`_
- `Codeberg (mirror) <https://codeberg.org/aclist/dzgui>`_
Installation
-------------
@@ -56,8 +56,8 @@ See: :doc:`kb` or :ref:`Submitting a ticket`.
:maxdepth: 3
:hidden:
steam
locale
flags
.. toctree::
:caption: Help
+25 -16
View File
@@ -1,28 +1,37 @@
Installation
==================
As of this writing, you have a choice of two DZGUI versions:
.. note::
Version 6 of DZGUI 6 has been fully replaced with DZGUI 7.
Users on existing DZGUI 6 installations should migrate to the DZGUI 7 build.
- DZGUI 6: Legacy stable version, more complicated to install
- DZGUI 7: Unstable beta version, much easier to install
In order to make the first-time setup experience easier for end-users, DZGUI 7 no longer requires
the tool to be installed from source code into a working Python environment. All necessary dependencies and the
runtime environment are built-in.
DZGUI 6
--------------------
This version is no longer receiving feature updates, but will receive security updates until it is replaced by DZGUI 7.
Turnkey installer
------------------------
DZGUI 6 must be installed from the source code and has many more package dependencies and prerequisites for it to function correctly.
If you are looking for a one-click, self-contained installer, use :ref:`DZGUI 7` instead.
- Visit the project's `Releases page <https://github.com/aclist/dzgui/releases/latest>`_.
- Download the DZGUI archive from the top of the **Assets** list. This file will be labeled ``dzgui-<VERSION>-x86_64-unknown-linux-musl.tar.gz``.
- Extract the archive's contents.
- From a terminal, run the command ``./dzgui`` or double click on the extracted file in a file explorer.
- Once the setup wizard opens, follow the steps at the bottom of this page.
To install **DZGUI 6**, visit :doc:`dzgui6`.
UI dependencies (Python and PyGObject)
---------------------------------------
On most major distributions, GObject introspection libraries should be available by default.
If you receive an error about a missing ``libgirepository-2.0`` dependency, install it via your system's package manager.
DZGUI 7
--------------------
This version is currently in beta testing and has all of the features found in DZGUI 6, but may be unstable.
On Debian-based distributions (Ubuntu, etc.), this package is not explicitly installed on the system.
You can install it via the following set of commands:
DZGUI 7 has an all-in-one installer and setup wizard, and many new features not found in DZGUI 6.
However, this codebase is newer and is provided as a pre-release beta candidate.
.. code:: console
If you want the simplest installer and don't mind experiencing the occasional bug, use this version.
sudo apt update
sudo apt install libgirepository-2.0-0
To install **DZGUI 7**, visit :doc:`dzgui7`.
Next steps
---------------
Proceed to the :doc:`setup` section for setup instructions.
+15 -2
View File
@@ -98,15 +98,28 @@ tend to have less headroom for simultaneous connections than their wired counter
DZG-009: Floating dialogs appear maximized on tiling window managers
-------------------------------------------------------------------
The main DZGUI window and its child dialogs are expected to be rendered as floating by your window manager.
DZGUI sends window manager hints to this effect, but tiling window managers designed to bisect the screen into quadrants (e.g., i3 window manager)
may try to always launch applications in fullscreen.
To resolve this, set specific exclusions or window hints in your WM's configuration file.
For example, for i3, add the following to your `XDG_CONFIG_HOME/i3/config` file (defaults to `$HOME/.config/i3/config`):
For example, for i3, add the following to your ``XDG_CONFIG_HOME/i3/config`` file (defaults to ``$HOME/.config/i3/config``):
.. code:: console
for_window [instance="DZGUI"] floating enable, move position center
for_window [instance="DZGUI - Dialog"] floating enable, move position center
DZG-010: Maps combobox extends to full height of window when there are many maps to choose from
---------------------------------------------------------------------------------------------------
This is a limitation of GTK 3. If and when DZGUI is refactored to support the GTK 4 API, this visual glitch is expected to be resolved.
DZG-011: GTK reports "Failed to load module 'xapp-gtk3-module' when starting DZGUI
---------------------------------------------------------------------------------------------------
This is a purely cosmetic message that appears when Cinnamon (Xapp) desktop integations are not present.
While you can suppress this message by installing the package ``xapp``, if you are not actually using Cinnamon as
part of your desktop environment, it will pull in a large number of unnecessary dependencies.
DZG-012: After adding the DZGUI Steam shortcut via the installer, shortcut icons do not appear in the small library list
-------------------------------------------------------------------------------------------------------------------------
It can take 1-2 restarts of the Steam client for these icons to synchronize.
+14 -5
View File
@@ -19,14 +19,14 @@ You will need at a minimum a :ref:`Steam Web API key<steam_api>` in order to bro
Steam Web API key
^^^^^^^^^^^^^^^^^^
**This step is required**.
Register for a `Steam Web API key <https://steamcommunity.com/dev/apikey>`_ (free) using your Steam account. You will be asked for a unique URL for your app when registering.
Register for a `Steam Web API key <https://steamcommunity.com/dev/apikey>`_ (free) using your Steam account.
Since this key is for a personal use application and does not actually call back anywhere, set a generic local identifier here like "127.0.0.1" or some other name that is meaningful to you.
You will be asked for a unique URL for your app when registering. Typically, an API would send logs back to your URL in the form of callbacks.
However, since these API queries will be used for local consumption by a single user only, you can set a generic local identifier here like ``127.0.0.1`` to have the server discard them.
Once configured, you can insert this key in the app when launching it for the first time.
Once configured, you can insert this API key in the app when launching it for the first time.
.. note::
If you are confused about this requirement, please refer to DZGUI Knowledge Base article :ref:`DZG-007<DZG-007>` for additional information.
@@ -36,7 +36,16 @@ Battlemetrics API key
.. warning::
This feature is no longer supported in DZGUI. Battlemetrics has switched to a paid service.
Battlemetrics queries are expected to fail in DZGUI 6. In DZGUI 7, this feature has been removed entirely.
Choosing a Steam client
^^^^^^^^^^^^^^^^^^^^^^^^^
If multiple Steam clients are available (native Steam client/Flatpak Steam client), you will be
asked to choose which you want to use. Due to the way Steam's inter-process communication and internal URIs work,
if you choose one or the other, you should not run both clients simultaneously. This can lead DZGUI to send requests to the wrong one.
.. note::
If you decide to switch to using a different Steam client with DZGUI, please uninstall fully (``dzgui -u``) and re-run the first time setup.
Next steps
--------------
-94
View File
@@ -1,94 +0,0 @@
Steam integration
====================
.. note::
In :doc:`DZGUI 7 <dzgui7>`, Steam shortcut creation and cover art setup are handled automatically during setup. You can skip this step unless you are using DZGUI 6.
DZGUI can be added to Steam as a "non-Steam game" in order to facilitate integration with Steam Deck or desktop environments.
First, launch Steam in the **Large** (default) view.
.. attention::
Steam Deck users: Gaming Mode has limited support for configuration of custom games. You will need to switch to **Desktop Mode** in order to add a non-Steam game.
.. figure:: images/01.png
:scale: 70%
:alt: Adding a non-Steam game
Select **Add a Game** > **Add a Non-Steam Game** from the bottom left corner of the Steam client.
Navigate to ``$HOME/.local/share/applications`` and select ``dzgui.desktop``.
Select **Add Selected Programs** to add a shortcut to DZGUI.
Artwork
^^^^^^^^^^
DZGUI ships with custom artwork that provides various cover/splash images to allow it to integrate with the rest of your games library.
.. figure:: images/02.png
:scale: 70%
:alt: Adding a non-Steam game
From the main library view, navigate to the app’s details page and right-click the blank image header at the top.
.. figure:: images/03.png
:scale: 70%
:alt: Adding a non-Steam game
Select **Set Custom Background**
Select to display **All Files** from the **File type** dropdown
Navigate to ``$HOME/.local/share/dzgui`` and select ``hero.png``.
.. figure:: images/04.png
:scale: 70%
:alt: Adding a non-Steam game
Next, right-click the image background and select **Set Custom Logo**.
Navigate to ``$HOME/.local/share/dzgui`` and select ``logo.png``.
.. figure:: images/05.png
:scale: 70%
:alt: Adding a non-Steam game
Notice that this removes the redundant app name that occluded the image, as seen above.
.. figure:: images/06.png
:scale: 70%
:alt: Adding a non-Steam game
Next, navigate to your Library index (looks like a bookshelf of cover art) and find the DZGUI app.
Right-click its cover and select **Manage** > **Set custom artwork**.
Navigate to ``$HOME/.local/share/dzgui`` and select ``grid.png``.
.. figure:: images/07.png
:scale: 70%
:alt: Adding a non-Steam game
The final result will create box art looking like the above.
.. figure:: images/08.png
:scale: 100%
:alt: Adding a non-Steam game
Next, right-click the DZGUI entry in your Library and select **Properties** to open the properties dialog. Next to the **Shortcut** field, you will see a small square box which represents the game’s
icon. Click this to open a file explorer, navigate to ``$HOME/.local/share/dzgui``, and select ``icon.png``. This will add a small icon to the list view.
Finally, after you launch DZGUI for the first time, you should quit the application and return to the Library view. Select the **Recent Games** dropdown on the right-hand side.
Steam shows a collection of box art based on categories like "Play Next", "Recent Games", etc. Look for a **downward-pointing caret icon** and click it, then select the **Recent Games** category.
.. figure:: images/09.png
:scale: 100%
:alt: Adding a non-Steam game
If DZGUI was the last item played, it will be shown with a landscape, rather than portrait, orientation cover, which is initially blank.
To customize this cover, right click it and select **Manage** > **Set custom artwork**, navigate to ``$HOME/.local/share/dzgui``, then select ``hero.png``.
+3 -7
View File
@@ -1,12 +1,8 @@
Uninstallation
==================
To uninstall DZGUI and its associated files, invoke ``./dzgui`` from the terminal with the ``-u`` or ``--uninstall`` flag.
To uninstall DZGUI and its associated files, invoke ``./dzgui.sh`` with the ``-u`` or ``--uninstall`` flag.
Follow the prompts to choose from:
- **Full uninstall** -- removes the application and all user-defined configuration files
- **Partial uninstall** -- removes the application, but keeps user-defined configuration files
You will be prompted to select atomic files you wish to remove.
.. tip::
If you intend to reinstall DZGUI again, keeping your configuration files is recommended.
If you intend to reinstall DZGUI again, keeping your configuration files at a minimum is recommended.
+12 -8
View File
@@ -1,25 +1,29 @@
Usage
=========
It is always advised to have Steam running in the background. DZGUI is meant to run "on top of" Steam.
DZGUI can be launched in one of three ways.
From a terminal
------------------
Invoke the command ``./dzgui.sh`` from wherever you downloaded the DZGUI script to.
Invoke the command ``./dzgui`` from wherever you downloaded DZGUI to.
Launching from a terminal may give more verbose information in the event of a crash, and can be a good way of troubleshooting problems.
From the shortcut shipped with the application
--------------------------------------------------
When completing the first-time setup, you will be asked if you want to create additional system shortcuts.
If applicable for yourDesktop Environment, these shortcuts can be created.
On most distributions, if you are using a desktop environment based on the Freedesktop specification, shortcuts will be installed for you.
- One shortcut is located under the ``Games`` category of your system’s applications list/start menu.
- The other is accessed via the ``DZGUI`` desktop icon (Steam Deck only)
- One shortcut will be located under the ``Games`` category of your system’s applications list/start menu.
- The other is accessed via the ``DZGUI`` shortcut on the desktop
From Steam
--------------
See :doc:`steam`.
DZGUI will also ask you if you want to add a "non-Steam game" shortcut to Steam.
This shortcut will launch DZGUI directly and comes with integrated grid and cover artwork.
You must restart Steam for this shortcut to take effect in your library.
.. note::
You can also pass DZGUI launch parameter's to the Steam shortcut via Steam's right-click menu. See :doc:`flags`.
+13 -4
View File
@@ -27,6 +27,7 @@ from dzgui.const.constants import (
FLATPAK_STEAM_PATH,
LIBRARYFOLDERS_PATH,
REQUEST_TIMEOUT,
SNAP_STEAM_PATH,
UBUNTU_STEAM_PATH,
VDF_PATH,
)
@@ -67,23 +68,31 @@ def get_steam_paths() -> list[tuple[Path, str]]:
HOME = Path.home()
env = os.environ.get("XDG_DATA_HOME")
if env is not None:
XDG_DATA_HOME = env
XDG_DATA_HOME = Path(env)
DEFAULT_PATH = XDG_DATA_HOME.joinpath("Steam")
else:
XDG_DATA_HOME = DEFAULT_STEAM_PATH
DEFAULT_PATH = HOME.joinpath(DEFAULT_STEAM_PATH)
DEFAULT_PATH = HOME.joinpath(XDG_DATA_HOME)
FLATPAK_PATH = HOME.joinpath(FLATPAK_STEAM_PATH)
UBUNTU_PATH = HOME.joinpath(UBUNTU_STEAM_PATH)
DEBIAN_PATH = HOME.joinpath(DEBIAN_STEAM_PATH)
SNAP_PATH = HOME.joinpath(SNAP_STEAM_PATH)
human = {
DEFAULT_PATH: wizard.desc_default_path,
FLATPAK_PATH: wizard.desc_flatpak_path,
UBUNTU_PATH: wizard.desc_ubuntu_path,
SNAP_PATH: wizard.desc_snap_path,
DEBIAN_PATH: wizard.desc_debian_path,
}
for path in DEFAULT_PATH, FLATPAK_PATH, UBUNTU_PATH, DEBIAN_PATH:
for path in (
DEFAULT_PATH,
FLATPAK_PATH,
UBUNTU_PATH,
SNAP_PATH,
DEBIAN_PATH,
):
if path is FLATPAK_PATH and has_flatpak_client() is False:
continue
if path is not FLATPAK_PATH and has_steam_client() is False:
+1
View File
@@ -60,6 +60,7 @@ DEFAULT_STEAM_PATH = ".local/share/Steam"
FLATPAK_ROOT_PATH = ".var/app/com.valvesoftware.Steam"
FLATPAK_STEAM_PATH = FLATPAK_ROOT_PATH + "/data/Steam"
UBUNTU_STEAM_PATH = ".steam/steam"
SNAP_STEAM_PATH = "snap/steam/common/" + DEFAULT_STEAM_PATH
DEBIAN_STEAM_PATH = ".steam/debian-installation"
LOG_FILTERS = ("CRITICAL", "WARNING", "INFO", "DEBUG")
+1
View File
@@ -17,6 +17,7 @@ desc_flatpak_path = (
"This is the default Steam path if you are using <b>Flatpak Steam</b>."
)
desc_ubuntu_path = "This is the default Steam path on <b>Ubuntu-based systems</b>."
desc_snap_path = "This is the default Steam path on <b>systems using Snap packages</b>."
desc_debian_path = "This is the default Steam path on <b>Debian-based systems</b>."
no_valid_paths = (
"No valid Steam path or Steam command found on system. Please install Steam to continue."
+4 -2
View File
@@ -1,5 +1,7 @@
from pathlib import Path
CWD = Path(__file__).parent
def fixture_path(fixture: str) -> str:
return str(CWD / fixture)
def fixture_path(fixture: str) -> Path:
return Path(CWD).joinpath(fixture)
+9 -6
View File
@@ -1,6 +1,7 @@
import pytest
from _pytest.monkeypatch import MonkeyPatch
from collections.abc import Iterator
from pathlib import Path
from dzgui.api.steam import get_app_allows_downloads, get_last_updated
@@ -36,30 +37,32 @@ def steam_path() -> Path:
@pytest.fixture(scope="module", autouse=True)
def patch_api() -> None:
def patch_api() -> Iterator[None]:
mp = MonkeyPatch()
mp.setattr("dzgui.api.steam.get_app_path", mock_path)
yield
mp.undo()
def test_no_last_update(steam_path) -> None:
def test_no_last_update(steam_path: Path) -> None:
assert get_last_updated(steam_path, 555) is None
def test_last_update(steam_path) -> None:
def test_last_update(steam_path: Path) -> None:
assert get_last_updated(steam_path, 444) == "2026-10-22 00:09:33"
def test_app_allows_downloads(steam_path) -> None:
def test_app_allows_downloads(steam_path: Path) -> None:
assert get_app_allows_downloads(steam_path, 111) is True
def test_app_disallows_downloads(steam_path):
def test_app_disallows_downloads(steam_path: Path) -> None:
assert get_app_allows_downloads(steam_path, 222) is False
def test_app_delegates_downloads(monkeypatch, steam_path, client_allows):
def test_app_delegates_downloads(
monkeypatch: MonkeyPatch, steam_path: Path, client_allows: Path
) -> None:
monkeypatch.setattr("dzgui.api.steam.get_config", mock_config_disallows)
assert get_app_allows_downloads(steam_path, 333) is False
monkeypatch.setattr("dzgui.api.steam.get_config", mock_config_allows)
+10 -4
View File
@@ -1,6 +1,8 @@
import pytest
import tempfile
from typing import TYPE_CHECKING
from dzgui.app_init import copy_bare_configs
from dzgui.config.xdg import get_xdg_paths, parse_filepaths
@@ -8,9 +10,13 @@ from dzgui.config.xdg import get_xdg_paths, parse_filepaths
CONF_STRING = "DZGUI_CONF\n"
STATE_STRING = "DZGUI_STATE\n"
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
from dzgui.config.xdg import Xdg
@pytest.fixture
def state_files():
def state_files() -> list[str]:
state = [
"dzg.history",
"dzg.versions",
@@ -25,7 +31,7 @@ def state_files():
@pytest.fixture
def xdg_paths(monkeypatch):
def xdg_paths(monkeypatch: "MonkeyPatch") -> "Xdg":
routes = {
"XDG_CONFIG_HOME": "",
"XDG_STATE_HOME": "",
@@ -42,7 +48,7 @@ def xdg_paths(monkeypatch):
@pytest.mark.mods
def test_config_file_import(xdg_paths, state_files):
def test_config_file_import(xdg_paths: "Xdg", state_files: list[str]) -> None:
# NOTE: write bare files in root
tmp_conf = xdg_paths.config.parent.parent
@@ -67,7 +73,7 @@ def test_config_file_import(xdg_paths, state_files):
@pytest.mark.mods
def test_config_file_no_import(xdg_paths, state_files):
def test_config_file_no_import(xdg_paths: "Xdg", state_files: list[str]) -> None:
for subdir in xdg_paths.config.parent, xdg_paths.resolution.parent:
subdir.mkdir()
+2 -2
View File
@@ -5,7 +5,7 @@ from pathlib import Path
@pytest.fixture
def changelog(request) -> None:
def changelog(request: pytest.FixtureRequest) -> str:
root = request.config.rootpath
changelog = Path(root).joinpath("CHANGELOG.md").read_text()
return changelog
@@ -19,7 +19,7 @@ def count_hash(line: str) -> int:
return cnt
def test_changelog_prefix(changelog) -> None:
def test_changelog_prefix(changelog: str) -> None:
r = r".*(\[.*\]).*"
lines = changelog.splitlines()
sort = sorted(lines)
+7 -2
View File
@@ -1,14 +1,19 @@
import pytest
from typing import Any, TYPE_CHECKING
from dzgui.const.constants import FLATPAK_RUN_CMD, STEAM_CMD
from dzgui.controllers.mc import Controller
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
@pytest.mark.parametrize(
"value, expected", [(FLATPAK_RUN_CMD, "Flatpak"), (STEAM_CMD, "Steam")]
)
def test_human_name(monkeypatch, value, expected) -> None:
def mock_query_config(*args) -> str:
def test_human_name(monkeypatch: "MonkeyPatch", value: str, expected: str) -> None:
def mock_query_config(*args: Any) -> str:
return value
monkeypatch.setattr(
+2 -2
View File
@@ -9,7 +9,7 @@ gi.require_version("Gtk", "3.0")
from gi.repository import Gtk, GLib
class DummyWidget(ColorAwareApp, Gtk.Button):
class DummyWidget(ColorAwareApp, Gtk.Button): # type: ignore
def __init__(self) -> None:
super().__init__()
@@ -26,7 +26,7 @@ def widget() -> DummyWidget:
@pytest.mark.parametrize("key, expect", [("default", False), ("prefer-dark", True)])
def test_light_mode(widget, key: str, expect: bool) -> None:
def test_light_mode(widget: DummyWidget, key: str, expect: bool) -> None:
local_pref = subprocess.run(
["gsettings", "get", "org.gnome.desktop.interface", "color-scheme"],
capture_output=True,
+21 -6
View File
@@ -1,33 +1,48 @@
import pytest
from typing import TYPE_CHECKING
from dzgui.init.migrate import convert_cols_file
from tests.fixtures import fixture_path
if TYPE_CHECKING:
from pathlib import Path
@pytest.fixture
def columns_with_perspective():
def columns_with_perspective() -> "Path":
return fixture_path("columns_1")
@pytest.fixture
def columns_without_perspective():
def columns_without_perspective() -> "Path":
return fixture_path("columns_2")
@pytest.fixture
def columns_with_view():
def columns_with_view() -> "Path":
return fixture_path("columns_3")
@pytest.mark.config
def test_columns_with_perspective(columns_with_perspective):
def test_columns_with_perspective(columns_with_perspective: "Path") -> None:
j = convert_cols_file(columns_with_perspective)
if j is None:
return
assert "View" in j["cols"]
assert "Max" in j["cols"]
@pytest.mark.config
def test_columns_without_perspective(columns_without_perspective):
def test_columns_without_perspective(columns_without_perspective: "Path") -> None:
j = convert_cols_file(columns_without_perspective)
if j is None:
return
assert "View" not in j["cols"]
assert "Max" not in j["cols"]
@pytest.mark.config
def test_columns_with_view(columns_with_view):
def test_columns_with_view(columns_with_view: "Path") -> None:
j = convert_cols_file(columns_with_view)
assert j is None
+17 -12
View File
@@ -1,25 +1,30 @@
import json
import pytest
from typing import Any, TYPE_CHECKING
from dzgui.const.boilerplate import config_boilerplate
from dzgui.config.query import get_config
from dzgui.config.xdg import get_xdg_paths, parse_filepaths
from dzgui.config import convert
from tests.fixtures import fixture_path
if TYPE_CHECKING:
from pathlib import Path
@pytest.fixture
def legacy_config():
def legacy_config() -> "Path":
return fixture_path("dztuirc_1")
@pytest.fixture
def unset_values():
def unset_values() -> "Path":
return fixture_path("dztuirc_3")
@pytest.fixture
def keys():
def keys() -> list[str]:
return [
"fav_server",
"fav_label",
@@ -36,7 +41,7 @@ def keys():
# TODO: use a static fixture instead of system config
@pytest.fixture
def config():
def config() -> Any:
paths = get_xdg_paths()
xdg = parse_filepaths(paths)
return get_config(xdg.config)
@@ -44,21 +49,21 @@ def config():
@pytest.mark.post_install
@pytest.mark.realconfig
def test_invalid_config_value(config):
def test_invalid_config_value(config: Any) -> None:
with pytest.raises(Exception):
assert config["foo"] is None
@pytest.mark.post_install
@pytest.mark.realconfig
def test_default_config_values(keys, config):
def test_default_config_values(keys: list[str], config: Any) -> None:
for key in keys:
assert config[key] is not None
@pytest.mark.post_install
@pytest.mark.realconfig
def test_contains_invalid_values(keys, config):
def test_contains_invalid_values(keys: list[str], config: Any) -> None:
for key in config:
assert key in keys
@@ -70,15 +75,15 @@ def test_contains_invalid_values(keys, config):
("dztuirc_2", (False, False, False)),
],
)
def test_bool_conversion(fixture, expect):
fixture = fixture_path(fixture)
j = convert.rc2json(fixture)
def test_bool_conversion(fixture: str, expect: tuple[bool, bool, bool]) -> None:
fixture_p = fixture_path(fixture)
j = convert.rc2json(fixture_p)
j = json.loads(j)
assert j["fullscreen"] == expect[0]
assert not j["use_miles"]
def test_key_conversion(legacy_config):
def test_key_conversion(legacy_config: "Path") -> None:
j = convert.rc2json(legacy_config)
j = json.loads(j)
keys = [
@@ -92,7 +97,7 @@ def test_key_conversion(legacy_config):
assert key not in j
def test_missing_values(unset_values):
def test_missing_values(unset_values: "Path") -> None:
j = convert.rc2json(unset_values)
j = json.loads(j)
assert j.keys() == config_boilerplate.keys()
+43
View File
@@ -0,0 +1,43 @@
import pytest
import tempfile
from pathlib import Path
from typing import TYPE_CHECKING
from dzgui.api.steam import get_steam_paths
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
def test_custom_xdg_path(monkeypatch: "MonkeyPatch") -> None:
tmp = tempfile.TemporaryDirectory(delete=False).name
custom_path = Path(tmp).joinpath("xdg_data_home")
monkeypatch.setenv("XDG_DATA_HOME", str(custom_path))
vdf_path = custom_path.joinpath("Steam/steamapps")
vdf_path.mkdir(parents=True, exist_ok=True)
vdf_path.joinpath("libraryfolders.vdf").touch()
resolved_paths = get_steam_paths()
expect = custom_path.joinpath("Steam")
assert any(expect in el for el in resolved_paths)
def test_default_xdg_path() -> None:
resolved_paths = get_steam_paths()
expect = Path.home().joinpath(".local/share/Steam")
assert any(expect in el for el in resolved_paths)
def test_ubuntu_path() -> None:
resolved_paths = get_steam_paths()
expect = Path.home().joinpath(".steam/steam")
assert any(expect in el for el in resolved_paths)
@pytest.mark.flatpak
def test_flatpak_path() -> None:
resolved_paths = get_steam_paths()
expect = Path.home().joinpath(".var/app/com.valvesoftware.Steam/data/steam")
assert any(expect in el for el in resolved_paths)
+11 -7
View File
@@ -1,6 +1,8 @@
import configparser
import pytest
from pathlib import Path
from dzgui.const.constants import FLATPAK_APPID, GTK_APP_ID, TMP_PATH
from dzgui.config.xdg import get_xdg_paths
from dzgui.util.flatpak import apply_overrides
@@ -13,17 +15,17 @@ pytestmark = pytest.mark.flatpak
@pytest.fixture
def xdg_paths() -> dict[str, str]:
def xdg_paths() -> dict[str, Path]:
return get_xdg_paths()
@pytest.fixture
def override(xdg_paths) -> None:
def override(xdg_paths: dict[str, Path]) -> None:
apply_overrides(xdg_paths)
@pytest.fixture
def config(xdg_paths) -> configparser.ConfigParser:
def config(xdg_paths: dict[str, Path]) -> configparser.ConfigParser:
conf_path = xdg_paths["XDG_DATA_HOME"].parent.joinpath(
f"flatpak/overrides/{FLATPAK_APPID}"
)
@@ -32,14 +34,16 @@ def config(xdg_paths) -> configparser.ConfigParser:
return config
def test_session_bus(override, config) -> None:
def test_session_bus(override: None, config: configparser.ConfigParser) -> None:
bus = config[BUS_KEY][GTK_APP_ID]
assert bus == "own"
def test_paths(override, xdg_paths, config) -> None:
expect: list[str] = []
expect.append(TMP_PATH)
def test_paths(
override: None, xdg_paths: dict[str, Path], config: configparser.ConfigParser
) -> None:
expect: list[Path] = []
expect.append(Path(TMP_PATH))
expect.extend([*xdg_paths.values()])
paths = config[PATHS_KEY][PATHS_SUBKEY].split(";")
assert all(str(path) in paths for path in expect)
+2 -1
View File
@@ -2,10 +2,11 @@ import pytest
from dzgui.const.constants import FLATPAK_RUN_CMD, FLATPAK_SANDBOX
from dzgui.const.enum import Preferences
from dzgui.controllers.mc import Controller
from dzgui.views.pages.options import FlatpakToggleField
class MockController:
class MockController(Controller):
def __init__(self) -> None:
self.command: str
+6 -3
View File
@@ -20,20 +20,23 @@ def get_db_len(path: Path) -> int:
c = conn.cursor()
c.execute("SELECT COUNT(*) from ips")
db_len = c.fetchone()[0]
return db_len
return int(db_len)
@pytest.fixture
def csv() -> Path:
csv = Path(tempfile.NamedTemporaryFile().name)
url = find_download_url(DB_IP)
if url is None:
raise TypeError
tmp = serialize(url)
unzip(tmp, csv)
strip_ipv6(csv)
return csv
@pytest.mark.slow
def test_stripping(csv):
def test_stripping(csv: Path) -> None:
with open(csv, "rb") as f:
first = f.readline().decode().rstrip()
try:
@@ -52,7 +55,7 @@ def test_stripping(csv):
@pytest.mark.slow
def test_row_parity(csv) -> None:
def test_row_parity(csv: Path) -> None:
rows = csv.read_text().splitlines()
db = Path(tempfile.NamedTemporaryFile().name)
+9 -7
View File
@@ -1,26 +1,28 @@
import gi
import pytest
from dzgui.api.servers import Details
from dzgui.controllers.mc import Controller
from dzgui.controllers.emitter import Emitter
from dzgui.views.dialogs.servers import ServerDetailsDialog
import gi
gi.require_version("Gtk", "3.0")
from gi.repository import Gtk
class MockController:
class MockController(Controller):
def __init__(self) -> None:
self.window = Gtk.Window()
pass
def get_window(self) -> Gtk.Window:
return self.window
def get_window(self) -> None: # type: ignore[override]
return None
def get_server_name(self) -> str:
return "My server"
def get_emitter(self) -> None:
return None
def get_emitter(self) -> Emitter:
return Emitter()
@pytest.mark.filterwarnings("ignore::DeprecationWarning")
+1 -1
View File
@@ -15,7 +15,7 @@ from dzgui.views.components.entry import validate_ip_truthy
("192.168.1.101:27016", True),
],
)
def test_ip_entry(ip) -> None:
def test_ip_entry(ip: tuple[str, bool]) -> None:
string, state = ip
assert validate_ip_truthy(string) is state
+11 -7
View File
@@ -1,27 +1,29 @@
import pytest
from typing import Any
from dzgui.model.model_factory import FastInsertListStore
@pytest.fixture
def heterogeneous_list() -> None:
def heterogeneous_list() -> list[list[Any]]:
return [["a", 0, True], ["b", 1, False]]
@pytest.fixture
def mismatched_length_list() -> None:
def mismatched_length_list() -> list[list[Any]]:
return [["a", 0, True], ["b", 1, False, 0]]
@pytest.fixture
def extended_list(heterogeneous_list) -> None:
def extended_list(heterogeneous_list: list[list[Any]]) -> FastInsertListStore:
fs = FastInsertListStore(str, int, bool)
fs.extend(heterogeneous_list)
return fs
@pytest.fixture
def appended_list(heterogeneous_list) -> None:
def appended_list(heterogeneous_list: list[list[Any]]) -> FastInsertListStore:
fs = FastInsertListStore(str, int, bool)
for row in heterogeneous_list:
fs.append(row)
@@ -29,19 +31,21 @@ def appended_list(heterogeneous_list) -> None:
@pytest.mark.parametrize("target", ["extended_list", "appended_list"])
def test_list_parity(heterogeneous_list, request, target) -> None:
def test_list_parity(
heterogeneous_list: list[list[Any]], request: pytest.FixtureRequest, target: str
) -> None:
target = request.getfixturevalue(target)
extracted = [[el for el in row] for row in target]
assert heterogeneous_list == extracted
def test_type_disparity(heterogeneous_list) -> None:
def test_type_disparity(heterogeneous_list: list[list[Any]]) -> None:
with pytest.raises(TypeError):
fs = FastInsertListStore(str, bool, bool)
fs.extend(heterogeneous_list)
def test_length_disparity(mismatched_length_list) -> None:
def test_length_disparity(mismatched_length_list: list[list[Any]]) -> None:
with pytest.raises(ValueError):
fs = FastInsertListStore(str, int, bool)
fs.extend(mismatched_length_list)
+9 -4
View File
@@ -1,27 +1,32 @@
from typing import TYPE_CHECKING
from dzgui.util import localize
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
def test_de(monkeypatch):
def test_de(monkeypatch: "MonkeyPatch") -> None:
monkeypatch.setenv("LC_ALL", "de_DE.UTF-8")
localize.set_locale()
assert localize.number(9900) == "9.900"
assert localize.number(99.88) == "99,88"
def test_en(monkeypatch):
def test_en(monkeypatch: "MonkeyPatch") -> None:
monkeypatch.setenv("LC_ALL", "en_US.UTF-8")
localize.set_locale()
assert localize.number(9900) == "9,900"
assert localize.number(99.88) == "99.88"
def test_none(monkeypatch):
def test_none(monkeypatch: "MonkeyPatch") -> None:
localize.set_locale()
assert localize.number(9900) == "9,900"
assert localize.number(99.88) == "99.88"
def test_empty(monkeypatch):
def test_empty(monkeypatch: "MonkeyPatch") -> None:
monkeypatch.setenv("LC_ALL", "")
localize.set_locale()
assert localize.number(9900) == "9,900"
+3 -3
View File
@@ -7,13 +7,13 @@ from dzgui.util.redact import RedactionFilter, REDACTION_PATTERNS
class RecordsListHandler(logging.Handler):
def __init__(self) -> None:
super().__init__()
self.records_list = []
self.records_list: list[logging.LogRecord] = []
def emit(self, record: logging.LogRecord) -> None:
self.records_list.append(record)
def pop(self) -> None:
return self.records_list[-1].msg
def pop(self) -> str:
return str(self.records_list[-1].msg)
@pytest.mark.redact
+7 -1
View File
@@ -1,6 +1,7 @@
import pytest
from pathlib import Path
from typing import TYPE_CHECKING
from dzgui.api.steam import find_user_id
from dzgui.const.constants import DEFAULT_STEAM_PATH
@@ -8,6 +9,9 @@ from tests.fixtures import fixture_path
pytestmark = pytest.mark.apitest
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
@pytest.mark.parametrize(
"fixture, expect",
@@ -19,12 +23,14 @@ pytestmark = pytest.mark.apitest
("api/loginusers_beta_client_multiple_2.vdf", 0),
],
)
def test_loginusers(monkeypatch, fixture: str, expect: int) -> None:
def test_loginusers(monkeypatch: "MonkeyPatch", fixture: str, expect: int) -> None:
def mock_loginusers(path: Path) -> Path:
return fixture_path(fixture)
monkeypatch.setattr("dzgui.api.steam.find_loginusers", mock_loginusers)
uid = find_user_id(Path(""))
if uid is None:
raise TypeError
assert int(uid) == expect
+16 -6
View File
@@ -11,37 +11,47 @@ import dzgui.config.query
from tests.fixtures import fixture_path
if TYPE_CHECKING:
from dzgui.const.enums import Preferences
from _pytest.monkeypatch import MonkeyPatch
from dzgui.const.enum import Preferences
pytestmark = pytest.mark.mods
@pytest.fixture
def versions() -> str:
def versions() -> "Path":
return fixture_path("dzg.versions")
@pytest.fixture
def tmp() -> str:
with tempfile.NamedTemporaryFile(delete=False) as f:
tmp = f.name
return tmp
def mock_local_ids(path: Path) -> list[int]:
return [3410710885, 3739934289]
def mock_lookup(path: Path, prefs: "Preferences") -> str:
return ""
def test_signatures(monkeypatch, tmp: str, versions: str) -> None:
def test_signatures(monkeypatch: "MonkeyPatch", tmp: str, versions: str) -> None:
ids = [1559212036, 1654462998]
shutil.copyfile(versions, tmp)
path = Path(tmp)
monkeypatch.setattr("dzgui.api.mods.lookup", mock_lookup)
dzgui.api.mods.remove_stale_signatures(path, path, ids)
with open(tmp, "r") as f:
lines = f.readlines()
assert ids not in lines
lines = [line.rstrip() for line in f.readlines()]
concat = ",".join(map(str, ids))
assert concat not in lines
def test_signatures_with_no_ids(monkeypatch, tmp: str, versions: str) -> None:
def test_signatures_with_no_ids(
monkeypatch: "MonkeyPatch", tmp: str, versions: str
) -> None:
shutil.copyfile(versions, tmp)
path = Path(tmp)
monkeypatch.setattr("dzgui.api.mods.get_local_mod_ids", mock_local_ids)
+3
View File
@@ -4,10 +4,13 @@ from pathlib import Path
from dzgui.api.mods import tokenize
from tests.fixtures import fixture_path
@pytest.mark.mods
@pytest.mark.parametrize("i", range(1, 7))
def test_modmeta(i: int) -> None:
fixture = fixture_path(f"cpp/mod{i}")
path = Path(fixture)
meta = tokenize(path)
if meta is None:
raise TypeError
assert meta["name"] == "ModName"
+6 -1
View File
@@ -1,8 +1,13 @@
from pathlib import Path
from typing import TYPE_CHECKING
from dzgui.config.xdg import get_xdg_paths
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
def test_path_fallback(monkeypatch) -> None:
def test_path_fallback(monkeypatch: "MonkeyPatch") -> None:
envs = ["XDG_DATA_HOME", "XDG_STATE_HOME", "XDG_CONFIG_HOME", "XDG_CACHE_HOME"]
for env in envs:
monkeypatch.setenv(env, "/etc/dzgui")
+9 -3
View File
@@ -1,8 +1,12 @@
import pytest
from pathlib import Path
from typing import TYPE_CHECKING
from dzgui.api.steam import is_dayz_downloading
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
@pytest.mark.parametrize(
"file_list, expect",
@@ -16,12 +20,14 @@ from dzgui.api.steam import is_dayz_downloading
(["state_221100_1111"], False),
],
)
def test_dayz_patch_pending(monkeypatch, file_list: list[str], expect: bool) -> None:
def mock_get_pending_downloads(steam_path: Path, appid: int) -> None:
def test_dayz_patch_pending(
monkeypatch: "MonkeyPatch", file_list: list[str], expect: bool
) -> None:
def mock_get_pending_downloads(steam_path: Path, appid: int) -> list[Path]:
files = [Path(file) for file in file_list]
return files
monkeypatch.setattr(
"dzgui.api.steam.get_pending_downloads", mock_get_pending_downloads
)
assert is_dayz_downloading(Path("/tmp"), Path("/tmp")) == expect
assert is_dayz_downloading(Path("/tmp"), 221100) == expect
+14 -8
View File
@@ -1,6 +1,7 @@
import pytest
from pathlib import Path
from pathlib import Path
from typing import TYPE_CHECKING
import dzgui.api.pefile as PeFile
from dzgui.api.steam import (
@@ -16,19 +17,22 @@ from dzgui.const.constants import APPID_DAYZ
from tests.fixtures import fixture_path
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
pytestmark = pytest.mark.apitest
@pytest.fixture
def default_steam_path():
def default_steam_path() -> str:
paths = get_xdg_paths()
xdg = parse_filepaths(paths)
conf = get_config(xdg.config)
return conf["default_steam_path"]
return str(conf["default_steam_path"])
# TODO: additional parsing tests
def test_pefile_length(default_steam_path):
def test_pefile_length(default_steam_path: str) -> None:
try:
pe_file_path = PeFile.get_pefile_path(Path(default_steam_path), APPID_DAYZ)
vers = PeFile.get_dayz_version(pe_file_path)
@@ -38,7 +42,7 @@ def test_pefile_length(default_steam_path):
assert len(st) == 3
def test_invalid_pefile_path():
def test_invalid_pefile_path() -> None:
with pytest.raises(VDFLoadError):
try:
PeFile.get_pefile_path(Path("/not/a/path"), APPID_DAYZ)
@@ -55,7 +59,9 @@ def test_invalid_pefile_path():
("malformed.vdf", VDFLoadError),
],
)
def test_not_in_library(monkeypatch, fixture, exception):
def test_not_in_library(
monkeypatch: "MonkeyPatch", fixture: str, exception: type[Exception]
) -> None:
import dzgui.api.steam as steam
monkeypatch.setattr(steam, "LIBRARYFOLDERS_PATH", fixture)
@@ -69,11 +75,11 @@ def test_not_in_library(monkeypatch, fixture, exception):
@pytest.fixture
def second_drive():
def second_drive() -> str:
return "in_library_on_second_drive.vdf"
def test_on_second_drive(monkeypatch, second_drive):
def test_on_second_drive(monkeypatch: "MonkeyPatch", second_drive: str) -> None:
import dzgui.api.steam as steam
monkeypatch.setattr(steam, "LIBRARYFOLDERS_PATH", second_drive)
+9 -7
View File
@@ -1,6 +1,8 @@
import pytest
import unittest
from unittest.mock import patch
from typing import Any
from dzgui.const.constants import (
FLATPAK_APPID,
@@ -14,9 +16,9 @@ pytestmark = pytest.mark.flatpak
class TestSteamDetection(unittest.TestCase):
def test_flatpak_detection_with_multiple_running_apps(self):
def flatpak_output(args, *, text):
# Default `flatpak ps` includes instance, PID, app and runtime columns.
def test_flatpak_detection_with_multiple_running_apps(self) -> None:
def flatpak_output(args: Any, *, text: str) -> str:
# Default 'flatpak ps' includes instance, PID, app and runtime columns.
if args == ["flatpak", "ps", "--columns=application"]:
return f"com.spotify.Client\n{FLATPAK_APPID}\n{FLATPAK_APPID}\n"
return f"3904921611\t1257689\t{FLATPAK_APPID}\torg.freedesktop.Platform\n"
@@ -29,7 +31,7 @@ class TestSteamDetection(unittest.TestCase):
with self.subTest(client=client):
self.assertTrue(proc.is_steam_running(client))
def test_flatpak_not_running(self):
def test_flatpak_not_running(self) -> None:
with patch.object(proc, "has_cmd", return_value=True):
for output in ("", "com.spotify.Client\n", f"{FLATPAK_APPID}Helper\n"):
with (
@@ -38,7 +40,7 @@ class TestSteamDetection(unittest.TestCase):
):
self.assertFalse(proc.is_flatpak_steam_running())
def test_flatpak_not_installed(self):
def test_flatpak_not_installed(self) -> None:
with (
patch.object(proc, "has_cmd", return_value=False),
patch.object(proc.subprocess, "check_output") as check_output,
@@ -46,7 +48,7 @@ class TestSteamDetection(unittest.TestCase):
self.assertFalse(proc.is_flatpak_steam_running())
check_output.assert_not_called()
def test_native_steam(self):
def test_native_steam(self) -> None:
with patch.object(proc, "has_cmd", return_value=True):
for output, expected in (
(
@@ -73,6 +75,6 @@ class TestSteamDetection(unittest.TestCase):
):
self.assertEqual(proc.is_native_steam_running(), expected)
def test_invalid_client(self):
def test_invalid_client(self) -> None:
with self.assertRaises(TypeError):
proc.is_steam_running("invalid-client")
+6 -4
View File
@@ -1,23 +1,25 @@
import pytest
from typing import Any
from dzgui.api import probe
from dzgui.config.query import get_config
from dzgui.config.xdg import get_xdg_paths, parse_filepaths
from dzgui.api import probe
pytestmark = pytest.mark.webtest
@pytest.fixture
def config():
def config() -> Any:
paths = get_xdg_paths()
xdg = parse_filepaths(paths)
return get_config(xdg.config)
def test_ipdb():
def test_ipdb() -> None:
assert probe.test_ipdb()
def test_steam(config):
def test_steam(config: Any) -> None:
key = config["steam_api"]
assert probe.test_steam_api(key)
+3 -2
View File
@@ -18,9 +18,10 @@ def test_row_conversion() -> None:
"Unofficial",
False,
]
rows = [ServerRow(*data)]
rows = [ServerRow(*data)] # type: ignore
marshalled = ServerRow.marshal_rows(rows)
store = ModelFactory().make_server_store()
store.extend(marshalled)
converted = [[el for el in row] for row in store]
cols = store.get_n_columns()
converted = [[row[i] for i in range(cols)] for row in store]
assert data == converted[0]
+10 -4
View File
@@ -3,9 +3,11 @@ import re
from dzgui.api.servers import Details, Record, get_details
pytestmark = pytest.mark.slow
@pytest.fixture
def details() -> Details:
def details() -> Details | None:
"""
Static official server, metadata is expected to be invariate
"""
@@ -19,17 +21,21 @@ def test_invalid_server() -> None:
@pytest.mark.parametrize("key, expect", [("day_accel", 2.3), ("night_accel", 6.8)])
def test_time_accel(details, key, expect) -> None:
def test_time_accel(details: Details | None, key: str, expect: float) -> None:
assert getattr(details, key) == expect
def test_gametime(details) -> None:
def test_gametime(details: Details | None) -> None:
time_reg = r"^(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]$)"
if details is None:
raise TypeError
match = re.match(time_reg, details.gametime)
assert match is not None
def test_metadata(details) -> None:
def test_metadata(details: Details | None) -> None:
if details is None:
raise TypeError
for row in details.data:
label, value = row
match label:
+18 -17
View File
@@ -1,9 +1,9 @@
import pytest
from hypothesis import given, strategies as st
from datetime import datetime, timedelta
from hypothesis import given, strategies as st
from dzgui.views.dialogs.calc import (
Emitter,
LocalClock,
ServerClock,
Time,
@@ -13,31 +13,28 @@ from dzgui.views.dialogs.calc import (
)
class DummyEmitter:
def __init__(self) -> None:
pass
def connect(self, _, __) -> None:
pass
@pytest.fixture(params=[("05:00", 10.0), ("15:30", 5.0)])
def accel_server_clock(request) -> None:
def accel_server_clock(request: pytest.FixtureRequest) -> tuple[str, ServerClock]:
clock_time, expect = request.param
cur_time = Time(clock_time, 5.0, 2.0)
emitter = DummyEmitter()
emitter = Emitter()
local_clock = LocalClock(emitter)
server_clock = ServerClock(cur_time, emitter, local_clock)
return expect, server_clock
def test_accel_factor(accel_server_clock) -> None:
def test_accel_factor(accel_server_clock: tuple[float, ServerClock]) -> None:
"""Static test checking times at known boundaries"""
expect, clock = accel_server_clock
assert clock.get_accel_factor(clock.cur_time) == expect
def reference_calc(start, end, day_factor, night_factor):
def reference_calc(
start: datetime,
end: datetime,
day_factor: float,
night_factor: float,
) -> timedelta:
"""
Reference implementation to test validity of UI-side calculator
Aggregates total seconds and applies accel factors after
@@ -80,7 +77,7 @@ night_accel = st.floats(
@st.composite
def time_ranges(draw):
def time_ranges(draw: st.DrawFn) -> tuple[datetime, datetime]:
start_time = draw(st.times())
deltas = st.timedeltas(min_value=timedelta(0), max_value=timedelta(days=1))
duration = draw(deltas)
@@ -91,12 +88,16 @@ def time_ranges(draw):
@given(span=time_ranges(), day_factor=day_accel, night_factor=night_accel)
def test_time_aggregation(span, day_factor, night_factor) -> None:
def test_time_aggregation(
span: tuple[datetime, datetime],
day_factor: float,
night_factor: float,
) -> None:
start, end = span
strtime = start.strftime("%H:%M")
t = Time(strtime, day_factor, night_factor)
emitter = DummyEmitter()
emitter = Emitter()
local_clock = LocalClock(emitter)
server_clock = ServerClock(t, emitter, local_clock)
h = end.time().hour
+41 -37
View File
@@ -1,91 +1,95 @@
import pytest
import tempfile
from pathlib import Path
from _pytest.monkeypatch import MonkeyPatch
from collections.abc import Iterator
from pathlib import Path
from typing import Any, cast, TYPE_CHECKING
from dzgui.api.shortcuts import Shortcuts
from tests.fixtures import fixture_path
if TYPE_CHECKING:
from _pytest.monkeypatch import MonkeyPatch
pytestmark = pytest.mark.apitest
def mock_find_shortcuts(self, steam_path: Path) -> Path:
def mock_find_shortcuts(self: Shortcuts, steam_path: Path) -> Path:
return Path(fixture_path("api/no_shortcuts.vdf"))
@pytest.fixture(scope="module", autouse=True)
def patch_api() -> None:
def patch_api() -> Iterator[None]:
mp = MonkeyPatch()
mp.setattr("dzgui.api.shortcuts.Shortcuts.find_shortcuts_path", mock_find_shortcuts)
yield
mp.undo()
def test_no_shortcuts(monkeypatch) -> None:
def test_no_shortcuts(monkeypatch: "MonkeyPatch") -> None:
s = Shortcuts(Path(""))
assert len(s.shortcuts["shortcuts"]) == 0
@pytest.fixture
def dummy_app() -> None:
def dummy_app() -> dict[str, Any]:
d = {
"AppName": "TEST APP",
"StartDir": "TEST_DIR",
"Exe": "TEST_DIR/TEST_EXE.EXE",
"icon": "IMAGES_DIR/TEST_IMAGE.PNG",
"StartDir": Path("TEST_DIR"),
"Exe": Path("TEST_DIR/TEST_EXE.EXE"),
"icon": Path("IMAGES_DIR/TEST_IMAGE.PNG"),
}
return d
def test_wrap_exe(dummy_app: dict[str, str]) -> None:
@pytest.fixture
def shortcuts(dummy_app: dict[str, Any]) -> Shortcuts:
s = Shortcuts(Path(""))
s.add_shortcut(*dummy_app.values())
assert s.shortcuts["shortcuts"]["0"]["Exe"][0] == '"'
assert s.shortcuts["shortcuts"]["0"]["Exe"][-1] == '"'
args = cast(tuple[str, Path, Path, Path], dummy_app.values())
s.add_shortcut(*args)
return s
def test_add_shortcut(dummy_app: dict[str, str]) -> None:
s = Shortcuts(Path(""))
s.add_shortcut(*dummy_app.values())
new = s.shortcuts["shortcuts"]
def test_wrap_exe(shortcuts: Shortcuts) -> None:
assert shortcuts.shortcuts["shortcuts"]["0"]["Exe"][0] == '"'
assert shortcuts.shortcuts["shortcuts"]["0"]["Exe"][-1] == '"'
def test_add_shortcut(shortcuts: Shortcuts, dummy_app: dict[str, Any]) -> None:
new = shortcuts.shortcuts["shortcuts"]
ind = str(len(new) - 1)
for k, v in dummy_app.items():
if k == "Exe":
v = f'"{v}"'
assert new[ind][k] == v
assert new[ind][k] == str(v)
def test_save_shortcut(dummy_app: dict[str, str]) -> None:
s = Shortcuts(Path(""))
s.add_shortcut(*dummy_app.values())
def test_save_shortcut(shortcuts: Shortcuts) -> None:
with tempfile.NamedTemporaryFile() as f:
tmp = Path(f.name)
s.shortcuts_path = tmp
s.save_shortcuts()
s._load_shortcuts(tmp)
assert len(s.shortcuts["shortcuts"]) == 1
shortcuts.shortcuts_path = tmp
shortcuts.save_shortcuts()
shortcuts._load_shortcuts(tmp)
assert len(shortcuts.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]
def test_shortcut_crc(shortcuts: Shortcuts) -> None:
for key in shortcuts.shortcuts["shortcuts"].keys():
entry = shortcuts.shortcuts["shortcuts"][key]
name = entry["AppName"]
exe = entry["Exe"]
uid = name + exe
bpid = s.gen_bpid(uid)
bpid = shortcuts.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]
def test_reverse_crc(shortcuts: Shortcuts) -> None:
for key in shortcuts.shortcuts["shortcuts"].keys():
entry = shortcuts.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
bpid = shortcuts.gen_bpid(uid)
assert shortcuts.find_appname_by_unsigned_id(bpid) == name
+2 -1
View File
@@ -2,7 +2,8 @@ import re
from dzgui.model.proxy_model import DAY_REG, NIGHT_REG
def iterate(h: str, r: str) -> None:
def iterate(h: int, r: str) -> None:
for m in range(60):
time = f"{h:02}:{m:02}"
assert re.match(r, time) is not None