migrate to pytest & test_docs -> tests/test_docs

Use pytest instead of unittest to have greater flexibility in test
parametrization.

.gitignore

@@ -132,9 +132,8 @@ dmypy.json
 *.tar.gz
 deb_dist
 .DS_Store
+tests/test_docs/**/*-safe.pdf
 install/windows/Dangerzone.wxs
-**/*-safe.pdf
-test_docs/out/
 share/container.tar
 share/container.tar.gz
 share/image-id.txt

tests/__init__.py

@@ -0,0 +1,22 @@
+import sys
+from pathlib import Path
+
+import pytest
+
+sys.dangerzone_dev = True
+
+SAMPLE_DIRECTORY = "test_docs"
+BASIC_SAMPLE = "sample.pdf"
+test_docs_dir = Path(__file__).parent.joinpath(SAMPLE_DIRECTORY)
+test_docs = [
+    p
+    for p in test_docs_dir.rglob("*")
+    if p.is_file() and not p.name.endswith("-safe.pdf")
+]
+
+# Pytest parameter decorators
+for_each_doc = pytest.mark.parametrize("doc", test_docs)
+
+
+class TestBase:
+    sample_doc = str(test_docs_dir.joinpath(BASIC_SAMPLE))

tests/test_cli.py

@@ -1,14 +1,13 @@
 from __future__ import annotations
 
-import os.path
-import sys
-from pathlib import Path
-from unittest import TestCase
+import tempfile
 
+import pytest
 from click.testing import CliRunner, Result
 
 from dangerzone.cli import cli_main
 
+from . import TestBase, for_each_doc
 
 # TODO --output-filename with spaces
 # TODO explore any symlink edge cases
@@ -22,65 +21,50 @@ from dangerzone.cli import cli_main
 # FIXME "/" path separator is platform-dependent, use pathlib instead
 
 
-class CliTestCase(TestCase):
-    SAMPLE_DIRECTORY = "test_docs"
-    BASIC_SAMPLE = f"{SAMPLE_DIRECTORY}/sample.pdf"
-    SAFE_SUFFIX = "-safe.pdf"
-
-    def setUp(self):
-        sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
-        sys.dangerzone_dev = True
-        self.runner = CliRunner()
-        # TODO Use pathlib or similar for safer file handling here
-        samples_dir = Path(self.SAMPLE_DIRECTORY)
-        self.samples: list[Path | str] = [
-            p
-            for p in samples_dir.rglob("*")
-            if p.is_file() and not p.name.endswith(self.SAFE_SUFFIX)
-        ]
-        print(f"{self.BASIC_SAMPLE} --output-filename {self.SAMPLE_DIRECTORY}/out/my-output.pdf")
-        if len(self.samples) < 10:
-            raise RuntimeWarning(f"Only {len(self.samples)} samples found.")
-
-    def invoke_runner(self, *args, **kwargs) -> Result:
-        return self.runner.invoke(cli_main, *args, **kwargs)
+class TestCli(TestBase):
+    def run_cli(self, *args, **kwargs) -> Result:
+        return CliRunner().invoke(cli_main, *args, **kwargs)
 
 
-class CliBasicTestCase(CliTestCase):
+class TestCliBasic(TestCli):
     def test_no_args(self):
         """``$ dangerzone-cli``"""
-        result = self.invoke_runner()
-        self.assertNotEqual(result.exit_code, 0)
+        result = self.run_cli()
+        assert result.exit_code != 0
 
     def test_help(self):
         """``$ dangerzone-cli --help``"""
-        result = self.invoke_runner("--help")
-        self.assertEqual(result.exit_code, 0)
+        result = self.run_cli("--help")
+        assert result.exit_code == 0
 
-class CliConversionTestCase(CliTestCase):
+
+class TestCliConversion(TestCliBasic):
     def test_invalid_lang(self):
-        result = self.invoke_runner(f"{self.BASIC_SAMPLE} --ocr-lang piglatin")
-        self.assertNotEqual(result.exit_code, 0)
+        result = self.run_cli(f"{self.sample_doc} --ocr-lang piglatin")
+        assert result.exit_code != 0
 
-    def test_samples(self):
-        for sample in self.samples:
-            with self.subTest(f"Convert {sample}"):
-                result = self.invoke_runner(f'"{sample}"')
-                self.assertEqual(result.exit_code, 0)
+    @for_each_doc
+    def test_formats(self, doc):
+        result = self.run_cli(f'"{doc}"')
+        assert result.exit_code == 0
 
     def test_output_filename(self):
-        result = self.invoke_runner(f"{self.BASIC_SAMPLE} --output-filename {self.SAMPLE_DIRECTORY}/out/my-output.pdf")
-        self.assertEqual(result.exit_code, 0)
+        temp_dir = tempfile.mkdtemp(prefix="dangerzone-")
+        result = self.run_cli(
+            f"{self.sample_doc} --output-filename {temp_dir}/safe.pdf"
+        )
+        assert result.exit_code == 0
 
     def test_output_filename_new_dir(self):
-        result = self.invoke_runner(f"{self.BASIC_SAMPLE} --output-filename fake-directory/my-output.pdf")
-        self.assertEqual(result.exit_code, 0)
+        result = self.run_cli(
+            f"{self.sample_doc} --output-filename fake-directory/my-output.pdf"
+        )
+        assert result.exit_code != 0
 
     def test_sample_not_found(self):
-        result = self.invoke_runner("fake-directory/fake-file.pdf")
-        self.assertEquals(result.exit_code, 1)
+        result = self.run_cli("fake-directory/fake-file.pdf")
+        assert result.exit_code != 0
 
     def test_lang_eng(self):
-        # Rewrite this case if samples in other languages or scripts are added.
-        result = self.invoke_runner(f'"{self.BASIC_SAMPLE}" --ocr-lang eng')
-        self.assertEqual(result.exit_code, 0)
+        result = self.run_cli(f'"{self.sample_doc}" --ocr-lang eng')
+        assert result.exit_code == 0

tests/test_global_common.py

@@ -1,58 +1,40 @@
-import io
 import os
 import platform
-import subprocess
-import sys
-import unittest
-from io import StringIO
 from pathlib import Path
-from unittest import TestCase, mock
 
+import pytest
 from strip_ansi import strip_ansi  # type: ignore
 
-import dangerzone.global_common as global_common
-
-
-class TestGlobalCommon(TestCase):
+import dangerzone.global_common
 
 VERSION_FILE_NAME = "version.txt"
 
-    def setUp(self):
-        self.global_common = global_common.GlobalCommon()
-        sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
-        sys.dangerzone_dev = True
 
-    def test_get_resource_path(self):
+@pytest.fixture
+def global_common():
+    return dangerzone.global_common.GlobalCommon()
+
+
+class TestGlobalCommon:
+    def test_get_resource_path(self, global_common):
         share_dir = Path("share").resolve()
-        resource_path = Path(
-            self.global_common.get_resource_path(self.VERSION_FILE_NAME)
-        ).parent
-        self.assertTrue(
-            share_dir.samefile(resource_path),
-            msg=f"{share_dir} is not the same file as {resource_path}",
-        )
+        resource_path = Path(global_common.get_resource_path(VERSION_FILE_NAME)).parent
+        assert share_dir.samefile(
+            resource_path
+        ), f"{share_dir} is not the same file as {resource_path}"
 
-    @unittest.skipUnless(platform.system() == "Windows", "STARTUPINFO is for Windows")
-    def test_get_subprocess_startupinfo(self):
-        startupinfo = self.global_common.get_subprocess_startupinfo()
+    @pytest.mark.skipif(platform.system() != "Windows", reason="Windows-specific")
+    def test_get_subprocess_startupinfo(self, global_common):
+        startupinfo = global_common.get_subprocess_startupinfo()
         self.assertIsInstance(startupinfo, subprocess.STARTUPINFO)
 
-    @unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
-    def test_display_banner(self, mock_stdout: StringIO):
-        self.global_common.display_banner()  # call the test subject
-        banner = mock_stdout.getvalue()
-        plain_lines = [strip_ansi(line) for line in banner.splitlines()]
-        with self.subTest("banner top border"):
-            self.assertEqual("╭──────────────────────────╮", plain_lines[0])
-        with self.subTest("banner bottom border"):
-            self.assertEqual("╰──────────────────────────╯", plain_lines[14])
-        with self.subTest("banner consistent dimensions"):
-            width = len(plain_lines[0])
-            for line in plain_lines:
-                self.assertEqual(len(line), width)
+    def test_display_banner(self, global_common, capfd):
+        global_common.display_banner()  # call the test subject
+        (out, err) = capfd.readouterr()
+        plain_lines = [strip_ansi(line) for line in out.splitlines()]
+        assert "╭──────────────────────────╮" in plain_lines, "missing top border"
+        assert "╰──────────────────────────╯" in plain_lines, "missing bottom border"
 
-    @unittest.mock.patch("sys.stdout", new_callable=io.StringIO)
-    def test_display_banner_dims(self, mock_stdout: StringIO):
-        self.global_common.display_banner()  # call the test subject
-        banner = mock_stdout.getvalue()
-        banner_lines = banner.splitlines()
+        banner_width = len(plain_lines[0])
+        for line in plain_lines:
+            assert len(line) == banner_width, "banner has inconsistent width"