Merge pull request github#17537 from github/redsun82/rust-doctest-gen

Rust: take test code also from property descriptions

Author: aibaars

misc/codegen/generators/rusttestgen.py

@@ -1,5 +1,7 @@
 import dataclasses
 import typing
+from collections.abc import Iterable
+
 import inflection
 
 from misc.codegen.loaders import schemaloader
@@ -27,6 +29,25 @@ class TestCode:
     function: Function | None = None
 
 
+def _get_code(doc: list[str]) -> list[str]:
+    adding_code = False
+    has_code = False
+    code = []
+    for line in doc:
+        match line, adding_code:
+            case ("```", _) | ("```rust", _):
+                adding_code = not adding_code
+                has_code = True
+            case _, False:
+                code.append(f"// {line}")
+            case _, True:
+                code.append(line)
+    assert not adding_code, "Unterminated code block in docstring:\n  " + "\n  ".join(doc)
+    if has_code:
+        return code
+    return []
+
+
 def generate(opts, renderer):
     assert opts.ql_test_output
     schema = schemaloader.load_file(opts.schema)
@@ -36,24 +57,18 @@ def generate(opts, renderer):
                          force=opts.force) as renderer:
         for cls in schema.classes.values():
             if (qlgen.should_skip_qltest(cls, schema.classes) or
-                    "rust_skip_test_from_doc" in cls.pragmas or
-                    not cls.doc):
+                    "rust_skip_doc_test" in cls.pragmas):
                 continue
-            code = []
-            adding_code = False
-            has_code = False
-            for line in cls.doc:
-                match line, adding_code:
-                    case ("```", _) | ("```rust", _):
-                        adding_code = not adding_code
-                        has_code = True
-                    case _, False:
-                        code.append(f"// {line}")
-                    case _, True:
-                        code.append(line)
-            if not has_code:
+            code = _get_code(cls.doc)
+            for p in schema.iter_properties(cls.name):
+                if "rust_skip_doc_test" in p.pragmas:
+                    continue
+                property_code = _get_code(p.description)
+                if property_code:
+                    code.append(f"// # {p.name}")
+                    code += property_code
+            if not code:
                 continue
-            assert not adding_code, "Unterminated code block in docstring: " + "\n".join(cls.doc)
             test_name = inflection.underscore(cls.name)
             signature = cls.pragmas.get("rust_doc_test_signature", "() -> ()")
             fn = signature and Function(f"test_{test_name}", signature)

misc/codegen/lib/schema.py

@@ -1,6 +1,7 @@
 """ schema format representation """
 import abc
 import typing
+from collections.abc import Iterable
 from dataclasses import dataclass, field
 from typing import List, Set, Union, Dict, Optional
 from enum import Enum, auto
@@ -144,6 +145,12 @@ def root_class(self):
     def null_class(self):
         return self.classes[self.null] if self.null else None
 
+    def iter_properties(self, cls: str) -> Iterable[Property]:
+        cls = self.classes[cls]
+        for b in cls.bases:
+            yield from self.iter_properties(b)
+        yield from cls.properties
+
 
 predicate_marker = object()