🎃Add some tests for modules

Author: sorasful

main.py

@@ -2,7 +2,7 @@
 
 from loguru import logger
 
-from unella.modules.audit_generator import AuditGenerator
+from unella.audit_generator import AuditGenerator
 
 PROJECT_TO_AUDIT = "/home/tevak/dev/jwt_tool"
 

pyproject.toml

@@ -61,4 +61,15 @@ ignore = [
   "S602", # subprocess.run with shell=True
 ]
 line-length = 120
-src = ["unella", ]
+src = ["unella", ]
+
+
+[tool.coverage.run]
+omit = ["*/tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+  'pragma: no cover',
+  'if TYPE_CHECKING:',
+  'raise NotImplementedError.*',
+]

tests/conftest.py

@@ -0,0 +1,4 @@
+import pathlib
+
+current_dir = pathlib.Path(__file__).parent
+ROOT_DIR = current_dir.parent

tests/modules/__init__.py

@@ -0,0 +1,18 @@
+from tests.conftest import ROOT_DIR
+from unella.modules.mypy.main import MypyReport
+
+
+def test_mypy_report():
+    report = MypyReport(ROOT_DIR)
+    report.perform_analysis()
+    results = report.get_results()
+
+    assert len(results["most_messages"]) >= 1
+    assert len(results["most_messages_categories"]) >= 1
+    assert len(results["files_most_messages"]) >= 1
+
+    # check the format of the first message for each
+    for result in [results["most_messages"], results["most_messages_categories"], results["files_most_messages"]]:
+        msg, occurence = result[0]
+        assert isinstance(msg, str)
+        assert isinstance(occurence, int)

tests/modules/test_mypy.py

@@ -0,0 +1,13 @@
+from tests.conftest import ROOT_DIR
+from unella.modules.ruff.main import RuffReport
+
+
+def test_ruff_report():
+    report = RuffReport(ROOT_DIR)
+    report.perform_analysis()
+    first_entry, *entries = report.get_results()
+
+    assert isinstance(first_entry["code"], str)
+    assert isinstance(first_entry["count"], int)
+    assert isinstance(first_entry["fixable"], bool)
+    assert isinstance(first_entry["message"], str)

tests/modules/test_ruff.py

@@ -0,0 +1,20 @@
+from tests.conftest import ROOT_DIR
+from unella.modules.structure.main import StructureReport
+
+
+def test_structure_report():
+    report = StructureReport(ROOT_DIR)
+    report.perform_analysis()
+    results = report.get_results()
+
+    assert results["has_tests"] is True
+    assert results["uses_pytest"] is True
+    assert results["is_git_repository"] is True
+    assert results["has_precommit_file"] is False
+    assert results["structure"] is not None
+    dependencies = results["dependencies"]
+    assert dependencies["requirements.txt"] is True
+    assert dependencies["pipenv"] is False
+    assert dependencies["poetry"] is False
+    assert dependencies["pip-tools"] is True
+    assert dependencies["setuptools"] is False

tests/modules/test_structure.py

@@ -0,0 +1,13 @@
+from tests.conftest import ROOT_DIR
+from unella.modules.vulture.main import VultureReport
+
+
+def test_vulture_report():
+    report = VultureReport(ROOT_DIR)
+    report.perform_analysis()
+    first_entry, *entries = report.get_results()
+
+    assert isinstance(first_entry["confidence"], str)
+    assert isinstance(first_entry["file_path"], str)
+    assert isinstance(first_entry["line"], str)
+    assert isinstance(first_entry["msg"], str)

tests/modules/test_vulture.py

@@ -2,12 +2,19 @@
 import subprocess
 from collections import Counter
 from dataclasses import dataclass
+from typing import TypedDict
 
 from unella.modules.generic import Report
 
 MYPY_LINE_REGEX = r"(?P<file_path>.*):\d+: (?P<msg_type>error|warning):(?P<msg>.*)\[(?P<msg_category>[\w_-]+)\]"
 
 
+class ResultDict(TypedDict):
+    files_most_messages: list | None
+    most_messages: list | None
+    most_messages_categories: list | None
+
+
 @dataclass
 class MypyReport(Report):
     _cmd_output: str | None = None
@@ -46,7 +53,7 @@ def perform_analysis(self) -> None:
 
         self._cmd_output = output
 
-    def get_results(self) -> dict:
+    def get_results(self) -> ResultDict:
         return {
             "files_most_messages": self._file_most_messages,
             "most_messages": self._most_messages,