From 9278d5ebf9c98b0afb5716ddcd03c5e1c5484137 Mon Sep 17 00:00:00 2001
From: Daniel <61800298+ffe4@users.noreply.github.com>
Date: Sat, 28 Mar 2020 05:45:15 +0100
Subject: [PATCH] lint: Add test for package readme syntax errors (#492)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Add a test to ensure readmes render properly

Also adds README.rst for testutil package to pass new test.

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>
---
 scripts/check_for_valid_readme.py | 51 +++++++++++++++++++++++++++++++
 scripts/eachdist.py               |  6 ++++
 2 files changed, 57 insertions(+)
 create mode 100644 scripts/check_for_valid_readme.py

diff --git a/scripts/check_for_valid_readme.py b/scripts/check_for_valid_readme.py
new file mode 100644
index 000000000..edf94d9c3
--- /dev/null
+++ b/scripts/check_for_valid_readme.py
@@ -0,0 +1,51 @@
+"""Test script to check given paths for valid README.rst files."""
+import argparse
+import sys
+from pathlib import Path
+
+import readme_renderer.rst
+
+
+def is_valid_rst(path):
+    """Checks if RST can be rendered on PyPI."""
+    with open(path) as readme_file:
+        markup = readme_file.read()
+    return readme_renderer.rst.render(markup) is not None
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description="Checks README.rst file in path for syntax errors."
+    )
+    parser.add_argument(
+        "paths", nargs="+", help="paths containing a README.rst to test"
+    )
+    parser.add_argument("-v", "--verbose", action="store_true")
+    return parser.parse_args()
+
+
+def main():
+    args = parse_args()
+    error = False
+
+    for path in map(Path, args.paths):
+        readme = path / "README.rst"
+        try:
+            if not is_valid_rst(readme):
+                error = True
+                print("FAILED: RST syntax errors in", readme)
+                continue
+        except FileNotFoundError:
+            error = True
+            print("FAILED: README.rst not found in", path)
+            continue
+        if args.verbose:
+            print("PASSED:", readme)
+
+    if error:
+        sys.exit(1)
+    print("All clear.")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/eachdist.py b/scripts/eachdist.py
index 406afb6eb..f1c5e18b6 100755
--- a/scripts/eachdist.py
+++ b/scripts/eachdist.py
@@ -482,6 +482,12 @@ def lint_args(args):
             args, ("exec", "pylint {}", "--all", "--mode", "lintroots")
         )
     )
+    execute_args(
+        parse_subargs(
+            args,
+            ("exec", "python scripts/check_for_valid_readme.py {}", "--all",),
+        )
+    )
 
 
 def test_args(args):