CodeTF: change descriptions are optional but must not be empty (#822)

Author: drdavella

src/codemodder/codemods/xml_transformer.py

@@ -95,7 +95,7 @@ def add_change(self, line):
         self.changes.append(
             Change(
                 lineNumber=line,
-                description=self.change_description,
+                description=self.change_description or None,
                 findings=self.file_context.get_findings_for_location(line),
             )
         )

src/codemodder/codetf.py

@@ -60,6 +60,12 @@ def validate_lineNumber(self):
             raise ValueError("lineNumber must be greater than 0")
         return self
 
+    @model_validator(mode="after")
+    def validate_description(self):
+        if self.description is not None and not self.description:
+            raise ValueError("description must not be empty")
+        return self
+
 
 class AIMetadata(BaseModel):
     provider: Optional[str] = None

tests/test_codetf.py

@@ -63,6 +63,15 @@ def test_change_invalid_line_number():
         Change(lineNumber=0, description="Change 1 to 2")
 
 
+def test_change_empty_description():
+    with pytest.raises(ValueError):
+        Change(lineNumber=1, description="")
+
+
+def test_change_description_optional():
+    Change(lineNumber=1, description=None)
+
+
 def test_write_codetf(tmpdir, mocker, codetf_schema):
     path = tmpdir / "test.codetf.json"