lint: Add test for package readme syntax errors (open-telemetry#492)

ffe4 · Oberon00 · web-flow · commit 5fbf99961492 · 2020-03-27T21:45:15.000-07:00
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 &lt;christian+github@neumueller.me&gt;
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -8,3 +8,4 @@ sphinx-rtd-theme~=0.4
 sphinx-autodoc-typehints~=1.10.2
 pytest!=5.2.3
 pytest-cov>=2.8
+readme-renderer~=24.0
diff --git a/ext/opentelemetry-ext-otcollector/README.rst b/ext/opentelemetry-ext-otcollector/README.rst
@@ -6,7 +6,7 @@ OpenTelemetry Collector Exporter
 .. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-otcollector.svg
    :target: https://pypi.org/project/opentelemetry-ext-otcollector/
 
-This library allows to export data to `OpenTelemetry Collector <https://github.com/open-telemetry/opentelemetry-collector/>`_ , currently using OpenCensus receiver in Collector side.
+This library allows to export data to `OpenTelemetry Collector`_ , currently using OpenCensus receiver in Collector side.
 
 Installation
 ------------
diff --git a/ext/opentelemetry-ext-testutil/README.rst b/ext/opentelemetry-ext-testutil/README.rst
@@ -0,0 +1,9 @@
+OpenTelemetry Test Utilities
+============================
+
+Test utilities for OpenTelemetry unit tests
+
+
+References
+----------
+* `OpenTelemetry Project <https://opentelemetry.io/>`_
diff --git a/scripts/check_for_valid_readme.py 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
@@ -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):
diff --git a/tox.ini b/tox.ini
@@ -188,6 +188,7 @@ deps =
   isort
   black
   psutil
+  readme_renderer
 
 commands_pre =
   python scripts/eachdist.py install --editable

Original file line number	Diff line number	Diff line change
`@@ -482,6 +482,12 @@ def lint_args(args):`
`482`	`482`	`args, ("exec", "pylint {}", "--all", "--mode", "lintroots")`
`483`	`483`	`)`
`484`	`484`	`)`
	`485`	`+ execute_args(`
	`486`	`+ parse_subargs(`
	`487`	`+ args,`
	`488`	`+ ("exec", "python scripts/check_for_valid_readme.py {}", "--all",),`
	`489`	`+ )`
	`490`	`+ )`
`485`	`491`
`486`	`492`
`487`	`493`	`def test_args(args):`