Documentation unit tests for widgets, closes #125

Author: simonw

docs/widgets.md

@@ -42,7 +42,7 @@ select 'Number of states' as label, count(*) as big_number from states;
 
 Big number live demo: [simonwillison.net/dashboard/big-numbers-demo/](https://simonwillison.net/dashboard/big-numbers-demo/)
 
-## Progress bar: total_count, completed_count
+## Progress bar: completed_count, total_count
 
 To display a progress bar, return columns `total_count` and `completed_count`.
 
@@ -62,7 +62,7 @@ select (
 
 Progress bar live demo: [simonwillison.net/dashboard/progress-bar-demo/](https://simonwillison.net/dashboard/progress-bar-demo/)
 
-## Word cloud: wordcloud_word, wordcloud_count
+## Word cloud: wordcloud_count, wordcloud_word
 
 To display a word cloud, return a column `wordcloud_word` containing words with a corresponding `wordcloud_count` column with the frequency of those words.
 

test_project/test_docs.py

@@ -0,0 +1,30 @@
+import pytest
+import pathlib
+import re
+
+docs_dir = pathlib.Path(__file__).parent.parent / "docs"
+widgets_md = (docs_dir / "widgets.md").read_text()
+widget_templates_dir = (
+    pathlib.Path(__file__).parent.parent
+    / "django_sql_dashboard"
+    / "templates"
+    / "django_sql_dashboard"
+    / "widgets"
+)
+header_re = re.compile(r"^## (.*)", re.M)
+headers = [
+    bit.split(":")[-1].strip().replace(", ", "-")
+    for bit in header_re.findall(widgets_md)
+]
+
+
+@pytest.mark.parametrize(
+    "template",
+    [
+        t
+        for t in widget_templates_dir.glob("*.html")
+        if t.stem not in ("default", "error") and not t.stem.startswith("_")
+    ],
+)
+def test_widgets_are_documented(template):
+    assert template.stem in headers, "Widget {} is not documented".format(template.stem)