Merge pull request #113 from Guts/tests

Unit testing enforced

tests/base.py

@@ -60,7 +60,11 @@ def get_plugin_config_from_mkdocs(
         return plugin_loaded.config
 
     def build_docs_setup(
-        self, testproject_path: Path, mkdocs_yml_filepath: Path, output_path: Path
+        self,
+        testproject_path: Path,
+        mkdocs_yml_filepath: Path,
+        output_path: Path,
+        strict: bool = True,
     ):
         """Runs the `mkdocs build` command.
 

tests/fixtures/docs/page_with_meta.md

@@ -2,8 +2,10 @@
 Title: Use the MkDocs RSS Plugin
 date: 2020-03-20 10:20
 description: First test page of mkdocs-rss-plugin test suite
+tags:
+    - test
 ---
 
-# First Test page
+# Test page with meta
 
 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_feed_length_custom.yml

@@ -0,0 +1,26 @@
+# Project information
+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"
+
+# Repository
+repo_name: "guts/mkdocs-rss-plugin"
+repo_url: "https://github.com/guts/mkdocs-rss-plugin"
+
+use_directory_urls: true
+
+plugins:
+  - rss:
+      abstract_chars_count: 200
+      comments_path: "#__comments"
+      feed_ttl: 90
+      length: 3
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/fixtures/mkdocs_feed_ttl_custom.yml

@@ -0,0 +1,23 @@
+# Project information
+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"
+
+# Repository
+repo_name: "guts/mkdocs-rss-plugin"
+repo_url: "https://github.com/guts/mkdocs-rss-plugin"
+
+use_directory_urls: true
+
+plugins:
+  - rss:
+      feed_ttl: 90
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/fixtures/mkdocs_item_categories.yml

@@ -0,0 +1,24 @@
+# Project information
+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'
+
+# Repository
+repo_name: 'guts/mkdocs-rss-plugin'
+repo_url: 'https://github.com/guts/mkdocs-rss-plugin'
+
+use_directory_urls: true
+
+plugins:
+  - rss:
+      categories:
+        - tags
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/fixtures/mkdocs_rss_length_full.yml → tests/fixtures/mkdocs_item_comments.yml

@@ -13,10 +13,7 @@ use_directory_urls: true
 
 plugins:
   - rss:
-      abstract_chars_count: 200
       comments_path: "#__comments"
-      feed_ttl: 90
-      length: 3
 
 theme:
   name: readthedocs

tests/fixtures/mkdocs_item_length_default.yml

@@ -0,0 +1,24 @@
+# Project information
+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"
+
+# Repository
+repo_name: "guts/mkdocs-rss-plugin"
+repo_url: "https://github.com/guts/mkdocs-rss-plugin"
+
+docs_dir: docs
+
+use_directory_urls: true
+
+plugins:
+  - rss
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/fixtures/mkdocs_item_length_unlimited.yml

@@ -0,0 +1,23 @@
+# Project information
+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"
+
+# Repository
+repo_name: "guts/mkdocs-rss-plugin"
+repo_url: "https://github.com/guts/mkdocs-rss-plugin"
+
+use_directory_urls: true
+
+plugins:
+  - rss:
+      abstract_chars_count: -1
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/fixtures/mkdocs_item_no_comments.yml

@@ -0,0 +1,22 @@
+# Project information
+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'
+
+# Repository
+repo_name: 'guts/mkdocs-rss-plugin'
+repo_url: 'https://github.com/guts/mkdocs-rss-plugin'
+
+use_directory_urls: true
+
+plugins:
+  - rss
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/fixtures/mkdocs_minimal.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/fixtures/mkdocs_pretty_print_disabled.yml

@@ -0,0 +1,12 @@
+site_name: Test RSS Plugin
+site_description: Test RSS Plugin
+
+use_directory_urls: true
+
+plugins:
+    - search
+    - rss:
+          pretty_print: False
+
+theme:
+    name: mkdocs

tests/fixtures/mkdocs.yml → tests/fixtures/mkdocs_pretty_print_enabled.yml

@@ -5,7 +5,8 @@ use_directory_urls: true
 
 plugins:
     - search
-    - rss
+    - rss:
+          pretty_print: True
 
 theme:
     name: mkdocs