tests: kdoc: fix parse failure logging

Commit 0a1066f ("tests: kdoc: fix handling file removal") added extra
logging to the test intending to help debug parsing failures.

Unfortunately, the newly added "<parse fail>" log line is added to every
warning which doesn't end in ':', regardless of whether or not the
KdocWarning class handles parsing of the line.

This appears to have happened due to the confusion of the way skip and
extra work. What we really want to do is convert the text into a warning
object, then check if it cleanly parsed. We could check for the 'Unknown'
kind. However, in the interest of being precise should new kinds ever be
added, expose a new 'parsed' field of the warning object. Its set to true
if we got a clean regex parse, and false otherwise.

Additionally refactor the conditional checks and add comments for clarity.
In particular, set extra to None unconditionally first, then perform the
merging check. This should improve the readability and intended flow of
this logic.

Signed-off-by: Jacob Keller <[email protected]>

Author: jacob-keller

tests/patch/kdoc/test.py

@@ -31,6 +31,7 @@ class KdocWarning:
     line : Optional[int] = dataclasses.field(repr=True, compare=False)
     # The content of the warning (excluding kind, file, line)
     content : str = dataclasses.field(repr=True, compare=True)
+    parsed : bool = dataclasses.field(repr=True, compare=True)
 
     @classmethod
     def from_text(self, line, extra=None):
@@ -60,14 +61,12 @@ def from_text(self, line, extra=None):
             content = m['content']
             if extra:
                 content += '\n' + extra
-        else:
-            kind = 'Unknown'
-            file = None
-            line = None
-            content = message
 
-        return KdocWarning(message, kind=kind, file=file, line=line,
-                           content=content)
+            return KdocWarning(message, kind=kind, file=file, line=line,
+                               content=content, parsed=True)
+
+        return KdocWarning(message, kind='Unknown', file=None, line=None,
+                           content=line, parsed=False)
 
     def __str__(self):
         return self.message
@@ -80,20 +79,28 @@ def parse_warnings(lines, logs) -> List[KdocWarning]:
 
     # Walk through lines and convert to warning objects
     for i, line in enumerate(lines):
+        # Skip lines already merged into previous warning
         if skip:
             skip = False
             continue
 
+        # Ignore blank lines
+        if not line.strip():
+            continue
+
+        # Check if we should merge the next line with this warning
+        extra = None
         if line.endswith(':') and i + 1 < length:
             extra = lines[i + 1]
             skip = True
-        elif not line.strip():
-            continue
-        else:
-            logs += ["<parse fail>: " + line.strip()]
-            extra = None
 
-        warnings.append(KdocWarning.from_text(line, extra))
+        # Parse line into warning object
+        warning = KdocWarning.from_text(line, extra);
+
+        if not warning.parsed:
+            logs += [f'<parse fail>: {line.strip()}']
+
+        warnings.append(warning)
 
     return warnings