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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
import os
import logging
import django
from django.test import TestCase, Client, modify_settings, override_settings
from applicationinsights import TelemetryClient
from applicationinsights.channel import TelemetryChannel, SynchronousQueue, SenderBase, NullSender, AsynchronousSender
from applicationinsights.channel.SenderBase import DEFAULT_ENDPOINT_URL as DEFAULT_ENDPOINT
from applicationinsights.django import common
if django.VERSION > (1, 10):
MIDDLEWARE_NAME = "MIDDLEWARE"
else:
MIDDLEWARE_NAME = "MIDDLEWARE_CLASSES"
TEST_IKEY = '12345678-1234-5678-9012-123456789abc'
TEST_ENDPOINT = 'https://test.endpoint/v2/track'
PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
class AITestCase(TestCase):
def plug_sender(self):
# Reset saved objects
common.saved_clients = {}
common.saved_channels = {}
# Create a client and mock out the sender
client = common.create_client()
sender = MockSender()
client._channel = TelemetryChannel(None, SynchronousQueue(sender))
self.events = sender.events
self.channel = client.channel
def get_events(self, count):
self.channel.flush()
self.assertEqual(len(self.events), count, "Expected %d event(s) in queue (%d actual)" % (count, len(self.events)))
if count == 1:
return self.events[0]
return self.events
@modify_settings(**{MIDDLEWARE_NAME: {'append': 'applicationinsights.django.ApplicationInsightsMiddleware'}})
@override_settings(
APPLICATION_INSIGHTS={'ikey': TEST_IKEY},
# Templates for 1.7
TEMPLATE_DIRS=(PROJECT_ROOT,),
TEMPLATE_LOADERS=('django.template.loaders.filesystem.Loader',),
# Templates for 1.8 and up
TEMPLATES=[{'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [PROJECT_ROOT]}])
class MiddlewareTests(AITestCase):
def setUp(self):
self.plug_sender()
def test_basic_request(self):
"""Tests that hitting a simple view generates a telemetry item with the correct properties"""
response = self.client.get('/')
self.assertEqual(response.status_code, 200)
event = self.get_events(1)
tags = event['tags']
data = event['data']['baseData']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(event['iKey'], TEST_IKEY)
self.assertEqual(tags['ai.operation.name'], 'GET /', "Operation name")
self.assertEqual(data['name'], 'GET /', "Request name")
self.assertEqual(data['responseCode'], 200, "Status code")
self.assertEqual(data['success'], True, "Success value")
self.assertEqual(data['url'], 'http://testserver/', "Request url")
def test_logger(self):
"""Tests that traces logged from inside of a view are submitted and parented to the request telemetry item"""
response = self.client.get('/logger')
self.assertEqual(response.status_code, 200)
logev, reqev = self.get_events(2)
# Check request event (minimal, since we validate this elsewhere)
tags = reqev['tags']
data = reqev['data']['baseData']
reqid = tags['ai.operation.id']
self.assertEqual(reqev['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(data['id'], reqid, "Request id")
self.assertEqual(data['name'], 'GET /logger', "Operation name")
self.assertEqual(data['url'], 'http://testserver/logger', "Request url")
self.assertTrue(reqid, "Request id not empty")
# Check log event
tags = logev['tags']
data = logev['data']['baseData']
self.assertEqual(logev['name'], 'Microsoft.ApplicationInsights.Message', "Event type")
self.assertEqual(logev['iKey'], TEST_IKEY)
self.assertEqual(tags['ai.operation.parentId'], reqid, "Parent id")
self.assertEqual(data['message'], 'Logger message', "Log message")
self.assertEqual(data['properties']['property'], 'value', "Property=value")
def test_thrower(self):
"""Tests that unhandled exceptions generate an exception telemetry item parented to the request telemetry item"""
with self.assertRaises(ValueError):
self.client.get('/thrower')
errev, reqev = self.get_events(2)
# Check request event
tags = reqev['tags']
data = reqev['data']['baseData']
reqid = tags['ai.operation.id']
self.assertEqual(reqev['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(reqev['iKey'], TEST_IKEY)
self.assertEqual(data['id'], reqid, "Request id")
self.assertEqual(data['responseCode'], 500, "Response code")
self.assertEqual(data['success'], False, "Success value")
self.assertEqual(data['name'], 'GET /thrower', "Request name")
self.assertEqual(data['url'], 'http://testserver/thrower', "Request url")
self.assertTrue(reqid, "Request id not empty")
# Check exception event
tags = errev['tags']
data = errev['data']['baseData']
self.assertEqual(errev['name'], 'Microsoft.ApplicationInsights.Exception', "Event type")
self.assertEqual(tags['ai.operation.parentId'], reqid, "Exception parent id")
self.assertEqual(len(data['exceptions']), 1, "Exception count")
exc = data['exceptions'][0]
self.assertEqual(exc['typeName'], 'ValueError', "Exception type")
self.assertEqual(exc['hasFullStack'], True, "Has full stack")
self.assertEqual(exc['parsedStack'][0]['method'], 'thrower', "Stack frame method name")
def test_error(self):
"""Tests that Http404 exception does not generate an exception event
and the request telemetry item properly logs the failure"""
response = self.client.get("/errorer")
self.assertEqual(response.status_code, 404)
event = self.get_events(1)
tags = event['tags']
data = event['data']['baseData']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(tags['ai.operation.name'], 'GET /errorer', "Operation name")
self.assertEqual(data['responseCode'], 404, "Status code")
self.assertEqual(data['success'], False, "Success value")
self.assertEqual(data['url'], 'http://testserver/errorer', "Request url")
def test_template(self):
"""Tests that views using templates operate correctly and that template data is logged"""
response = self.client.get("/templater/ctx")
self.assertEqual(response.status_code, 200)
event = self.get_events(1)
data = event['data']['baseData']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(data['success'], True, "Success value")
self.assertEqual(data['responseCode'], 200, "Status code")
self.assertEqual(data['properties']['template_name'], 'template.html', "Template name")
def test_no_view_arguments(self):
"""Tests that view id logging is off by default"""
self.plug_sender()
response = self.client.get('/getid/24')
self.assertEqual(response.status_code, 200)
event = self.get_events(1)
data = event['data']['baseData']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertTrue('properties' not in data or 'view_arg_0' not in data['properties'])
def test_no_view(self):
"""Tests that requests to URLs not backed by views are still logged"""
response = self.client.get('/this/view/does/not/exist')
self.assertEqual(response.status_code, 404)
event = self.get_events(1)
tags = event['tags']
data = event['data']['baseData']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(data['responseCode'], 404, "Status code")
self.assertEqual(data['success'], False, "Success value")
self.assertEqual(data['name'], 'GET /this/view/does/not/exist', "Request name")
self.assertEqual(data['url'], 'http://testserver/this/view/does/not/exist', "Request url")
def test_401_success(self):
"""Tests that a 401 status code is considered successful"""
response = self.client.get("/returncode/401")
self.assertEqual(response.status_code, 401)
event = self.get_events(1)
tags = event['tags']
data = event['data']['baseData']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(tags['ai.operation.name'], 'GET /returncode/401', "Operation name")
self.assertEqual(data['responseCode'], 401, "Status code")
self.assertEqual(data['success'], True, "Success value")
self.assertEqual(data['url'], 'http://testserver/returncode/401', "Request url")
@modify_settings(**{MIDDLEWARE_NAME: {'append': 'applicationinsights.django.ApplicationInsightsMiddleware'}})
class RequestSettingsTests(AITestCase):
# This type needs to plug the sender during the test -- doing it in setUp would have nil effect
# because each method's override_settings wouldn't have happened by then.
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'use_view_name': True})
def test_use_view_name(self):
"""Tests that request names are set to view names when use_view_name=True"""
self.plug_sender()
self.client.get('/')
event = self.get_events(1)
self.assertEqual(event['data']['baseData']['name'], 'GET aitest.views.home', "Request name")
self.assertEqual(event['tags']['ai.operation.name'], 'GET aitest.views.home', "Operation name")
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'use_view_name': False})
def test_use_view_name_off(self):
"""Tests that request names are set to URLs when use_view_name=False"""
self.plug_sender()
self.client.get('/')
event = self.get_events(1)
self.assertEqual(event['data']['baseData']['name'], 'GET /', "Request name")
self.assertEqual(event['tags']['ai.operation.name'], 'GET /', "Operation name")
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'use_view_name': True})
def test_view_name_class(self):
"""Tests that classes can be correctly identified when use_view_name=True"""
self.plug_sender()
self.client.get('/class')
event = self.get_events(1)
self.assertEqual(event['data']['baseData']['name'], 'GET aitest.views.classview', "Request name")
self.assertEqual(event['tags']['ai.operation.name'], 'GET aitest.views.classview', "Operation name")
@override_settings(APPLICATION_INSIGHTS=None)
def test_appinsights_still_supplied(self):
"""Tests that appinsights is still added to requests even if APPLICATION_INSIGHTS is unspecified"""
# This uses request.appinsights -- it will crash if it's not there.
response = self.client.get('/logger')
self.assertEqual(response.status_code, 200)
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'record_view_arguments': True})
def test_view_id(self):
"""Tests that view arguments are logged when record_view_arguments=True"""
self.plug_sender()
response = self.client.get('/getid/24')
self.assertEqual(response.status_code, 200)
event = self.get_events(1)
props = event['data']['baseData']['properties']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(props['view_arg_0'], '24', "View argument")
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'log_exceptions': False})
def test_log_exceptions_off(self):
"""Tests that exceptions are not logged when log_exceptions=False"""
self.plug_sender()
with self.assertRaises(ValueError):
response = self.client.get('/thrower')
event = self.get_events(1)
data = event['data']['baseData']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Request', "Event type")
self.assertEqual(data['responseCode'], 500, "Response code")
class SettingsTests(TestCase):
def setUp(self):
# Just clear out any cached objects
common.saved_clients = {}
common.saved_channels = {}
def test_no_app_insights(self):
"""Tests that events are swallowed when APPLICATION_INSIGHTS is unspecified"""
client = common.create_client()
self.assertTrue(type(client.channel.sender) is NullSender)
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY})
def test_default_endpoint(self):
"""Tests that the default endpoint is used when endpoint is unspecified"""
client = common.create_client()
self.assertEqual(client.channel.sender.service_endpoint_uri, DEFAULT_ENDPOINT)
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'endpoint': TEST_ENDPOINT})
def test_overridden_endpoint(self):
"""Tests that the endpoint is used when specified"""
client = common.create_client()
self.assertEqual(client.channel.sender.service_endpoint_uri, TEST_ENDPOINT)
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'send_time': 999})
def test_send_time(self):
"""Tests that send_time is propagated to sender"""
client = common.create_client()
self.assertEqual(client.channel.sender.send_time, 999)
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY, 'send_interval': 999})
def test_send_interval(self):
"""Tests that send_interval is propagated to sender"""
client = common.create_client()
self.assertEqual(client.channel.sender.send_interval, 999)
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY})
def test_default_send_time(self):
"""Tests that send_time is equal to the default when it is unspecified"""
client = common.create_client()
self.assertEqual(client.channel.sender.send_time, AsynchronousSender().send_time)
@override_settings(APPLICATION_INSIGHTS={'ikey': TEST_IKEY})
def test_default_send_interval(self):
"""Tests that send_interval is equal to the default when it is unspecified"""
client = common.create_client()
self.assertEqual(client.channel.sender.send_interval, AsynchronousSender().send_interval)
@override_settings(LOGGING={
'version': 1,
'handlers': {
'appinsights': {
'class': 'applicationinsights.django.LoggingHandler',
'level': 'INFO',
}
},
'loggers': {
__name__: {
'handlers': ['appinsights'],
'level': 'INFO',
}
}
}, APPLICATION_INSIGHTS={'ikey': TEST_IKEY})
class LoggerTests(AITestCase):
def setUp(self):
self.plug_sender()
def test_log_error(self):
"""Tests an error trace telemetry is properly sent"""
django.setup()
logger = logging.getLogger(__name__)
msg = "An error log message"
logger.error(msg)
event = self.get_events(1)
data = event['data']['baseData']
props = data['properties']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Message', "Event type")
self.assertEqual(event['iKey'], TEST_IKEY)
self.assertEqual(data['message'], msg, "Log message")
self.assertEqual(data['severityLevel'], 3, "Severity level")
self.assertEqual(props['fileName'], 'tests.py', "Filename property")
self.assertEqual(props['level'], 'ERROR', "Level property")
self.assertEqual(props['module'], 'tests', "Module property")
def test_log_info(self):
"""Tests an info trace telemetry is properly sent"""
django.setup()
logger = logging.getLogger(__name__)
msg = "An info message"
logger.info(msg)
event = self.get_events(1)
data = event['data']['baseData']
props = data['properties']
self.assertEqual(event['name'], 'Microsoft.ApplicationInsights.Message', "Event type")
self.assertEqual(event['iKey'], TEST_IKEY)
self.assertEqual(data['message'], msg, "Log message")
self.assertEqual(data['severityLevel'], 1, "Severity level")
self.assertEqual(props['fileName'], 'tests.py', "Filename property")
self.assertEqual(props['level'], 'INFO', "Level property")
self.assertEqual(props['module'], 'tests', "Module property")
class MockSender(SenderBase):
def __init__(self):
SenderBase.__init__(self, DEFAULT_ENDPOINT)
self.events = []
def send(self, data):
self.events.extend(a.write() for a in data)
|