CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-18 21:04:19 +08:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

test: Extract basic_stream_fields.

Browse Source 
This avoids some code duplication as well
as adding some missing fields.

We also use check_dict_only to prevent
folks from adding new fields to the
relevant events without updating these
tests.  (A bigger sweep comes later.)
This commit is contained in:
Steve Howell 2020-06-24 21:20:40 +00:00 committed by Tim Abbott
parent e0ebc1307a
commit 0039c858a4
1 changed files with 27 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
zerver/tests/test_events.py
View File

@ -175,6 +175,21 @@ from zerver.tornado.event_queue import (
from zerver.tornado.views import get_events
from zerver.views.events_register import _default_all_public_streams, _default_narrow
# These fields are used for "stream" events, and are included in the
# larger "subscription" events that also contain personal settings.
basic_stream_fields = [
('description', check_string),
('first_message_id', check_none_or(check_int)),
('history_public_to_subscribers', check_bool),
('invite_only', check_bool),
('is_announcement_only', check_bool),
('is_web_public', check_bool),
('message_retention_days', equals(None)),
('name', check_string),
('rendered_description', check_string),
('stream_id', check_int),
('stream_post_policy', check_int),
]
class LogEventsTest(ZulipTestCase):
def test_with_missing_event_log_dir_setting(self) -> None:
@ -1407,18 +1422,7 @@ class EventsRegisterTest(ZulipTestCase):
('name', check_string),
('id', check_int),
('description', check_string),
('streams', check_list(check_dict_only([
('description', check_string),
('rendered_description', check_string),
('invite_only', check_bool),
('is_web_public', check_bool),
('is_announcement_only', check_bool),
('stream_post_policy', check_int_in(Stream.STREAM_POST_POLICY_TYPES)),
('message_retention_days', check_none_or(check_int)),
('name', check_string),
('stream_id', check_int),
('first_message_id', check_none_or(check_int)),
('history_public_to_subscribers', check_bool)]))),
('streams', check_list(check_dict_only(basic_stream_fields))),
]))),
])
@ -1469,12 +1473,7 @@ class EventsRegisterTest(ZulipTestCase):
def test_default_streams_events(self) -> None:
default_streams_checker = self.check_events_dict([
('type', equals('default_streams')),
('default_streams', check_list(check_dict([
('description', check_string),
('invite_only', check_bool),
('name', check_string),
('stream_id', check_int),
]))),
('default_streams', check_list(check_dict_only(basic_stream_fields))),
])
stream = get_stream("Scotland", self.user_profile.realm)
@ -2443,7 +2442,7 @@ class EventsRegisterTest(ZulipTestCase):
schema_checker = self.check_events_dict([
('type', equals('stream')),
('op', equals('delete')),
('streams', check_list(check_dict([]))),
('streams', check_list(check_dict_only(basic_stream_fields))),
])
schema_checker('events[0]', events[0])
@ -2467,30 +2466,20 @@ class EventsRegisterTest(ZulipTestCase):
self.do_test_subscribe_events(include_subscribers=False)
def do_test_subscribe_events(self, include_subscribers: bool) -> None:
subscription_fields = [
('color', check_string),
('description', check_string),
('rendered_description', check_string),
('email_address', check_string),
('invite_only', check_bool),
('is_web_public', check_bool),
('is_announcement_only', check_bool),
('stream_post_policy', check_int_in(Stream.STREAM_POST_POLICY_TYPES)),
('message_retention_days', check_none_or(check_int)),
('is_muted', check_bool),
('in_home_view', check_bool),
('name', check_string),
subscription_fields = basic_stream_fields + [
('audible_notifications', check_none_or(check_bool)),
('email_notifications', check_none_or(check_bool)),
('color', check_string),
('desktop_notifications', check_none_or(check_bool)),
('push_notifications', check_none_or(check_bool)),
('stream_id', check_int),
('first_message_id', check_none_or(check_int)),
('history_public_to_subscribers', check_bool),
('email_address', check_string),
('email_notifications', check_none_or(check_bool)),
('in_home_view', check_bool),
('is_muted', check_bool),
('pin_to_top', check_bool),
('push_notifications', check_none_or(check_bool)),
('stream_weekly_traffic', check_none_or(check_int)),
('wildcard_mentions_notify', check_none_or(check_bool)),
]
if include_subscribers:
subscription_fields.append(('subscribers', check_list(check_int)))
subscription_schema_checker = check_list(
@ -2499,13 +2488,7 @@ class EventsRegisterTest(ZulipTestCase):
stream_create_schema_checker = self.check_events_dict([
('type', equals('stream')),
('op', equals('create')),
('streams', check_list(check_dict([
('name', check_string),
('stream_id', check_int),
('invite_only', check_bool),
('description', check_string),
('rendered_description', check_string),
]))),
('streams', check_list(check_dict_only(basic_stream_fields))),
])
add_schema_checker = self.check_events_dict([
('type', equals('subscription')),