Add tests

Author: twsl

tests/basic_setup/mkdocs_mkapi.yml

@@ -0,0 +1,10 @@
+site_name: test gitauthors_plugin
+
+nav:
+  - Home: index.md
+  - API: $api:src/mkdocs_git_authors_plugin.*
+
+plugins:
+    - search
+    - mkapi
+    - git-authors

tests/test_basic.py

@@ -19,10 +19,13 @@
 import os
 import re
 import shutil
+import sys
 from contextlib import contextmanager
+from distutils.version import LooseVersion
 from typing import Any, Generator
 
 import git as gitpython
+import mkdocs
 import pytest
 from click.testing import CliRunner, Result
 from git import Repo
@@ -316,3 +319,26 @@ def test_fallback(tmp_path) -> None:
         assert (
             result.exit_code == 0
         ), f"'mkdocs build' command failed. Error: {result.stdout}"
+
+
+# https://github.com/daizutabi/mkapi#:~:text=Python%203.10%20or,1.6%20or%20higher
+@pytest.mark.skipif(sys.version_info < (3, 10), reason="Requires Python 3.10 or higher")
+@pytest.mark.skipif(
+    LooseVersion(mkdocs.__version__) < LooseVersion("1.6"),
+    reason="Requires mkdocs 1.6 or higher",
+)
+def test_mkapi_v3(tmp_path) -> None:
+    result = build_docs_setup("tests/basic_setup/mkdocs_mkapi.yml", tmp_path)
+    assert (
+        result.exit_code == 0
+    ), f"'mkdocs build' command failed. Error: {result.stdout}"
+
+    index_file = tmp_path / "index.html"
+    assert index_file.exists(), f"{index_file} does not exist"
+
+    contents = index_file.read_text()
+    assert re.search("<span class='git-page-authors", contents)
+    assert re.search(
+        '<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown"  aria-expanded="false">API</a>',
+        contents,
+    )

tests/test_requirements.txt

@@ -13,4 +13,7 @@ mkdocs-macros-plugin
 # mkdocs
 mkdocs
 mkdocs-git-revision-date-localized-plugin
-mkdocs-material
+mkdocs-material
+
+# mkapi
+mkapi>=3