Expand unit tests for authorship_threshold_percent and sort_authors_by options

Author: timvink

tests/basic_setup/mkdocs.yml

@@ -3,6 +3,4 @@ use_directory_urls: true
 
 plugins:
     - search
-    - git-authors:
-          sort_authors_by: "contribution"
-          authorship_threshold_percent: 50
+    - git-authors

tests/basic_setup/mkdocs_w_contribution.yml

@@ -7,4 +7,3 @@ plugins:
         count_empty_lines: false
         show_contribution: true
         show_line_count: true
-        authorship_threshold_percent: 50

tests/basic_setup/mkdocs_w_contribution_and_author_threshold.yml

@@ -0,0 +1,10 @@
+site_name: test gitauthors_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-authors:
+        count_empty_lines: false
+        show_contribution: true
+        show_line_count: true
+        authorship_threshold_percent: 50

tests/basic_setup/mkdocs_w_contribution_sort_and_author_threshold.yml

@@ -0,0 +1,8 @@
+site_name: test gitauthors_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-authors:
+          sort_authors_by: "contribution"
+          authorship_threshold_percent: 50

tests/test_basic.py

@@ -27,6 +27,20 @@
 import git as gitpython
 from contextlib import contextmanager
 
+SITES_THAT_SHOULD_SUCCEED = [
+    "mkdocs.yml",
+    "mkdocs_complete_material_disabled.yml",
+    "mkdocs_complete_material.yml",
+    "mkdocs_exclude.yml",
+    "mkdocs_fallback.yml",
+    "mkdocs_genfiles.yml",
+    "mkdocs_no_email.yml",
+    "mkdocs_w_contribution_and_author_threshold.yml",
+    "mkdocs_w_contribution_sort_and_author_threshold.yml",
+    "mkdocs_w_contribution.yml",
+    "mkdocs_w_macros.yml",
+    "mkdocs_w_macros2.yml",
+]
 
 @contextmanager
 def working_directory(path):
@@ -58,7 +72,7 @@ def build_docs_setup(mkdocs_path, output_path):
 
 @pytest.mark.parametrize(
     "mkdocs_file",
-    ["mkdocs.yml", "mkdocs_w_macros.yml", "mkdocs_w_macros2.yml", "mkdocs_complete_material.yml"],
+    SITES_THAT_SHOULD_SUCCEED,
 )
 def test_basic_working(tmp_path, mkdocs_file):
     """

tests/test_util.py

@@ -33,6 +33,8 @@
     "count_empty_lines": True,
     "sort_authors_by_name": True,
     "sort_reverse": False,
+    "sort_authors_by": "name",
+    "authorship_threshold_percent": 0,
 }
 
 #### Helpers ####
@@ -331,7 +333,6 @@ def test_mkdocs_in_git_subdir(tmp_path):
 
     os.chdir(cwd)
 
-
 def test_summarize_authors():
     """
     Test summary functions. 
@@ -365,3 +366,5 @@ def test_summarize_authors():
     # # Now contribution is displayed
     # 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