Merge pull request #114 from Guts/quality/completing-tests

Tests: road to 80% of coverage

Author: Guts

.gitignore

@@ -217,3 +217,4 @@ dmypy.json
 
 **/*.xml
 site/
+tests/fixtures/docs/temp_page_not_in_git_log.md

mkdocs_rss_plugin/util.py

@@ -131,7 +131,7 @@ def get_file_dates(
 
         if source_date_update != "git" and in_page.meta.get(source_date_update):
             dt_updated = self.get_date_from_meta(
-                date_metatag_value=in_page.meta.get(source_date_creation),
+                date_metatag_value=in_page.meta.get(source_date_update),
                 meta_datetime_format=meta_datetime_format,
             )
             if isinstance(dt_updated, str):

tests/base.py

@@ -80,19 +80,20 @@ def build_docs_setup(
         :return: Object with results of command
         :rtype: click.testing.Result
         """
+        cmd_args = [
+            "--clean",
+            "--config-file",
+            f"{mkdocs_yml_filepath}",
+            "--site-dir",
+            f"{output_path}",
+            "--verbose",
+        ]
+        if strict:
+            cmd_args.append("--strict")
+
         try:
             runner = CliRunner()
-            run = runner.invoke(
-                build_command,
-                [
-                    "--clean",
-                    "--config-file",
-                    f"{mkdocs_yml_filepath}",
-                    "--site-dir",
-                    f"{output_path}",
-                    "--verbose",
-                ],
-            )
+            run = runner.invoke(build_command, cmd_args)
             return run
         except Exception as err:
             logging.critical(err)

tests/fixtures/docs/index.md

@@ -1,8 +1,7 @@
 # Test home page
 
-Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
+Sed ut perspiciatis *unde* omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
 
-Feeds:
+Eos **aliquid incidunt non**. Possimus ipsam id reiciendis enim. Laudantium eligendi deleniti rem delectus corrupti sit doloremque quod. Dolorem est laborum enim a ut aut.
 
-- latest created: [feed_rss_created.xml](feed_rss_created.xml)
-- latest updated: [feed_rss_updated.xml](feed_rss_updated.xml)
+Laudantium minima cumque mollitia alias voluptatibus sit doloribus natus. Nam earum dolores est velit optio ipsa sit. Veritatis aut iusto distinctio veritatis aperiam in. Nemo aperiam ipsum dolorem ea officiis pariatur sapiente. Quibusdam est ut eligendi vitae ducimus fugiat. Harum ea necessitatibus inventore rem voluptatem est quaerat incidunt.

tests/fixtures/docs/page_with_meta.md

@@ -1,11 +1,13 @@
 ---
-title: Use the MkDocs RSS Plugin
+title: Page with complete meta
 authors:
     - Guts
     - Tim Vink
     - liang2kl
 date: 2020-03-20 10:20
+update: 2022-03-30 10:20
 description: First test page of mkdocs-rss-plugin test suite
+image: "https://svgsilh.com/png-512/97849.png"
 tags:
     - test
 ---

tests/fixtures/docs/page_with_meta_as_string.md

@@ -0,0 +1,12 @@
+---
+author: Julien Moura
+category: blog
+date: 2022-03-30
+description: First test page of mkdocs-rss-plugin test suite
+tags:
+    - test
+---
+
+# Test page with meta values as string
+
+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/docs/page_with_meta_singulars.md

@@ -0,0 +1,18 @@
+---
+author:
+    - Julien Moura
+    - Tim Vink
+tags:
+    - blog
+    - tests
+date: 2022-03-30
+description: Test page with meta keys as singular and values as iterable
+tags:
+    - test
+---
+
+# 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

@@ -13,11 +13,24 @@ use_directory_urls: true
 
 plugins:
   - rss:
-      abstract_chars_count: 200
+      abstract_chars_count: 160  # -1 for full content
+      categories:
+        - tags
       comments_path: "#__comments"
-      feed_ttl: 90
-      length: 3
-
+      date_from_meta:
+        as_creation: "date"
+        as_update: false
+        datetime_format: "%Y-%m-%d %H:%M"
+      enabled: true
+      feed_ttl: 1440
+      image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
+      length: 20
+      pretty_print: false
+      match_path: ".*"
+      url_parameters:
+        utm_source: "documentation"
+        utm_medium: "RSS"
+        utm_campaign: "feed-syndication"
 theme:
   name: readthedocs
 

tests/fixtures/mkdocs_dates_overridden.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:
+      date_from_meta:
+        as_creation: "date"
+        as_update: "update"
+        datetime_format: "%Y-%m-%d %H:%M"
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/test_build.py

@@ -57,7 +57,14 @@ def tearDown(self):
     @classmethod
     def tearDownClass(cls):
         """Executed after the last test."""
-        pass
+        # In case of some tests failure, ensure that everything is cleaned up
+        temp_page = Path("tests/fixtures/docs/temp_page_not_in_git_log.md")
+        # if temp_page.exists():
+        #     temp_page.unlink()
+
+        git_dir = Path("_git")
+        if git_dir.exists():
+            git_dir.replace(git_dir.with_name(".git"))
 
     # -- TESTS ---------------------------------------------------------
     def test_simple_build(self):
@@ -111,6 +118,48 @@ def test_simple_build_minimal(self):
                 if feed_item.title in ("Test page with meta",):
                     self.assertTrue("author" in feed_item)
 
+    def test_simple_build_complete(self):
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_complete.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:
+
+                # 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
+                if (
+                    "without_meta" in feed_item.title
+                    or feed_item.title == "Test home page"
+                ):
+                    self.assertTrue("category" not in feed_item)
+                    self.assertTrue("comments" in feed_item)
+                elif "with_meta" in feed_item.title:
+                    self.assertTrue("author" in feed_item)
+                    self.assertTrue("category" in feed_item)
+                    self.assertTrue("enclosure" in feed_item)
+                else:
+                    pass
+
     def test_simple_build_disabled(self):
         with tempfile.TemporaryDirectory() as tmpdirname:
             cli_result = self.build_docs_setup(
@@ -125,6 +174,20 @@ def test_simple_build_disabled(self):
             self.assertEqual(cli_result.exit_code, 0)
             self.assertIsNone(cli_result.exception)
 
+    def test_simple_build_item_dates(self):
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_dates_overridden.yml"),
+                output_path=tmpdirname,
+            )
+            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_feed_length(self):
         with tempfile.TemporaryDirectory() as tmpdirname:
             cli_result = self.build_docs_setup(
@@ -316,7 +379,7 @@ def test_rss_feed_validation(self):
         with tempfile.TemporaryDirectory() as tmpdirname:
             cli_result = self.build_docs_setup(
                 testproject_path="docs",
-                mkdocs_yml_filepath=Path("mkdocs.yml"),
+                mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_complete.yml"),
                 output_path=tmpdirname,
             )
 
@@ -342,15 +405,85 @@ def test_bad_config(self):
         with tempfile.TemporaryDirectory() as tmpdirname:
             cli_result = self.build_docs_setup(
                 testproject_path="docs",
-                mkdocs_yml_filepath=Path("mkdocs_bad_config.yml"),
+                mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_bad_config.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_date_format(self):
+        # add a new page without tracking it
+        md_str = """---\ndate: 13 April 2022\n---\n\n# This page is dynamically created for test purposes\n\nHi!\n
+        """
+        temp_page = Path("tests/fixtures/docs/temp_page_not_in_git_log.md")
+        if temp_page.exists():
+            temp_page.unlink()
+        temp_page.write_text(md_str)
+
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path("mkdocs.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)
+
+        # rm page
+        temp_page.unlink()
+
+    def test_not_in_git_log(self):
+        # add a new page without tracking it
+        md_str = """# This page is dynamically created for test purposes\n\nHi!\n
+        """
+        temp_page = Path("tests/fixtures/docs/temp_page_not_in_git_log.md")
+        if temp_page.exists():
+            temp_page.unlink()
+        temp_page.write_text(md_str)
+
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_disabled.yml"),
                 output_path=tmpdirname,
                 strict=True,
             )
 
-            # cli should returns an error code (2)
-            self.assertEqual(cli_result.exit_code, 2)
+            self.assertEqual(cli_result.exit_code, 0)
+            self.assertIsNone(cli_result.exception)
+
+        # rm page
+        temp_page.unlink()
+
+    def test_not_git_repo(self):
+        # temporarily rename the git folder to fake a non-git repo
+        git_dir = Path(".git")
+        git_dir_tmp = git_dir.with_name("_git")
+        git_dir.replace(git_dir_tmp)
+
+        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,
+            )
+            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, 1)
             self.assertIsNotNone(cli_result.exception)
 
+        # restore name
+        git_dir_tmp.replace(git_dir)
+
 
 # ##############################################################################
 # ##### Stand alone program ########