feat: --validate-output-json to output validation result as JSON (#536)

Author: TrueBrain

README.md

@@ -191,6 +191,7 @@ Options:
   --cache-page-folder TEXT        Folder used to cache rendered pages.
   --validate-all                  Validate all mediawiki files and report all
                                   errors
+  --validate-output-json          Report validation result as JSON
   -h, --help                      Show this message and exit.
 ```
 

truewiki/__main__.py

@@ -1,5 +1,6 @@
 import asyncio
 import click
+import json
 import logging
 import os
 import re
@@ -159,7 +160,8 @@ async def wait_for_storage():
 @click_user_microsoft
 @click_page
 @click.option("--validate-all", help="Validate all mediawiki files and report all errors", is_flag=True)
-def main(bind, port, storage, frontend_url, cache_time, remote_ip_header, validate_all):
+@click.option("--validate-output-json", help="Report validation result as JSON", is_flag=True)
+def main(bind, port, storage, frontend_url, cache_time, remote_ip_header, validate_all, validate_output_json):
     if frontend_url and frontend_url.endswith("/"):
         frontend_url = frontend_url[:-1]
     singleton.FRONTEND_URL = frontend_url
@@ -178,7 +180,13 @@ def main(bind, port, storage, frontend_url, cache_time, remote_ip_header, valida
     config.load()
 
     if validate_all:
-        validate.all()
+        log.info("Validating all mediawiki files ..")
+
+        errors = {} if validate_output_json else None
+        validate.all(errors)
+
+        if errors is not None:
+            print(json.dumps(errors, indent=4))
         return
 
     webapp = web.Application(client_max_size=MAX_UPLOAD_SIZE, middlewares=[remove_cookie_middleware])

truewiki/validate.py

@@ -5,10 +5,10 @@
 from .wiki_page import WikiPage
 
 
-def validate_folder(folder, ignore_index):
+def validate_folder(folder, ignore_index, errors):
     for item in sorted(glob.glob(f"{folder}/*")):
         if os.path.isdir(item):
-            validate_folder(item, ignore_index)
+            validate_folder(item, ignore_index, errors)
             continue
 
         if not item.endswith(".mediawiki"):
@@ -21,15 +21,21 @@ def validate_folder(folder, ignore_index):
         try:
             wiki_page = WikiPage(item).render()
         except Exception as e:
-            print(f"{item}:")
-            print(" - EXCEPTION: ", e)
+            if errors is None:
+                print(f"{item}:")
+                print(" - EXCEPTION: ", e)
+            else:
+                errors[item] = {"exception": str(e)}
             continue
 
         if wiki_page.errors:
-            print(f"{item}:")
-            for error in wiki_page.errors:
-                print(f" - {error}")
+            if errors is None:
+                print(f"{item}:")
+                for error in wiki_page.errors:
+                    print(f" - {error}")
+            else:
+                errors[item] = {"errors": wiki_page.errors}
 
 
-def all():
-    validate_folder(singleton.STORAGE.folder, len(singleton.STORAGE.folder) + 1)
+def all(errors):
+    validate_folder(singleton.STORAGE.folder, len(singleton.STORAGE.folder) + 1, errors)