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
|
# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the 'License'). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# https://aws.amazon.com/apache2.0/
#
# or in the 'license' file accompanying this file. This file is
# distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
import pytest
from boto3.exceptions import ResourceLoadException
from boto3.resources.base import ResourceMeta, ServiceResource
from boto3.resources.model import Request
from boto3.resources.params import (
build_param_structure,
create_request_parameters,
)
from tests import BaseTestCase, mock
class TestServiceActionParams(BaseTestCase):
def test_service_action_params_identifier(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [
{
'target': 'WarehouseUrl',
'source': 'identifier',
'name': 'Url',
}
],
}
)
parent = mock.Mock()
parent.url = 'w-url'
params = create_request_parameters(parent, request_model)
assert params['WarehouseUrl'] == 'w-url'
def test_service_action_params_data_member(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [
{
'target': 'WarehouseUrl',
'source': 'data',
'path': 'SomeMember',
}
],
}
)
parent = mock.Mock()
parent.meta = ResourceMeta('test', data={'SomeMember': 'w-url'})
params = create_request_parameters(parent, request_model)
assert params['WarehouseUrl'] == 'w-url'
def test_service_action_params_data_member_missing(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [
{
'target': 'WarehouseUrl',
'source': 'data',
'path': 'SomeMember',
}
],
}
)
parent = mock.Mock()
def load_data():
parent.meta.data = {'SomeMember': 'w-url'}
parent.load.side_effect = load_data
parent.meta = ResourceMeta('test')
params = create_request_parameters(parent, request_model)
parent.load.assert_called_with()
assert params['WarehouseUrl'] == 'w-url'
def test_service_action_params_data_member_missing_no_load(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [
{
'target': 'WarehouseUrl',
'source': 'data',
'path': 'SomeMember',
}
],
}
)
# This mock has no ``load`` method.
parent = mock.Mock(spec=ServiceResource)
parent.meta = ResourceMeta('test', data=None)
with pytest.raises(ResourceLoadException):
create_request_parameters(parent, request_model)
def test_service_action_params_constants(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [
{
'target': 'Param1',
'source': 'string',
'value': 'param1',
},
{'target': 'Param2', 'source': 'integer', 'value': 123},
{'target': 'Param3', 'source': 'boolean', 'value': True},
],
}
)
params = create_request_parameters(None, request_model)
assert params['Param1'] == 'param1'
assert params['Param2'] == 123
assert params['Param3'] is True
def test_service_action_params_input(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [{'target': 'Param1', 'source': 'input'}],
}
)
params = create_request_parameters(None, request_model)
assert params == {}
params['param1'] = 'myinput'
params = create_request_parameters(None, request_model, params=params)
assert params == {'param1': 'myinput'}
def test_service_action_params_invalid(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [{'target': 'Param1', 'source': 'invalid'}],
}
)
with pytest.raises(NotImplementedError):
create_request_parameters(None, request_model)
def test_service_action_params_list(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [
{
'target': 'WarehouseUrls[0]',
'source': 'string',
'value': 'w-url',
}
],
}
)
params = create_request_parameters(None, request_model)
assert isinstance(params['WarehouseUrls'], list)
assert len(params['WarehouseUrls']) == 1
assert 'w-url' in params['WarehouseUrls']
def test_service_action_params_reuse(self):
request_model = Request(
{
'operation': 'GetFrobs',
'params': [
{
'target': 'Delete.Objects[].Key',
'source': 'data',
'path': 'Key',
}
],
}
)
item1 = mock.Mock()
item1.meta = ResourceMeta('test', data={'Key': 'item1'})
item2 = mock.Mock()
item2.meta = ResourceMeta('test', data={'Key': 'item2'})
# Here we create params and then re-use it to build up a more
# complex structure over multiple calls.
params = create_request_parameters(item1, request_model)
create_request_parameters(item2, request_model, params=params)
assert params == {
'Delete': {'Objects': [{'Key': 'item1'}, {'Key': 'item2'}]}
}
class TestStructBuilder(BaseTestCase):
def test_simple_value(self):
params = {}
build_param_structure(params, 'foo', 'bar')
assert params['foo'] == 'bar'
def test_nested_dict(self):
params = {}
build_param_structure(params, 'foo.bar.baz', 123)
assert params['foo']['bar']['baz'] == 123
def test_nested_list(self):
params = {}
build_param_structure(params, 'foo.bar[0]', 'test')
assert params['foo']['bar'][0] == 'test'
def test_strange_offset(self):
params = {}
build_param_structure(params, 'foo[2]', 'test')
assert params['foo'] == [{}, {}, 'test']
def test_nested_list_dict(self):
params = {}
build_param_structure(params, 'foo.bar[0].baz', 123)
assert params['foo']['bar'][0]['baz'] == 123
def test_modify_existing(self):
params = {'foo': [{'key': 'abc'}]}
build_param_structure(params, 'foo[0].secret', 123)
assert params['foo'][0]['key'] == 'abc'
assert params['foo'][0]['secret'] == 123
def test_append_no_index(self):
params = {}
build_param_structure(params, 'foo[]', 123)
assert params['foo'] == [123]
build_param_structure(params, 'foo[]', 456)
assert params['foo'] == [123, 456]
def test_provided_index_with_wildcard(self):
params = {}
index = 0
build_param_structure(params, 'foo[*].bar', 123, index)
build_param_structure(params, 'foo[*].baz', 456, index)
assert params['foo'][index] == {'bar': 123, 'baz': 456}
index = 1
build_param_structure(params, 'foo[*].bar', 789, index)
build_param_structure(params, 'foo[*].baz', 123, index)
assert params['foo'] == [
{'bar': 123, 'baz': 456},
{'bar': 789, 'baz': 123},
]
|