Fix multiline jinja pattern in schema (#2775)

ssbarnea · web-flow · commit 14393aca5b6b · 2022-12-03T20:18:35.000Z
Fixes: #2772
diff --git a/src/ansiblelint/schemas/__main__.py b/src/ansiblelint/schemas/__main__.py
@@ -2,7 +2,7 @@
 # pragma: no cover
 import sys
 
-from .main import refresh_schemas
+from ansiblelint.schemas.main import refresh_schemas
 
 if __name__ == "__main__":
 
diff --git a/src/ansiblelint/schemas/ansible.json b/src/ansiblelint/schemas/ansible.json
@@ -248,7 +248,7 @@
       "title": "Environment"
     },
     "full-jinja": {
-      "pattern": "^\\{\\{.*\\}\\}$",
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$",
       "type": "string"
     },
     "ignore_errors": {
diff --git a/src/ansiblelint/schemas/playbook.json b/src/ansiblelint/schemas/playbook.json
@@ -259,7 +259,7 @@
       "title": "Environment"
     },
     "full-jinja": {
-      "pattern": "^\\{\\{.*\\}\\}$",
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$",
       "type": "string"
     },
     "ignore_errors": {
diff --git a/src/ansiblelint/schemas/tasks.json b/src/ansiblelint/schemas/tasks.json
@@ -211,7 +211,7 @@
       "title": "Environment"
     },
     "full-jinja": {
-      "pattern": "^\\{\\{.*\\}\\}$",
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$",
       "type": "string"
     },
     "ignore_errors": {
diff --git a/test/schemas/negative_test/playbooks/environment.yml.md b/test/schemas/negative_test/playbooks/environment.yml.md
@@ -59,9 +59,9 @@
   {
     "instancePath": "/0/environment",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -128,7 +128,7 @@ stdout:
         },
         {
           "path": "$[0].environment",
-          "message": "'{{ foo }}-123' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'{{ foo }}-123' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         }
       ]
     }
diff --git a/test/schemas/negative_test/playbooks/ignore_errors.yml.md b/test/schemas/negative_test/playbooks/ignore_errors.yml.md
@@ -59,9 +59,9 @@
   {
     "instancePath": "/0/tasks/0/ignore_errors",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -95,9 +95,9 @@
   {
     "instancePath": "/0/tasks/0/ignore_errors",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -177,7 +177,7 @@ stdout:
         },
         {
           "path": "$[0].tasks[0].ignore_errors",
-          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].tasks[0].ignore_errors",
@@ -189,7 +189,7 @@ stdout:
         },
         {
           "path": "$[0].tasks[0].ignore_errors",
-          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].tasks[0]",
diff --git a/test/schemas/negative_test/playbooks/invalid-serial.yml.md b/test/schemas/negative_test/playbooks/invalid-serial.yml.md
@@ -68,9 +68,9 @@
   {
     "instancePath": "/0/serial",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -163,7 +163,7 @@ stdout:
         },
         {
           "path": "$[0].serial",
-          "message": "'10%BAD' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'10%BAD' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].serial",
diff --git a/test/schemas/negative_test/playbooks/invalid_become.yml.md b/test/schemas/negative_test/playbooks/invalid_become.yml.md
@@ -59,9 +59,9 @@
   {
     "instancePath": "/0/become",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -130,7 +130,7 @@ stdout:
         },
         {
           "path": "$[0].become",
-          "message": "'yes' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'yes' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         }
       ]
     }
diff --git a/test/schemas/negative_test/playbooks/no_log_partial_template.yml.md b/test/schemas/negative_test/playbooks/no_log_partial_template.yml.md
@@ -59,9 +59,9 @@
   {
     "instancePath": "/0/tasks/0/no_log",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -95,9 +95,9 @@
   {
     "instancePath": "/0/tasks/0/no_log",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -177,7 +177,7 @@ stdout:
         },
         {
           "path": "$[0].tasks[0].no_log",
-          "message": "'foo-{{ some_var }}' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'foo-{{ some_var }}' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].tasks[0].no_log",
@@ -189,7 +189,7 @@ stdout:
         },
         {
           "path": "$[0].tasks[0].no_log",
-          "message": "'foo-{{ some_var }}' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'foo-{{ some_var }}' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].tasks[0]",
diff --git a/test/schemas/negative_test/playbooks/no_log_string.yml.md b/test/schemas/negative_test/playbooks/no_log_string.yml.md
@@ -59,9 +59,9 @@
   {
     "instancePath": "/0/tasks/0/no_log",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -95,9 +95,9 @@
   {
     "instancePath": "/0/tasks/0/no_log",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -177,7 +177,7 @@ stdout:
         },
         {
           "path": "$[0].tasks[0].no_log",
-          "message": "'some_var' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'some_var' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].tasks[0].no_log",
@@ -189,7 +189,7 @@ stdout:
         },
         {
           "path": "$[0].tasks[0].no_log",
-          "message": "'some_var' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'some_var' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].tasks[0]",
diff --git a/test/schemas/negative_test/playbooks/tasks/args_string.yml.md b/test/schemas/negative_test/playbooks/tasks/args_string.yml.md
@@ -14,9 +14,9 @@
   {
     "instancePath": "/0/args",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -76,7 +76,7 @@ stdout:
         },
         {
           "path": "$[0].args",
-          "message": "'{{ }}123' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'{{ }}123' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0]",
diff --git a/test/schemas/negative_test/playbooks/tasks/become_method_untemplated.yml.md b/test/schemas/negative_test/playbooks/tasks/become_method_untemplated.yml.md
@@ -24,9 +24,9 @@
   {
     "instancePath": "/0/become_method",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -70,9 +70,9 @@
   {
     "instancePath": "/0/become_method",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -123,7 +123,7 @@ stdout:
         },
         {
           "path": "$[0].become_method",
-          "message": "'sudo_var' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'sudo_var' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].become_method",
@@ -135,7 +135,7 @@ stdout:
         },
         {
           "path": "$[0].become_method",
-          "message": "'sudo_var' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'sudo_var' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0]",
diff --git a/test/schemas/negative_test/playbooks/tasks/ignore_errors.yml.md b/test/schemas/negative_test/playbooks/tasks/ignore_errors.yml.md
@@ -14,9 +14,9 @@
   {
     "instancePath": "/0/ignore_errors",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -50,9 +50,9 @@
   {
     "instancePath": "/0/ignore_errors",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -103,7 +103,7 @@ stdout:
         },
         {
           "path": "$[0].ignore_errors",
-          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].ignore_errors",
@@ -115,7 +115,7 @@ stdout:
         },
         {
           "path": "$[0].ignore_errors",
-          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'should_ignore_errors' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0]",
diff --git a/test/schemas/negative_test/playbooks/tasks/no_log_string.yml.md b/test/schemas/negative_test/playbooks/tasks/no_log_string.yml.md
@@ -14,9 +14,9 @@
   {
     "instancePath": "/0/no_log",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -50,9 +50,9 @@
   {
     "instancePath": "/0/no_log",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -103,7 +103,7 @@ stdout:
         },
         {
           "path": "$[0].no_log",
-          "message": "'some_var' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'some_var' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].no_log",
@@ -115,7 +115,7 @@ stdout:
         },
         {
           "path": "$[0].no_log",
-          "message": "'some_var' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'some_var' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0]",
diff --git a/test/schemas/negative_test/playbooks/tasks/with_items_untemplated_string.yml.md b/test/schemas/negative_test/playbooks/tasks/with_items_untemplated_string.yml.md
@@ -5,9 +5,9 @@
   {
     "instancePath": "/0/with_items",
     "keyword": "pattern",
-    "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",
+    "message": "must match pattern \"^\\{\\{(.|[\r\n])*\\}\\}$\"",
     "params": {
-      "pattern": "^\\{\\{.*\\}\\}$"
+      "pattern": "^\\{\\{(.|[\r\n])*\\}\\}$"
     },
     "schemaPath": "#/$defs/full-jinja/pattern"
   },
@@ -70,7 +70,7 @@ stdout:
         },
         {
           "path": "$[0].with_items",
-          "message": "'foobar' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"
+          "message": "'foobar' does not match '^\\\\{\\\\{(.|[\\r\\n])*\\\\}\\\\}$'"
         },
         {
           "path": "$[0].with_items",
diff --git a/test/schemas/test/playbooks/full-jinja.yml b/test/schemas/test/playbooks/full-jinja.yml

Original file line number	Diff line number	Diff line change
`@@ -59,9 +59,9 @@`
`59`	`59`	`{`
`60`	`60`	`"instancePath": "/0/environment",`
`61`	`61`	`"keyword": "pattern",`
`62`		`- "message": "must match pattern \"^\\{\\{.*\\}\\}$\"",`
	`62`	`+ "message": "must match pattern \"^\\{\\{(.\|[\r\n])*\\}\\}$\"",`
`63`	`63`	`"params": {`
`64`		`- "pattern": "^\\{\\{.*\\}\\}$"`
	`64`	`+ "pattern": "^\\{\\{(.\|[\r\n])*\\}\\}$"`
`65`	`65`	`},`
`66`	`66`	`"schemaPath": "#/$defs/full-jinja/pattern"`
`67`	`67`	`},`
`@@ -128,7 +128,7 @@ stdout:`
`128`	`128`	`},`
`129`	`129`	`{`
`130`	`130`	`"path": "$[0].environment",`
`131`		`- "message": "'{{ foo }}-123' does not match '^\\\\{\\\\{.*\\\\}\\\\}$'"`
	`131`	`+ "message": "'{{ foo }}-123' does not match '^\\\\{\\\\{(.\|[\\r\\n])*\\\\}\\\\}$'"`
`132`	`132`	`}`
`133`	`133`	`]`
`134`	`134`	`}`