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
|
# -*- coding: utf-8 -*-
# Authors: Natalia B Bidart <natalia.bidart@canonical.com>
#
# Copyright 2011 Canonical Ltd.
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3, as published
# by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
# PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
"""Tests for the uri_hook helper."""
import logging
from PyQt4 import QtGui, QtCore
from twisted.internet import defer
from ubuntuone.controlpanel.logger import setup_logging
from ubuntuone.controlpanel.gui import (
GENERAL_ERROR_TITLE,
GENERAL_ERROR_MSG,
)
from ubuntuone.controlpanel.gui.qt import uri_hook, handle_errors
from ubuntuone.controlpanel.gui.qt.tests import (
BaseTestCase,
FakedDialog,
)
class UriHookTestCase(BaseTestCase):
"""The test suite for the uri_hook."""
@defer.inlineCallbacks
def setUp(self):
yield super(UriHookTestCase, self).setUp()
self.patch(QtGui.QDesktopServices, 'openUrl', self._set_called)
def test_opens_url(self):
"""The url is opened properly."""
expected = 'foo bar'
uri_hook(expected)
self.assertEqual(self._called, ((QtCore.QUrl(expected),), {}))
def test_opens_url_encoded(self):
"""The encoded url is opened properly."""
expected = 'http://foo.bar/?next=https://one.ubuntu.com/'
uri_hook(expected)
self.assertEqual(self._called, ((QtCore.QUrl(expected),), {}))
class HandleErrorTestCase(BaseTestCase):
"""Test suite for the generic error handler."""
error_handler = None
use_logger = False
logger = logging.getLogger() # root logger
@defer.inlineCallbacks
def setUp(self):
yield super(HandleErrorTestCase, self).setUp()
self.called = None
self.result = None
self.failure = None
self.error_handler_called = None
if self.use_logger:
logger = self.logger
else:
logger = None
self.decorate_me = handle_errors(error_handler=self.error_handler,
logger=logger)(self._decorate_me)
@defer.inlineCallbacks
def _decorate_me(self, *args, **kwargs):
"""Helper to test thye decorator."""
if self.failure:
# Raising only classes, instances or string are allowed
# pylint: disable=E0702
raise self.failure
yield
self.called = (args, kwargs)
defer.returnValue(self.result)
def assert_detailed_text_correct(self, expected):
"""Check that the QMessageBox detailed text is correct."""
self.assertIn('detailed_text', FakedDialog.properties)
actual = FakedDialog.properties['detailed_text']
self.assertEqual(expected, actual)
@defer.inlineCallbacks
def test_is_decorator(self):
"""Is a decorator."""
yield self.decorate_me()
@defer.inlineCallbacks
def test_params_are_passed(self):
"""Named and unnamed arguments are passed."""
args = ({}, object(), 'foo')
kwargs = {'1': 1, 'test': None, '0': ['a']}
yield self.decorate_me(*args, **kwargs)
self.assertTrue(self.called, (args, kwargs))
@defer.inlineCallbacks
def test_result_is_returned(self):
"""Result is returned."""
self.result = object()
result = yield self.decorate_me()
self.assertEqual(self.result, result)
def test_name_is_preserved(self):
"""The method name is not masqueraded."""
self.assertEqual(self.decorate_me.__name__, self._decorate_me.__name__)
@defer.inlineCallbacks
def test_exeptions_are_handled(self):
"""Any exception is handled and logged in the root logger."""
msg = 'This is me failing badly.'
self.failure = Exception(msg)
yield self.decorate_me()
logged = self.memento.check_exception(self.failure.__class__, msg)
recs = '\n'.join(rec.exc_text for rec in self.memento.records
if rec.exc_text is not None)
self.assertTrue(logged, 'Exception must be logged, got:\n%s' % recs)
@defer.inlineCallbacks
def test_show_error_message(self):
"""On error, show an error message."""
self.failure = Exception()
yield self.decorate_me()
args = (QtGui.QMessageBox.Critical,
GENERAL_ERROR_TITLE, GENERAL_ERROR_MSG,
QtGui.QMessageBox.Close)
self.assertEqual(FakedDialog.args, args)
self.assertEqual(FakedDialog.kwargs, {'parent': None})
self.assertEqual(FakedDialog.properties['shown'], 1)
@defer.inlineCallbacks
def test_show_error_message_default_button(self):
"""On error, 'Close' is the default button."""
self.failure = Exception()
yield self.decorate_me()
self.assertIn('default_button', FakedDialog.properties)
expected = QtGui.QMessageBox.Close
actual = FakedDialog.properties['default_button']
self.assertEqual(expected, actual)
@defer.inlineCallbacks
def test_show_error_message_detailed_text(self):
"""On error, show optional detailed text."""
self.failure = Exception()
yield self.decorate_me()
expected = self.failure.__class__.__name__
self.assert_detailed_text_correct(expected)
@defer.inlineCallbacks
def test_show_error_message_detailed_text_if_args(self):
"""On error, show an error message."""
msg1 = 'This is me failing badly.'
msg2 = 'More details about what went wrong.'
obj = object()
self.failure = Exception(msg1, msg2, obj)
yield self.decorate_me()
msg = '\n'.join(map(repr, (msg1, msg2, obj)))
msg = self.failure.__class__.__name__ + '\n' + msg
self.assert_detailed_text_correct(msg)
@defer.inlineCallbacks
def test_show_error_message_detailed_text_if_mapping(self):
"""On error, show an error message."""
msg1 = 'This is me failing badly.'
msg2 = 'More details about what went wrong.'
errdict = {'foo': msg1, 'bar': msg2}
self.failure = Exception(errdict)
yield self.decorate_me()
msg = '\n'.join((msg1, msg2))
self.assert_detailed_text_correct(msg)
@defer.inlineCallbacks
def test_no_error_message_if_no_exception(self):
"""On success, do not show an error message."""
yield self.decorate_me()
self.assertEqual(FakedDialog.args, None)
self.assertEqual(FakedDialog.kwargs, None)
@defer.inlineCallbacks
def test_call_error_handler(self):
"""On success, do not execute error_handler."""
yield self.decorate_me()
self.assertFalse(self.error_handler_called)
class HandleErrorWithCustomLoggerTestCase(HandleErrorTestCase):
"""Test suite for the generic error handler."""
use_logger = True
logger = setup_logging('HandleErrorWithoutLoggerTestCase') # custom logger
class HandleErrorWithHandlerTestCase(HandleErrorTestCase):
"""Test suite for the generic error handler when using a custom handler."""
@defer.inlineCallbacks
def error_handler(self, *a, **kw):
"""Implement an error handler."""
self.error_handler_called = (a, kw)
yield
@defer.inlineCallbacks
def test_call_error_handler(self):
"""On error, execute error_handler."""
msg = 'This is me failing badly.'
self.failure = Exception(msg)
yield self.decorate_me()
self.assertEqual(self.error_handler_called, ((), {}))
|