summaryrefslogtreecommitdiffstats
path: root/tests/unittests/test_markdown_doc_render.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/unittests/test_markdown_doc_render.py')
-rw-r--r--tests/unittests/test_markdown_doc_render.py28
1 files changed, 28 insertions, 0 deletions
diff --git a/tests/unittests/test_markdown_doc_render.py b/tests/unittests/test_markdown_doc_render.py
new file mode 100644
index 0000000..0538299
--- /dev/null
+++ b/tests/unittests/test_markdown_doc_render.py
@@ -0,0 +1,28 @@
+"""
+This test ensures that all of redis-doc's markdown can be rendered.
+Why do we need this?
+see:
+https://github.com/antirez/redis-doc/commit/02b3d1a345093c1794fd86273e9d516fffd3b819
+"""
+
+import pytest
+from importlib_resources import read_text
+
+from iredis.commands import commands_summary
+from iredis.data import commands as commands_data
+from iredis.markdown import render
+
+
+doc_files = []
+for command, info in commands_summary.items():
+ command_docs_name = "-".join(command.split()).lower()
+ if info["group"] == "iredis":
+ continue
+ doc_files.append(f"{command_docs_name}.md")
+
+
+@pytest.mark.parametrize("filename", doc_files)
+def test_markdown_render(filename):
+ print(filename)
+ doc = read_text(commands_data, filename)
+ render(doc)