Restructuring and adding tests (#8)

oraNod · web-flow · commit cced906d0ebc · 2025-05-29T12:57:00.000+01:00
* add tests requirements

* initial test files

* update git ignore for test repos

* create a package structure with hatch

* update json to use full payload with example values

* update tests to use mocks

* update noxfile to lint python files in src and tests dirs

* add pytest plugins for mypy

* make isort compatible with black

* attempt to simplify things + url tests

* gitignore dst/tmp directory

* addressing review comments

* add some docs for running tests
diff --git a/.gitignore b/.gitignore
@@ -132,3 +132,6 @@ dmypy.json
 
 # VScode stuff
 .vscode/
+
+# Repository clone directory
+dst/tmp/output
diff --git a/README.md b/README.md
@@ -71,3 +71,27 @@ For example, to upgrade the `isort` package only:
 ``` bash
 nox -s "pip-compile-3.12(formatters)" -- --no-upgrade --upgrade-package=isort
 ```
+
+## Running tests
+
+This project contains several tests to verify functionality.
+To run the tests, do the following:
+
+1. Install test requirements.
+
+   ``` bash
+   python -m pip install -r requirements/tests.in -c requirements/tests.txt
+   ```
+
+1. From the repository root, run `pytest` in one of the following ways:
+
+   ``` bash
+   # Run all tests
+   pytest
+
+   # Run a specific test class
+   pytest tests/test_parser_functions.py::TestParseArguments
+
+   # Run a specific test function
+   pytest tests/test_parser_functions.py::TestParseArguments::test_with_url_arg
+   ```
diff --git a/noxfile.py b/noxfile.py
@@ -3,7 +3,9 @@
 
 import nox
 
-LINT_FILES = glob.glob("*.py")
+LINT_FILES = glob.glob("src/**/*.py", recursive=True) + glob.glob(
+    "tests/**/*.py", recursive=True
+)
 
 requirements_directory = Path("requirements")
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,58 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "forge-webhook-parser"
+dynamic = ["version"]
+description = 'Parse webhook payloads from popular git forges.'
+readme = "README.md"
+requires-python = ">=3.9"
+license = "GPL-3.0-or-later"
+authors = [
+  { name = "Don Naro", email = "dnaro@redhat.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+    "requests",
+]
+
+[project.urls]
+Documentation = "https://github.com/fedora-copr/forge-webhook-parser/blob/main/README.md"
+Issues = "https://github.com/fedora-copr/forge-webhook-parser/issues"
+Source = "https://github.com/fedora-copr/forge-webhook-parser"
+
+[project.scripts]
+forge-webhook-parser = "forge_webhook_parser.main:main"
+
+[tool.hatch.version]
+path = "src/forge_webhook_parser/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/forge_webhook_parser"]
+
+[tool.hatch.envs.test]
+dependencies = [
+    "pytest",
+    "pytest-cov",
+]
+
+[tool.hatch.envs.test.scripts]
+test = "pytest {args:tests}"
+test-cov = "pytest --cov=forge_webhook_parser {args:tests}"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.isort]
+profile = "black"
diff --git a/requirements/tests.in b/requirements/tests.in
@@ -0,0 +1 @@
+pytest
diff --git a/requirements/tests.txt b/requirements/tests.txt
@@ -0,0 +1,14 @@
+#
+# This file is autogenerated by pip-compile with Python 3.12
+# by the following command:
+#
+#    pip-compile --allow-unsafe --output-file=requirements/tests.txt --strip-extras requirements/tests.in
+#
+iniconfig==2.0.0
+    # via pytest
+packaging==24.1
+    # via pytest
+pluggy==1.5.0
+    # via pytest
+pytest==8.3.3
+    # via -r requirements/tests.in
diff --git a/requirements/typing.in b/requirements/typing.in
@@ -1,3 +1,4 @@
 mypy
 nox
 types-requests
+pytest-mypy-plugins
diff --git a/requirements/typing.txt b/requirements/typing.txt
@@ -4,29 +4,76 @@
 #
 #    pip-compile --allow-unsafe --output-file=requirements/typing.txt --strip-extras requirements/typing.in
 #
-argcomplete==3.5.0
+argcomplete==3.6.0
     # via nox
-colorlog==6.8.2
+attrs==25.3.0
+    # via
+    #   jsonschema
+    #   nox
+    #   referencing
+colorlog==6.9.0
     # via nox
-distlib==0.3.8
+decorator==5.2.1
+    # via pytest-mypy-plugins
+dependency-groups==1.3.0
+    # via nox
+distlib==0.3.9
     # via virtualenv
-filelock==3.16.1
+filelock==3.18.0
     # via virtualenv
-mypy==1.11.2
-    # via -r requirements/typing.in
+iniconfig==2.1.0
+    # via pytest
+jinja2==3.1.6
+    # via pytest-mypy-plugins
+jsonschema==4.23.0
+    # via pytest-mypy-plugins
+jsonschema-specifications==2024.10.1
+    # via jsonschema
+markupsafe==3.0.2
+    # via jinja2
+mypy==1.15.0
+    # via
+    #   -r requirements/typing.in
+    #   pytest-mypy-plugins
 mypy-extensions==1.0.0
     # via mypy
-nox==2024.4.15
+nox==2025.2.9
     # via -r requirements/typing.in
-packaging==24.1
-    # via nox
-platformdirs==4.3.6
+packaging==24.2
+    # via
+    #   dependency-groups
+    #   nox
+    #   pytest
+    #   pytest-mypy-plugins
+platformdirs==4.3.7
     # via virtualenv
-types-requests==2.32.0.20241016
+pluggy==1.5.0
+    # via pytest
+pytest==8.3.5
+    # via pytest-mypy-plugins
+pytest-mypy-plugins==3.2.0
+    # via -r requirements/typing.in
+pyyaml==6.0.2
+    # via pytest-mypy-plugins
+referencing==0.36.2
+    # via
+    #   jsonschema
+    #   jsonschema-specifications
+regex==2024.11.6
+    # via pytest-mypy-plugins
+rpds-py==0.23.1
+    # via
+    #   jsonschema
+    #   referencing
+tomlkit==0.13.2
+    # via pytest-mypy-plugins
+types-requests==2.32.0.20250306
     # via -r requirements/typing.in
 typing-extensions==4.12.2
-    # via mypy
-urllib3==2.2.3
+    # via
+    #   mypy
+    #   referencing
+urllib3==2.3.0
     # via types-requests
-virtualenv==20.26.5
+virtualenv==20.29.3
     # via nox
diff --git a/src/forge_webhook_parser/__init__.py b/src/forge_webhook_parser/__init__.py
@@ -0,0 +1,25 @@
+from .main import (
+    PayloadFields,
+    clean_clone_path,
+    clone_repo,
+    extract_project_name,
+    extract_repository_url,
+    load_json_data,
+    main,
+    parse_arguments,
+    parse_commits,
+)
+
+__all__ = [
+    "PayloadFields",
+    "clean_clone_path",
+    "clone_repo",
+    "extract_project_name",
+    "extract_repository_url",
+    "load_json_data",
+    "main",
+    "parse_arguments",
+    "parse_commits",
+]
+
+__version__ = "0.1.0"
diff --git a/src/forge_webhook_parser/main.py b/src/forge_webhook_parser/main.py
@@ -106,7 +106,7 @@ def main():
     data = load_json_data(args)
     repo_url = extract_repository_url(data)
     project_name = extract_project_name(repo_url)
-    clone_path = Path.cwd() / project_name
+    clone_path = Path.cwd() / "dst" / "tmp" / "output" / project_name
 
     clean_clone_path(clone_path)
     clone_repo(repo_url, clone_path)
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -0,0 +1,49 @@
+"""Pytest conftest.py"""
+
+import json
+from pathlib import Path
+from typing import Any, Dict
+from unittest.mock import MagicMock
+
+import pytest
+
+TESTS_DIR = Path(__file__).parent
+JSON_DIR = TESTS_DIR / "json"
+EMPTY_PAYLOAD: Dict[str, Any] = {}
+
+
+def load_json_payload(filename: str) -> Dict[str, Any]:
+    with open(JSON_DIR / filename, encoding="utf-8") as file:
+        return json.load(file)
+
+
+@pytest.fixture
+def github_payload() -> Dict[str, Any]:
+    """Return GitHub payload as a Python dict."""
+    file_path = JSON_DIR / "github-payload.json"
+    with open(file_path, encoding="utf-8") as file:
+        return json.load(file)
+
+
+@pytest.fixture
+def empty_payload() -> Dict[str, Any]:
+    """Return empty payload dict."""
+    return {}
+
+
+@pytest.fixture
+def mock_args_file():
+    """Mock command line args for file input."""
+    args = MagicMock()
+    args.file = "payload.json"
+    args.url = None
+    return args
+
+
+@pytest.fixture
+def mock_args_url():
+    """Mock command line args for URL input."""
+    args = MagicMock()
+    args.file = None
+    args.url = "http://example.com/payload.json"
+    return args
diff --git a/tests/json/github-payload.json b/tests/json/github-payload.json
diff --git a/tests/json/gitlab-payload.json b/tests/json/gitlab-payload.json
diff --git a/tests/test_parser_functions.py b/tests/test_parser_functions.py

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 mypy
 nox
 types-requests
 +pytest-mypy-plugins