Add type hints to tests

Author: twsl

tests/test_basic.py

@@ -1,5 +1,5 @@
 """
-Note that pytest offers a `tmp_path`. 
+Note that pytest offers a `tmp_path`.
 You can reproduce locally with
 
 ```python
@@ -16,16 +16,17 @@
 ```
 """
 
+import os
 import re
 import shutil
-import os
-import pytest
+from contextlib import contextmanager
+from typing import Any, Generator
 
-from click.testing import CliRunner
-from mkdocs.__main__ import build_command
-from git import Repo
 import git as gitpython
-from contextlib import contextmanager
+import pytest
+from click.testing import CliRunner, Result
+from git import Repo
+from mkdocs.__main__ import build_command
 
 SITES_THAT_SHOULD_SUCCEED = [
     "mkdocs.yml",
@@ -40,8 +41,9 @@
     "mkdocs_w_macros2.yml",
 ]
 
+
 @contextmanager
-def working_directory(path):
+def working_directory(path) -> Generator[None, Any, None]:
     """
     Temporarily change working directory.
     A context manager which changes the working directory to the given
@@ -62,20 +64,21 @@ def working_directory(path):
         os.chdir(prev_cwd)
 
 
-def build_docs_setup(mkdocs_path, output_path):
+def build_docs_setup(mkdocs_path, output_path) -> Result:
     runner = CliRunner()
     return runner.invoke(
         build_command, ["--config-file", mkdocs_path, "--site-dir", str(output_path)]
     )
 
+
 @pytest.mark.parametrize(
     "mkdocs_file",
     SITES_THAT_SHOULD_SUCCEED,
 )
-def test_basic_working(tmp_path, mkdocs_file):
+def test_basic_working(tmp_path, mkdocs_file: str) -> None:
     """
     combination with mkdocs-macros-plugin lead to error.
-    See https://github.com/timvink/mkdocs-git-authors-plugin/issues/60    
+    See https://github.com/timvink/mkdocs-git-authors-plugin/issues/60
     """
     result = build_docs_setup(f"tests/basic_setup/{mkdocs_file}", tmp_path)
     assert result.exit_code == 0, (
@@ -90,12 +93,11 @@ def test_basic_working(tmp_path, mkdocs_file):
     assert re.search('<a href="mailto:[email protected]">Tim Vink</a>', contents)
 
 
-def test_custom_href(tmp_path):
-    """
-    """
+def test_custom_href(tmp_path) -> None:
+    """ """
     result = build_docs_setup("tests/basic_setup/mkdocs_custom_href.yml", tmp_path)
     assert result.exit_code == 0, (
-            "'mkdocs build' command failed. Error: %s" % result.stdout
+        "'mkdocs build' command failed. Error: %s" % result.stdout
     )
 
     index_file = tmp_path / "index.html"
@@ -104,16 +106,20 @@ def test_custom_href(tmp_path):
     contents = index_file.read_text()
     assert re.search("<span class='git-page-authors", contents)
     # Checking Page Authors
-    assert re.search((r"<p>Page authors:.*<a href='https://teams.microsoft.com/l/chat/0/0\?"
-                      "[email protected]'>Tim Vink</a>.*<\/p>"), contents)
+    assert re.search(
+        r"<p>Page authors:.*<a href='https://teams.microsoft.com/l/chat/0/0\?"
+        r"[email protected]'>Tim Vink</a>.*</p>",
+        contents,
+    )
     # Checking Site Authors
-    assert re.search(('<li><a href="https://teams.microsoft.com/l/chat/0/0\?'
-                      '[email protected]">Tim Vink</a><\/li>'), contents)
-
-
+    assert re.search(
+        r'<li><a href="https://teams.microsoft.com/l/chat/0/0\?'
+        r'[email protected]">Tim Vink</a></li>',
+        contents,
+    )
 
-def test_no_email(tmp_path):
 
+def test_no_email(tmp_path) -> None:
     result = build_docs_setup("tests/basic_setup/mkdocs_no_email.yml", tmp_path)
     assert result.exit_code == 0, (
         "'mkdocs build' command failed. Error: %s" % result.stdout
@@ -127,9 +133,7 @@ def test_no_email(tmp_path):
     assert re.search("<li>Tim Vink</li>", contents)
 
 
-
-def test_exclude_working(tmp_path):
-
+def test_exclude_working(tmp_path) -> None:
     result = build_docs_setup("tests/basic_setup/mkdocs_exclude.yml", tmp_path)
     assert result.exit_code == 0, (
         "'mkdocs build' command failed. Error: %s" % result.stdout
@@ -142,12 +146,10 @@ def test_exclude_working(tmp_path):
     assert not re.search("<span class='git-page-authors", contents)
 
 
-
-def test_ignore_authors_working(tmp_path):
-
+def test_ignore_authors_working(tmp_path) -> None:
     result = build_docs_setup("tests/basic_setup/mkdocs_ignore_authors.yml", tmp_path)
     assert result.exit_code == 0, (
-            "'mkdocs build' command failed. Error: %s" % result.stdout
+        "'mkdocs build' command failed. Error: %s" % result.stdout
     )
 
     page_file = tmp_path / "page_with_tag/index.html"
@@ -159,18 +161,15 @@ def test_ignore_authors_working(tmp_path):
     assert not re.search("Julien", contents)
 
 
-
-def test_exclude_working_with_genfiles(tmp_path):
+def test_exclude_working_with_genfiles(tmp_path) -> None:
     """
     A warning for uncommited files should not show up
     when those uncommited files are excluded.
     """
-    
+
     testproject_path = tmp_path / "testproject_genfiles"
 
-    shutil.copytree(
-        "tests/basic_setup/docs", str(testproject_path / "docs")
-    )
+    shutil.copytree("tests/basic_setup/docs", str(testproject_path / "docs"))
     shutil.copyfile(
         "tests/basic_setup/mkdocs_genfiles.yml",
         str(testproject_path / "mkdocs.yml"),
@@ -199,18 +198,21 @@ def test_exclude_working_with_genfiles(tmp_path):
             str(testproject_path / "mkdocs.yml"), str(testproject_path / "site")
         )
         assert result.exit_code == 0, (
-                "'mkdocs build' command failed. Error: %s" % result.stdout
+            "'mkdocs build' command failed. Error: %s" % result.stdout
         )
 
         # files generated ourselves right before build but not committed, should not generate warnings
         assert "manually_created.md has not been committed yet." not in result.stdout
-        assert "manually_created_infolder.md has not been committed yet." not in result.stdout
-
-
+        assert (
+            "manually_created_infolder.md has not been committed yet."
+            not in result.stdout
+        )
 
-def test_enabled_working(tmp_path):
 
-    result = build_docs_setup("tests/basic_setup/mkdocs_complete_material_disabled.yml", tmp_path)
+def test_enabled_working(tmp_path) -> None:
+    result = build_docs_setup(
+        "tests/basic_setup/mkdocs_complete_material_disabled.yml", tmp_path
+    )
     assert result.exit_code == 0, (
         "'mkdocs build' command failed. Error: %s" % result.stdout
     )
@@ -222,11 +224,10 @@ def test_enabled_working(tmp_path):
     assert not re.search("<span class='git-page-authors", contents)
 
 
-
-def test_project_with_no_commits(tmp_path):
+def test_project_with_no_commits(tmp_path) -> None:
     """
     Structure:
-    
+
     tmp_path/testproject
     website/
         ├── docs/
@@ -253,12 +254,10 @@ def test_project_with_no_commits(tmp_path):
         )
 
 
-
-
-def test_building_empty_site(tmp_path):
+def test_building_empty_site(tmp_path) -> None:
     """
     Structure:
-    
+
     ```
     tmp_path/testproject
     website/
@@ -288,11 +287,10 @@ def test_building_empty_site(tmp_path):
         )
 
 
-
-def test_fallback(tmp_path):
+def test_fallback(tmp_path) -> None:
     """
     Structure:
-    
+
     ```
     tmp_path/testproject
     website/
@@ -311,7 +309,6 @@ def test_fallback(tmp_path):
     )
 
     with working_directory(str(testproject_path)):
-
         result = build_docs_setup(
             str(testproject_path / "website/mkdocs.yml"), str(testproject_path / "site")
         )

tests/test_util.py

@@ -1,5 +1,5 @@
 """
-Note that pytest offers a `tmp_path`. 
+Note that pytest offers a `tmp_path`.
 You can reproduce locally with
 
 ```python
@@ -16,16 +16,17 @@
 ```
 """
 
+import logging
 import os
 import shutil
-import logging
-
-from mkdocs_git_authors_plugin import util
-from mkdocs_git_authors_plugin.git import repo
+from typing import Any
 
 # GitPython
 import git as gitpython
 
+from mkdocs_git_authors_plugin import util
+from mkdocs_git_authors_plugin.git import repo
+
 DEFAULT_CONFIG = {
     "show_contribution": False,
     "show_line_count": False,
@@ -41,18 +42,18 @@
 #### Helpers ####
 
 
-def setup_clean_mkdocs_folder(mkdocs_yml_path, output_path):
+def setup_clean_mkdocs_folder(mkdocs_yml_path, output_path) -> Any:
     """
     Sets up a clean mkdocs directory
-    
+
     outputpath/testproject
     ├── docs/
     └── mkdocs.yml
-    
+
     Args:
         mkdocs_yml_path (Path): Path of mkdocs.yml file to use
         output_path (Path): Path of folder in which to create mkdocs project
-        
+
     Returns:
         testproject_path (Path): Path to test project
     """
@@ -77,14 +78,14 @@ def setup_clean_mkdocs_folder(mkdocs_yml_path, output_path):
 def setup_commit_history(testproject_path):
     """
     Initializes and creates a git commit history
-    in a new mkdocs testproject. 
-    
-    We commit the pages one by one in order 
+    in a new mkdocs testproject.
+
+    We commit the pages one by one in order
     to create some git depth.
-    
+
     Args:
         testproject_path (Path): Path to test project
-        
+
     Returns:
         repo (repo): git.Repo object
     """
@@ -131,8 +132,7 @@ def setup_commit_history(testproject_path):
 #### Tests ####
 
 
-def test_empty_file(tmp_path):
-
+def test_empty_file(tmp_path) -> None:
     # Change working directory
     cwd = os.getcwd()
     os.chdir(str(tmp_path))
@@ -331,7 +331,7 @@ def test_retrieve_authors_ignoring_commits(tmp_path):
         the_file.write(commit.hexsha + "\n")
     repo_instance = repo.Repo()
     config = DEFAULT_CONFIG.copy()
-    config['ignore_commits'] = ignored_commits_files
+    config["ignore_commits"] = ignored_commits_files
     repo_instance.set_config(config)
     repo_instance.page(file_name)
     authors = repo_instance.get_authors()
@@ -386,7 +386,7 @@ def test_retrieve_authors_ignoring_emails(tmp_path):
     # Get the authors while ignoring [email protected] user
     repo_instance = repo.Repo()
     config = DEFAULT_CONFIG.copy()
-    config['ignore_authors'] = ['[email protected]']
+    config["ignore_authors"] = ["[email protected]"]
     repo_instance.set_config(config)
     repo_instance.page(file_name)
     authors = repo_instance.get_authors()
@@ -402,7 +402,7 @@ def test_retrieve_authors_ignoring_emails(tmp_path):
             "last_datetime": None,
             "lines": 0,
             "lines_all_pages": 0,
-            "name": "John"
+            "name": "John",
         },
         {
             "name": "Tim",
@@ -476,9 +476,10 @@ def test_mkdocs_in_git_subdir(tmp_path):
 
     os.chdir(cwd)
 
+
 def test_summarize_authors():
     """
-    Test summary functions. 
+    Test summary functions.
     TODO
     """
     pass
@@ -510,4 +511,5 @@ def test_summarize_authors():
     # summary = util.Util().summarize(authors, config)
     # assert summary == "<span class='git-authors'><a href='mailto:[email protected]'>Tim</a> (64.23%), <a href='mailto:[email protected]'>Tom</a> (35.77%)</span>"
 
-# TODO: test authors threshold with commits
+
+# TODO: test authors threshold with commits