add mkdocs tests

Author: mustafasoylu

tests/conftest.py

@@ -12,6 +12,7 @@
 from somesy.julia import Julia
 from somesy.fortran import Fortran
 from somesy.pom_xml.writer import POM
+from somesy.mkdocs import MkDocs
 
 TEST_DIR = Path(__file__).resolve().parent
 
@@ -28,6 +29,7 @@ class FileTypes(Enum):
     JULIA = "julia"
     FORTRAN = "fortran"
     POM_XML = "pom_xml"
+    MKDOCS = "mkdocs"
 
 
 @pytest.fixture(scope="session", autouse=True)
@@ -85,6 +87,8 @@ def _create_files(files: Set[Tuple[FileTypes, str]]):
                 read_file_name = read_file_path / Path("fpm.toml")
             elif file_type == FileTypes.POM_XML:
                 read_file_name = read_file_path / Path("pom.xml")
+            elif file_type == FileTypes.MKDOCS:
+                read_file_name = read_file_path / Path("mkdocs.yml")
 
             with open(read_file_name, "r") as f:
                 content = f.read()
@@ -139,6 +143,9 @@ def _load_files(files: Set[FileTypes]):
             elif file_type == FileTypes.POM_XML:
                 read_file_name = read_file_name / Path("pom.xml")
                 file_instances[file_type] = POM(read_file_name)
+            elif file_type == FileTypes.MKDOCS:
+                read_file_name = read_file_name / Path("mkdocs.yml")
+                file_instances[file_type] = MkDocs(read_file_name)
 
         return file_instances
 

tests/data/mkdocs.yml

@@ -0,0 +1,24 @@
+# basic configuration:
+site_name: "test-package"
+site_description: "This is a test package for demonstration purposes."
+site_url: "https://example.com/test-package"
+repo_url: "https://github.com/example/test-package"
+edit_uri: "blob/main/docs/"
+repo_name: "/example/test-package"
+site_author: "John Doe"
+
+nav:
+  - Home:
+    - Overview: index.md
+    - Changelog: changelog.md
+    - Credits: credits.md
+    - License: license.md
+  - Usage:
+    - Quickstart: quickstart.md
+    - User Manual: manual.md
+    - API: reference/
+  - Development:
+    - How To Contribute: contributing.md
+    - Developer Guide: dev_guide.md
+    - Code of Conduct: code_of_conduct.md
+    - Coverage Report: coverage.md

tests/input/test_mkdocs_validate.py

@@ -0,0 +1,23 @@
+import pytest
+from ruamel.yaml import YAML
+
+from somesy.mkdocs.writer import MkDocs
+
+
+def test_mkdocs_validate_accept(load_files, file_types):
+    """Validate by loading the data file using the fixture."""
+    load_files([file_types.MKDOCS])
+
+
+def test_mkdocs_validate_reject(tmp_path):
+    """Test validating a mkdocs file."""
+    mkdocs_path = tmp_path / "mkdocs.yml"
+
+    # create a mkdocs file with a invalid version
+    reject_mkdocs_object = {"site_description": "A project"}
+    yaml = YAML()
+    yaml.dump(reject_mkdocs_object, mkdocs_path)
+
+    # try to load the mkdocs file
+    with pytest.raises(ValueError):
+        MkDocs(mkdocs_path)

tests/output/test_mkdocs_writer.py

@@ -0,0 +1,41 @@
+import pytest
+
+from somesy.mkdocs import MkDocs
+from somesy.core.models import Person
+
+
+@pytest.fixture
+def mkdocs(load_files, file_types):
+    files = load_files([file_types.MKDOCS])
+    return files[file_types.MKDOCS]
+
+
+def test_content_match(mkdocs: MkDocs):
+    assert mkdocs.name == "test-package"
+    assert mkdocs.description == "This is a test package for demonstration purposes."
+    assert len(mkdocs.authors) == 0
+
+
+def test_sync(mkdocs: MkDocs, somesy_input: dict):
+    mkdocs.sync(somesy_input.project)
+    assert mkdocs.name == "testproject"
+    assert mkdocs.authors[0] == "John Doe <john.doe@example.com>"
+    assert mkdocs.repo_name == "/example/testproject"
+
+
+def test_save(tmp_path):
+    # test save with default path
+    file_path = tmp_path / "mkdocs.yml"
+    mkdocs = MkDocs(file_path, create_if_not_exists=True)
+    mkdocs.save()
+    assert file_path.is_file()
+
+    # test save with custom path
+    custom_path = tmp_path / "mkdocs2.yml"
+    mkdocs.save(custom_path)
+    assert custom_path.is_file()
+
+
+def test_from_person(person: Person):
+    p = MkDocs._to_person(MkDocs._from_person(person))
+    assert p.to_name_email_string() == person.to_name_email_string()