Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

test_decorators: Extract check_rate_limit_public_or_user_views. 

The test setup for some of the test cases are largely similar, so it
would be cleaner to be able to reuse them.

Note that we use "check" in the name of this helper because later we
will extend it to take a flag to set whether rate limiting is expected.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
This commit is contained in:
Zixuan James Li 2022-08-14 18:02:28 -04:00 committed by Tim Abbott
parent 29bad25f83
commit 0916f9eca2
1 changed files with 25 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
zerver/tests/test_decorators.py
View File

@ -647,64 +647,43 @@ class RateLimitTestCase(ZulipTestCase):
return mock.patch("logging.error", side_effect=TestLoggingErrorException) return mock.patch("logging.error", side_effect=TestLoggingErrorException)
def test_internal_local_clients_skip_rate_limiting(self) -> None: def check_rate_limit_public_or_user_views(self, remote_addr: str, client_name: str) -> None:
META = {"REMOTE_ADDR": "127.0.0.1"} META = {"REMOTE_ADDR": remote_addr}
request = HostRequestMock(client_name="internal", meta_data=META) request = HostRequestMock(client_name=client_name, meta_data=META)
f = self.get_ratelimited_view() f = self.get_ratelimited_view()
with self.settings(RATE_LIMITING=True): with mock.patch(
with mock.patch( "zerver.lib.rate_limiter.rate_limit_user"
"zerver.lib.rate_limiter.rate_limit_user" ) as rate_limit_user_mock, mock.patch(
) as rate_limit_user_mock, mock.patch( "zerver.lib.rate_limiter.rate_limit_ip"
"zerver.lib.rate_limiter.rate_limit_ip" ) as rate_limit_ip_mock:
) as rate_limit_ip_mock: with self.errors_disallowed():
with self.errors_disallowed(): self.assertEqual(orjson.loads(f(request).content).get("msg"), "some value")
self.assertEqual(orjson.loads(f(request).content).get("msg"), "some value")
self.assertFalse(rate_limit_ip_mock.called) self.assertFalse(rate_limit_ip_mock.called)
self.assertFalse(rate_limit_user_mock.called) self.assertFalse(rate_limit_user_mock.called)
def test_internal_local_clients_skip_rate_limiting(self) -> None:
with self.settings(RATE_LIMITING=True):
self.check_rate_limit_public_or_user_views(
remote_addr="127.0.0.1", client_name="internal"
)
def test_debug_clients_skip_rate_limiting(self) -> None: def test_debug_clients_skip_rate_limiting(self) -> None:
META = {"REMOTE_ADDR": "3.3.3.3"} with self.settings(DEBUG_RATE_LIMITING=True, RATE_LIMITING=True):
# Rate limiting is skipped for internal clients with an external address
req = HostRequestMock(client_name="internal", meta_data=META) # when DEBUG_RATE_LIMITING is True.
self.check_rate_limit_public_or_user_views(
f = self.get_ratelimited_view() remote_addr="3.3.3.3", client_name="internal"
)
with self.settings(RATE_LIMITING=True):
with mock.patch(
"zerver.lib.rate_limiter.rate_limit_user"
) as rate_limit_user_mock, mock.patch(
"zerver.lib.rate_limiter.rate_limit_ip"
) as rate_limit_ip_mock:
with self.errors_disallowed():
with self.settings(DEBUG_RATE_LIMITING=True):
self.assertEqual(orjson.loads(f(req).content).get("msg"), "some value")
self.assertFalse(rate_limit_ip_mock.called)
self.assertFalse(rate_limit_user_mock.called)
def test_rate_limit_setting_of_false_bypasses_rate_limiting(self) -> None: def test_rate_limit_setting_of_false_bypasses_rate_limiting(self) -> None:
META = {"REMOTE_ADDR": "3.3.3.3"}
user = self.example_user("hamlet")
req = HostRequestMock(client_name="external", user_profile=user, meta_data=META)
f = self.get_ratelimited_view()
with self.settings(RATE_LIMITING=False): with self.settings(RATE_LIMITING=False):
with mock.patch( self.check_rate_limit_public_or_user_views(
"zerver.lib.rate_limiter.rate_limit_user" remote_addr="3.3.3.3", client_name="external"
) as rate_limit_user_mock, mock.patch( )
"zerver.lib.rate_limiter.rate_limit_ip"
) as rate_limit_ip_mock:
with self.errors_disallowed():
self.assertEqual(orjson.loads(f(req).content).get("msg"), "some value")
self.assertFalse(rate_limit_ip_mock.called)
self.assertFalse(rate_limit_user_mock.called)
def test_rate_limiting_happens_in_normal_case(self) -> None: def test_rate_limiting_happens_in_normal_case(self) -> None:
META = {"REMOTE_ADDR": "3.3.3.3"} META = {"REMOTE_ADDR": "3.3.3.3"}