Merge pull request #152 from Guts/tests/better-coverage

Tests: more use cases, better coverage

Author: Guts

setup.cfg

@@ -49,6 +49,7 @@ addopts =
     --cov-config=setup.cfg
     --cov=mkdocs_rss_plugin
     --cov-report=html
+    --cov-report=term
     --cov-report=xml
     --ignore=tests/_wip/
 junit_family = xunit2
@@ -58,6 +59,7 @@ python_files = test_*.py
 testpaths = tests
 
 [coverage:run]
+disable_warnings=include-ignored
 branch = True
 include =
     mkdocs_rss_plugin/*

tests/fixtures/docs/page_with_meta_bad_date.md

@@ -0,0 +1,8 @@
+---
+date: 2022-03-30 15:09:34
+description: Test page with meta keys as singular and values as iterable
+---
+
+# Test page with meta keys as singular
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

tests/fixtures/mkdocs_complete.yml

@@ -35,6 +35,7 @@ plugins:
         utm_campaign: "feed-syndication"
 theme:
   name: readthedocs
+  locale: fr
 
 # Extensions to enhance markdown
 markdown_extensions:

tests/fixtures/mkdocs_item_categories.yml

@@ -3,11 +3,11 @@ site_name: MkDocs RSS Plugin - TEST
 site_description: Basic setup to test against MkDocs RSS plugin
 site_author: Julien Moura (Guts)
 site_url: https://guts.github.io/mkdocs-rss-plugin
-copyright: 'Guts - In Geo Veritas'
+copyright: "Guts - In Geo Veritas"
 
 # Repository
-repo_name: 'guts/mkdocs-rss-plugin'
-repo_url: 'https://github.com/guts/mkdocs-rss-plugin'
+repo_name: "guts/mkdocs-rss-plugin"
+repo_url: "https://github.com/guts/mkdocs-rss-plugin"
 
 use_directory_urls: true
 
@@ -18,6 +18,7 @@ plugins:
 
 theme:
   name: readthedocs
+  language: de
 
 # Extensions to enhance markdown
 markdown_extensions:

tests/fixtures/mkdocs_minimal_no_site_url.yml

@@ -0,0 +1,11 @@
+site_name: Test RSS Plugin
+site_description: Test RSS Plugin
+# site_url: https://guts.github.io/mkdocs-rss-plugin
+
+use_directory_urls: true
+
+plugins:
+  - rss
+
+theme:
+  name: mkdocs

tests/test_build.py

@@ -401,6 +401,21 @@ def test_rss_feed_validation(self):
             # some feed characteristics
             self.assertEqual(feed_parsed.version, "rss20")
 
+    def test_config_no_site_url(self):
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path(
+                    "tests/fixtures/mkdocs_minimal_no_site_url.yml"
+                ),
+                output_path=tmpdirname,
+                strict=True,
+            )
+
+            # cli should returns an error code (1)
+            self.assertEqual(cli_result.exit_code, 1)
+            self.assertIsNotNone(cli_result.exception)
+
     def test_bad_config(self):
         with tempfile.TemporaryDirectory() as tmpdirname:
             cli_result = self.build_docs_setup(