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

node tests: Explicitly call make_stub. 

This commit replaces all `with_stub` calls and
explicitly calls `make_stub` instead.
The `with_stub` helper does not add much clarity
hence we now use scoped stub objects instead.

This de-indents some blocks where scoping isn't
required, for example when there is a single
stub object inside a `run_test` function.

With this change, we also need to explicitly
assert `num_calls`.
This commit is contained in:
Abhijeet Prasad Bodas 2021-02-13 08:16:14 +05:30 committed by Steve Howell
parent a0d0b89adb
commit 0d770c32cc
7 changed files with 362 additions and 301 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

346
frontend_tests/node_tests/dispatch.js
View File

@ -3,7 +3,7 @@
const {strict: assert} = require("assert");
const {set_global, zrequire} = require("../zjsunit/namespace");
const {make_stub, with_stub} = require("../zjsunit/stub");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
const {make_zjquery} = require("../zjsunit/zjquery");
@ -123,51 +123,59 @@ run_test("alert_words", (override) => {
run_test("attachments", (override) => {
const event = event_fixtures.attachment__add;
with_stub((stub) => {
// attachments_ui is hard to test deeply
override(attachments_ui, "update_attachments", stub.f);
dispatch(event);
assert_same(stub.get_args("event").event, event);
});
const stub = make_stub();
// attachments_ui is hard to test deeply
override(attachments_ui, "update_attachments", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
assert_same(stub.get_args("event").event, event);
});
run_test("user groups", (override) => {
let event = event_fixtures.user_group__add;
override(settings_user_groups, "reload", noop);
with_stub((stub) => {
{
const stub = make_stub();
override(user_groups, "add", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("group");
assert_same(args.group, event.group);
});
}
event = event_fixtures.user_group__add_members;
with_stub((stub) => {
{
const stub = make_stub();
override(user_groups, "add_members", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("group_id", "user_ids");
assert_same(args.group_id, event.group_id);
assert_same(args.user_ids, event.user_ids);
});
}
event = event_fixtures.user_group__remove_members;
with_stub((stub) => {
{
const stub = make_stub();
override(user_groups, "remove_members", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("group_id", "user_ids");
assert_same(args.group_id, event.group_id);
assert_same(args.user_ids, event.user_ids);
});
}
event = event_fixtures.user_group__update;
with_stub((stub) => {
{
const stub = make_stub();
override(user_groups, "update", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("event");
assert_same(args.event.group_id, event.group_id);
assert_same(args.event.data.name, event.data.name);
assert_same(args.event.data.description, event.data.description);
});
}
});
run_test("custom profile fields", (override) => {
@ -181,12 +189,12 @@ run_test("custom profile fields", (override) => {
run_test("default_streams", (override) => {
const event = event_fixtures.default_streams;
override(settings_streams, "update_default_streams_table", noop);
with_stub((stub) => {
override(stream_data, "set_realm_default_streams", stub.f);
dispatch(event);
const args = stub.get_args("realm_default_streams");
assert_same(args.realm_default_streams, event.default_streams);
});
const stub = make_stub();
override(stream_data, "set_realm_default_streams", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("realm_default_streams");
assert_same(args.realm_default_streams, event.default_streams);
});
run_test("hotspots", (override) => {
@ -198,54 +206,58 @@ run_test("hotspots", (override) => {
run_test("invites_changed", (override) => {
const event = event_fixtures.invites_changed;
with_stub((stub) => {
override(settings_invites, "set_up", stub.f);
dispatch(event); // stub automatically checks if stub.f is called once
});
const stub = make_stub();
override(settings_invites, "set_up", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
});
run_test("muted_topics", (override) => {
const event = event_fixtures.muted_topics;
with_stub((stub) => {
override(muting_ui, "handle_topic_updates", stub.f);
dispatch(event);
const args = stub.get_args("muted_topics");
assert_same(args.muted_topics, event.muted_topics);
});
const stub = make_stub();
override(muting_ui, "handle_topic_updates", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("muted_topics");
assert_same(args.muted_topics, event.muted_topics);
});
run_test("presence", (override) => {
const event = event_fixtures.presence;
with_stub((stub) => {
override(activity, "update_presence_info", stub.f);
dispatch(event);
const args = stub.get_args("user_id", "presence", "server_time");
assert_same(args.user_id, event.user_id);
assert_same(args.presence, event.presence);
assert_same(args.server_time, event.server_timestamp);
});
const stub = make_stub();
override(activity, "update_presence_info", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("user_id", "presence", "server_time");
assert_same(args.user_id, event.user_id);
assert_same(args.presence, event.presence);
assert_same(args.server_time, event.server_timestamp);
});
run_test("reaction", (override) => {
let event = event_fixtures.reaction__add;
with_stub((stub) => {
{
const stub = make_stub();
override(reactions, "add_reaction", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("event");
assert_same(args.event.emoji_name, event.emoji_name);
assert_same(args.event.message_id, event.message_id);
});
}
event = event_fixtures.reaction__remove;
with_stub((stub) => {
{
const stub = make_stub();
override(reactions, "remove_reaction", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("event");
assert_same(args.event.emoji_name, event.emoji_name);
assert_same(args.event.message_id, event.message_id);
});
}
});
run_test("realm settings", (override) => {
@ -387,32 +399,32 @@ run_test("realm settings", (override) => {
run_test("realm_bot add", (override) => {
const event = event_fixtures.realm_bot__add;
with_stub((bot_stub) => {
with_stub((admin_stub) => {
override(bot_data, "add", bot_stub.f);
override(settings_users, "update_bot_data", admin_stub.f);
dispatch(event);
const args = bot_stub.get_args("bot");
assert_same(args.bot, event.bot);
const bot_stub = make_stub();
const admin_stub = make_stub();
override(bot_data, "add", bot_stub.f);
override(settings_users, "update_bot_data", admin_stub.f);
dispatch(event);
admin_stub.get_args("update_user_id", "update_bot_data");
});
});
assert.equal(bot_stub.num_calls, 1);
assert.equal(admin_stub.num_calls, 1);
const args = bot_stub.get_args("bot");
assert_same(args.bot, event.bot);
admin_stub.get_args("update_user_id", "update_bot_data");
});
run_test("realm_bot remove", (override) => {
const event = event_fixtures.realm_bot__remove;
with_stub((bot_stub) => {
with_stub((admin_stub) => {
override(bot_data, "deactivate", bot_stub.f);
override(settings_users, "update_bot_data", admin_stub.f);
dispatch(event);
const args = bot_stub.get_args("user_id");
assert_same(args.user_id, event.bot.user_id);
const bot_stub = make_stub();
const admin_stub = make_stub();
override(bot_data, "deactivate", bot_stub.f);
override(settings_users, "update_bot_data", admin_stub.f);
dispatch(event);
admin_stub.get_args("update_user_id", "update_bot_data");
});
});
assert.equal(bot_stub.num_calls, 1);
assert.equal(admin_stub.num_calls, 1);
const args = bot_stub.get_args("user_id");
assert_same(args.user_id, event.bot.user_id);
admin_stub.get_args("update_user_id", "update_bot_data");
});
run_test("realm_bot delete", () => {
@ -423,21 +435,21 @@ run_test("realm_bot delete", () => {
run_test("realm_bot update", (override) => {
const event = event_fixtures.realm_bot__update;
with_stub((bot_stub) => {
with_stub((admin_stub) => {
override(bot_data, "update", bot_stub.f);
override(settings_users, "update_bot_data", admin_stub.f);
const bot_stub = make_stub();
const admin_stub = make_stub();
override(bot_data, "update", bot_stub.f);
override(settings_users, "update_bot_data", admin_stub.f);
dispatch(event);
dispatch(event);
let args = bot_stub.get_args("user_id", "bot");
assert_same(args.user_id, event.bot.user_id);
assert_same(args.bot, event.bot);
assert.equal(bot_stub.num_calls, 1);
assert.equal(admin_stub.num_calls, 1);
let args = bot_stub.get_args("user_id", "bot");
assert_same(args.user_id, event.bot.user_id);
assert_same(args.bot, event.bot);
args = admin_stub.get_args("update_user_id", "update_bot_data");
assert_same(args.update_user_id, event.bot.user_id);
});
});
args = admin_stub.get_args("update_user_id", "update_bot_data");
assert_same(args.update_user_id, event.bot.user_id);
});
run_test("realm_emoji", (override) => {
@ -521,38 +533,38 @@ run_test("realm_user", (override) => {
assert(!people.is_active_user_for_popover(event.person.user_id));
event = event_fixtures.realm_user__update;
with_stub((stub) => {
override(user_events, "update_person", stub.f);
dispatch(event);
const args = stub.get_args("person");
assert_same(args.person, event.person);
});
const stub = make_stub();
override(user_events, "update_person", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("person");
assert_same(args.person, event.person);
});
run_test("restart", (override) => {
const event = event_fixtures.restart;
with_stub((stub) => {
override(reload, "initiate", stub.f);
dispatch(event);
const args = stub.get_args("options");
assert.equal(args.options.save_pointer, true);
assert.equal(args.options.immediate, true);
});
const stub = make_stub();
override(reload, "initiate", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("options");
assert.equal(args.options.save_pointer, true);
assert.equal(args.options.immediate, true);
});
run_test("submessage", (override) => {
const event = event_fixtures.submessage;
with_stub((stub) => {
override(submessage, "handle_event", stub.f);
dispatch(event);
const submsg = stub.get_args("submsg").submsg;
assert_same(submsg, {
id: 99,
sender_id: 42,
msg_type: "stream",
message_id: 56,
content: "test",
});
const stub = make_stub();
override(submessage, "handle_event", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const submsg = stub.get_args("submsg").submsg;
assert_same(submsg, {
id: 99,
sender_id: 42,
msg_type: "stream",
message_id: 56,
content: "test",
});
});
@ -560,20 +572,24 @@ run_test("submessage", (override) => {
run_test("typing", (override) => {
let event = event_fixtures.typing__start;
with_stub((stub) => {
{
const stub = make_stub();
override(typing_events, "display_notification", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("event");
assert_same(args.event.sender.user_id, typing_person1.user_id);
});
}
event = event_fixtures.typing__stop;
with_stub((stub) => {
{
const stub = make_stub();
override(typing_events, "hide_notification", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("event");
assert_same(args.event.sender.user_id, typing_person1.user_id);
});
}
page_params.user_id = typing_person1.user_id;
event = event_fixtures.typing__start;
@ -643,39 +659,47 @@ run_test("update_display_settings", (override) => {
override(realm_logo, "rerender", noop);
with_stub((stub) => {
{
const stub = make_stub();
event = event_fixtures.update_display_settings__color_scheme_dark;
page_params.color_scheme = 1;
override(night_mode, "enable", stub.f); // automatically checks if called
dispatch(event);
assert.equal(stub.num_calls, 1);
assert(page_params.color_scheme, 2);
});
}
with_stub((stub) => {
{
const stub = make_stub();
event = event_fixtures.update_display_settings__color_scheme_light;
page_params.color_scheme = 1;
override(night_mode, "disable", stub.f); // automatically checks if called
dispatch(event);
assert.equal(stub.num_calls, 1);
assert(page_params.color_scheme, 3);
});
}
with_stub((stub) => {
{
const stub = make_stub();
event = event_fixtures.update_display_settings__color_scheme_automatic;
page_params.color_scheme = 2;
override(night_mode, "default_preference_checker", stub.f); // automatically checks if called
dispatch(event);
assert.equal(stub.num_calls, 1);
assert(page_params.color_scheme, 1);
});
}
with_stub((stub) => {
{
const stub = make_stub();
event = event_fixtures.update_display_settings__emojiset;
called = false;
override(settings_display, "report_emojiset_change", stub.f);
page_params.emojiset = "text";
dispatch(event);
assert.equal(stub.num_calls, 1);
assert_same(called, true);
assert_same(page_params.emojiset, "google");
});
}
override(starred_messages, "rerender_ui", noop);
event = event_fixtures.update_display_settings__starred_message_counts;
@ -689,66 +713,68 @@ run_test("update_display_settings", (override) => {
dispatch(event);
assert_same(page_params.fluid_layout_width, true);
with_stub((stub) => {
{
const stub = make_stub();
event = event_fixtures.update_display_settings__demote_inactive_streams;
override(stream_data, "set_filter_out_inactives", noop);
override(stream_list, "update_streams_sidebar", stub.f);
page_params.demote_inactive_streams = 1;
dispatch(event);
assert.equal(stub.num_calls, 1);
assert_same(page_params.demote_inactive_streams, 2);
});
}
});
run_test("update_global_notifications", (override) => {
const event = event_fixtures.update_global_notifications;
with_stub((stub) => {
override(notifications, "handle_global_notification_updates", stub.f);
override(settings_notifications, "update_page", noop);
dispatch(event);
const args = stub.get_args("name", "setting");
assert_same(args.name, event.notification_name);
assert_same(args.setting, event.setting);
});
const stub = make_stub();
override(notifications, "handle_global_notification_updates", stub.f);
override(settings_notifications, "update_page", noop);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("name", "setting");
assert_same(args.name, event.notification_name);
assert_same(args.setting, event.setting);
});
run_test("update_message (read)", (override) => {
const event = event_fixtures.update_message_flags__read;
with_stub((stub) => {
override(unread_ops, "process_read_messages_event", stub.f);
dispatch(event);
const args = stub.get_args("message_ids");
assert_same(args.message_ids, [999]);
});
const stub = make_stub();
override(unread_ops, "process_read_messages_event", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("message_ids");
assert_same(args.message_ids, [999]);
});
run_test("update_message (add star)", (override) => {
override(starred_messages, "rerender_ui", noop);
const event = event_fixtures.update_message_flags__starred_add;
with_stub((stub) => {
override(ui, "update_starred_view", stub.f);
dispatch(event);
const args = stub.get_args("message_id", "new_value");
assert_same(args.message_id, test_message.id);
assert_same(args.new_value, true); // for 'add'
const msg = message_store.get(test_message.id);
assert.equal(msg.starred, true);
});
const stub = make_stub();
override(ui, "update_starred_view", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("message_id", "new_value");
assert_same(args.message_id, test_message.id);
assert_same(args.new_value, true); // for 'add'
const msg = message_store.get(test_message.id);
assert.equal(msg.starred, true);
});
run_test("update_message (remove star)", (override) => {
override(starred_messages, "rerender_ui", noop);
const event = event_fixtures.update_message_flags__starred_remove;
with_stub((stub) => {
override(ui, "update_starred_view", stub.f);
dispatch(event);
const args = stub.get_args("message_id", "new_value");
assert_same(args.message_id, test_message.id);
assert_same(args.new_value, false);
const msg = message_store.get(test_message.id);
assert.equal(msg.starred, false);
});
const stub = make_stub();
override(ui, "update_starred_view", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("message_id", "new_value");
assert_same(args.message_id, test_message.id);
assert_same(args.new_value, false);
const msg = message_store.get(test_message.id);
assert.equal(msg.starred, false);
});
run_test("delete_message", (override) => {
@ -784,39 +810,45 @@ run_test("delete_message", (override) => {
run_test("user_status", (override) => {
let event = event_fixtures.user_status__set_away;
with_stub((stub) => {
{
const stub = make_stub();
override(activity, "on_set_away", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("user_id");
assert_same(args.user_id, 55);
});
}
event = event_fixtures.user_status__revoke_away;
with_stub((stub) => {
{
const stub = make_stub();
override(activity, "on_revoke_away", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("user_id");
assert_same(args.user_id, 63);
});
}
event = event_fixtures.user_status__set_status_text;
with_stub((stub) => {
{
const stub = make_stub();
override(activity, "redraw_user", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("user_id");
assert_same(args.user_id, test_user.user_id);
const status_text = user_status.get_status_text(test_user.user_id);
assert.equal(status_text, "out to lunch");
});
}
});
run_test("realm_export", (override) => {
const event = event_fixtures.realm_export;
with_stub((stub) => {
override(settings_exports, "populate_exports_table", stub.f);
dispatch(event);
const stub = make_stub();
override(settings_exports, "populate_exports_table", stub.f);
dispatch(event);
const args = stub.get_args("exports");
assert.equal(args.exports, event.exports);
});
assert.equal(stub.num_calls, 1);
const args = stub.get_args("exports");
assert.equal(args.exports, event.exports);
});

101
frontend_tests/node_tests/dispatch_subs.js
View File

@ -3,7 +3,7 @@
const {strict: assert} = require("assert");
const {set_global, zrequire} = require("../zjsunit/namespace");
const {make_stub, with_stub} = require("../zjsunit/stub");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
const events = require("./lib/events");
@ -62,13 +62,13 @@ test("add", (override) => {
name: sub.name,
});
with_stub((subscription_stub) => {
override(stream_events, "mark_subscribed", subscription_stub.f);
dispatch(event);
const args = subscription_stub.get_args("sub", "subscribers");
assert.deepEqual(args.sub.stream_id, stream_id);
assert.deepEqual(args.subscribers, event.subscriptions[0].subscribers);
});
const subscription_stub = make_stub();
override(stream_events, "mark_subscribed", subscription_stub.f);
dispatch(event);
assert.equal(subscription_stub.num_calls, 1);
const args = subscription_stub.get_args("sub", "subscribers");
assert.deepEqual(args.sub.stream_id, stream_id);
assert.deepEqual(args.subscribers, event.subscriptions[0].subscribers);
});
test("peer add/remove", (override) => {
@ -111,34 +111,36 @@ test("remove", (override) => {
stream_data.add_sub(sub);
with_stub((stub) => {
override(stream_events, "mark_unsubscribed", stub.f);
dispatch(event);
const args = stub.get_args("sub");
assert.deepEqual(args.sub, sub);
});
const stub = make_stub();
override(stream_events, "mark_unsubscribed", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub");
assert.deepEqual(args.sub, sub);
});
test("update", (override) => {
const event = event_fixtures.subscription__update;
with_stub((stub) => {
override(stream_events, "update_property", stub.f);
dispatch(event);
const args = stub.get_args("stream_id", "property", "value");
assert.deepEqual(args.stream_id, event.stream_id);
assert.deepEqual(args.property, event.property);
assert.deepEqual(args.value, event.value);
});
const stub = make_stub();
override(stream_events, "update_property", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("stream_id", "property", "value");
assert.deepEqual(args.stream_id, event.stream_id);
assert.deepEqual(args.property, event.property);
assert.deepEqual(args.value, event.value);
});
test("add error handling", (override) => {
// test blueslip errors/warns
const event = event_fixtures.subscription__add;
with_stub((stub) => {
override(blueslip, "error", stub.f);
dispatch(event);
assert.deepEqual(stub.get_args("param").param, "Subscribing to unknown stream with ID 101");
});
const stub = make_stub();
override(blueslip, "error", stub.f);
dispatch(event);
assert.equal(stub.num_calls, 1);
assert.deepEqual(stub.get_args("param").param, "Subscribing to unknown stream with ID 101");
});
test("peer event error handling (bad stream_ids/user_ids)", (override) => {
@ -171,32 +173,33 @@ test("peer event error handling (bad stream_ids/user_ids)", (override) => {
test("stream update", (override) => {
const event = event_fixtures.stream__update;
with_stub((stub) => {
override(stream_events, "update_property", stub.f);
override(settings_streams, "update_default_streams_table", noop);
dispatch(event);
const args = stub.get_args("stream_id", "property", "value");
assert.equal(args.stream_id, event.stream_id);
assert.equal(args.property, event.property);
assert.equal(args.value, event.value);
});
const stub = make_stub();
override(stream_events, "update_property", stub.f);
override(settings_streams, "update_default_streams_table", noop);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("stream_id", "property", "value");
assert.equal(args.stream_id, event.stream_id);
assert.equal(args.property, event.property);
assert.equal(args.value, event.value);
});
test("stream create", (override) => {
const event = event_fixtures.stream__create;
with_stub((stub) => {
override(stream_data, "create_streams", stub.f);
override(stream_data, "get_sub_by_id", noop);
override(stream_data, "update_calculated_fields", noop);
override(subs, "add_sub_to_table", noop);
override(overlays, "streams_open", () => true);
dispatch(event);
const args = stub.get_args("streams");
assert.deepEqual(
args.streams.map((stream) => stream.stream_id),
[101, 102],
);
});
const stub = make_stub();
override(stream_data, "create_streams", stub.f);
override(stream_data, "get_sub_by_id", noop);
override(stream_data, "update_calculated_fields", noop);
override(subs, "add_sub_to_table", noop);
override(overlays, "streams_open", () => true);
dispatch(event);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("streams");
assert.deepEqual(
args.streams.map((stream) => stream.stream_id),
[101, 102],
);
});
test("stream delete (normal)", (override) => {

15
frontend_tests/node_tests/hotkey.js
View File

@ -3,7 +3,7 @@
const {strict: assert} = require("assert");
const {set_global, with_overrides, zrequire} = require("../zjsunit/namespace");
const {with_stub} = require("../zjsunit/stub");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
const {make_zjquery} = require("../zjsunit/zjquery");
@ -86,10 +86,9 @@ function return_false() {
function stubbing(module, func_name_to_stub, test_function) {
with_overrides((override) => {
with_stub((stub) => {
override(module, func_name_to_stub, stub.f);
test_function(stub);
});
const stub = make_stub();
override(module, func_name_to_stub, stub.f);
test_function(stub);
});
}
@ -192,8 +191,9 @@ run_test("basic_chars", () => {
}
function assert_mapping(c, module, func_name, shiftKey) {
stubbing(module, func_name, () => {
stubbing(module, func_name, (stub) => {
assert(process(c, shiftKey));
assert.equal(stub.num_calls, 1);
});
}
@ -406,8 +406,9 @@ run_test("motion_keys", () => {
}
function assert_mapping(key_name, module, func_name, shiftKey, ctrlKey) {
stubbing(module, func_name, () => {
stubbing(module, func_name, (stub) => {
assert(process(key_name, shiftKey, ctrlKey));
assert.equal(stub.num_calls, 1);
});
}

31
frontend_tests/node_tests/message_list.js
View File

@ -3,7 +3,7 @@
const {strict: assert} = require("assert");
const {set_global, stub_out_jquery, zrequire} = require("../zjsunit/namespace");
const {with_stub} = require("../zjsunit/stub");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
// These unit tests for static/js/message_list.js emphasize the model-ish
// aspects of the MessageList class. We have to stub out a few functions
@ -316,54 +316,62 @@ run_test("bookend", (override) => {
override(stream_data, "is_subscribed", () => is_subscribed);
override(stream_data, "get_sub", () => ({invite_only}));
with_stub((stub) => {
{
const stub = make_stub();
list.view.render_trailing_bookend = stub.f;
list.update_trailing_bookend();
assert.equal(stub.num_calls, 1);
const bookend = stub.get_args("content", "subscribed", "show_button");
assert.equal(bookend.content, expected);
assert.equal(bookend.subscribed, true);
assert.equal(bookend.show_button, true);
});
}
expected = "translated: You unsubscribed from stream IceCream";
list.last_message_historical = false;
is_subscribed = false;
with_stub((stub) => {
{
const stub = make_stub();
list.view.render_trailing_bookend = stub.f;
list.update_trailing_bookend();
assert.equal(stub.num_calls, 1);
const bookend = stub.get_args("content", "subscribed", "show_button");
assert.equal(bookend.content, expected);
assert.equal(bookend.subscribed, false);
assert.equal(bookend.show_button, true);
});
}
// Test when the stream is privates (invite only)
expected = "translated: You unsubscribed from stream IceCream";
invite_only = true;
with_stub((stub) => {
{
const stub = make_stub();
list.view.render_trailing_bookend = stub.f;
list.update_trailing_bookend();
assert.equal(stub.num_calls, 1);
const bookend = stub.get_args("content", "subscribed", "show_button");
assert.equal(bookend.content, expected);
assert.equal(bookend.subscribed, false);
assert.equal(bookend.show_button, false);
});
}
expected = "translated: You are not subscribed to stream IceCream";
list.last_message_historical = true;
with_stub((stub) => {
{
const stub = make_stub();
list.view.render_trailing_bookend = stub.f;
list.update_trailing_bookend();
assert.equal(stub.num_calls, 1);
const bookend = stub.get_args("content", "subscribed", "show_button");
assert.equal(bookend.content, expected);
assert.equal(bookend.subscribed, false);
assert.equal(bookend.show_button, true);
});
}
});
run_test("filter_muted_topic_messages", () => {
@ -414,11 +422,12 @@ run_test("add_remove_rerender", () => {
list.add_messages(messages);
assert.equal(list.num_items(), 3);
with_stub((stub) => {
{
const stub = make_stub();
list.rerender = stub.f;
const message_ids = messages.map((msg) => msg.id);
list.remove_and_rerender(message_ids);
assert.equal(stub.num_calls, 1);
assert.equal(list.num_items(), 0);
});
}
});

14
frontend_tests/node_tests/message_store.js
View File

@ -3,7 +3,7 @@
const {strict: assert} = require("assert");
const {set_global, zrequire} = require("../zjsunit/namespace");
const {with_stub} = require("../zjsunit/stub");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
const {make_zjquery} = require("../zjsunit/zjquery");
@ -348,22 +348,26 @@ run_test("message_id_change", () => {
new_id: 402,
};
with_stub((stub) => {
{
const stub = make_stub();
home_msg_list.change_message_id = stub.f;
message_store.reify_message_id(opts);
assert.equal(stub.num_calls, 1);
const msg_id = stub.get_args("old", "new");
assert.equal(msg_id.old, 401);
assert.equal(msg_id.new, 402);
});
}
home_msg_list.view = {};
with_stub((stub) => {
{
const stub = make_stub();
home_msg_list.view.change_message_id = stub.f;
message_store.reify_message_id(opts);
assert.equal(stub.num_calls, 1);
const msg_id = stub.get_args("old", "new");
assert.equal(msg_id.old, 401);
assert.equal(msg_id.new, 402);
});
}
});
run_test("errors", () => {

32
frontend_tests/node_tests/reactions.js
View File

@ -4,7 +4,7 @@ const {strict: assert} = require("assert");
const {stub_templates} = require("../zjsunit/handlebars");
const {set_global, with_field, zrequire} = require("../zjsunit/namespace");
const {with_stub} = require("../zjsunit/stub");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
const {make_zjquery} = require("../zjsunit/zjquery");
@ -264,9 +264,11 @@ run_test("sending", (override) => {
override(reactions, "add_reaction", () => {});
override(reactions, "remove_reaction", () => {});
with_stub((stub) => {
{
const stub = make_stub();
channel.del = stub.f;
reactions.toggle_emoji_reaction(message_id, emoji_name);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("args").args;
assert.equal(args.url, "/json/messages/1001/reactions");
assert.deepEqual(args.data, {
@ -284,11 +286,13 @@ run_test("sending", (override) => {
return "XHR Error Message.";
};
args.error();
});
}
emoji_name = "alien"; // not set yet
with_stub((stub) => {
{
const stub = make_stub();
channel.post = stub.f;
reactions.toggle_emoji_reaction(message_id, emoji_name);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("args").args;
assert.equal(args.url, "/json/messages/1001/reactions");
assert.deepEqual(args.data, {
@ -296,16 +300,18 @@ run_test("sending", (override) => {
emoji_name: "alien",
emoji_code: "1f47d",
});
});
}
emoji_name = "inactive_realm_emoji";
with_stub((stub) => {
{
// Test removing a deactivated realm emoji. An user can interact with a
// deactivated realm emoji only by clicking on a reaction, hence, only
// `process_reaction_click()` codepath supports deleting/adding a deactivated
// realm emoji.
const stub = make_stub();
channel.del = stub.f;
reactions.process_reaction_click(message_id, "realm_emoji,992");
assert.equal(stub.num_calls, 1);
const args = stub.get_args("args").args;
assert.equal(args.url, "/json/messages/1001/reactions");
assert.deepEqual(args.data, {
@ -313,12 +319,14 @@ run_test("sending", (override) => {
emoji_name: "inactive_realm_emoji",
emoji_code: "992",
});
});
}
emoji_name = "zulip"; // Test adding zulip emoji.
with_stub((stub) => {
{
const stub = make_stub();
channel.post = stub.f;
reactions.toggle_emoji_reaction(message_id, emoji_name);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("args").args;
assert.equal(args.url, "/json/messages/1001/reactions");
assert.deepEqual(args.data, {
@ -326,7 +334,7 @@ run_test("sending", (override) => {
emoji_name: "zulip",
emoji_code: "zulip",
});
});
}
emoji_name = "unknown-emoji"; // Test sending an emoji unknown to frontend.
blueslip.expect("warn", "Bad emoji name: " + emoji_name);
@ -778,13 +786,15 @@ run_test("process_reaction_click", () => {
emoji_name: "smile",
emoji_code: "1f642",
};
with_stub((stub) => {
{
const stub = make_stub();
channel.del = stub.f;
reactions.process_reaction_click(message_id, "unicode_emoji,1f642");
assert.equal(stub.num_calls, 1);
const args = stub.get_args("args").args;
assert.equal(args.url, "/json/messages/1001/reactions");
assert.deepEqual(args.data, expected_reaction_info);
});
}
});
run_test("warnings", () => {

124
frontend_tests/node_tests/stream_events.js
View File

@ -3,7 +3,7 @@
const {strict: assert} = require("assert");
const {set_global, zrequire} = require("../zjsunit/namespace");
const {make_stub, with_stub} = require("../zjsunit/stub");
const {make_stub} = require("../zjsunit/stub");
const {run_test} = require("../zjsunit/test");
const {make_zjquery} = require("../zjsunit/zjquery");
@ -89,24 +89,24 @@ run_test("update_property", (override) => {
// Test update color
{
with_stub((stub) => {
override(stream_color, "update_stream_color", stub.f);
stream_events.update_property(stream_id, "color", "blue");
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, "blue");
});
const stub = make_stub();
override(stream_color, "update_stream_color", stub.f);
stream_events.update_property(stream_id, "color", "blue");
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, "blue");
}
// Test in home view
{
with_stub((stub) => {
override(stream_muting, "update_is_muted", stub.f);
stream_events.update_property(stream_id, "in_home_view", false);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, true);
});
const stub = make_stub();
override(stream_muting, "update_is_muted", stub.f);
stream_events.update_property(stream_id, "in_home_view", false);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, true);
}
function checkbox_for(property) {
@ -145,26 +145,26 @@ run_test("update_property", (override) => {
// Test name change
{
with_stub((stub) => {
override(subs, "update_stream_name", stub.f);
stream_events.update_property(stream_id, "name", "the frontend");
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, "the frontend");
});
const stub = make_stub();
override(subs, "update_stream_name", stub.f);
stream_events.update_property(stream_id, "name", "the frontend");
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, "the frontend");
}
// Test description change
{
with_stub((stub) => {
override(subs, "update_stream_description", stub.f);
stream_events.update_property(stream_id, "description", "we write code", {
rendered_description: "we write code",
});
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, "we write code");
const stub = make_stub();
override(subs, "update_stream_description", stub.f);
stream_events.update_property(stream_id, "description", "we write code", {
rendered_description: "we write code",
});
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, "we write code");
}
// Test email address change
@ -181,44 +181,44 @@ run_test("update_property", (override) => {
// Test stream privacy change event
{
with_stub((stub) => {
override(subs, "update_stream_privacy", stub.f);
stream_events.update_property(stream_id, "invite_only", true, {
history_public_to_subscribers: true,
});
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.deepEqual(args.val, {
invite_only: true,
history_public_to_subscribers: true,
});
const stub = make_stub();
override(subs, "update_stream_privacy", stub.f);
stream_events.update_property(stream_id, "invite_only", true, {
history_public_to_subscribers: true,
});
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.deepEqual(args.val, {
invite_only: true,
history_public_to_subscribers: true,
});
}
// Test stream stream_post_policy change event
{
with_stub((stub) => {
override(subs, "update_stream_post_policy", stub.f);
stream_events.update_property(
stream_id,
"stream_post_policy",
stream_data.stream_post_policy_values.admins.code,
);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, stream_data.stream_post_policy_values.admins.code);
});
const stub = make_stub();
override(subs, "update_stream_post_policy", stub.f);
stream_events.update_property(
stream_id,
"stream_post_policy",
stream_data.stream_post_policy_values.admins.code,
);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, stream_data.stream_post_policy_values.admins.code);
}
// Test stream message_retention_days change event
{
with_stub((stub) => {
override(subs, "update_message_retention_setting", stub.f);
stream_events.update_property(stream_id, "message_retention_days", 20);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, 20);
});
const stub = make_stub();
override(subs, "update_message_retention_setting", stub.f);
stream_events.update_property(stream_id, "message_retention_days", 20);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("sub", "val");
assert.equal(args.sub.stream_id, stream_id);
assert.equal(args.val, 20);
}
});
@ -298,14 +298,16 @@ run_test("marked_subscribed (color)", (override) => {
});
// narrow state is undefined
with_stub((stub) => {
{
const stub = make_stub();
override(subs, "set_color", stub.f);
stream_events.mark_subscribed(frontend, [], undefined);
assert.equal(stub.num_calls, 1);
const args = stub.get_args("id", "color");
assert.equal(args.id, frontend.stream_id);
assert.equal(args.color, "green");
assert.equal(warnings, 1);
});
}
});
run_test("marked_subscribed (emails)", (override) => {