improve msg for validation

Author: juiwenchen

src/sphinx_codelinks/cmd.py

@@ -1,4 +1,5 @@
 from collections import deque
+import json
 from os import linesep
 from pathlib import Path
 import tomllib
@@ -14,7 +15,7 @@
     generate_project_configs,
 )
 from sphinx_codelinks.logger import logger
-from sphinx_codelinks.needextend_write import convert_marked_content
+from sphinx_codelinks.needextend_write import MarkedObjType, convert_marked_content
 from sphinx_codelinks.source_discover.config import (
     CommentType,
     SourceDiscoverConfig,
@@ -268,7 +269,24 @@ def write_rst(  # noqa: PLR0913  # for CLI, so it takes as many as it requires
 ) -> None:
     """Generate needextend.rst from the extracted obj in JSON."""
     logger.configure(verbose, quiet)
-    convert_marked_content(jsonpath, outpath, remote_url_field, title)
+    try:
+        with jsonpath.open("r") as f:
+            marked_content = json.load(f)
+    except Exception as e:
+        raise typer.BadParameter(
+            f"Failed to load marked content from {jsonpath}: {e}"
+        ) from e
+
+    marked_objs: list[MarkedObjType] = [
+        obj for objs in marked_content.values() for obj in objs
+    ]
+
+    errors = convert_marked_content(marked_objs, outpath, remote_url_field, title)
+    if errors:
+        raise typer.BadParameter(
+            f"Errors occurred during conversion: {linesep.join(errors)}"
+        )
+    typer.echo(f"Generated {outpath}")
 
 
 def load_config_from_toml(toml_file: Path) -> CodeLinksConfigType:

src/sphinx_codelinks/needextend_write.py

@@ -2,7 +2,6 @@
 
 from collections import deque
 from dataclasses import MISSING, dataclass, field, fields
-import json
 from os import linesep
 from pathlib import Path
 from string import Template
@@ -11,7 +10,6 @@
 from jsonschema import ValidationError, validate
 
 from sphinx_codelinks.analyse.models import MarkedContentType, SourceMap
-from sphinx_codelinks.logger import logger
 
 NEEDEXTEND_TEMPLATE = Template(""".. needextend:: $need_id
    :$remote_url_field: $remote_url
@@ -164,21 +162,13 @@ class MarkedObjType(TypedDict):
 
 
 def convert_marked_content(
-    jsonpath: Path,
+    marked_objs: list[MarkedObjType],
     outpath: Path,
     remote_url_field: str = "remote-url",
     title: str | None = None,
-) -> None:
+) -> list[str] | None:
     """Convert marked objects extracted by anaylse CLI to needextend in RST"""
-    with jsonpath.open("r") as f:
-        marked_content = json.load(f)
-
-    warnings = []
-
-    # flatten objects
-    marked_objs: list[MarkedObjType] = [
-        obj for objs in marked_content.values() for obj in objs
-    ]
+    errors = []
 
     intersted_objs = [
         obj
@@ -187,18 +177,20 @@ def convert_marked_content(
     ]
 
     for obj in intersted_objs:
-        schema = MarkedContentSchema(**obj)
-        obj_warnings: deque[str] = deque()
-        obj_warnings.extend(schema.check_schema())
-        obj_warnings.extend(schema.check_conditional_required_fields())
-        if obj_warnings:
-            obj_warnings.appendleft(f"{obj} has the following warnings:")
-            warnings.extend(list(obj_warnings))
-
-    if warnings:
-        logger.warning(
-            f"Marked objects have the following warnings: {linesep.join(warnings)}"
-        )
+        try:
+            schema = MarkedContentSchema(**obj)
+        except TypeError as e:
+            errors.append(str(e))
+            continue
+        obj_errors: deque[str] = deque()
+        obj_errors.extend(schema.check_schema())
+        obj_errors.extend(schema.check_conditional_required_fields())
+        if obj_errors:
+            obj_errors.appendleft(f"{obj} has the following errors:")
+            errors.extend(list(obj_errors))
+
+    if errors:
+        return errors
 
     needextend_texts: list[str] = []
     if title:
@@ -217,4 +209,4 @@ def convert_marked_content(
     with outpath.open("w") as f:
         f.writelines(needextend_texts)
 
-    logger.info(f"Generated {outpath}")
+    return None

tests/test_cmd.py

@@ -212,3 +212,73 @@ def test_analyse_project_negative(projects, output_lines, tmp_path: Path) -> Non
     assert result.exit_code != 0
     for line in output_lines:
         assert line in result.stdout
+
+
+def test_write_rst_invalid_json(tmp_path: Path) -> None:
+    json_obj = {
+        "whatever": "json",
+        "not": "expected",
+    }
+    json_text = json.dumps(json_obj)
+    json_text = json_text.replace(",", "")
+    jsonpath = tmp_path / "invalid_json.json"
+    with jsonpath.open("w") as f:
+        f.write(json_text)
+
+    options = [
+        "write",
+        "rst",
+        str(jsonpath),
+        "--outpath",
+        str(tmp_path / "out.rst"),
+    ]
+    result = runner.invoke(app, options)
+
+    assert result.exit_code != 0
+    assert "Expecting ',' delimiter: line 1 column 21 (char 20)" in result.stdout
+
+
+@pytest.mark.parametrize(
+    ("json_objs", "output_lines"),
+    [
+        (
+            [
+                {
+                    "filepath": 123,
+                    "remote_url": "https://github.com/useblocks/sphinx-codelinks/blob/951e40e7845f06d5cfc4ca20ebb984308fdaf985/tests/data/marked_rst/dummy_1.cpp#L4",
+                    "source_map": {
+                        "start": {"row": 3, "column": 8},
+                        "end": {"row": 3, "column": 61},
+                    },
+                    "tagged_scope": "void dummy_func1(){\n     //...\n }",
+                    "rst": ".. impl:: implement dummy function 1\n   :id: IMPL_71\n",
+                    "type": "need-id-refs",
+                }
+            ],
+            [
+                "Invalid value: Errors occurred",
+                "Schema validation error in field 'filepath': 123 is not of type 'string'",
+                "Marker is required for marked content of type 'need_id_refs' ",
+                "Need id refs are required for marked content of type 'need_id_refs'",
+            ],
+        ),
+    ],
+)
+def test_write_rst_negative(json_objs: list[dict], output_lines, tmp_path) -> None:
+    to_dump = {"project_1": json_objs}
+    jsonpath = Path("invalid_objs.json")
+    with jsonpath.open("w") as f:
+        json.dump(to_dump, f)
+    outpath = tmp_path / "needextend.rst"
+    options = [
+        "write",
+        "rst",
+        str(jsonpath),
+        "--outpath",
+        str(outpath),
+    ]
+    result = runner.invoke(app, options)
+
+    assert result.exit_code != 0
+    for line in output_lines:
+        assert line in result.stdout