@redpanda-data/docs-extensions-and-macros 4.11.0 → 4.12.0

package/tools/property-extractor/tests/transformers_test.py

@@ -109,8 +109,9 @@ class NeedsRestartTransformerTestCase(unittest.TestCase):
             )
         )
 
-    def test_rejects_without_needs_restart(self):
-        self.assertFalse(
+    def test_accepts_without_needs_restart(self):
+        """NeedsRestartTransformer now accepts all properties and applies defaults"""
+        self.assertTrue(
             self.transformer.accepts(
                 create_property_info(
                     "test_property", "test description", "bool", PropertyBag()
@@ -251,21 +252,34 @@ class DeprecatedTransformerTestCase(unittest.TestCase):
     def setUp(self):
         self.transformer = DeprecatedTransformer()
 
-    def test_accepts_deprecated_visibility(self):
+    def test_accepts_deprecated_metadata(self):
+        """DeprecatedTransformer accepts properties with .deprecated in meta"""
         self.assertTrue(
             self.transformer.accepts(
                 create_property_info(
                     "test_property",
                     "test description",
                     "bool",
-                    PropertyBag(visibility="visibility::deprecated"),
+                    PropertyBag(deprecated="yes"),
                 ),
                 None,
             )
         )
 
-    def test_accepts_deprecated_property_type(self):
-        self.assertTrue(
+    def test_rejects_without_deprecated_metadata(self):
+        """DeprecatedTransformer rejects properties without .deprecated in meta"""
+        self.assertFalse(
+            self.transformer.accepts(
+                create_property_info(
+                    "test_property",
+                    "test description",
+                    "bool",
+                    PropertyBag(visibility="visibility::deprecated"),
+                ),
+                None,
+            )
+        )
+        self.assertFalse(
             self.transformer.accepts(
                 create_property_info(
                     "test_property",
@@ -372,5 +386,66 @@ class IsSecretTransformerTestCase(unittest.TestCase):
         self.assertFalse(property["is_secret"])
 
 
+class FriendlyDefaultTransformerTestCase(unittest.TestCase):
+    def setUp(self):
+        self.transformer = FriendlyDefaultTransformer()
+
+    def test_strips_unsigned_integer_suffix(self):
+        """Test that C++ unsigned integer suffixes are stripped from defaults"""
+        property = PropertyBag()
+        info = create_property_info(
+            "test_property",
+            "test description",
+            "uint32_t",
+            PropertyBag(needs_restart="needs_restart::no"),
+            default_value="1024u",
+            default_value_type="number_literal"
+        )
+        self.transformer.parse(property, info, FilePair("testfile.h", "testfile.cc"))
+        self.assertEqual(1024, property["default"])
+
+    def test_strips_long_integer_suffix(self):
+        """Test that C++ long integer suffixes are stripped from defaults"""
+        property = PropertyBag()
+        info = create_property_info(
+            "test_property",
+            "test description",
+            "int64_t",
+            PropertyBag(needs_restart="needs_restart::no"),
+            default_value="42L",
+            default_value_type="number_literal"
+        )
+        self.transformer.parse(property, info, FilePair("testfile.h", "testfile.cc"))
+        self.assertEqual(42, property["default"])
+
+    def test_strips_unsigned_long_long_suffix(self):
+        """Test that C++ unsigned long long suffixes are stripped from defaults"""
+        property = PropertyBag()
+        info = create_property_info(
+            "test_property",
+            "test description",
+            "uint64_t",
+            PropertyBag(needs_restart="needs_restart::no"),
+            default_value="999ULL",
+            default_value_type="number_literal"
+        )
+        self.transformer.parse(property, info, FilePair("testfile.h", "testfile.cc"))
+        self.assertEqual(999, property["default"])
+
+    def test_strips_float_suffix(self):
+        """Test that C++ float suffixes are stripped from defaults"""
+        property = PropertyBag()
+        info = create_property_info(
+            "test_property",
+            "test description",
+            "float",
+            PropertyBag(needs_restart="needs_restart::no"),
+            default_value="3.14f",
+            default_value_type="number_literal"
+        )
+        self.transformer.parse(property, info, FilePair("testfile.h", "testfile.cc"))
+        self.assertAlmostEqual(3.14, property["default"], places=2)
+
+
 if __name__ == "__main__":
     unittest.main()

package/tools/property-extractor/topic_property_extractor.py

@@ -107,7 +107,7 @@ class TopicPropertyExtractor:
                         self.topic_properties[property_name] = {
                             "variable_name": f"topic_property_{var_name}",
                             "property_name": property_name,
-                            "source_file": str(file_path.relative_to(self.source_path)),
+                            "defined_in": str(file_path.relative_to(self.source_path)),
                             "description": "",
                             "type": self._determine_property_type(property_name),
                             "acceptable_values": None,
@@ -120,6 +120,10 @@ class TopicPropertyExtractor:
             
     def _scan_file_for_topic_properties(self, file_path: Path):
         """Scan any file for topic_property_ constants"""
+        # Skip admin proxy files - they contain RPC service definitions, not topic properties
+        if 'admin/proxy/' in str(file_path):
+            return
+
         try:
             with open(file_path, 'r', encoding='utf-8', errors='ignore') as f:
                 content = f.read()
@@ -156,7 +160,7 @@ class TopicPropertyExtractor:
                         self.topic_properties[property_name] = {
                             "variable_name": f"topic_property_{var_name}",
                             "property_name": property_name,
-                            "source_file": str(file_path.relative_to(self.source_path)),
+                            "defined_in": str(file_path.relative_to(self.source_path)),
                             "description": "",
                             "type": self._determine_property_type(property_name),
                             "acceptable_values": None,
@@ -231,7 +235,7 @@ class TopicPropertyExtractor:
                 values = self._extract_enum_values(enum_body)
                 if values:
                     self.enum_values[enum_name] = {
-                        "source_file": str(file_path.relative_to(self.source_path)),
+                        "defined_in": str(file_path.relative_to(self.source_path)),
                         "values": values
                     }
                     
@@ -243,7 +247,7 @@ class TopicPropertyExtractor:
                 values = self._extract_enum_values(enum_body)
                 if values:
                     self.enum_values[enum_name] = {
-                        "source_file": str(file_path.relative_to(self.source_path)),
+                        "defined_in": str(file_path.relative_to(self.source_path)),
                         "values": values
                     }
                     
@@ -265,7 +269,7 @@ class TopicPropertyExtractor:
                     values = self._extract_enum_values(enum_body)
                     if values:
                         self.enum_values[enum_name] = {
-                            "source_file": str(file_path.relative_to(self.source_path)),
+                            "defined_in": str(file_path.relative_to(self.source_path)),
                             "values": values
                         }
         except Exception as e:
@@ -273,14 +277,22 @@ class TopicPropertyExtractor:
             
     def _is_valid_topic_property(self, prop_name: str) -> bool:
         """Validate that a string looks like a real topic property"""
-        
+
         # Must be non-empty and reasonable length
         if not prop_name or len(prop_name) < 3 or len(prop_name) > 100:
             return False
-            
+
         # Must contain only valid characters for topic properties
         if not re.match(r'^[a-zA-Z][a-zA-Z0-9._-]*$', prop_name):
             return False
+
+        # Reject Java-style package names (e.g., "redpanda.core.admin.Service")
+        # Topic properties use lowercase with dots (e.g., "cleanup.policy", "segment.ms")
+        # Split by dots and check each segment - reject if any segment after first has uppercase
+        segments = prop_name.split('.')
+        for i, segment in enumerate(segments):
+            if i > 0 and segment and segment[0].isupper():
+                return False
             
         # Known topic property prefixes/patterns
         valid_patterns = [
@@ -525,10 +537,11 @@ class TopicPropertyExtractor:
                     
         elif "timestamp.type" in prop_name:
             return "[`CreateTime`, `LogAppendTime`]"
-            
+
         elif prop_data.get("type") == "boolean":
-            return "[`true`, `false`]"
-            
+            # Boolean properties don't need acceptable_values - it's redundant
+            return ""
+
         # For numeric properties, determine format based on type and name
         elif prop_data.get("type") == "number" and "ratio" in prop_name:
             return "[`0`, `1.0`]"