root / snf-django-lib / snf_django / utils / testing.py @ c9a2aff3
History | View | Annotate | Download (9.6 kB)
1 |
# Copyright 2011-2013 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# interpreted as representing official policies, either expressed
|
32 |
# or implied, of GRNET S.A.
|
33 |
|
34 |
|
35 |
from contextlib import contextmanager |
36 |
from django.test import TestCase |
37 |
from django.utils import simplejson as json |
38 |
from synnefo.util.text import uenc |
39 |
from mock import patch |
40 |
|
41 |
|
42 |
@contextmanager
|
43 |
def override_settings(settings, **kwargs): |
44 |
"""
|
45 |
Helper context manager to override django settings within the provided
|
46 |
context.
|
47 |
|
48 |
All keyword arguments provided are set to the django settings object and
|
49 |
get reverted/removed when the manager exits.
|
50 |
|
51 |
>>> from synnefo.util.testing import override_settings
|
52 |
>>> from django.conf import settings
|
53 |
>>> with override_settings(settings, DEBUG=True):
|
54 |
>>> assert settings.DEBUG == True
|
55 |
|
56 |
The special arguemnt ``prefix`` can be set to prefix all setting keys with
|
57 |
the provided value.
|
58 |
|
59 |
>>> from django.conf import settings
|
60 |
>>> from django.core import mail
|
61 |
>>> with override_settings(settings, CONTACT_EMAILS=['kpap@grnet.gr'],
|
62 |
>>> prefix='MYAPP_'):
|
63 |
>>> from django.core.mail import send_mail
|
64 |
>>> send_mail("hello", "I love you kpap", settings.DEFAULT_FROM_EMAIL,
|
65 |
>>> settings.MYAPP_CONTACT_EMAILS)
|
66 |
>>> assert 'kpap@grnet.gr' in mail.mailbox[0].recipients()
|
67 |
|
68 |
If you plan to reuse it
|
69 |
|
70 |
>>> import functools
|
71 |
>>> from synnefo.util.testing import override_settings
|
72 |
>>> from django.conf import settings
|
73 |
>>> myapp_settings = functools.partial(override_settings, prefix='MYAPP_')
|
74 |
>>> with myapp_settings(CONTACT_EMAILS=['kpap@grnet.gr'])
|
75 |
>>> assert settings.MYAPP_CONTACT_EMAILS == ['kpap@grnet.gr']
|
76 |
|
77 |
"""
|
78 |
|
79 |
_prefix = kwargs.get('prefix', '') |
80 |
prefix = lambda key: '%s%s' % (_prefix, key) |
81 |
|
82 |
oldkeys = [k for k in dir(settings) if k.upper() == k] |
83 |
oldsettings = dict([(k, getattr(settings, k)) for k in oldkeys]) |
84 |
|
85 |
toremove = [] |
86 |
for key, value in kwargs.iteritems(): |
87 |
key = prefix(key) |
88 |
if not hasattr(settings, key): |
89 |
toremove.append(key) |
90 |
setattr(settings, key, value)
|
91 |
|
92 |
yield
|
93 |
|
94 |
# Remove keys that didn't exist
|
95 |
for key in toremove: |
96 |
delattr(settings, key)
|
97 |
|
98 |
# Remove keys that added during the execution of the context
|
99 |
if kwargs.get('reset_changes', True): |
100 |
newkeys = [k for k in dir(settings) if k.upper() == k] |
101 |
for key in newkeys: |
102 |
if not key in oldkeys: |
103 |
delattr(settings, key)
|
104 |
|
105 |
# Revert old keys
|
106 |
for key in oldkeys: |
107 |
if key == key.upper():
|
108 |
setattr(settings, key, oldsettings.get(key))
|
109 |
|
110 |
|
111 |
def with_settings(settings, prefix='', **override): |
112 |
def wrapper(func): |
113 |
def inner(*args, **kwargs): |
114 |
with override_settings(settings, prefix=prefix, **override):
|
115 |
ret = func(*args, **kwargs) |
116 |
return ret
|
117 |
return inner
|
118 |
return wrapper
|
119 |
|
120 |
serial = 0
|
121 |
|
122 |
|
123 |
@contextmanager
|
124 |
def astakos_user(user): |
125 |
"""
|
126 |
Context manager to mock astakos response.
|
127 |
|
128 |
usage:
|
129 |
with astakos_user("user@user.com"):
|
130 |
.... make api calls ....
|
131 |
|
132 |
"""
|
133 |
with patch("snf_django.lib.api.get_token") as get_token: |
134 |
get_token.return_value = "DummyToken"
|
135 |
with patch('astakosclient.AstakosClient.get_user_info') as m: |
136 |
m.return_value = {"uuid": uenc(user, 'utf8')} |
137 |
with patch('astakosclient.AstakosClient.get_quotas') as m2: |
138 |
m2.return_value = { |
139 |
"system": {
|
140 |
"pithos.diskspace": {
|
141 |
"usage": 0, |
142 |
"limit": 1073741824, # 1GB |
143 |
"pending": 0 |
144 |
} |
145 |
} |
146 |
} |
147 |
with patch('astakosclient.AstakosClient.issue_one_commission') as m3: |
148 |
serials = [] |
149 |
append = serials.append |
150 |
|
151 |
def get_serial(*args, **kwargs): |
152 |
global serial
|
153 |
serial += 1
|
154 |
append(serial) |
155 |
return serial
|
156 |
|
157 |
m3.side_effect = get_serial |
158 |
with patch('astakosclient.AstakosClient.resolve_commissions') as m4: |
159 |
m4.return_value = {'accepted': serials,
|
160 |
'rejected': [],
|
161 |
'failed': []}
|
162 |
with patch('astakosclient.AstakosClient.get_usernames') as m5: |
163 |
|
164 |
def get_usernames(*args, **kwargs): |
165 |
uuids = args[-1]
|
166 |
return dict((uuid, uuid) for uuid in uuids) |
167 |
|
168 |
m5.side_effect = get_usernames |
169 |
yield
|
170 |
|
171 |
|
172 |
@contextmanager
|
173 |
def mocked_quotaholder(success=True): |
174 |
with patch("synnefo.quotas.Quotaholder.get") as astakos: |
175 |
global serial
|
176 |
serial += 10
|
177 |
|
178 |
def foo(*args, **kwargs): |
179 |
return (len(astakos.return_value.issue_one_commission.mock_calls) + |
180 |
serial) |
181 |
astakos.return_value.issue_one_commission.side_effect = foo |
182 |
astakos.return_value.resolve_commissions.return_value = {"failed": []}
|
183 |
yield astakos.return_value
|
184 |
|
185 |
|
186 |
class BaseAPITest(TestCase): |
187 |
def get(self, url, user='user', *args, **kwargs): |
188 |
with astakos_user(user):
|
189 |
with mocked_quotaholder():
|
190 |
response = self.client.get(url, *args, **kwargs)
|
191 |
return response
|
192 |
|
193 |
def delete(self, url, user='user'): |
194 |
with astakos_user(user):
|
195 |
with mocked_quotaholder():
|
196 |
response = self.client.delete(url)
|
197 |
return response
|
198 |
|
199 |
def post(self, url, user='user', params={}, ctype='json', *args, **kwargs): |
200 |
if ctype == 'json': |
201 |
content_type = 'application/json'
|
202 |
with astakos_user(user):
|
203 |
with mocked_quotaholder():
|
204 |
response = self.client.post(url, params,
|
205 |
content_type=content_type, |
206 |
*args, **kwargs) |
207 |
return response
|
208 |
|
209 |
def put(self, url, user='user', params={}, ctype='json', *args, **kwargs): |
210 |
if ctype == 'json': |
211 |
content_type = 'application/json'
|
212 |
with astakos_user(user):
|
213 |
with mocked_quotaholder():
|
214 |
response = self.client.put(url, params,
|
215 |
content_type=content_type, |
216 |
*args, **kwargs) |
217 |
return response
|
218 |
|
219 |
def assertSuccess(self, response): |
220 |
self.assertTrue(response.status_code in [200, 202, 203, 204]) |
221 |
|
222 |
def assertFault(self, response, status_code, name): |
223 |
self.assertEqual(response.status_code, status_code)
|
224 |
fault = json.loads(response.content) |
225 |
self.assertEqual(fault.keys(), [name])
|
226 |
|
227 |
def assertBadRequest(self, response): |
228 |
self.assertFault(response, 400, 'badRequest') |
229 |
|
230 |
def assertItemNotFound(self, response): |
231 |
self.assertFault(response, 404, 'itemNotFound') |
232 |
|
233 |
def assertMethodNotAllowed(self, response): |
234 |
self.assertFault(response, 400, 'badRequest') |
235 |
try:
|
236 |
error = json.loads(response.content) |
237 |
except ValueError: |
238 |
self.assertTrue(False) |
239 |
self.assertEqual(error['badRequest']['message'], 'Method not allowed') |
240 |
|
241 |
|
242 |
# Imitate unittest assertions new in Python 2.7
|
243 |
|
244 |
class _AssertRaisesContext(object): |
245 |
"""
|
246 |
A context manager used to implement TestCase.assertRaises* methods.
|
247 |
Adapted from unittest2.
|
248 |
"""
|
249 |
|
250 |
def __init__(self, expected): |
251 |
self.expected = expected
|
252 |
|
253 |
def __enter__(self): |
254 |
return self |
255 |
|
256 |
def __exit__(self, exc_type, exc_value, tb): |
257 |
if exc_type is None: |
258 |
try:
|
259 |
exc_name = self.expected.__name__
|
260 |
except AttributeError: |
261 |
exc_name = str(self.expected) |
262 |
raise AssertionError( |
263 |
"%s not raised" % (exc_name,))
|
264 |
if not issubclass(exc_type, self.expected): |
265 |
# let unexpected exceptions pass through
|
266 |
return False |
267 |
self.exception = exc_value # store for later retrieval |
268 |
return True |
269 |
|
270 |
|
271 |
def assertRaises(excClass): |
272 |
return _AssertRaisesContext(excClass)
|
273 |
|
274 |
|
275 |
def assertGreater(x, y): |
276 |
assert x > y
|
277 |
|
278 |
|
279 |
def assertIn(x, y): |
280 |
assert x in y |