Fix rich exception with tasks containing square brackets (ansible#2510)

Fixes: ansible#2507
ssbarnea · Oct 4, 2022 · e1b398b · e1b398b
1 parent 8dfa3dc
commit e1b398b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/ansiblelint/formatters/__init__.py b/src/ansiblelint/formatters/__init__.py
@@ -66,7 +66,7 @@ def format(self, match: MatchError) -> str:
             f"[filename]{self._format_path(match.filename or '')}[/]:{match.position}"
         )
         if match.details:
-            result += f" [dim]{match.details}[/]"
+            result += f" [dim]{self.escape(str(match.details))}[/]"
         result += "\n"
         return result
 

diff --git a/test/test_formatter.py b/test/test_formatter.py
@@ -28,14 +28,16 @@
 rule = AnsibleLintRule()
 rule.id = "TCF0001"
 formatter = Formatter(pathlib.Path.cwd(), display_relative_path=True)
+# These details would generate a rich rendering error if not escaped:
+DETAILS = "Some [/tmp/foo] details."
 
 
 def test_format_coloured_string() -> None:
     """Test formetting colored."""
     match = MatchError(
         message="message",
         linenumber=1,
-        details="hello",
+        details=DETAILS,
         filename=Lintable("filename.yml"),
         rule=rule,
     )
@@ -47,7 +49,7 @@ def test_unicode_format_string() -> None:
     match = MatchError(
         message="\U0001f427",
         linenumber=1,
-        details="hello",
+        details=DETAILS,
         filename=Lintable("filename.yml"),
         rule=rule,
     )