add tests; more types

Author: andiwand

.github/workflows/docker.yml .github/workflows/docker.yaml.github/workflows/docker.yml renamed to .github/workflows/docker.yaml

@@ -16,5 +16,5 @@ jobs:
       with:
         python-version: "3.x"
     - run: pip install black
-    - run: black src
+    - run: black src tests
     - run: git diff --exit-code

.github/workflows/format.yaml

@@ -0,0 +1,20 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+    - main
+
+jobs:
+  pre-commit:
+    name: black
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - run: pip install .
+    - run: pip install pytest
+    - run: pytest

.github/workflows/test.yaml

@@ -32,6 +32,9 @@ download = "https://pypi.org/project/pyodr/#files"
 tracker = "https://github.com/opendocument-app/compare-html/issues"
 "release notes" = "https://github.com/opendocument-app/compare-html/releases"
 
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
 [build-system]
 requires = [
     "setuptools",

pyproject.toml

@@ -14,11 +14,13 @@
 from selenium.webdriver.support.ui import WebDriverWait
 
 
-def to_url(path: Path):
-    if not isinstance(path, Path):
-        raise TypeError(f"Expected Path, got {type(path)}")
+def to_url(path: str | Path):
+    if not isinstance(path, (str, Path)):
+        raise TypeError(f"Expected str or Path, got {type(path)}")
 
-    if path.is_file():
+    if isinstance(path, Path):
+        if not path.is_file():
+            raise FileNotFoundError(f"File not found: {path}")
         return path.resolve().as_uri()
     return path
 
@@ -55,9 +57,7 @@ def screenshot(browser, url: str):
     return Image.open(io.BytesIO(png))
 
 
-def get_browser(
-    driver: str = "firefox", max_width: int = 1000, max_height: int = 10000
-):
+def get_browser(driver: str, max_width: int = 1000, max_height: int = 10000):
     if not isinstance(driver, str):
         raise TypeError(f"Expected str, got {type(driver)}")
     if not isinstance(max_width, int) or not isinstance(max_height, int):
@@ -71,19 +71,19 @@ def get_browser(
         options = webdriver.FirefoxOptions()
         options.add_argument("--headless")
         browser = webdriver.Firefox(options=options)
-    else:  # chrome or unknown
+    elif driver == "chrome":
         options = webdriver.ChromeOptions()
         options.add_argument("--headless=new")
         browser = webdriver.Chrome(options=options)
+    else:
+        raise ValueError(f"Unsupported driver: {driver}")
     browser.set_window_size(max_width, max_height)
     return browser
 
 
-def html_render_diff(a: Path, b: Path, browser):
-    if not isinstance(a, Path) or not isinstance(b, Path):
-        raise TypeError("Both arguments must be of type Path")
-    if not a.is_file() or not b.is_file():
-        raise FileNotFoundError("Both arguments must be files")
+def html_render_diff(a: str | Path, b: str | Path, browser):
+    if browser is None:
+        raise TypeError("Browser instance cannot be None")
 
     image_a = screenshot(browser, to_url(a))
     image_b = screenshot(browser, to_url(b))

src/htmlcmp/html_render_diff.py

@@ -10,7 +10,12 @@
 from htmlcmp.common import bcolors
 
 
-def tidy_json(path):
+def tidy_json(path: Path) -> int:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+
     try:
         with open(path, "r") as f:
             json.load(f)
@@ -19,7 +24,16 @@ def tidy_json(path):
         return 1
 
 
-def tidy_html(path, html_tidy_config=None):
+def tidy_html(path: Path, html_tidy_config: Path = None) -> int:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+    if html_tidy_config is not None and not isinstance(html_tidy_config, Path):
+        raise TypeError("html_tidy_config must be a Path object or None")
+    if html_tidy_config is not None and not html_tidy_config.is_file():
+        raise FileNotFoundError(f"{html_tidy_config} is not a file")
+
     cmd = ["tidy"]
     if html_tidy_config:
         cmd.extend(["-config", str(html_tidy_config.resolve())])
@@ -34,22 +48,47 @@ def tidy_html(path, html_tidy_config=None):
     return 0
 
 
-def tidy_file(path, html_tidy_config=None):
+def tidy_file(path: Path, html_tidy_config: Path = None) -> int:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+
     if path.suffix == ".json":
         return tidy_json(path)
     elif path.suffix == ".html":
         return tidy_html(path, html_tidy_config=html_tidy_config)
 
 
-def tidyable_file(path):
+def tidyable_file(path: Path) -> bool:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_file():
+        raise FileNotFoundError(f"{path} is not a file")
+
     if path.suffix == ".json":
         return True
     if path.suffix == ".html":
         return True
     return False
 
 
-def tidy_dir(path, level=0, prefix="", html_tidy_config=None):
+def tidy_dir(
+    path: Path, level: int = 0, prefix: str = "", html_tidy_config: Path = None
+) -> dict[str, list[Path]]:
+    if not isinstance(path, Path):
+        raise TypeError("path must be a Path object")
+    if not path.is_dir():
+        raise NotADirectoryError(f"{path} is not a directory")
+    if not isinstance(level, int) or level < 0:
+        raise ValueError("level must be a non-negative integer")
+    if not isinstance(prefix, str):
+        raise TypeError("prefix must be a string")
+    if html_tidy_config is not None and not isinstance(html_tidy_config, Path):
+        raise TypeError("html_tidy_config must be a Path object or None")
+    if html_tidy_config is not None and not html_tidy_config.is_file():
+        raise FileNotFoundError(f"{html_tidy_config} is not a file")
+
     prefix_file = prefix + "├── "
     if level == 0:
         print(f"tidy dir {path}")

src/htmlcmp/tidy_output.py

@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html>
+<body>
+test1
+</body>
+</html>

tests/test1.html

@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html>
+<body>
+test2
+</body>
+</html>

tests/test2.html

@@ -0,0 +1,51 @@
+import pytest
+from pathlib import Path
+
+from htmlcmp.html_render_diff import to_url, get_browser, html_render_diff
+
+
+def test_to_url():
+    with pytest.raises(TypeError):
+        to_url(None)
+    with pytest.raises(TypeError):
+        to_url(1)
+    with pytest.raises(FileNotFoundError):
+        to_url(Path(__file__).parent)
+    assert to_url("file:///path/to/file") == "file:///path/to/file"
+    assert to_url("https://example.com") == "https://example.com"
+    assert to_url(Path(__file__))
+
+
+def test_get_browser():
+    with pytest.raises(ValueError):
+        get_browser("unsupported_driver")
+
+    # Test with Chrome
+    browser = get_browser("chrome")
+    assert browser.name == "chrome"
+    browser.quit()
+
+    # Test with Firefox
+    browser = get_browser("firefox")
+    assert browser.name == "firefox"
+    browser.quit()
+
+    # Test with PhantomJS
+    browser = get_browser("phantomjs")
+    assert browser.name == "phantomjs"
+    browser.quit()
+
+
+def test_html_render_diff():
+    test1 = Path(__file__).parent / "test1.html"
+    test2 = Path(__file__).parent / "test2.html"
+
+    with pytest.raises(TypeError):
+        html_render_diff(None, None, None)
+    with pytest.raises(TypeError):
+        html_render_diff(str(test1), str(test2), None)
+
+    diff, _ = html_render_diff(test1, test1, get_browser("firefox"))
+    assert diff.getbbox() is None
+    diff, _ = html_render_diff(test1, test2, get_browser("firefox"))
+    assert diff.getbbox() is not None