test: add tests for generate_pdf.list_files function

Former-commit-id: 25f0dfc

Author: George Song

Diff for: .gitignore

@@ -74,9 +74,10 @@ yarn-error.log
 __pycache__
 
 # Project specific
+.project
+advocacy_docs/kubernetes/cloud_native_postgresql/*.md.in
 dev-sources.json
 product_docs/content/
 product_docs/content_build/
 static/nginx_redirects.generated
 temp_kubernetes/
-advocacy_docs/kubernetes/cloud_native_postgresql/*.md.in

Diff for: pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+minversion = 6.0
+testpaths =
+  scripts

Diff for: requirements.in

@@ -0,0 +1,2 @@
+pip-tools
+pytest

Diff for: requirements.txt

@@ -0,0 +1,33 @@
+#
+# This file is autogenerated by pip-compile
+# To update, run:
+#
+#    pip-compile
+#
+attrs==21.2.0
+    # via pytest
+click==8.0.1
+    # via pip-tools
+iniconfig==1.1.1
+    # via pytest
+packaging==20.9
+    # via pytest
+pep517==0.10.0
+    # via pip-tools
+pip-tools==6.1.0
+    # via -r requirements.in
+pluggy==0.13.1
+    # via pytest
+py==1.10.0
+    # via pytest
+pyparsing==2.4.7
+    # via packaging
+pytest==6.2.4
+    # via -r requirements.in
+toml==0.10.2
+    # via
+    #   pep517
+    #   pytest
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip

Diff for: scripts/pdf/__init__.py

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/__init__.py

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/1/1.1.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/1/1.2/1.2.1.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/1/1.2/index.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/1/index.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/2/2.1.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/2/index.mdx

@@ -0,0 +1,13 @@
+from pathlib import Path
+
+from ....generate_pdf import TocItem
+
+expected = [
+    TocItem(filename=Path(__file__).parent / "1/index.mdx", chapter=[1]),
+    TocItem(filename=Path(__file__).parent / "1/1.1.mdx", chapter=[1, 1]),
+    TocItem(filename=Path(__file__).parent / "1/1.2/index.mdx", chapter=[1, 2]),
+    TocItem(filename=Path(__file__).parent / "1/1.2/1.2.1.mdx", chapter=[1, 2, 1]),
+    TocItem(filename=Path(__file__).parent / "2/index.mdx", chapter=[2]),
+    TocItem(filename=Path(__file__).parent / "2/2.1.mdx", chapter=[2, 1]),
+    TocItem(filename=Path(__file__).parent / "3.mdx", chapter=[3]),
+]

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/3.mdx

@@ -0,0 +1,3 @@
+---
+title: 'Title'
+---

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/expected.py

@@ -0,0 +1 @@
+expected = []

Diff for: scripts/pdf/__tests__/list_files_test_cases/empty_root_index_1/index.mdx

@@ -0,0 +1,3 @@
+---
+title: 'Title'
+---

Diff for: scripts/pdf/__tests__/list_files_test_cases/frontmatter_only/expected.py

@@ -0,0 +1,5 @@
+from pathlib import Path
+
+from ....generate_pdf import TocItem
+
+expected = [TocItem(filename=Path(__file__).parent / "index.mdx", chapter=[1])]

Diff for: scripts/pdf/__tests__/list_files_test_cases/frontmatter_only/index.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+# Title

Diff for: scripts/pdf/__tests__/list_files_test_cases/index_only/expected.py

@@ -0,0 +1 @@
+expected = []

Diff for: scripts/pdf/__tests__/list_files_test_cases/index_only/index.mdx

@@ -0,0 +1,5 @@
+---
+title: 'Title'
+---
+
+<StubCards product="efm" version="3.10" />

Diff for: scripts/pdf/__tests__/list_files_test_cases/stubcards/expected.py

@@ -0,0 +1,31 @@
+import importlib
+from collections import namedtuple
+from pathlib import Path
+from tempfile import mkdtemp
+
+import pytest
+
+from ..generate_pdf import list_files
+
+base = Path(__file__).parent
+base_package = ".".join(__name__.split(".")[:-1])
+Scenario = namedtuple("Scenario", ("path", "expected_module"))
+
+
+def test_empty():
+    tmp_path = Path(mkdtemp())
+    assert list_files(tmp_path) == []
+    tmp_path.rmdir()
+
+
+@pytest.fixture(params=(base / "list_files_test_cases").iterdir())
+def test_case(request):
+    expected_module = ".".join(
+        ["", *str(request.param.relative_to(base)).split("/"), "expected"]
+    )
+    return Scenario(request.param, expected_module)
+
+
+def test_list_files(test_case):
+    expected = importlib.import_module(test_case.expected_module, base_package)
+    assert list_files(test_case.path) == expected.expected

Diff for: scripts/pdf/__tests__/list_files_test_cases/stubcards/index.mdx

@@ -186,12 +186,12 @@ def list_files(doc_path, chapter=None):
     )
 
     for i, entry in enumerate(directory_contents):
-        if entry.is_dir():
-            chapter = chapter if i == 0 else advance_chapter(chapter)
-            all_files += list_files(entry, chapter)
-        else:
+        if entry.is_file():
             chapter = [*chapter, 0] if i == 0 else advance_chapter(chapter)
             all_files.append(TocItem(filename=entry, chapter=chapter))
+        else:
+            chapter = chapter if i == 0 else advance_chapter(chapter)
+            all_files += list_files(entry, chapter)
 
     return all_files