mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 14:03:30 +00:00
df001db1a9
Black 23 enforces some slightly more specific rules about empty line counts and redundant parenthesis removal, but the result is still compatible with Black 22. (This does not actually upgrade our Python environment to Black 23 yet.) Signed-off-by: Anders Kaseorg <anders@zulip.com>
268 lines
10 KiB
Python
268 lines
10 KiB
Python
import time
|
|
from typing import List
|
|
from unittest.mock import patch
|
|
|
|
from bs4 import BeautifulSoup
|
|
from django.http import HttpResponse
|
|
|
|
from zerver.lib.realm_icon import get_realm_icon_url
|
|
from zerver.lib.request import RequestNotes
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
from zerver.lib.test_helpers import HostRequestMock
|
|
from zerver.lib.utils import assert_is_not_none
|
|
from zerver.middleware import LogRequests, is_slow_query, write_log_line
|
|
from zerver.models import get_realm
|
|
from zilencer.models import RemoteZulipServer
|
|
|
|
|
|
class SlowQueryTest(ZulipTestCase):
|
|
SLOW_QUERY_TIME = 10
|
|
log_data = {
|
|
"extra": "[transport=websocket]",
|
|
"time_started": 0,
|
|
"markdown_requests_start": 0,
|
|
"markdown_time_start": 0,
|
|
"remote_cache_time_start": 0,
|
|
"remote_cache_requests_start": 0,
|
|
}
|
|
|
|
def test_is_slow_query(self) -> None:
|
|
self.assertFalse(is_slow_query(1.1, "/some/random/url"))
|
|
self.assertTrue(is_slow_query(2, "/some/random/url"))
|
|
self.assertTrue(is_slow_query(5.1, "/activity"))
|
|
self.assertFalse(is_slow_query(2, "/activity"))
|
|
self.assertFalse(is_slow_query(2, "/json/report/error"))
|
|
self.assertFalse(is_slow_query(2, "/api/v1/deployments/report_error"))
|
|
self.assertFalse(is_slow_query(2, "/realm_activity/whatever"))
|
|
self.assertFalse(is_slow_query(2, "/user_activity/whatever"))
|
|
self.assertFalse(is_slow_query(9, "/accounts/webathena_kerberos_login/"))
|
|
self.assertTrue(is_slow_query(11, "/accounts/webathena_kerberos_login/"))
|
|
|
|
def test_slow_query_log(self) -> None:
|
|
self.log_data["time_started"] = time.time() - self.SLOW_QUERY_TIME
|
|
with self.assertLogs(
|
|
"zulip.slow_queries", level="INFO"
|
|
) as slow_query_logger, self.assertLogs(
|
|
"zulip.requests", level="INFO"
|
|
) as middleware_normal_logger:
|
|
write_log_line(
|
|
self.log_data,
|
|
path="/some/endpoint/",
|
|
method="GET",
|
|
remote_ip="123.456.789.012",
|
|
requestor_for_logs="unknown",
|
|
client_name="?",
|
|
)
|
|
self.assert_length(middleware_normal_logger.output, 1)
|
|
self.assert_length(slow_query_logger.output, 1)
|
|
|
|
self.assertRegex(
|
|
slow_query_logger.output[0],
|
|
r"123\.456\.789\.012 GET 200 10\.\ds .* \(unknown via \?\)",
|
|
)
|
|
|
|
|
|
class OpenGraphTest(ZulipTestCase):
|
|
def check_title_and_description(
|
|
self,
|
|
path: str,
|
|
title: str,
|
|
in_description: List[str],
|
|
not_in_description: List[str],
|
|
status_code: int = 200,
|
|
) -> None:
|
|
response = self.client_get(path)
|
|
self.assertEqual(response.status_code, status_code)
|
|
bs = BeautifulSoup(response.content, features="lxml")
|
|
open_graph_title = assert_is_not_none(bs.select_one('meta[property="og:title"]')).get(
|
|
"content"
|
|
)
|
|
self.assertEqual(open_graph_title, title)
|
|
|
|
open_graph_description = assert_is_not_none(
|
|
bs.select_one('meta[property="og:description"]')
|
|
).get("content")
|
|
assert isinstance(open_graph_description, str)
|
|
for substring in in_description:
|
|
self.assertIn(substring, open_graph_description)
|
|
for substring in not_in_description:
|
|
self.assertNotIn(substring, open_graph_description)
|
|
|
|
def test_admonition_and_link(self) -> None:
|
|
# disable-message-edit-history starts with an {!admin-only.md!}, and has a link
|
|
# in the first paragraph.
|
|
self.check_title_and_description(
|
|
"/help/disable-message-edit-history",
|
|
"Disable message edit history | Zulip help center",
|
|
[
|
|
"In Zulip, users can view the edit history of a message. | To remove the",
|
|
"best to delete the message entirely. ",
|
|
],
|
|
[
|
|
"Disable message edit history",
|
|
"feature is only available",
|
|
"Related articles",
|
|
"Restrict message editing",
|
|
],
|
|
)
|
|
|
|
def test_settings_tab(self) -> None:
|
|
# deactivate-your-account starts with {settings_tab|account-and-privacy}
|
|
self.check_title_and_description(
|
|
"/help/deactivate-your-account",
|
|
"Deactivate your account | Zulip help center",
|
|
["Any bots that you maintain will be disabled. | Deactivating "],
|
|
["Confirm by clicking", " ", "\n"],
|
|
)
|
|
|
|
def test_tabs(self) -> None:
|
|
# logging-out starts with {start_tabs}
|
|
self.check_title_and_description(
|
|
"/help/logging-out",
|
|
"Logging out | Zulip help center",
|
|
# Ideally we'd do something better here
|
|
[
|
|
"Your feedback helps us make Zulip better for everyone! Please contact us with"
|
|
" questions, suggestions, and feature requests."
|
|
],
|
|
["Click on the gear"],
|
|
)
|
|
|
|
def test_index_pages(self) -> None:
|
|
self.check_title_and_description(
|
|
"/help/",
|
|
"Zulip help center",
|
|
[("Welcome to the Zulip")],
|
|
[],
|
|
)
|
|
|
|
self.check_title_and_description(
|
|
"/api/",
|
|
"Zulip API documentation",
|
|
[
|
|
(
|
|
"Zulip's APIs allow you to integrate other services with Zulip. This "
|
|
"guide should help you find the API you need:"
|
|
)
|
|
],
|
|
[],
|
|
)
|
|
|
|
def test_nonexistent_page(self) -> None:
|
|
self.check_title_and_description(
|
|
"/help/not-a-real-page",
|
|
# Probably we should make this "Zulip Help Center"
|
|
"No such article. | Zulip help center",
|
|
[
|
|
"No such article.",
|
|
"Your feedback helps us make Zulip better for everyone! Please contact us",
|
|
],
|
|
[],
|
|
# Test that our open graph logic doesn't throw a 500
|
|
404,
|
|
)
|
|
|
|
def test_login_page_simple_description(self) -> None:
|
|
name = "Zulip Dev"
|
|
description = (
|
|
"The Zulip development environment default organization. It's great for testing!"
|
|
)
|
|
|
|
self.check_title_and_description("/login/", name, [description], [])
|
|
|
|
def test_login_page_markdown_description(self) -> None:
|
|
realm = get_realm("zulip")
|
|
description = (
|
|
"Welcome to **Clojurians Zulip** - the place where the Clojure community meets.\n\n"
|
|
"Before you signup/login:\n\n"
|
|
"* note-1\n"
|
|
"* note-2\n"
|
|
"* note-3\n\n"
|
|
"Enjoy!"
|
|
)
|
|
realm.description = description
|
|
realm.save(update_fields=["description"])
|
|
|
|
self.check_title_and_description(
|
|
"/login/",
|
|
"Zulip Dev",
|
|
[
|
|
"Welcome to Clojurians Zulip - the place where the Clojure community meets",
|
|
"* note-1 * note-2 * note-3 | Enjoy!",
|
|
],
|
|
[],
|
|
)
|
|
|
|
def test_login_page_realm_icon(self) -> None:
|
|
realm = get_realm("zulip")
|
|
realm.icon_source = "U"
|
|
realm.save(update_fields=["icon_source"])
|
|
realm_icon = get_realm_icon_url(realm)
|
|
|
|
response = self.client_get("/login/")
|
|
self.assertEqual(response.status_code, 200)
|
|
|
|
bs = BeautifulSoup(response.content, features="lxml")
|
|
open_graph_image = assert_is_not_none(bs.select_one('meta[property="og:image"]')).get(
|
|
"content"
|
|
)
|
|
self.assertEqual(open_graph_image, f"{realm.uri}{realm_icon}")
|
|
|
|
def test_login_page_realm_icon_absolute_url(self) -> None:
|
|
realm = get_realm("zulip")
|
|
realm.icon_source = "U"
|
|
realm.save(update_fields=["icon_source"])
|
|
icon_url = f"https://foo.s3.amazonaws.com/{realm.id}/realm/icon.png?version={1}"
|
|
with patch(
|
|
"zerver.lib.realm_icon.upload_backend.get_realm_icon_url", return_value=icon_url
|
|
):
|
|
response = self.client_get("/login/")
|
|
self.assertEqual(response.status_code, 200)
|
|
|
|
bs = BeautifulSoup(response.content, features="lxml")
|
|
open_graph_image = assert_is_not_none(bs.select_one('meta[property="og:image"]')).get(
|
|
"content"
|
|
)
|
|
self.assertEqual(open_graph_image, icon_url)
|
|
|
|
def test_no_realm_api_page_og_url(self) -> None:
|
|
response = self.client_get("/api/", subdomain="")
|
|
self.assertEqual(response.status_code, 200)
|
|
|
|
bs = BeautifulSoup(response.content, features="lxml")
|
|
open_graph_url = assert_is_not_none(bs.select_one('meta[property="og:url"]')).get("content")
|
|
|
|
assert isinstance(open_graph_url, str)
|
|
self.assertTrue(open_graph_url.endswith("/api/"))
|
|
|
|
|
|
class LogRequestsTest(ZulipTestCase):
|
|
meta_data = {"REMOTE_ADDR": "127.0.0.1"}
|
|
|
|
def test_requestor_for_logs_as_user(self) -> None:
|
|
hamlet = self.example_user("hamlet")
|
|
request = HostRequestMock(user_profile=hamlet, meta_data=self.meta_data)
|
|
RequestNotes.get_notes(request).log_data = None
|
|
|
|
with self.assertLogs("zulip.requests", level="INFO") as m:
|
|
LogRequests(lambda _: HttpResponse())(request)
|
|
self.assertIn(hamlet.format_requestor_for_logs(), m.output[0])
|
|
|
|
def test_requestor_for_logs_as_remote_server(self) -> None:
|
|
remote_server = RemoteZulipServer()
|
|
request = HostRequestMock(remote_server=remote_server, meta_data=self.meta_data)
|
|
RequestNotes.get_notes(request).log_data = None
|
|
|
|
with self.assertLogs("zulip.requests", level="INFO") as m:
|
|
LogRequests(lambda _: HttpResponse())(request)
|
|
self.assertIn(remote_server.format_requestor_for_logs(), m.output[0])
|
|
|
|
def test_requestor_for_logs_unauthenticated(self) -> None:
|
|
request = HostRequestMock(meta_data=self.meta_data)
|
|
RequestNotes.get_notes(request).log_data = None
|
|
|
|
expected_requestor = "unauth@root"
|
|
with self.assertLogs("zulip.requests", level="INFO") as m:
|
|
LogRequests(lambda _: HttpResponse())(request)
|
|
self.assertIn(expected_requestor, m.output[0])
|