mirror of https://github.com/zulip/zulip.git
189 lines
9.0 KiB
Python
189 lines
9.0 KiB
Python
from django.conf import settings
|
||
from typing_extensions import override
|
||
|
||
from zerver.actions.message_send import internal_send_private_message
|
||
from zerver.lib.test_classes import ZulipTestCase
|
||
from zerver.lib.test_helpers import message_stream_count, most_recent_message
|
||
from zerver.models import UserProfile
|
||
from zerver.models.users import get_system_bot
|
||
|
||
|
||
class TutorialTests(ZulipTestCase):
|
||
@override
|
||
def setUp(self) -> None:
|
||
super().setUp()
|
||
# This emulates the welcome message sent by the welcome bot to hamlet@zulip.com
|
||
# This is only a quick fix - ideally, we would have this message sent by the initialization
|
||
# code in populate_db.py
|
||
user = self.example_user("hamlet")
|
||
welcome_bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
content = "Shortened welcome message."
|
||
internal_send_private_message(
|
||
welcome_bot,
|
||
user,
|
||
content,
|
||
# disable_external_notifications set to False will still lead
|
||
# the tests to pass. Setting this to True, because we contextually
|
||
# set this to true for welcome_bot in the codebase.
|
||
disable_external_notifications=True,
|
||
)
|
||
|
||
def test_tutorial_status(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
self.login_user(user)
|
||
|
||
cases = [
|
||
("started", UserProfile.TUTORIAL_STARTED),
|
||
("finished", UserProfile.TUTORIAL_FINISHED),
|
||
]
|
||
for incoming_status, expected_db_status in cases:
|
||
params = dict(status=incoming_status)
|
||
result = self.client_post("/json/users/me/tutorial_status", params)
|
||
self.assert_json_success(result)
|
||
user = self.example_user("hamlet")
|
||
self.assertEqual(user.tutorial_status, expected_db_status)
|
||
|
||
def test_response_to_pm_for_app(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["app", "Apps"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"You can [download](/apps/) the [mobile and desktop apps](/apps/). "
|
||
"Zulip also works great in a browser."
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_edit(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["profile", "Profile"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"Go to [Profile settings](#settings/profile) "
|
||
"to add a [profile picture](/help/change-your-profile-picture) "
|
||
"and edit your [profile information](/help/edit-your-profile)."
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_theme(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["theme", "Theme"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"Go to [Preferences](#settings/preferences) "
|
||
"to [switch between the light and dark themes](/help/dark-theme), "
|
||
"[pick your favorite emoji theme](/help/emoji-and-emoticons#change-your-emoji-set), "
|
||
"[change your language](/help/change-your-language), and make other tweaks to your Zulip experience."
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_stream(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["Streams", "streams", "channels"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"In Zulip, channels [determine who gets a message](/help/streams-and-topics).\n\n"
|
||
"[Browse and subscribe to channels](#channels/all)."
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_topic(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["Topics", "topics"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"In Zulip, topics [tell you what a message is about](/help/streams-and-topics). "
|
||
"They are light-weight subjects, very similar to the subject line of an email.\n\n"
|
||
"Check out [Recent conversations](#recent) to see what's happening! "
|
||
'You can return to this conversation by clicking "Direct messages" in the upper left.'
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_shortcuts(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["Keyboard shortcuts", "shortcuts", "Shortcuts"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"Zulip's [keyboard shortcuts](#keyboard-shortcuts) "
|
||
"let you navigate the app quickly and efficiently.\n\n"
|
||
"Press `?` any time to see a [cheat sheet](#keyboard-shortcuts)."
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_formatting(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["message formatting", "Formatting"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"Zulip uses [Markdown](/help/format-your-message-using-markdown), "
|
||
"an intuitive format for **bold**, *italics*, bulleted lists, and more. "
|
||
"Click [here](#message-formatting) for a cheat sheet.\n\n"
|
||
"Check out our [messaging tips](/help/messaging-tips) to learn about emoji reactions, "
|
||
"code blocks and much more!"
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_help(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["help", "Help", "?"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"Here are a few messages I understand: "
|
||
"`apps`, `profile`, `theme`, "
|
||
"`channels`, `topics`, `message formatting`, `keyboard shortcuts`.\n\n"
|
||
"Check out our [Getting started guide](/help/getting-started-with-zulip), "
|
||
"or browse the [Help center](/help/) to learn more!"
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_response_to_pm_for_undefined(self) -> None:
|
||
user = self.example_user("hamlet")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user.realm_id)
|
||
messages = ["Hello", "HAHAHA", "OKOK", "LalulaLapas"]
|
||
self.login_user(user)
|
||
for content in messages:
|
||
self.send_personal_message(user, bot, content)
|
||
expected_response = (
|
||
"I’m sorry, I did not understand your message. Please try one of the following commands: "
|
||
"`apps`, `profile`, `theme`, `channels`, "
|
||
"`topics`, `message formatting`, `keyboard shortcuts`, `help`."
|
||
)
|
||
self.assertEqual(most_recent_message(user).content, expected_response)
|
||
|
||
def test_no_response_to_group_pm(self) -> None:
|
||
user1 = self.example_user("hamlet")
|
||
user2 = self.example_user("cordelia")
|
||
bot = get_system_bot(settings.WELCOME_BOT, user1.realm_id)
|
||
content = "whatever"
|
||
self.login_user(user1)
|
||
self.send_huddle_message(user1, [bot, user2], content)
|
||
user1_messages = message_stream_count(user1)
|
||
self.assertEqual(most_recent_message(user1).content, content)
|
||
# Welcome bot should still respond to initial direct message
|
||
# after group direct message.
|
||
self.send_personal_message(user1, bot, content)
|
||
self.assertEqual(message_stream_count(user1), user1_messages + 2)
|