tests: refactor test_pkgcheck_scan & REPO_ROOT

- use `Path` object for REPO_ROOT
- various improvements and cleanups around test_pkgcheck_scan

Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>

Author: arthurzam

tests/checks/test_network.py

@@ -1,4 +1,3 @@
-import glob
 import importlib.util
 import os
 import socket
@@ -15,31 +14,31 @@
                                      HomepageUrlCheck)
 from pkgcheck.packages import RawCPV
 from snakeoil.formatters import PlainTextFormatter
-from snakeoil.osutils import pjoin
 
 # skip module tests if requests isn't available
 requests = pytest.importorskip('requests')
 
 
 class TestNetworkChecks:
 
-    repos_data = pjoin(pytest.REPO_ROOT, 'testdata', 'data', 'repos')
-    repos_dir = pjoin(pytest.REPO_ROOT, 'testdata', 'repos')
+    repos_data = pytest.REPO_ROOT / 'testdata/data/repos'
+    repos_dir = pytest.REPO_ROOT / 'testdata/repos'
 
     @pytest.fixture(autouse=True)
     def _setup(self, testconfig, tmp_path):
         base_args = ['--config', testconfig]
         self.scan = partial(scan, base_args=base_args)
         self.scan_args = [
             '--config', 'no', '--cache-dir', str(tmp_path), '--net',
-            '-r', pjoin(self.repos_dir, 'network'),
+            '-r', str(self.repos_dir / 'network'),
         ]
 
-    _net_results = []
-    for name, cls in sorted(objects.CHECKS.items()):
-        if issubclass(cls, NetworkCheck):
-            for result in sorted(cls.known_results, key=attrgetter('__name__')):
-                _net_results.append((cls, result))
+    _net_results = [
+        (cls, result)
+        for _name, cls in sorted(objects.CHECKS.items())
+        if issubclass(cls, NetworkCheck)
+        for result in sorted(cls.known_results, key=attrgetter('__name__'))
+    ]
 
     def _render_results(self, results, **kwargs):
         """Render a given set of result objects into their related string form."""
@@ -55,18 +54,18 @@ def _render_results(self, results, **kwargs):
     def test_scan(self, check, result):
         check_name = check.__name__
         keyword = result.__name__
-        result_dir = pjoin(self.repos_dir, 'network', check_name, keyword)
 
-        paths = glob.glob(f'{result_dir}*')
+        result_dir = self.repos_dir / 'network' / check_name
+        paths = tuple(result_dir.glob(keyword + '*'))
         if not paths:
             pytest.skip('data unavailable')
 
         for path in paths:
             ebuild_name = os.path.basename(path)
-            data_dir = pjoin(self.repos_data, 'network', check_name, ebuild_name)
+            data_dir = self.repos_data / 'network' / check_name / ebuild_name
 
             # load response data to fake
-            module_path = pjoin(path, 'responses.py')
+            module_path = path / 'responses.py'
             spec = importlib.util.spec_from_file_location('responses_mod', module_path)
             responses_mod = importlib.util.module_from_spec(spec)
             spec.loader.exec_module(responses_mod)
@@ -78,7 +77,7 @@ def test_scan(self, check, result):
 
                 # load expected results if they exist
                 try:
-                    with open(pjoin(data_dir, 'expected.json')) as f:
+                    with (data_dir / 'expected.json').open() as f:
                         expected_results = set(reporters.JsonStream.from_iter(f))
                 except FileNotFoundError:
                     # check stopped before making request or completed successfully
@@ -94,8 +93,10 @@ def test_scan(self, check, result):
                     error.append(f'got:\n{rendered_results}')
                     pytest.fail('\n'.join(error))
 
-    @pytest.mark.parametrize(
-        'check, result', ((HomepageUrlCheck, DeadUrl), (FetchablesUrlCheck, DeadUrl)))
+    @pytest.mark.parametrize('check, result', (
+        (HomepageUrlCheck, DeadUrl),
+        (FetchablesUrlCheck, DeadUrl),
+    ))
     def test_scan_ftp(self, check, result):
         check_name = check.__name__
         keyword = result.__name__
@@ -121,6 +122,5 @@ def test_scan_ftp(self, check, result):
                 if side_effect is None:
                     assert not results
                 else:
-                    assert len(results) == 1
-                    assert results[0] == expected_result
+                    assert results == [expected_result]
                     assert self._render_results(results), 'failed rendering results'

tests/conftest.py

@@ -2,6 +2,7 @@
 import tempfile
 import textwrap
 from contextlib import ExitStack
+from pathlib import Path
 from unittest.mock import patch
 
 import pytest
@@ -15,7 +16,7 @@
 from snakeoil.osutils import pjoin
 
 pytest_plugins = ['pkgcore']
-REPO_ROOT = os.path.dirname(os.path.dirname(__file__))
+REPO_ROOT = Path(__file__).parent.parent
 
 
 def pytest_configure():
@@ -57,17 +58,17 @@ def testconfig(tmp_path_factory):
     config = tmp_path_factory.mktemp('testconfig')
     repos_conf = config / 'repos.conf'
     stubrepo = pjoin(pkgcore_const.DATA_PATH, 'stubrepo')
-    testdir = pjoin(REPO_ROOT, 'testdata', 'repos')
+    testdir = REPO_ROOT / 'testdata/repos'
     with open(repos_conf, 'w') as f:
         f.write(textwrap.dedent(f"""\
             [DEFAULT]
             main-repo = standalone
             [stubrepo]
             location = {stubrepo}
         """))
-        for repo in os.listdir(testdir):
-            f.write(f'[{repo}]\n')
-            f.write(f'location = {pjoin(testdir, repo)}\n')
+        for repo in testdir.iterdir():
+            f.write(f'[{repo.name}]\n')
+            f.write(f'location = {repo}\n')
     profile_path = pjoin(stubrepo, 'profiles', 'default')
     os.symlink(profile_path, str(config / 'make.profile'))
     return str(config)
@@ -83,13 +84,11 @@ def cache_dir(tmp_path_factory):
 @pytest.fixture
 def fakerepo(tmp_path_factory):
     """Generate a stub repo."""
-    fakerepo = str(tmp_path_factory.mktemp('fakerepo'))
-    os.makedirs(pjoin(fakerepo, 'profiles'))
-    os.makedirs(pjoin(fakerepo, 'metadata'))
-    with open(pjoin(fakerepo, 'profiles', 'repo_name'), 'w') as f:
-        f.write('fakerepo\n')
-    with open(pjoin(fakerepo, 'metadata', 'layout.conf'), 'w') as f:
-        f.write('masters =\n')
+    fakerepo = tmp_path_factory.mktemp('fakerepo')
+    (profiles := fakerepo / 'profiles').mkdir(parents=True)
+    (profiles / 'repo_name').write_text('fakerepo\n')
+    (metadata := fakerepo / 'metadata').mkdir(parents=True)
+    (metadata / 'layout.conf').write_text('masters =\n')
     return fakerepo
 
 

tests/scripts/test_pkgcheck_replay.py

@@ -73,7 +73,7 @@ def test_invalid_file(self, capsys):
                 assert excinfo.value.code == 2
 
     def test_replay_pipe_stdin(self):
-        script = os.path.join(pytest.REPO_ROOT, 'bin', 'pkgcheck')
+        script = pytest.REPO_ROOT / 'bin/pkgcheck'
         result = ProfileWarning('profile warning: foo')
         with tempfile.NamedTemporaryFile() as f:
             out = PlainTextFormatter(f)