htmlcmp 1.0.1__tar.gz → 1.0.3__tar.gz

htmlcmp-1.0.3/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: htmlcmp
+Version: 1.0.3
+Summary: Compare HTML files by rendered output
+Home-page: https://github.com/opendocument-app/compare-html
+Author: Andreas Stefl
+Author-email: stefl.andreas@gmail.com
+Maintainer-email: Andreas Stefl <stefl.andreas@gmail.com>
+Project-URL: homepage, https://opendocument.app/
+Project-URL: source, https://github.com/opendocument-app/compare-html
+Project-URL: download, https://pypi.org/project/pyodr/#files
+Project-URL: tracker, https://github.com/opendocument-app/compare-html/issues
+Project-URL: release notes, https://github.com/opendocument-app/compare-html/releases
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: requires-python
+
+# htmlcmp
+
+Tool to compare (generated) HTML files visually and automatically using Selenium.
+
+Provides various entry points to run:
+- `compare-html` is a CLI tool to compare two directory structures containing HTML files
+- `compare-html-server` starts a webserver and allows to inspect differences manually
+- `html-render-diff` renders two HTML files and produces images
+- `html-tidy` allows to run HTML tidy on a directory
+
+Used for regression testing in https://github.com/opendocument-app/OpenDocument.core.
+
+## Install via PyPI
+
+```bash
+pip install htmlcmp
+```
+
+## Download and run the docker image
+
+```bash
+docker pull ghcr.io/opendocument-app/odr_core_test
+```
+
+```bash
+docker run -ti \
+  -v $(pwd):/repo \
+  -p 8000:8000 \
+  ghcr.io/opendocument-app/odr_core_test \
+  compare-html-server /repo/REFERENCE /repo/MONITORED --compare --driver firefox --port 8000
+```
+
+## Manually build the docker image
+
+```bash
+docker build --tag odr_core_test test/docker
+```

htmlcmp-1.0.3/README.md

@@ -0,0 +1,37 @@
+# htmlcmp
+
+Tool to compare (generated) HTML files visually and automatically using Selenium.
+
+Provides various entry points to run:
+- `compare-html` is a CLI tool to compare two directory structures containing HTML files
+- `compare-html-server` starts a webserver and allows to inspect differences manually
+- `html-render-diff` renders two HTML files and produces images
+- `html-tidy` allows to run HTML tidy on a directory
+
+Used for regression testing in https://github.com/opendocument-app/OpenDocument.core.
+
+## Install via PyPI
+
+```bash
+pip install htmlcmp
+```
+
+## Download and run the docker image
+
+```bash
+docker pull ghcr.io/opendocument-app/odr_core_test
+```
+
+```bash
+docker run -ti \
+  -v $(pwd):/repo \
+  -p 8000:8000 \
+  ghcr.io/opendocument-app/odr_core_test \
+  compare-html-server /repo/REFERENCE /repo/MONITORED --compare --driver firefox --port 8000
+```
+
+## Manually build the docker image
+
+```bash
+docker build --tag odr_core_test test/docker
+```

{htmlcmp-1.0.1 → htmlcmp-1.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "htmlcmp"
-version = "1.0.1"
+version = "1.0.3"
 description = "Compare HTML files by rendered output"
 classifiers = []
 authors = [

{htmlcmp-1.0.1 → htmlcmp-1.0.3}/setup.py

@@ -7,7 +7,7 @@ long_description = (this_directory / "README.md").read_text()
 
 setup(
     name="htmlcmp",
-    version="1.0.1",
+    version="1.0.3",
     author="Andreas Stefl",
     author_email="stefl.andreas@gmail.com",
     description="Compare HTML files by rendered output",

{htmlcmp-1.0.1 → htmlcmp-1.0.3}/src/htmlcmp/compare_output.py

@@ -8,8 +8,9 @@ import json
 import threading
 import filecmp
 from concurrent.futures import ThreadPoolExecutor
-from html_render_diff import get_browser, html_render_diff
-from common import bcolors
+
+from htmlcmp.html_render_diff import get_browser, html_render_diff
+from htmlcmp.common import bcolors
 
 
 class Config:

{htmlcmp-1.0.1 → htmlcmp-1.0.3}/src/htmlcmp/html_render_diff.py

@@ -1,24 +1,23 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-import os
 import sys
 import argparse
 import io
 import time
+from pathlib import Path
 
 from PIL import Image, ImageChops
 from selenium import webdriver
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions
 from selenium.webdriver.support.ui import WebDriverWait
-import pathlib
 
 
-def to_url(something):
-    if os.path.isfile(something):
-        return pathlib.Path(os.path.abspath(something)).as_uri()
-    return something
+def to_url(path):
+    if path.is_file():
+        return path.as_uri()
+    return path
 
 
 def screenshot(browser, url):
@@ -77,8 +76,8 @@ def html_render_diff(a, b, browser):
 
 def main():
     parser = argparse.ArgumentParser()
-    parser.add_argument("a")
-    parser.add_argument("b")
+    parser.add_argument("a", type=Path)
+    parser.add_argument("b", type=Path)
     parser.add_argument(
         "--driver", choices=["chrome", "firefox", "phantomjs"], default="firefox"
     )

htmlcmp-1.0.3/src/htmlcmp/tidy_output.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import sys
+import argparse
+import json
+import subprocess
+import shlex
+from pathlib import Path
+
+from htmlcmp.common import bcolors
+
+
+def tidy_json(path):
+    try:
+        with open(path, "r") as f:
+            json.load(f)
+        return 0
+    except ValueError:
+        return 1
+
+
+def tidy_html(path, html_tidy_config=None):
+    if html_tidy_config:
+        cmd = shlex.split(f'tidy -config "{html_tidy_config.resolve()}" -q "{path}"')
+    else:
+        cmd = shlex.split(f'tidy -q "{path}"')
+    result = subprocess.run(
+        cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True
+    )
+    if result.returncode == 1:
+        print(result.stdout)
+        return 1
+    if result.returncode > 1:
+        print(result.stdout)
+        return 2
+    return 0
+
+
+def tidy_file(path, html_tidy_config=None):
+    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):
+    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):
+    prefix_file = prefix + "├── "
+    if level == 0:
+        print(f"tidy dir {path}")
+
+    result = {
+        "warning": [],
+        "error": [],
+    }
+
+    items = [path / name for name in path.iterdir()]
+    files = sorted([path for path in items if path.is_file() and tidyable_file(path)])
+    dirs = sorted([path for path in items if path.is_dir()])
+
+    for filename in [path.name for path in files]:
+        filepath = path / filename
+        tidy = tidy_file(filepath, html_tidy_config=html_tidy_config)
+        if tidy == 0:
+            print(f"{prefix_file}{bcolors.OKGREEN}{filename} ✓{bcolors.ENDC}")
+        elif tidy == 1:
+            print(f"{prefix_file}{bcolors.WARNING}{filename} ✓{bcolors.ENDC}")
+            result["warning"].append(filepath)
+        elif tidy > 1:
+            print(f"{prefix_file}{bcolors.FAIL}{filename} ✘{bcolors.ENDC}")
+            result["error"].append(filepath)
+
+    for dirname in [path.name for path in dirs]:
+        print(prefix + "├── " + dirname)
+        subresult = tidy_dir(
+            path / dirname,
+            level=level + 1,
+            prefix=prefix + "│   ",
+            html_tidy_config=html_tidy_config,
+        )
+        result["warning"].extend(subresult["warning"])
+        result["error"].extend(subresult["error"])
+
+    return result
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("path", type=Path, help="Path to directory to tidy")
+    parser.add_argument(
+        "--html-tidy-config", type=Path, help="Path to tidy config file"
+    )
+    args = parser.parse_args()
+
+    result = tidy_dir(args.path, html_tidy_config=args.html_tidy_config)
+    if result["error"]:
+        return 1
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

htmlcmp-1.0.3/src/htmlcmp.egg-info/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: htmlcmp
+Version: 1.0.3
+Summary: Compare HTML files by rendered output
+Home-page: https://github.com/opendocument-app/compare-html
+Author: Andreas Stefl
+Author-email: stefl.andreas@gmail.com
+Maintainer-email: Andreas Stefl <stefl.andreas@gmail.com>
+Project-URL: homepage, https://opendocument.app/
+Project-URL: source, https://github.com/opendocument-app/compare-html
+Project-URL: download, https://pypi.org/project/pyodr/#files
+Project-URL: tracker, https://github.com/opendocument-app/compare-html/issues
+Project-URL: release notes, https://github.com/opendocument-app/compare-html/releases
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: requires-python
+
+# htmlcmp
+
+Tool to compare (generated) HTML files visually and automatically using Selenium.
+
+Provides various entry points to run:
+- `compare-html` is a CLI tool to compare two directory structures containing HTML files
+- `compare-html-server` starts a webserver and allows to inspect differences manually
+- `html-render-diff` renders two HTML files and produces images
+- `html-tidy` allows to run HTML tidy on a directory
+
+Used for regression testing in https://github.com/opendocument-app/OpenDocument.core.
+
+## Install via PyPI
+
+```bash
+pip install htmlcmp
+```
+
+## Download and run the docker image
+
+```bash
+docker pull ghcr.io/opendocument-app/odr_core_test
+```
+
+```bash
+docker run -ti \
+  -v $(pwd):/repo \
+  -p 8000:8000 \
+  ghcr.io/opendocument-app/odr_core_test \
+  compare-html-server /repo/REFERENCE /repo/MONITORED --compare --driver firefox --port 8000
+```
+
+## Manually build the docker image
+
+```bash
+docker build --tag odr_core_test test/docker
+```

htmlcmp-1.0.1/PKG-INFO

@@ -1,28 +0,0 @@
-Metadata-Version: 2.4
-Name: htmlcmp
-Version: 1.0.1
-Summary: Compare HTML files by rendered output
-Home-page: https://github.com/opendocument-app/compare-html
-Author: Andreas Stefl
-Author-email: stefl.andreas@gmail.com
-Maintainer-email: Andreas Stefl <stefl.andreas@gmail.com>
-Project-URL: homepage, https://opendocument.app/
-Project-URL: source, https://github.com/opendocument-app/compare-html
-Project-URL: download, https://pypi.org/project/pyodr/#files
-Project-URL: tracker, https://github.com/opendocument-app/compare-html/issues
-Project-URL: release notes, https://github.com/opendocument-app/compare-html/releases
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-Dynamic: author-email
-Dynamic: home-page
-Dynamic: requires-python
-
-# comare-html
-
-originally moved out of https://github.com/opendocument-app/OpenDocument.core
-
-## Manually build the docker image
-
-```bash
-docker build --tag odr_core_test test/docker
-```

htmlcmp-1.0.1/README.md

@@ -1,9 +0,0 @@
-# comare-html
-
-originally moved out of https://github.com/opendocument-app/OpenDocument.core
-
-## Manually build the docker image
-
-```bash
-docker build --tag odr_core_test test/docker
-```

htmlcmp-1.0.1/src/htmlcmp/tidy_output.py

@@ -1,102 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-import os
-import sys
-import argparse
-import json
-import subprocess
-import shlex
-from common import bcolors
-
-
-def tidy_json(path):
-    try:
-        with open(path, "r") as f:
-            json.load(f)
-        return 0
-    except ValueError:
-        return 1
-
-
-def tidy_html(path):
-    config_path = os.path.join(
-        os.path.dirname(os.path.realpath(__file__)), ".html-tidy"
-    )
-    cmd = shlex.split(f'tidy -config "{config_path}" -q "{path}"')
-    result = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-    if result.returncode == 1:
-        return 1
-    if result.returncode > 1:
-        return 2
-    return 0
-
-
-def tidy_file(path):
-    if path.endswith(".json"):
-        return tidy_json(path)
-    elif path.endswith(".html"):
-        return tidy_html(path)
-
-
-def tidyable_file(path):
-    if path.endswith(".json"):
-        return True
-    if path.endswith(".html"):
-        return True
-    return False
-
-
-def tidy_dir(path, level=0, prefix=""):
-    prefix_file = prefix + "├── "
-    if level == 0:
-        print(f"tidy dir {path}")
-
-    result = {
-        "warning": [],
-        "error": [],
-    }
-
-    items = [os.path.join(path, name) for name in os.listdir(path)]
-    files = sorted(
-        [path for path in items if os.path.isfile(path) and tidyable_file(path)]
-    )
-    dirs = sorted([path for path in items if os.path.isdir(path)])
-
-    for filename in [os.path.basename(path) for path in files]:
-        filepath = os.path.join(path, filename)
-        tidy = tidy_file(filepath)
-        if tidy == 0:
-            print(f"{prefix_file}{bcolors.OKGREEN}{filename} ✓{bcolors.ENDC}")
-        elif tidy == 1:
-            print(f"{prefix_file}{bcolors.WARNING}{filename} ✓{bcolors.ENDC}")
-            result["warning"].append(filepath)
-        elif tidy > 1:
-            print(f"{prefix_file}{bcolors.FAIL}{filename} ✘{bcolors.ENDC}")
-            result["error"].append(filepath)
-
-    for dirname in [os.path.basename(path) for path in dirs]:
-        print(prefix + "├── " + dirname)
-        subresult = tidy_dir(
-            os.path.join(path, dirname), level=level + 1, prefix=prefix + "│   "
-        )
-        result["warning"].extend(subresult["warning"])
-        result["error"].extend(subresult["error"])
-
-    return result
-
-
-def main():
-    parser = argparse.ArgumentParser()
-    parser.add_argument("a")
-    args = parser.parse_args()
-
-    result = tidy_dir(args.a)
-    if result["error"]:
-        return 1
-
-    return 0
-
-
-if __name__ == "__main__":
-    sys.exit(main())

htmlcmp-1.0.1/src/htmlcmp.egg-info/PKG-INFO

@@ -1,28 +0,0 @@
-Metadata-Version: 2.4
-Name: htmlcmp
-Version: 1.0.1
-Summary: Compare HTML files by rendered output
-Home-page: https://github.com/opendocument-app/compare-html
-Author: Andreas Stefl
-Author-email: stefl.andreas@gmail.com
-Maintainer-email: Andreas Stefl <stefl.andreas@gmail.com>
-Project-URL: homepage, https://opendocument.app/
-Project-URL: source, https://github.com/opendocument-app/compare-html
-Project-URL: download, https://pypi.org/project/pyodr/#files
-Project-URL: tracker, https://github.com/opendocument-app/compare-html/issues
-Project-URL: release notes, https://github.com/opendocument-app/compare-html/releases
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-Dynamic: author-email
-Dynamic: home-page
-Dynamic: requires-python
-
-# comare-html
-
-originally moved out of https://github.com/opendocument-app/OpenDocument.core
-
-## Manually build the docker image
-
-```bash
-docker build --tag odr_core_test test/docker
-```