Merge pull request #79 from ByteInternet/add_tests_generate_nginx_redirects

Author: tdgroot

.pre-commit-config.yaml

@@ -2,21 +2,22 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 'v4.1.0'
+    rev: 'v4.4.0'
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
 -   repo: https://github.com/psf/black
-    rev: '22.10.0'
+    rev: '22.12.0'
     hooks:
     -   id: black
 -   repo: https://github.com/myint/autoflake
-    rev: 'v1.4'
+    rev: 'v2.0.0'
     hooks:
     -   id: autoflake
         args: ["--in-place", "--remove-unused-variables", "--remove-all-unused-imports"]
 -   repo: https://github.com/pycqa/isort
-    rev: '5.10.1'
+    rev: '5.11.4'
     hooks:
     -   id: isort
         name: isort (python)
+        args: ["--profile", "black"]

hypernode/redirect/generate_nginx_redirects.py

@@ -3,16 +3,13 @@
 from pathlib import Path
 from typing import List
 
-from frontmatter import Frontmatter
-
-from hypernode.common.docs import get_all_docs
+from hypernode.common.docs import get_all_docs, read_doc
 from hypernode.common.settings import DOCS_DIR
 
 
 def get_redirects_from_doc(doc: Path) -> List[str]:
-    fm = Frontmatter.read_file(doc)
-    attributes = fm["attributes"] or {}
-    return attributes.get("redirect_from", [])
+    fm, _, _ = read_doc(doc)
+    return fm.get("redirect_from", [])
 
 
 def get_path_for_doc(doc: Path) -> str:

tests/redirect/__init__.py

@@ -0,0 +1,81 @@
+import os
+from pathlib import Path
+
+from hypernode.common.settings import DOCS_DIR
+from hypernode.redirect.generate_nginx_redirects import (
+    get_path_for_doc,
+    get_redirects_from_doc,
+    main,
+)
+from tests.testcase import HypernodeTestCase
+
+
+class TestMain(HypernodeTestCase):
+    def setUp(self) -> None:
+        module = "hypernode.redirect.generate_nginx_redirects."
+        self.print = self.set_up_patch("builtins.print")
+        self.get_all_docs = self.set_up_patch(
+            module + "get_all_docs", return_value=[DOCS_DIR / "index.html"]
+        )
+        self.get_redirects_from_doc = self.set_up_patch(
+            module + "get_redirects_from_doc", return_value=["/old-url/"]
+        )
+
+    def test_main_prints_rewrites(self):
+        main()
+
+        expected_output = """
+rewrite ^/old-url/$ / permanent;
+        """.strip()
+        self.print.assert_called_once_with(expected_output)
+
+
+class TestGetPathForDoc(HypernodeTestCase):
+    def test_get_path_for_doc_resolves_relative_to_docs_dir(self):
+        result = get_path_for_doc(DOCS_DIR / "some/doc.md")
+
+        self.assertEqual("/some/doc.html", result)
+
+    def test_get_path_for_doc_replaces_md_with_html(self):
+        result = get_path_for_doc(DOCS_DIR / "something.md")
+
+        self.assertEqual("/something.html", result)
+
+    def test_get_path_for_doc_replaces_index_html_with_slash(self):
+        result = get_path_for_doc(DOCS_DIR / "index.md")
+
+        self.assertEqual("/", result)
+
+    def test_get_path_for_doc_prepends_docs_base_url(self):
+        try:
+            os.environ["DOCS_BASE_URL"] = "https://www.example.com/"
+
+            result = get_path_for_doc(DOCS_DIR / "some/doc.html")
+
+            self.assertEqual("https://www.example.com/some/doc.html", result)
+        finally:
+            del os.environ["DOCS_BASE_URL"]
+
+
+class TestGetRedirectsFromDoc(HypernodeTestCase):
+    def setUp(self) -> None:
+        module = "hypernode.redirect.generate_nginx_redirects."
+        self.read_doc = self.set_up_patch(
+            module + "read_doc",
+            return_value=({"redirect_from": ["/old/path/"]}, "", ""),
+        )
+        self.doc = Path("/some/path.md")
+
+    def test_get_redirects_from_doc(self):
+        result = get_redirects_from_doc(self.doc)
+
+        self.assertEqual(["/old/path/"], result)
+        self.read_doc.assert_called_once_with(self.doc)
+
+    def test_get_redirects_from_doc_defaults_to_empty_list(self):
+        self.read_doc.return_value = ({}, "", "")
+
+        result = get_redirects_from_doc(self.doc)
+
+        self.assertEqual([], result)
+        self.read_doc.assert_called_once_with(self.doc)