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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
import logging
import pytest
from exam import before, fixture
from flask import Flask, current_app, g
try:
from flask.ext.login import LoginManager, AnonymousUserMixin, login_user
except ImportError:
from flask_login import LoginManager, AnonymousUserMixin, login_user
from mock import patch, Mock
from raven.contrib.flask import Sentry, logging_configured
from raven.handlers.logging import SentryHandler
from raven.utils.testutils import InMemoryClient, TestCase
class User(AnonymousUserMixin):
is_active = lambda x: True
is_authenticated = lambda x: True
get_id = lambda x: 1
name = 'TestUser'
def to_dict(self):
return {
'id': self.get_id(),
'name': self.name
}
def create_app(ignore_exceptions=None, debug=False, **config):
import os
app = Flask(__name__)
app.config['SECRET_KEY'] = os.urandom(40)
for key, value in config.items():
app.config[key] = value
app.debug = debug
if ignore_exceptions:
app.config['RAVEN_IGNORE_EXCEPTIONS'] = ignore_exceptions
@app.route('/an-error/', methods=['GET', 'POST'])
def an_error():
raise ValueError('hello world')
@app.route('/log-an-error/', methods=['GET'])
def log_an_error():
app.logger.error('Log an error')
return 'Hello'
@app.route('/log-a-generic-error/', methods=['GET'])
def log_a_generic_error():
logger = logging.getLogger('random-logger')
logger.error('Log an error')
return 'Hello'
@app.route('/capture/', methods=['GET', 'POST'])
def capture_exception():
try:
raise ValueError('Boom')
except:
current_app.extensions['sentry'].captureException()
return 'Hello'
@app.route('/message/', methods=['GET', 'POST'])
def capture_message():
current_app.extensions['sentry'].captureMessage('Interesting')
return 'World'
@app.route('/login/', methods=['GET', 'POST'])
def login():
login_user(User())
return "hello world"
return app
def init_login(app):
login_manager = LoginManager()
login_manager.init_app(app)
@login_manager.user_loader
def load_user(userid):
return User()
return login_manager
class BaseTest(TestCase):
@fixture
def app(self):
return create_app()
@fixture
def client(self):
return self.app.test_client()
@before
def bind_sentry(self):
self.raven = InMemoryClient()
self.middleware = Sentry(self.app, client=self.raven)
def make_client_and_raven(self, logging=False, *args, **kwargs):
app = create_app(*args, **kwargs)
raven = InMemoryClient()
Sentry(app, logging=logging, client=raven)
return app.test_client(), raven, app
class FlaskTest(BaseTest):
def test_does_add_to_extensions(self):
self.assertIn('sentry', self.app.extensions)
self.assertEquals(self.app.extensions['sentry'], self.middleware)
def test_error_handler(self):
response = self.client.get('/an-error/')
self.assertEquals(response.status_code, 500)
self.assertEquals(len(self.raven.events), 1)
event = self.raven.events.pop(0)
assert 'exception' in event
exc = event['exception']['values'][-1]
self.assertEquals(exc['type'], 'ValueError')
self.assertEquals(exc['value'], 'hello world')
self.assertEquals(event['level'], logging.ERROR)
self.assertEquals(event['message'], 'ValueError: hello world')
def test_capture_plus_logging(self):
client, raven, app = self.make_client_and_raven(debug=False, logging=True)
client.get('/an-error/')
client.get('/log-an-error/')
client.get('/log-a-generic-error/')
assert len(raven.events) == 3
def test_get(self):
response = self.client.get('/an-error/?foo=bar')
self.assertEquals(response.status_code, 500)
self.assertEquals(len(self.raven.events), 1)
event = self.raven.events.pop(0)
assert 'request' in event
http = event['request']
self.assertEquals(http['url'], 'http://localhost/an-error/')
self.assertEquals(http['query_string'], 'foo=bar')
self.assertEquals(http['method'], 'GET')
self.assertEquals(http['data'], {})
self.assertTrue('headers' in http)
headers = http['headers']
self.assertTrue('Content-Length' in headers, headers.keys())
self.assertEquals(headers['Content-Length'], '0')
self.assertTrue('Content-Type' in headers, headers.keys())
self.assertEquals(headers['Content-Type'], '')
self.assertTrue('Host' in headers, headers.keys())
self.assertEquals(headers['Host'], 'localhost')
env = http['env']
self.assertTrue('SERVER_NAME' in env, env.keys())
self.assertEquals(env['SERVER_NAME'], 'localhost')
self.assertTrue('SERVER_PORT' in env, env.keys())
self.assertEquals(env['SERVER_PORT'], '80')
def test_post(self):
response = self.client.post('/an-error/?biz=baz', data={'foo': 'bar'})
self.assertEquals(response.status_code, 500)
self.assertEquals(len(self.raven.events), 1)
event = self.raven.events.pop(0)
assert 'request' in event
http = event['request']
self.assertEquals(http['url'], 'http://localhost/an-error/')
self.assertEquals(http['query_string'], 'biz=baz')
self.assertEquals(http['method'], 'POST')
self.assertEquals(http['data'], {'foo': 'bar'})
self.assertTrue('headers' in http)
headers = http['headers']
self.assertTrue('Content-Length' in headers, headers.keys())
self.assertEquals(headers['Content-Length'], '7')
self.assertTrue('Content-Type' in headers, headers.keys())
self.assertEquals(headers['Content-Type'], 'application/x-www-form-urlencoded')
self.assertTrue('Host' in headers, headers.keys())
self.assertEquals(headers['Host'], 'localhost')
env = http['env']
self.assertTrue('SERVER_NAME' in env, env.keys())
self.assertEquals(env['SERVER_NAME'], 'localhost')
self.assertTrue('SERVER_PORT' in env, env.keys())
self.assertEquals(env['SERVER_PORT'], '80')
def test_captureException_captures_http(self):
response = self.client.get('/capture/?foo=bar')
self.assertEquals(response.status_code, 200)
self.assertEquals(len(self.raven.events), 1)
event = self.raven.events.pop(0)
self.assertEquals(event['event_id'], response.headers['X-Sentry-ID'])
assert event['message'] == 'ValueError: Boom'
assert 'request' in event
assert 'exception' in event
def test_captureMessage_captures_http(self):
response = self.client.get('/message/?foo=bar')
self.assertEquals(response.status_code, 200)
self.assertEquals(len(self.raven.events), 1)
event = self.raven.events.pop(0)
self.assertEquals(event['event_id'], response.headers['X-Sentry-ID'])
assert 'sentry.interfaces.Message' in event
assert 'request' in event
@patch('flask.wrappers.RequestBase._load_form_data')
def test_get_data_handles_disconnected_client(self, lfd):
from werkzeug.exceptions import ClientDisconnected
lfd.side_effect = ClientDisconnected
self.client.post('/capture/?foo=bar', data={'baz': 'foo'})
event = self.raven.events.pop(0)
assert 'request' in event
http = event['request']
self.assertEqual({}, http.get('data'))
def test_wrap_wsgi_status(self):
_, _, app_debug = self.make_client_and_raven(debug=True)
self.assertFalse(app_debug.extensions['sentry'].wrap_wsgi)
_, _, app_ndebug = self.make_client_and_raven(debug=False)
self.assertTrue(app_ndebug.extensions['sentry'].wrap_wsgi)
def test_captureException_sets_last_event_id(self):
with self.app.test_request_context('/'):
try:
raise ValueError
except Exception:
self.middleware.captureException()
else:
self.fail()
event_id = self.raven.events.pop(0)['event_id']
assert self.middleware.last_event_id == event_id
assert g.sentry_event_id == event_id
def test_captureMessage_sets_last_event_id(self):
with self.app.test_request_context('/'):
self.middleware.captureMessage('foo')
event_id = self.raven.events.pop(0)['event_id']
assert self.middleware.last_event_id == event_id
assert g.sentry_event_id == event_id
@pytest.mark.skip(reason="Fails with the current implementation if the logger is already configured")
def test_logging_setup_with_exclusion_list(self):
app = Flask(__name__)
raven = InMemoryClient()
Sentry(app, client=raven, logging=True, logging_exclusions=("excluded_logger",))
excluded_logger = logging.getLogger("excluded_logger")
self.assertFalse(excluded_logger.propagate)
some_other_logger = logging.getLogger("some_other_logger")
self.assertTrue(some_other_logger.propagate)
def test_logging_setup_signal(self):
app = Flask(__name__)
mock_handler = Mock()
def receiver(sender, *args, **kwargs):
self.assertIn("exclude", kwargs)
mock_handler(*args, **kwargs)
logging_configured.connect(receiver)
raven = InMemoryClient()
Sentry(
app, client=raven, logging=True,
logging_exclusions=("excluded_logger",))
mock_handler.assert_called()
def test_check_client_type(self):
self.assertRaises(TypeError, lambda _: Sentry(self.app, "oops, I'm putting my DSN instead"))
def test_uses_dsn(self):
app = Flask(__name__)
sentry = Sentry(app, dsn='http://public:secret@example.com/1')
assert sentry.client.remote.base_url == 'http://example.com'
def test_binds_default_include_paths(self):
app = Flask(__name__)
sentry = Sentry(app, dsn='http://public:secret@example.com/1')
assert sentry.client.include_paths == set([app.import_name])
def test_overrides_default_include_paths(self):
app = Flask(__name__)
app.config['SENTRY_CONFIG'] = {'include_paths': ['foo.bar']}
sentry = Sentry(app, dsn='http://public:secret@example.com/1')
assert sentry.client.include_paths == set(['foo.bar'])
class FlaskLoginTest(BaseTest):
@fixture
def app(self):
return create_app(SENTRY_USER_ATTRS=['name'])
@before
def setup_login(self):
self.login_manager = init_login(self.app)
def test_user(self):
self.client.get('/login/')
self.client.get('/an-error/')
event = self.raven.events.pop(0)
assert event['message'] == 'ValueError: hello world'
assert 'request' in event
assert 'user' in event
self.assertDictEqual(event['user'], User().to_dict())
|