ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-17 17:42:20 +03:00
Code Issues Projects Releases Wiki Activity

tests/journal_lock: Use proper pytest types in fixtures

Browse Source 
When I last typed this I couldn't find any official way to type `pytest`
fixtures.  Perhaps that was before:

    https://docs.pytest.org/en/6.2.x/changelog.html#improvements

which now makes it clean and simple.
This commit is contained in:
Athanasius 2022-12-23 12:59:44 +00:00
parent 5064b10744
commit 90183554ef
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 19 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
tests/journal_lock.py/test_journal_lock.py
View File

@ -3,11 +3,10 @@ import multiprocessing as mp
import os import os
import pathlib import pathlib
import sys import sys
from typing import Generator
import pytest import pytest
# Import as other names else they get picked up when used as fixtures from pytest import MonkeyPatch, TempdirFactory, TempPathFactory
from _pytest import monkeypatch as _pytest_monkeypatch
from _pytest import tmpdir as _pytest_tmpdir
from config import config from config import config
from journal_lock import JournalLock, JournalLockResult from journal_lock import JournalLock, JournalLockResult
@ -117,9 +116,9 @@ class TestJournalLock:
@pytest.fixture @pytest.fixture
def mock_journaldir( def mock_journaldir(
self, monkeypatch: _pytest_monkeypatch, self, monkeypatch: MonkeyPatch,
tmp_path_factory: _pytest_tmpdir.TempPathFactory tmp_path_factory: TempdirFactory
) -> _pytest_tmpdir.TempPathFactory: ) -> Generator:
"""Fixture for mocking config.get_str('journaldir').""" """Fixture for mocking config.get_str('journaldir')."""
def get_str(key: str, *, default: str | None = None) -> str: def get_str(key: str, *, default: str | None = None) -> str:
"""Mock config.*Config get_str to provide fake journaldir.""" """Mock config.*Config get_str to provide fake journaldir."""
@ -136,9 +135,9 @@ class TestJournalLock:
@pytest.fixture @pytest.fixture
def mock_journaldir_changing( def mock_journaldir_changing(
self, self,
monkeypatch: _pytest_monkeypatch, monkeypatch: MonkeyPatch,
tmp_path_factory: _pytest_tmpdir.TempPathFactory tmp_path_factory: TempdirFactory
) -> _pytest_tmpdir.TempPathFactory: ) -> Generator:
"""Fixture for mocking config.get_str('journaldir').""" """Fixture for mocking config.get_str('journaldir')."""
def get_str(key: str, *, default: str | None = None) -> str: def get_str(key: str, *, default: str | None = None) -> str:
"""Mock config.*Config get_str to provide fake journaldir.""" """Mock config.*Config get_str to provide fake journaldir."""
@ -154,7 +153,7 @@ class TestJournalLock:
########################################################################### ###########################################################################
# Tests against JournalLock.__init__() # Tests against JournalLock.__init__()
def test_journal_lock_init(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_journal_lock_init(self, mock_journaldir: TempPathFactory):
"""Test JournalLock instantiation.""" """Test JournalLock instantiation."""
print(f'{type(mock_journaldir)=}') print(f'{type(mock_journaldir)=}')
tmpdir = str(mock_journaldir.getbasetemp()) tmpdir = str(mock_journaldir.getbasetemp())
@ -176,14 +175,14 @@ class TestJournalLock:
jlock.set_path_from_journaldir() jlock.set_path_from_journaldir()
assert jlock.journal_dir_path is None assert jlock.journal_dir_path is None
def test_path_from_journaldir_with_tmpdir(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_path_from_journaldir_with_tmpdir(self, mock_journaldir: TempPathFactory):
"""Test JournalLock.set_path_from_journaldir() with tmpdir.""" """Test JournalLock.set_path_from_journaldir() with tmpdir."""
tmpdir = mock_journaldir tmpdir = mock_journaldir
jlock = JournalLock() jlock = JournalLock()
# Check that an actual journaldir is handled correctly. # Check that an actual journaldir is handled correctly.
jlock.journal_dir = tmpdir jlock.journal_dir = str(tmpdir)
jlock.set_path_from_journaldir() jlock.set_path_from_journaldir()
assert isinstance(jlock.journal_dir_path, pathlib.Path) assert isinstance(jlock.journal_dir_path, pathlib.Path)
@ -200,7 +199,7 @@ class TestJournalLock:
locked = jlock.obtain_lock() locked = jlock.obtain_lock()
assert locked == JournalLockResult.JOURNALDIR_IS_NONE assert locked == JournalLockResult.JOURNALDIR_IS_NONE
def test_obtain_lock_with_tmpdir(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_obtain_lock_with_tmpdir(self, mock_journaldir: TempPathFactory):
"""Test JournalLock.obtain_lock() with tmpdir.""" """Test JournalLock.obtain_lock() with tmpdir."""
jlock = JournalLock() jlock = JournalLock()
@ -213,7 +212,7 @@ class TestJournalLock:
assert jlock.release_lock() assert jlock.release_lock()
os.unlink(str(jlock.journal_dir_lockfile_name)) os.unlink(str(jlock.journal_dir_lockfile_name))
def test_obtain_lock_with_tmpdir_ro(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_obtain_lock_with_tmpdir_ro(self, mock_journaldir: TempPathFactory):
"""Test JournalLock.obtain_lock() with read-only tmpdir.""" """Test JournalLock.obtain_lock() with read-only tmpdir."""
tmpdir = str(mock_journaldir.getbasetemp()) tmpdir = str(mock_journaldir.getbasetemp())
print(f'{tmpdir=}') print(f'{tmpdir=}')
@ -280,7 +279,7 @@ class TestJournalLock:
assert locked == JournalLockResult.JOURNALDIR_READONLY assert locked == JournalLockResult.JOURNALDIR_READONLY
def test_obtain_lock_already_locked(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_obtain_lock_already_locked(self, mock_journaldir: TempPathFactory):
"""Test JournalLock.obtain_lock() with tmpdir.""" """Test JournalLock.obtain_lock() with tmpdir."""
continue_q: mp.Queue = mp.Queue() continue_q: mp.Queue = mp.Queue()
exit_q: mp.Queue = mp.Queue() exit_q: mp.Queue = mp.Queue()
@ -312,7 +311,7 @@ class TestJournalLock:
########################################################################### ###########################################################################
# Tests against JournalLock.release_lock() # Tests against JournalLock.release_lock()
def test_release_lock(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_release_lock(self, mock_journaldir: TempPathFactory):
"""Test JournalLock.release_lock().""" """Test JournalLock.release_lock()."""
# First actually obtain the lock, and check it worked # First actually obtain the lock, and check it worked
jlock = JournalLock() jlock = JournalLock()
@ -330,12 +329,12 @@ class TestJournalLock:
# Cleanup, to avoid side-effect on other tests # Cleanup, to avoid side-effect on other tests
os.unlink(str(jlock.journal_dir_lockfile_name)) os.unlink(str(jlock.journal_dir_lockfile_name))
def test_release_lock_not_locked(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_release_lock_not_locked(self, mock_journaldir: TempPathFactory):
"""Test JournalLock.release_lock() when not locked.""" """Test JournalLock.release_lock() when not locked."""
jlock = JournalLock() jlock = JournalLock()
assert jlock.release_lock() assert jlock.release_lock()
def test_release_lock_lie_locked(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_release_lock_lie_locked(self, mock_journaldir: TempPathFactory):
"""Test JournalLock.release_lock() when not locked, but lie we are.""" """Test JournalLock.release_lock() when not locked, but lie we are."""
jlock = JournalLock() jlock = JournalLock()
jlock.locked = True jlock.locked = True
@ -345,7 +344,7 @@ class TestJournalLock:
# Tests against JournalLock.update_lock() # Tests against JournalLock.update_lock()
def test_update_lock( def test_update_lock(
self, self,
mock_journaldir_changing: _pytest_tmpdir.TempPathFactory): mock_journaldir_changing: TempPathFactory):
""" """
Test JournalLock.update_lock(). Test JournalLock.update_lock().
@ -373,7 +372,7 @@ class TestJournalLock:
# And the old_journaldir's lockfile too # And the old_journaldir's lockfile too
os.unlink(str(old_journaldir_lockfile_name)) os.unlink(str(old_journaldir_lockfile_name))
def test_update_lock_same(self, mock_journaldir: _pytest_tmpdir.TempPathFactory): def test_update_lock_same(self, mock_journaldir: TempPathFactory):
""" """
Test JournalLock.update_lock(). Test JournalLock.update_lock().