add unit tests

Author: timvink

test/basic_setup/docs/index.md

@@ -0,0 +1,3 @@
+# Test page
+
+Markdown tag: {{ git_revision_date_localized }}

test/basic_setup/docs/page_without_tag.md

@@ -0,0 +1,3 @@
+# test page
+
+this page has no git authors tag

test/basic_setup/mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-revision-date-localized

test/basic_setup/mkdocs_locale.yml

@@ -0,0 +1,8 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+locale: nl
+
+plugins:
+    - search
+    - git-revision-date-localized

test/basic_setup/mkdocs_plugin_locale.yml

@@ -0,0 +1,7 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-revision-date-localized:
+        locale: nl

test/basic_setup/mkdocs_theme_locale.yml

@@ -0,0 +1,10 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+theme:
+    name: 'material'
+    language: nl
+
+plugins:
+    - search
+    - git-revision-date-localized

test/basic_setup/mkdocs_timeago.yml

@@ -0,0 +1,7 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-revision-date-localized:
+        type: timeago

test/test_basic.py

@@ -0,0 +1,61 @@
+import re
+import yaml
+from click.testing import CliRunner
+from mkdocs.__main__ import build_command
+from pytest import mark
+
+def load_config(mkdocs_path):
+    return yaml.load(open(mkdocs_path, 'rb'), Loader=yaml.Loader)
+    
+def build_docs_setup(mkdocs_path, output_path):
+    runner = CliRunner()
+    return runner.invoke(build_command, 
+                ['--config-file', 
+                 mkdocs_path, 
+                 '--site-dir', 
+                 str(output_path)])
+
+def built_site_tests(path):
+    # Make sure there is proper output
+    index_file = path/'index.html'
+    assert index_file.exists(),  f"{index_file} does not exist"
+    
+    # Make sure there is some output for the tag 
+    contents = index_file.read_text()
+    assert re.search(r"Markdown tag\:\s[\w].+", contents)
+    
+def test_basic_working(tmp_path):
+
+    # No config
+    result = build_docs_setup('test/basic_setup/mkdocs.yml', tmp_path)
+    assert result.exit_code == 0, "'mkdocs build' command failed"
+    built_site_tests(tmp_path)
+
+    # Locales set
+    result = build_docs_setup('test/basic_setup/mkdocs_plugin_locale.yml', tmp_path)
+    assert result.exit_code == 0, "'mkdocs build' command failed"
+    built_site_tests(tmp_path)
+
+    result = build_docs_setup('test/basic_setup/mkdocs_locale.yml', tmp_path)
+    assert result.exit_code == 0, "'mkdocs build' command failed"
+    built_site_tests(tmp_path)
+
+    # With the mkdocs-material theme:
+    result = build_docs_setup('test/basic_setup/mkdocs_theme_locale.yml', tmp_path)
+    assert result.exit_code == 0, "'mkdocs build' command failed"
+    built_site_tests(tmp_path)
+    
+    # In mkdocs-material, a 'last update' should appear 
+    # in Dutch because locale is set to nl
+    index_file = tmp_path/'index.html'
+    built_site_tests(tmp_path)
+    contents = index_file.read_text()
+    assert re.search(r"Laatst geüpdatet op\:\s[\w].+", contents) 
+    
+    # Test timeago
+    result = build_docs_setup('test/basic_setup/mkdocs_timeago.yml', tmp_path)
+    assert result.exit_code == 0, "'mkdocs build' command failed"
+    index_file = tmp_path/'index.html'
+    contents = index_file.read_text()
+    assert re.search("<span class='timeago'", contents) 
+    

test/test_requirements.txt

@@ -0,0 +1,5 @@
+pytest
+pytest-cov
+codecov
+click
+mkdocs-material

test/test_util.py

@@ -0,0 +1,102 @@
+from mkdocs_git_authors_plugin import util
+import os
+from git import Actor, Repo
+
+# def test_empty_file(tmp_path):
+    
+#     # Create empty file
+#     file_name = os.path.join(tmp_path, 'new-file')
+#     open(file_name, 'a').close()
+
+#     # Get authors of empty, uncommitted file
+#     r = Repo.init(tmp_path)
+#     instance = util.Util(tmp_path)
+#     authors = instance.get_authors(path = file_name)
+#     assert authors == ""
+    
+#     # Get authors of empty, committed file
+#     r.index.add([file_name])
+#     author = Actor('Tim', '[email protected]')
+#     r.index.commit("initial commit", author = author)
+#     authors = instance.get_authors(path = file_name)
+#     assert authors == "" 
+    
+# def test_retrieve_authors(tmp_path):
+
+#     # Create file
+#     file_name = os.path.join(tmp_path, 'new-file')
+#     with open(file_name, 'w') as the_file:
+#         the_file.write('Hello\n')
+
+#     # Create git repo and commit file
+#     r = Repo.init(tmp_path)
+#     r.index.add([file_name])
+#     author = Actor('Tim', '[email protected]')
+#     r.index.commit("initial commit", author = author)
+    
+#     instance = util.Util(tmp_path)
+#     authors = instance.get_authors(path = file_name)
+#     authors[0]['last_datetime'] = None
+     
+#     assert authors == [{
+#                     'name' : "Tim",
+#                     'email' : "[email protected]",
+#                     'last_datetime' : None,
+#                     'lines' : 1,
+#                     'contribution' : '100.0%'
+#                 }]
+    
+#     # Now add a line to the file 
+#     # From a second author with same email
+#     with open(file_name, 'a+') as the_file:
+#         the_file.write('World\n')
+#     r.index.add([file_name])
+#     author = Actor('Tim2', '[email protected]')
+#     r.index.commit("another commit", author = author) 
+   
+#     authors = instance.get_authors(path = file_name)
+#     authors[0]['last_datetime'] = None 
+    
+#     assert authors == [{
+#                     'name' : "Tim",
+#                     'email' : "[email protected]",
+#                     'last_datetime' : None,
+#                     'lines' : 2,
+#                     'contribution' : '100.0%'
+#                 }]
+    
+#     # Then a third commit from a new author
+#     with open(file_name, 'a+') as the_file:
+#         the_file.write('A new line\n')
+#     r.index.add([file_name])
+#     author = Actor('John', '[email protected]')
+#     r.index.commit("third commit", author = author)  
+    
+#     authors = instance.get_authors(path = file_name)
+#     authors[0]['last_datetime'] = None 
+#     authors[1]['last_datetime'] = None 
+    
+#     assert authors == [{
+#                     'name' : "John",
+#                     'email' : "[email protected]",
+#                     'last_datetime' : None,
+#                     'lines' : 1,
+#                     'contribution' : '33.33%'
+#                 },{
+#                     'name' : "Tim",
+#                     'email' : "[email protected]",
+#                     'last_datetime' : None,
+#                     'lines' : 2,
+#                     'contribution' : '66.67%'
+#                 }] 
+
+# def test_summarize_authors():
+    
+#     authors = [
+#         {'name' : 'Tim',
+#          'email' : '[email protected]'
+#         }
+#     ]
+    
+#     summary = util.Util().summarize(authors)
+#     assert summary == "<span class='git-authors'><a href='mailto:[email protected]'>Tim</a></span>"