class ViewTests(TestCase):
def setUp(self):
# set up one, catch-all rule.
self.rule = RuleSet(enabled=True)
self.rule.save()
def test_rules_match_response(self):
url = reverse('test_response')
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
record = ProfilingRecord.objects.get()
self.assertIsNone(record.user)
# session is save even if user is Anonymous
self.assertNotEqual(record.session_key, '')
self.assertEqual(record.http_user_agent, "(u'',)")
self.assertEqual(record.http_referer, u'')
self.assertEqual(record.http_method, 'GET')
self.assertEqual(record.view_func_name, 'test_response')
self.assertEqual(str(record.duration), response['X-Profiler-Duration'])
self.assertEqual(record.response_status_code, 200)
def test_rules_match_view(self):
url = reverse('test_view')
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
record = ProfilingRecord.objects.get()
self.assertIsNone(record.user)
self.assertNotEqual(record.session_key, '')
self.assertEqual(record.http_user_agent, "(u'',)")
self.assertEqual(record.http_referer, u'')
self.assertEqual(record.http_method, 'GET')
self.assertEqual(record.view_func_name, 'test_view')
self.assertEqual(str(record.duration), response['X-Profiler-Duration'])
self.assertEqual(record.response_status_code, 200)
def test_rules_match_view_no_session(self):
url = reverse('test_view')
settings.STORE_ANONYMOUS_SESSIONS = False
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
record = ProfilingRecord.objects.get()
self.assertIsNone(record.user)
self.assertEqual(record.session_key, '')
def test_no_rules_match(self):
self.rule.delete()
url = reverse('test_response')
response = self.client.get(url)
self.assertFalse(response.has_header('X-Profiler-Duration'))
self.assertFalse(ProfilingRecord.objects.exists())
def test_404(self):
# Validate that the profiler handles an error page
url = reverse('test_404')
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
self.assertEqual(ProfilingRecord.objects.get().response_status_code,
404)
class ViewTests(TestCase):
def setUp(self):
# set up one, catch-all rule.
self.rule = RuleSet(enabled=True)
self.rule.save()
def test_rules_match_response(self):
url = reverse('test_response')
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
record = ProfilingRecord.objects.get()
self.assertIsNone(record.user)
# session is save even if user is Anonymous
self.assertNotEqual(record.session_key, '')
self.assertEqual(record.http_user_agent, "")
self.assertEqual(record.http_referer, u'')
self.assertEqual(record.http_method, 'GET')
self.assertEqual(record.view_func_name, 'test_response')
self.assertEqual(str(record.duration), response['X-Profiler-Duration'])
self.assertEqual(record.response_status_code, 200)
def test_rules_match_view(self):
url = reverse('test_view')
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
record = ProfilingRecord.objects.get()
self.assertIsNone(record.user)
self.assertNotEqual(record.session_key, '')
self.assertEqual(record.http_user_agent, "")
self.assertEqual(record.http_referer, u'')
self.assertEqual(record.http_method, 'GET')
self.assertEqual(record.view_func_name, 'test_view')
self.assertEqual(str(record.duration), response['X-Profiler-Duration'])
self.assertEqual(record.response_status_code, 200)
def test_rules_match_view_no_session(self):
url = reverse('test_view')
settings.STORE_ANONYMOUS_SESSIONS = False
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
record = ProfilingRecord.objects.get()
self.assertIsNone(record.user)
self.assertEqual(record.session_key, '')
def test_no_rules_match(self):
self.rule.delete()
url = reverse('test_response')
response = self.client.get(url)
self.assertFalse(response.has_header('X-Profiler-Duration'))
self.assertFalse(ProfilingRecord.objects.exists())
def test_404(self):
# Validate that the profiler handles an error page
url = reverse('test_404')
response = self.client.get(url)
self.assertTrue(response.has_header('X-Profiler-Duration'))
self.assertEqual(ProfilingRecord.objects.get().response_status_code, 404)
def test_match_uri(self):
ruleset = RuleSet("")
uri = "/test/"
regexes = (("", True), (" ", True), ("^/test", True), (".", True),
("/x", False))
for r in regexes:
ruleset.uri_regex = r[0]
self.assertEqual(ruleset.match_uri(uri), r[1])
def test_has_group_filter(self):
ruleset = RuleSet()
filters = (
("", False),
(" ", False),
("test", True),
)
for f in filters:
ruleset.user_group_filter = f[0]
self.assertEqual(ruleset.has_group_filter, f[1])
def test_has_group_filter(self):
ruleset = RuleSet()
filters = (
("", False),
(" ", False),
("test", True),
)
for f in filters:
ruleset.user_group_filter = f[0]
self.assertEqual(ruleset.has_group_filter, f[1])
def test_match_uri(self):
ruleset = RuleSet("")
uri = "/test/"
regexes = (
("", True),
(" ", True),
("^/test", True),
(".", True),
("/x", False)
)
for r in regexes:
ruleset.uri_regex = r[0]
self.assertEqual(ruleset.match_uri(uri), r[1])
def test_live_rules_with_caching(self):
settings.RULESET_CACHE_TIMEOUT = 10
self.assertIsNone(cache.get(settings.RULESET_CACHE_KEY))
# save a couple of rules
RuleSet(uri_regex="", enabled=True).save()
RuleSet(uri_regex="", enabled=True).save()
self.assertEqual(RuleSet.objects.live_rules().count(), 2)
self.assertIsNotNone(cache.get(settings.RULESET_CACHE_KEY))
# cache is full, delete the underlying records and retrieve
RuleSet.objects.all().delete()
# we're going to the cache, so even so DB is empty, we get two back
self.assertEqual(RuleSet.objects.live_rules().count(), 2)
# clear out cache and confirm we're now going direct to DB
cache.clear()
self.assertEqual(RuleSet.objects.live_rules().count(), 0)
def test_live_rules(self):
r1 = RuleSet(uri_regex="", enabled=True)
r1.save()
self.assertEqual(RuleSet.objects.live_rules().count(), 1)
r2 = RuleSet(uri_regex="", enabled=True)
r2.save()
self.assertEqual(RuleSet.objects.live_rules().count(), 2)
r2.enabled = False
r2.save()
self.assertEqual(RuleSet.objects.live_rules().count(), 1)
def test_match_rules(self):
# rule1 - to match all users
r1 = RuleSet()
self.assertTrue(r1.match_user(self.anon))
request = self.factory.get('/')
request.user = self.anon
self.assertTrue(r1.match_uri, request.path)
middleware = ProfilingMiddleware()
self.assertEqual(middleware.match_rules(request, [r1]), [r1])
# now change the uri_regex so we no longer get a match
r1.uri_regex = "^xyz$"
self.assertEqual(middleware.match_rules(request, [r1]), [])
# now change the user_groups so we no longer get a match
request.user = self.bob
r1.uri_regex = ""
r1.user_filter_type = RuleSet.USER_FILTER_GROUP
r1.user_group_filter = "test"
self.assertEqual(middleware.match_rules(request, [r1]), [])
# add bob to the group
self.bob.groups.add(self.test_group)
self.assertEqual(middleware.match_rules(request, [r1]), [r1])
def test_default_properties(self):
ruleset = RuleSet()
props = [
('enabled', True),
('uri_regex', ""),
('user_filter_type', 0),
('user_group_filter', ""),
]
for p in props:
self.assertEqual(getattr(ruleset, p[0]), p[1])
self.assertIsInstance(RuleSet.objects, RuleSetManager)
def test_process_response(self):
request = self.factory.get('/')
middleware = ProfilingMiddleware()
with self.assertRaises(AssertionError):
middleware.process_response(request, None)
# try no matching rules
request.profiler = ProfilingRecord().start()
response = middleware.process_response(request, MockResponse(200))
self.assertEqual(response.status_code, 200)
self.assertFalse(hasattr(request, 'profiler'))
# try matching a rule, and checking response values
r1 = RuleSet()
r1.save()
request.profiler = ProfilingRecord().start()
response = middleware.process_response(request, MockResponse(200))
self.assertIsNotNone(response)
self.assertTrue(request.profiler.response_status_code, response.status_code)
self.assertTrue(response['X-Profiler-Duration'], request.profiler.duration)
def test_clean(self):
ruleset = RuleSet(user_group_filter="test")
for f in (RuleSet.USER_FILTER_ALL, RuleSet.USER_FILTER_AUTH):
ruleset.user_filter_type = f
self.assertRaises(ValidationError, ruleset.clean)
ruleset.user_filter_type = RuleSet.USER_FILTER_GROUP
ruleset.clean()
# now try the opposite - user_filter_type set, but no group set
ruleset.user_group_filter = ""
self.assertRaises(ValidationError, ruleset.clean)
def test_process_response(self):
request = self.factory.get('/')
middleware = ProfilingMiddleware()
with self.assertRaises(AssertionError):
middleware.process_response(request, None)
# try no matching rules
request.profiler = ProfilingRecord().start()
response = middleware.process_response(request, MockResponse(200))
self.assertEqual(response.status_code, 200)
self.assertFalse(hasattr(request, 'profiler'))
# try matching a rule, and checking response values
r1 = RuleSet()
r1.save()
request.profiler = ProfilingRecord().start()
response = middleware.process_response(request, MockResponse(200))
self.assertIsNotNone(response)
self.assertTrue(request.profiler.response_status_code, response.status_code)
self.assertTrue(response['X-Profiler-Duration'], request.profiler.duration)
def test_match_rules(self):
# rule1 - to match all users
r1 = RuleSet()
self.assertTrue(r1.match_user(self.anon))
request = self.factory.get('/')
request.user = self.anon
self.assertTrue(r1.match_uri, request.path)
middleware = ProfilingMiddleware()
self.assertEqual(middleware.match_rules(request, [r1]), [r1])
# now change the uri_regex so we no longer get a match
r1.uri_regex = "^xyz$"
self.assertEqual(middleware.match_rules(request, [r1]), [])
# now change the user_groups so we no longer get a match
request.user = self.bob
r1.uri_regex = ""
r1.user_filter_type = RuleSet.USER_FILTER_GROUP
r1.user_group_filter = "test"
self.assertEqual(middleware.match_rules(request, [r1]), [])
# add bob to the group
self.bob.groups.add(self.test_group)
self.assertEqual(middleware.match_rules(request, [r1]), [r1])
def test_process_response_signal_cancellation(self):
request = self.factory.get('/')
request.profiler = ProfilingRecord().start()
middleware = ProfilingMiddleware()
# try matching a rule, anc checking response values
r1 = RuleSet()
r1.save()
self.signal_received = False
def on_request_profile_complete(sender, **kwargs):
self.signal_received = True
kwargs.get('instance').cancel()
request_profile_complete.connect(on_request_profile_complete)
middleware.process_response(request, MockResponse(200))
# because we returned False from the signal receiver,
# we should have stopped profiling.
self.assertTrue(self.signal_received)
# because we called cancel(), the record is not saved.
self.assertIsNone(request.profiler.id)
def test_process_response_signal_cancellation(self):
request = self.factory.get('/')
request.profiler = ProfilingRecord().start()
middleware = ProfilingMiddleware()
# try matching a rule, anc checking response values
r1 = RuleSet()
r1.save()
self.signal_received = False
def on_request_profile_complete(sender, **kwargs):
self.signal_received = True
kwargs.get('instance').cancel()
request_profile_complete.connect(on_request_profile_complete)
middleware.process_response(request, MockResponse(200))
# because we returned False from the signal receiver,
# we should have stopped profiling.
self.assertTrue(self.signal_received)
# because we called cancel(), the record is not saved.
self.assertIsNone(request.profiler.id)
def test_clean(self):
ruleset = RuleSet(user_group_filter="test")
for f in (RuleSet.USER_FILTER_ALL, RuleSet.USER_FILTER_AUTH):
ruleset.user_filter_type = f
self.assertRaises(ValidationError, ruleset.clean)
ruleset.user_filter_type = RuleSet.USER_FILTER_GROUP
ruleset.clean()
# now try the opposite - user_filter_type set, but no group set
ruleset.user_group_filter = ""
self.assertRaises(ValidationError, ruleset.clean)
def test_global_exclude_function(self):
# set the func to ignore everything
RuleSet().save()
request = self.factory.get('/')
request.profiler = ProfilingRecord().start()
middleware = ProfilingMiddleware()
# process normally, record is saved.
middleware.process_response(request, MockResponse(200))
self.assertIsNotNone(request.profiler.id)
# NB for some reason (prb. due to imports, the standard
# 'override_settings' decorator doesn't work here.)
settings.GLOBAL_EXCLUDE_FUNC = lambda x: False
request.profiler = ProfilingRecord().start()
# process now, and profiler is cancelled
middleware.process_response(request, MockResponse(200))
self.assertFalse(hasattr(request, 'profiler'))
settings.GLOBAL_EXCLUDE_FUNC = lambda x: True
def setUp(self):
# set up one, catch-all rule.
self.rule = RuleSet(enabled=True)
self.rule.save()
def test_match_custom_user(self):
ruleset = RuleSet("")
self.assertFalse(ruleset.has_group_filter)
self.assertEqual(ruleset.user_filter_type, RuleSet.USER_FILTER_ALL)
# start with no user / anonymous
self.assertTrue(ruleset.match_user(None))
self.assertTrue(ruleset.match_user(AnonymousUser()))
# now exclude anonymous
ruleset.user_filter_type = RuleSet.USER_FILTER_AUTH
self.assertFalse(ruleset.match_user(None))
self.assertFalse(ruleset.match_user(AnonymousUser()))
# create a real user, but still no group filter
bob = CustomUser.objects.create_user(
mobile_number="+886-999888777",
password="******"
)
self.assertFalse(bob.groups.exists())
self.assertFalse(bob.is_staff)
self.assertTrue(bob.is_authenticated())
self.assertTrue(ruleset.match_user(bob))
# now create the filter, and check bob no longer matches
ruleset.user_filter_type = RuleSet.USER_FILTER_GROUP
ruleset.user_group_filter = "test"
test_group = Group(name="test")
test_group.save()
self.assertFalse(ruleset.match_user(bob))
# add bob to the group, and check he now matches
bob.groups.add(test_group)
self.assertTrue(bob.groups.filter(name="test").exists())
self.assertTrue(ruleset.match_user(bob))
# test setting an invalid value
ruleset.user_filter_type = -1
self.assertFalse(ruleset.match_user(bob))
bob.is_staff = False
self.assertFalse(ruleset.match_user(bob))
self.assertFalse(ruleset.match_user(None))
self.assertFalse(ruleset.match_user(AnonymousUser()))
def setUp(self):
# set up one, catch-all rule.
self.rule = RuleSet(enabled=True)
self.rule.save()
def test_live_rules(self):
r1 = RuleSet(uri_regex="", enabled=True)
r1.save()
self.assertEqual(RuleSet.objects.live_rules().count(), 1)
r2 = RuleSet(uri_regex="", enabled=True)
r2.save()
self.assertEqual(RuleSet.objects.live_rules().count(), 2)
r2.enabled = False
r2.save()
self.assertEqual(RuleSet.objects.live_rules().count(), 1)
def test_match_custom_user(self):
ruleset = RuleSet("")
self.assertFalse(ruleset.has_group_filter)
self.assertEqual(ruleset.user_filter_type, RuleSet.USER_FILTER_ALL)
# start with no user / anonymous
self.assertTrue(ruleset.match_user(None))
self.assertTrue(ruleset.match_user(AnonymousUser()))
# now exclude anonymous
ruleset.user_filter_type = RuleSet.USER_FILTER_AUTH
self.assertFalse(ruleset.match_user(None))
self.assertFalse(ruleset.match_user(AnonymousUser()))
# create a real user, but still no group filter
bob = CustomUser.objects.create_user(mobile_number="+886-999888777",
password="******")
self.assertFalse(bob.groups.exists())
self.assertFalse(bob.is_staff)
self.assertTrue(bob.is_authenticated())
self.assertTrue(ruleset.match_user(bob))
# now create the filter, and check bob no longer matches
ruleset.user_filter_type = RuleSet.USER_FILTER_GROUP
ruleset.user_group_filter = "test"
test_group = Group(name="test")
test_group.save()
self.assertFalse(ruleset.match_user(bob))
# add bob to the group, and check he now matches
bob.groups.add(test_group)
self.assertTrue(bob.groups.filter(name="test").exists())
self.assertTrue(ruleset.match_user(bob))
# test setting an invalid value
ruleset.user_filter_type = -1
self.assertFalse(ruleset.match_user(bob))
bob.is_staff = False
self.assertFalse(ruleset.match_user(bob))
self.assertFalse(ruleset.match_user(None))
self.assertFalse(ruleset.match_user(AnonymousUser()))
