added proper escaping

Author: Andrei Neagu

packages/service-integration/src/service_integration/cli/_escaping.py

@@ -1,3 +1,4 @@
+import re
 from pathlib import Path
 from typing import Annotated
 
@@ -6,6 +7,24 @@
 from ..osparc_config import OSPARC_CONFIG_DIRNAME
 
 
+def escape_dollar_brace(text: str) -> str:
+    """
+    Replaces all '$${' sequences with '$$$${' unless they are part of an
+    existing '$$$${' sequence.
+
+    Args:
+      text: The input string.
+
+    Returns:
+      The modified string. This function will NOT return None.
+    """
+    # The pattern finds '$${' that is not preceded by another '$'.
+    pattern = r"(?<!\$)\$\${"
+    replacement = "$$$${"
+
+    return re.sub(pattern, replacement, text)
+
+
 def legacy_escape(
     osparc_config_dirname: Annotated[
         Path,
@@ -18,7 +37,7 @@ def legacy_escape(
     """Escapes the `$${` with `$$$${` in all .y*ml files in the osparc config directory."""
     for file in osparc_config_dirname.glob("*.y*ml"):
         read_text = file.read_text()
-        replaced_text = read_text.replace("$${", "$$$${")
+        replaced_text = escape_dollar_brace(read_text)
         if read_text != replaced_text:
             print(f"Escaped sequnce in {file}")
         file.write_text(replaced_text)

packages/service-integration/tests/test_cli__escaping.py

@@ -0,0 +1,20 @@
+import pytest
+from service_integration.cli._escaping import escape_dollar_brace
+
+
+@pytest.mark.parametrize(
+    "to_escape, escaped",
+    [
+        ("some text", "some text"),
+        ("$${escapes}", "$$$${escapes}"),
+        ("$$${preserves}", "$$${preserves}"),
+        ("$$$${preserves}", "$$$${preserves}"),
+        ("$$$$${preserves}", "$$$$${preserves}"),
+        (
+            "$${escapes} & $$${preserves},$$$${preserves}, $$$$${preserves}",
+            "$$$${escapes} & $$${preserves},$$$${preserves}, $$$$${preserves}",
+        ),
+    ],
+)
+def test_escape_dollar_brace(to_escape: str, escaped: str):
+    assert escape_dollar_brace(to_escape) == escaped