Merge pull request #7 from PMCC-BioinformaticsCore/sanitise-parammeta

Sanitise param meta + other values

tests/test_common.py

@@ -0,0 +1,17 @@
+import unittest
+
+from wdlgen import ParameterMeta
+
+
+class TestParamMeta(unittest.TestCase):
+    def test_quote_sanitise(self):
+        meta = ParameterMeta(foo='"bar"').get_string()
+        self.assertEqual('foo: "\\"bar\\""', meta)
+
+    def test_nl_sanitise(self):
+        meta = ParameterMeta(foo="bar\nbaz").get_string()
+        self.assertEqual('foo: "bar\\nbaz"', meta)
+
+    def test_backslackquote_sanitise(self):
+        meta = ParameterMeta(foo='bar\\"').get_string()
+        self.assertEqual('foo: "bar\\\\\\""', meta)

wdlgen/util.py

@@ -14,7 +14,12 @@ def convert_python_value_to_wdl_literal(val) -> str:
     if isinstance(val, bool):
         return "true" if val else "false"
     if isinstance(val, str):
-        return f'"{val}"'
+        # sanitise string here
+        sanitised = val\
+            .replace("\\", "\\\\")\
+            .replace("\n", "\\n")\
+            .replace('"', '\\"')
+        return f'"{sanitised}"'
 
     return str(val)