Added unit tests

couling · couling · commit f14c335689e0 · 2024-11-05T09:12:29.000Z
diff --git a/source/mkdocstrings_python_generator/__init__.py b/source/mkdocstrings_python_generator/__init__.py
@@ -1,3 +0,0 @@
-"""
-Blah blah blah
-"""
diff --git a/source/mkdocstrings_python_generator/files_generator.py b/source/mkdocstrings_python_generator/files_generator.py
@@ -114,9 +114,6 @@ def discover_python_files(base_dir: Path, source_dir: Path, ignore: List[str]) -
             yield from discover_python_files(base_dir, file, ignore)
 
         elif file.is_file() and file.suffix == ".py":
-            if file.name == "__main__.py":
-                log.debug(f"Skipping {str(file)} all __main__ entrypoints are ignored")
-                continue
             if not file.read_text().strip():
                 log.debug(f"Skipping empty file {str(file)} ")
                 continue
diff --git a/source/tests/conftest.py b/source/tests/conftest.py
@@ -0,0 +1,16 @@
+import pytest
+from pathlib import Path
+
+from mkdocstrings_python_generator.files_generator import FilesGenerator
+
+
+@pytest.fixture(scope='session')
+def example_files() -> Path:
+    return Path(__file__).parent / "example"
+
+
+@pytest.fixture()
+def files_generator(tmp_path: Path) -> FilesGenerator:
+    generator = FilesGenerator(str(tmp_path / "destination"), use_directory_urls=True)
+    yield generator
+    generator.cleanup()
diff --git a/source/tests/example/__init__.py b/source/tests/example/__init__.py
@@ -0,0 +1 @@
+"""This is not empty"""
diff --git a/source/tests/example/bar.py b/source/tests/example/bar.py
@@ -0,0 +1 @@
+"""This is not empty"""
diff --git a/source/tests/example/foo.py b/source/tests/example/foo.py
@@ -0,0 +1 @@
+"""This is not empty"""
diff --git a/source/tests/example/sub_package/__init__.py b/source/tests/example/sub_package/__init__.py
diff --git a/source/tests/example/sub_package/__main__.py b/source/tests/example/sub_package/__main__.py
@@ -0,0 +1 @@
+"""This is not empty"""
diff --git a/source/tests/example/sub_package/baz.py b/source/tests/example/sub_package/baz.py
@@ -0,0 +1 @@
+"""This is not empty"""
diff --git a/source/tests/example/sub_package/baz_bob.py b/source/tests/example/sub_package/baz_bob.py
@@ -0,0 +1 @@
+"""This is not empty"""
diff --git a/source/tests/test_files_generator.py b/source/tests/test_files_generator.py
@@ -0,0 +1,59 @@
+from pathlib import Path
+from mkdocstrings_python_generator import files_generator
+
+
+def test_discover_python_files_has_correct_base(example_files: Path):
+    assert all(v.base_path == example_files for v in files_generator.discover_python_files(example_files, example_files, []))
+
+
+def test_discover_correct_module_path(example_files: Path):
+    results = {v.module_path for v in  files_generator.discover_python_files(example_files, example_files, [])}
+    # Note that sub_package / __init__.py should NOT be present due to being empty.
+    assert results == {
+        example_files / "foo.py",
+        example_files / "bar.py",
+        example_files / "__init__.py",
+        example_files / "sub_package" / "__main__.py",
+        example_files / "sub_package" / "baz.py",
+        example_files / "sub_package" / "baz_bob.py",
+    }
+
+
+def test_discover_ignores_files(example_files: Path):
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, [])}
+    assert "sub_package.__main__" in results
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, ["__main__.py"])}
+    assert "sub_package.__main__" not in results
+
+
+def test_discover_ignores_wildcard_files(example_files: Path):
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, [])}
+    assert "sub_package.baz" in results
+    assert "sub_package.baz_bob" in results
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, ["baz*"])}
+    assert "sub_package.baz" not in results
+    assert "sub_package.baz_bob" not in results
+
+
+def test_discover_ignores_packages(example_files: Path):
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, [])}
+    assert "sub_package.baz" in results
+    assert "sub_package.baz_bob" in results
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, ["sub_package"])}
+    assert "sub_package.baz" not in results
+    assert "sub_package.baz_bob" not in results
+
+
+def test_non_wildcard_ignore_is_discriminative(example_files: Path):
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, [])}
+    assert "sub_package.baz" in results
+    assert "sub_package.baz_bob" in results
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, ["baz"])}
+    assert "sub_package.baz" in results
+    assert "sub_package.baz_bob" in results
+    results = {v.module_id for v in files_generator.discover_python_files(example_files, example_files, ["baz.py"])}
+    assert "sub_package.baz" not in results
+    assert "sub_package.baz_bob" in results
+
+
+def 
