This repository was archived by the owner on Mar 23, 2026. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Expand file tree
/
Copy pathtest_templating.py
More file actions
277 lines (240 loc) · 10.3 KB
/
Copy pathtest_templating.py
File metadata and controls
277 lines (240 loc) · 10.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
import json
import re
from localstack.services.apigateway.legacy.templates import ApiGatewayVtlTemplate
from localstack.utils.aws.templating import render_velocity_template
# template used to transform incoming requests at the API Gateway (forward to Kinesis)
APIGW_TEMPLATE_TRANSFORM_KINESIS = """{
"StreamName": "stream-1",
"Records": [
#set( $numRecords = $input.path('$.records').size() )
#if($numRecords > 0)
#set( $maxIndex = $numRecords - 1 )
#foreach( $idx in [0..$maxIndex] )
#set( $elem = $input.path("$.records[${idx}]") )
#set( $elemJsonB64 = $util.base64Encode($input.json("$.records[${idx}].data")) )
{
"Data": "$elemJsonB64",
"PartitionKey": #if( $elem.partitionKey != '')"$elem.partitionKey"
#else"$elemJsonB64"#end
}#if($foreach.hasNext),#end
#end
#end
]
}"""
# template used to construct JSON via #define method
APIGW_TEMPLATE_CONSTRUCT_JSON = """
#set( $body = $input.json("$") )
#define( $loop $map )
{
#foreach($key in $map.keySet())
#set( $k = $util.escapeJavaScript($key) )
#set( $v = $util.escapeJavaScript($map.get($key)))
"$k": "$v"
#if( $foreach.hasNext ) , #end
#end
}
#end
{
"p0": true,
"p1": $loop($input.path('$.p1')),
"p2": $loop($input.path('$.p2'))
}
"""
APIGW_TEMPLATE_CUSTOM_BODY = """
#set( $body = $input.json("$") )
#define( $loop )
{
#foreach($key in $map.keySet())
#set( $k = $util.escapeJavaScript($key) )
#set( $v = $util.escapeJavaScript($map.get($key)).replaceAll("\\'", "'") )
"$k": "$v"
#if( $foreach.hasNext ) , #end
#end
}
#end
{
#set( $map = $context.authorizer )
"enhancedAuthContext": $loop,
#set( $map = $input.params().header )
"headers": $loop,
#set( $map = $input.params().querystring )
"query": $loop,
#set( $map = $input.params().path )
"path": $loop,
#set( $map = $context.identity )
"identity": $loop,
#set( $map = $stageVariables )
"stageVariables": $loop,
}
"""
class TestMessageTransformationBasic:
def test_return_macro(self):
template = """
#set($v1 = {})
$v1.put('foo', 'bar')
#return($v1)
"""
result = render_velocity_template(template, {})
expected = {"foo": "bar"}
assert json.loads(result) == expected
def test_quiet_return_function(self):
# render .put(..) without quiet function
template = """
#set($v1 = {})
$v1.put('foo', 'bar1')$v1.put('foo', 'bar2')
#return($v1)
"""
result = render_velocity_template(template, {})
result = re.sub(r"\s+", " ", result).strip()
assert result == 'bar1 {"foo": "bar2"}'
# render .put(..) with quiet function
template = """
#set($v1 = {})\n$v1.put('foo', 'bar1')$util.qr($v1.put('foo', 'bar2'))\n#return($v1)
"""
result = render_velocity_template(template, {})
result = re.sub(r"\s+", " ", result).strip()
assert result == '{"foo": "bar2"}'
def test_quiet_return_put(self):
template = "#set($v1 = {})\n$util.qr($v1.put('value', 'hi2'))\n#return($v1)"
result = render_velocity_template(template, {})
assert json.loads(result) == {"value": "hi2"}
template = "#set($v1 = {})\n$util.qr($v1.put('value', 'hi2'))\n"
result = render_velocity_template(template, {})
assert result.strip() == ""
def test_map_put_all(self):
template = """
#set($v1 = {})
$v1.putAll({'foo1': 'bar', 'foo2': 'bar'})
result: $v1
"""
result = render_velocity_template(template, {})
result = re.sub(r"\s+", " ", result).strip()
assert result == "result: {'foo1': 'bar', 'foo2': 'bar'}"
def test_assign_var_loop_return(self):
template = """
#foreach($x in [1, 2, 3])
#if($x == 1 or $x == 3)
#set($context.return__val = "loop$x")
#set($context.return__flag = true)
#return($context.return__val)
#end
#end
#return('end')
"""
result = render_velocity_template(template, {"context": {}})
result = re.sub(r"\s+", " ", result).strip()
assert result == "loop1 loop3 end"
def test_put_value_to_dict(self):
template = r"""
$util.qr($ctx.test.put("foo", "bar"))
$ctx.test
"""
result = render_velocity_template(template, {"ctx": {"test": {}}})
assert result.strip() == str({"foo": "bar"})
def test_put_value_to_nested_dict(self):
template = r"""
$ctx.test.get('a').get('b').put('foo', 'bar')
$ctx.test.get('a')
"""
wrapped = {"a": {"b": {"c": "foobar"}}}
result = render_velocity_template(template, {"ctx": {"test": wrapped}})
assert result.strip() == str({"b": {"c": "foobar", "foo": "bar"}})
class TestMessageTransformationApiGateway:
def test_construct_json_using_define(self):
template = APIGW_TEMPLATE_CONSTRUCT_JSON
variables = {"input": {"body": {"p1": {"test": 123}, "p2": {"foo": "bar", "foo2": False}}}}
result = ApiGatewayVtlTemplate().render_vtl(template, variables)
result = re.sub(r"\s+", " ", result).strip()
result = json.loads(result)
assert result == {"p0": True, "p1": {"test": "123"}, "p2": {"foo": "bar", "foo2": "false"}}
def test_array_size(self):
template = "#set($list = $input.path('$.records')) $list.size()"
body = {"records": [{"data": {"foo": "bar1"}}, {"data": {"foo": "bar2"}}]}
variables = {
"input": {
"body": body,
},
}
result = ApiGatewayVtlTemplate().render_vtl(template, variables)
assert result == " 2"
def test_message_transformation(self):
template = APIGW_TEMPLATE_TRANSFORM_KINESIS
records = [
{"data": {"foo": "foo1", "bar": "bar2"}},
{"data": {"foo": "foo1", "bar": "bar2"}, "partitionKey": "key123"},
]
variables = {"input": {"body": {"records": records}}}
def do_test(_vars):
res = ApiGatewayVtlTemplate().render_vtl(template, _vars, as_json=True)
data_encoded = res["Records"][0]["Data"]
assert res["Records"][0]["PartitionKey"] == data_encoded
assert res["Records"][1]["PartitionKey"] == "key123"
# try rendering the template
do_test(variables)
# test with empty array
records = []
variables = {"input": {"body": {"records": records}}}
# try rendering the template
result = ApiGatewayVtlTemplate().render_vtl(template, variables, as_json=True)
assert result["Records"] == []
def test_array_in_set_expr(self):
template = "#set ($bar = $input.path('$.foo')[1]) \n $bar"
variables = {"input": {"body": {"foo": ["e1", "e2", "e3", "e4"]}}}
result = ApiGatewayVtlTemplate().render_vtl(template, variables).strip()
assert result == "e2"
template = "#set ($bar = $input.path('$.foo')[1][1][1]) $bar"
variables = {"input": {"body": {"foo": [["e1"], ["e2", ["e3", "e4"]]]}}}
result = ApiGatewayVtlTemplate().render_vtl(template, variables).strip()
assert result == "e4"
def test_string_methods(self):
context = {"foo": {"bar": "BAZ baz"}}
variables = {"input": {"body": context}}
template1 = "${foo.bar.strip().lower().replace(' ','-')}"
template2 = "${foo.bar.trim().toLowerCase().replace(' ','-')}"
template3 = "${foo.bar.toString().lower().replace(' ','-')}"
template4 = '${foo.bar.trim().toLowerCase().replaceAll("^(.*)\\s(.*)$","$1-$2")}'
for template in [template1, template2, template3, template4]:
result = ApiGatewayVtlTemplate().render_vtl(template, variables=variables)
assert result == "baz-baz"
contains_template1 = ("${foo.bar.toString().lower().contains('baz')}", "true")
contains_template2 = ("${foo.bar.toString().lower().contains('bar')}", "false")
for template, expected_result in [contains_template1, contains_template2]:
result = ApiGatewayVtlTemplate().render_vtl(template, variables=variables)
assert result == expected_result
def test_render_urlencoded_string_data(self):
template = "MessageBody=$util.base64Encode($input.json('$'))"
variables = {"input": {"body": {"spam": "eggs"}}}
result = ApiGatewayVtlTemplate().render_vtl(template, variables)
assert result == "MessageBody=eyJzcGFtIjogImVnZ3MifQ=="
def test_keyset_functions(self):
template = "#set($list = $input.path('$..var1[1]').keySet()) #foreach($e in $list)$e#end"
body = {"var1": [{"a": 1}, {"b": 2}]}
variables = {"input": {"body": body}}
result = ApiGatewayVtlTemplate().render_vtl(template, variables)
assert result == " b"
def test_dash_in_variable_name(self):
template = "#set($start = 1)#set($end = 5)#foreach($i in [$start .. $end])$i -#end"
result = ApiGatewayVtlTemplate().render_vtl(template, {})
assert result == "1 -2 -3 -4 -5 -"
template = """
$method.request.header.X-My-Header
"""
variables = {"method": {"request": {"header": {"X-My-Header": "my-header-value"}}}}
result = ApiGatewayVtlTemplate().render_vtl(template, variables).strip()
assert result == "my-header-value"
def test_boolean_in_variable(self):
# Inspired by authorizer context from Lambda authorizer:
# https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html
# The returned values are all stringified. Notice that you cannot set a JSON
# object or array as a valid value of any key in the context map.
template = '{"booleanKeyTrue": $booleanKeyTrue, "booleanKeyFalse": $booleanKeyFalse}'
variables = {
"booleanKeyTrue": "true",
"booleanKeyFalse": "false",
}
result = ApiGatewayVtlTemplate().render_vtl(template, variables)
assert "true" in result
assert "false" in result
assert result == '{"booleanKeyTrue": true, "booleanKeyFalse": false}'
# test is valid json
json.loads(result)