Test against minimal configuration

Author: Guts

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_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.yml tests/fixtures/mkdocs_minimal.ymltests/fixtures/mkdocs.yml renamed to tests/fixtures/mkdocs_minimal.yml

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

tests/test_build.py

@@ -66,6 +66,22 @@ def test_simple_build(self):
                 testproject_path="docs",
                 mkdocs_yml_filepath=Path("mkdocs.yml"),
                 output_path=tmpdirname,
+                strict=False,
+            )
+
+            if cli_result.exception is not None:
+                e = cli_result.exception
+                logger.debug(format_exception(type(e), e, e.__traceback__))
+
+            self.assertEqual(cli_result.exit_code, 0)
+            self.assertIsNone(cli_result.exception)
+
+    def test_simple_build_minimal(self):
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_minimal.yml"),
+                output_path=tmpdirname,
                 strict=True,
             )
 
@@ -76,6 +92,23 @@ def test_simple_build(self):
             self.assertEqual(cli_result.exit_code, 0)
             self.assertIsNone(cli_result.exception)
 
+            # created items
+            feed_parsed = feedparser.parse(Path(tmpdirname) / "feed_rss_created.xml")
+            for feed_item in feed_parsed.entries:
+                print(feed_item.keys())
+                # mandatory properties
+                self.assertTrue("description" in feed_item)
+                self.assertTrue("guid" in feed_item)
+                self.assertTrue("link" in feed_item)
+                self.assertTrue("published" in feed_item)
+                self.assertTrue("source" in feed_item)
+                self.assertTrue("title" in feed_item)
+                # optional - following should not be present in the feed by default
+                self.assertTrue("author" not in feed_item)
+                self.assertTrue("category" not in feed_item)
+                self.assertTrue("comments" not in feed_item)
+                self.assertTrue("enclosure" not in feed_item)
+
     def test_simple_build_disabled(self):
         with tempfile.TemporaryDirectory() as tmpdirname:
             cli_result = self.build_docs_setup(
@@ -108,14 +141,34 @@ def test_simple_build_feed_length(self):
 
             # created items
             feed_parsed = feedparser.parse(Path(tmpdirname) / "feed_rss_created.xml")
-            self.assertEqual(feed_parsed.bozo, 0)
+            self.assertEqual(len(feed_parsed.entries), 3)
 
             # updated items
             feed_parsed = feedparser.parse(Path(tmpdirname) / "feed_rss_updated.xml")
-            self.assertEqual(feed_parsed.bozo, 0)
-
             self.assertEqual(len(feed_parsed.entries), 3)
 
+    def test_simple_build_item_categories_enabled(self):
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_item_categories.yml"),
+                output_path=tmpdirname,
+                strict=True,
+            )
+            if cli_result.exception is not None:
+                e = cli_result.exception
+                logger.debug(format_exception(type(e), e, e.__traceback__))
+
+            self.assertEqual(cli_result.exit_code, 0)
+            self.assertIsNone(cli_result.exception)
+
+            # created items
+            feed_parsed = feedparser.parse(Path(tmpdirname) / "feed_rss_created.xml")
+
+            for feed_item in feed_parsed.entries:
+                if feed_item.title in ("Test page with meta",):
+                    self.assertTrue("category" in feed_item)
+
     def test_simple_build_item_comments_enabled(self):
         with tempfile.TemporaryDirectory() as tmpdirname:
             cli_result = self.build_docs_setup(