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
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License 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 mock
from openstack.tests.unit import base
class TestProxyBase(base.TestCase):
def setUp(self):
super(TestProxyBase, self).setUp()
self.session = mock.Mock()
def _add_path_args_for_verify(self, path_args, method_args,
expected_kwargs):
if path_args is not None:
for key in path_args:
method_args.append(path_args[key])
expected_kwargs['path_args'] = path_args
def _verify(self, mock_method, test_method,
method_args=None, method_kwargs=None,
expected_args=None, expected_kwargs=None,
expected_result=None):
with mock.patch(mock_method) as mocked:
mocked.return_value = expected_result
if any([method_args, method_kwargs,
expected_args, expected_kwargs]):
method_args = method_args or ()
method_kwargs = method_kwargs or {}
expected_args = expected_args or ()
expected_kwargs = expected_kwargs or {}
self.assertEqual(expected_result, test_method(*method_args,
**method_kwargs))
mocked.assert_called_with(self.session,
*expected_args, **expected_kwargs)
else:
self.assertEqual(expected_result, test_method())
mocked.assert_called_with(self.session)
# NOTE(briancurtin): This is a duplicate version of _verify that is
# temporarily here while we shift APIs. The difference is that
# calls from the Proxy classes aren't going to be going directly into
# the Resource layer anymore, so they don't pass in the session which
# was tested in assert_called_with.
# This is being done in lieu of adding logic and complicating
# the _verify method. It will be removed once there is one API to
# be verifying.
def _verify2(self, mock_method, test_method,
method_args=None, method_kwargs=None,
expected_args=None, expected_kwargs=None,
expected_result=None):
with mock.patch(mock_method) as mocked:
mocked.return_value = expected_result
if any([method_args, method_kwargs,
expected_args, expected_kwargs]):
method_args = method_args or ()
method_kwargs = method_kwargs or {}
expected_args = expected_args or ()
expected_kwargs = expected_kwargs or {}
self.assertEqual(expected_result, test_method(*method_args,
**method_kwargs))
mocked.assert_called_with(*expected_args, **expected_kwargs)
else:
self.assertEqual(expected_result, test_method())
mocked.assert_called_with(self.session)
def verify_create(self, test_method, resource_type,
mock_method="openstack.proxy.BaseProxy._create",
expected_result="result", **kwargs):
the_kwargs = {"x": 1, "y": 2, "z": 3}
method_kwargs = kwargs.pop("method_kwargs", the_kwargs)
expected_args = [resource_type]
expected_kwargs = kwargs.pop("expected_kwargs", the_kwargs)
self._verify2(mock_method, test_method,
expected_result=expected_result,
method_kwargs=method_kwargs,
expected_args=expected_args,
expected_kwargs=expected_kwargs,
**kwargs)
def verify_delete(self, test_method, resource_type, ignore,
input_path_args=None, expected_path_args=None,
mock_method="openstack.proxy.BaseProxy._delete"):
method_kwargs = {"ignore_missing": ignore}
if isinstance(input_path_args, dict):
for key in input_path_args:
method_kwargs[key] = input_path_args[key]
expected_kwargs = {"ignore_missing": ignore}
if expected_path_args:
expected_kwargs["path_args"] = expected_path_args
self._verify2(mock_method, test_method,
method_args=["resource_or_id"],
method_kwargs=method_kwargs,
expected_args=[resource_type, "resource_or_id"],
expected_kwargs=expected_kwargs)
def verify_get(self, test_method, resource_type, value=None, args=None,
mock_method="openstack.proxy.BaseProxy._get",
ignore_value=False, **kwargs):
the_value = value
if value is None:
the_value = [] if ignore_value else ["value"]
expected_kwargs = kwargs.pop("expected_kwargs", {})
method_kwargs = kwargs.pop("method_kwargs", kwargs)
if args:
expected_kwargs["args"] = args
if kwargs:
expected_kwargs["path_args"] = kwargs
self._verify2(mock_method, test_method,
method_args=the_value,
method_kwargs=method_kwargs or {},
expected_args=[resource_type] + the_value,
expected_kwargs=expected_kwargs)
def verify_head(self, test_method, resource_type,
mock_method="openstack.proxy.BaseProxy._head",
value=None, **kwargs):
the_value = [value] if value is not None else []
expected_kwargs = {"path_args": kwargs} if kwargs else {}
self._verify2(mock_method, test_method,
method_args=the_value,
method_kwargs=kwargs,
expected_args=[resource_type] + the_value,
expected_kwargs=expected_kwargs)
def verify_find(self, test_method, resource_type, path_args=None,
mock_method="openstack.proxy.BaseProxy._find", **kwargs):
method_args = ["name_or_id"]
expected_kwargs = {}
self._add_path_args_for_verify(path_args, method_args, expected_kwargs)
# TODO(briancurtin): if sub-tests worked in this mess of
# test dependencies, the following would be a lot easier to work with.
expected_kwargs["ignore_missing"] = False
self._verify2(mock_method, test_method,
method_args=method_args + [False],
expected_args=[resource_type, "name_or_id"],
expected_kwargs=expected_kwargs,
expected_result="result",
**kwargs)
expected_kwargs["ignore_missing"] = True
self._verify2(mock_method, test_method,
method_args=method_args + [True],
expected_args=[resource_type, "name_or_id"],
expected_kwargs=expected_kwargs,
expected_result="result",
**kwargs)
def verify_list(self, test_method, resource_type, paginated=False,
mock_method="openstack.proxy.BaseProxy._list",
**kwargs):
expected_kwargs = kwargs.pop("expected_kwargs", {})
expected_kwargs.update({"paginated": paginated})
expected_kwargs['limit'] = 2
method_kwargs = kwargs.pop("method_kwargs", {})
method_kwargs['limit'] = 2
self._verify2(mock_method, test_method,
method_kwargs=method_kwargs,
expected_args=[resource_type],
expected_kwargs=expected_kwargs,
expected_result=["result"],
**kwargs)
def verify_list_no_kwargs(self, test_method, resource_type,
paginated=False,
mock_method="openstack.proxy.BaseProxy._list"):
self._verify2(mock_method, test_method,
method_kwargs={},
expected_args=[resource_type],
expected_kwargs={"paginated": paginated},
expected_result=["result"])
def verify_update(self, test_method, resource_type,
mock_method="openstack.proxy.BaseProxy._update",
expected_result="result", path_args=None, **kwargs):
the_kwargs = {"x": 1, "y": 2, "z": 3}
method_args = ["resource_or_id"]
method_kwargs = the_kwargs.copy()
expected_args = [resource_type, "resource_or_id"]
expected_kwargs = the_kwargs.copy()
self._add_path_args_for_verify(path_args, method_args, expected_kwargs)
self._verify2(mock_method, test_method,
expected_result=expected_result,
method_args=method_args,
method_kwargs=method_kwargs,
expected_args=expected_args,
expected_kwargs=expected_kwargs,
**kwargs)
def verify_wait_for_status(
self, test_method,
mock_method="openstack.resource.wait_for_status", **kwargs):
self._verify(mock_method, test_method, **kwargs)
|
