paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-29 19:13:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

open graph: Include multiple paragraphs in description tags.

Browse Source
This commit is contained in:
Rishi Gupta
2019-02-10 22:03:20 -08:00
committed by Tim Abbott
parent cd0e55cb95
commit e1f02dc6f2
3 changed files with 47 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
zerver/tests/test_middleware.py
View File

@@ -1,4 +1,6 @@
import re
import time
from typing import List
from django.test import override_settings
from unittest.mock import Mock, patch
@@ -51,16 +53,29 @@ class SlowQueryTest(ZulipTestCase):
mock_internal_send_message.assert_not_called()
class OpenGraphTest(ZulipTestCase):
def check_title_and_description(self, path: str, title: str, description: str) -> None:
def check_title_and_description(self, path: str, title: str,
in_description: List[str],
not_in_description: List[str]) -> None:
response = self.client_get(path)
self.assert_in_success_response([
# Open graph
'<meta property="og:title" content="{}">'.format(title),
'<meta property="og:description" content="{}">'.format(description),
# Twitter
'<meta property="twitter:title" content="{}">'.format(title),
'<meta name="twitter:description" content="{}">'.format(description),
], response)
self.assertEqual(response.status_code, 200)
decoded = response.content.decode('utf-8')
for title_string in [
'<meta property="og:title" content="{}">'.format(title),
'<meta property="twitter:title" content="{}">'.format(title)]:
self.assertIn(title_string, decoded)
open_graph_description = re.search( # type: ignore
r'<meta property="og:description" content="(?P<description>[^>]*)">',
decoded).group('description')
twitter_description = re.search( # type: ignore
r'<meta name="twitter:description" content="(?P<description>[^>]*)">',
decoded).group('description')
for substring in in_description:
self.assertIn(substring, open_graph_description)
self.assertIn(substring, twitter_description)
for substring in not_in_description:
self.assertNotIn(substring, open_graph_description)
self.assertNotIn(substring, twitter_description)
def test_admonition_and_link(self) -> None:
# disable-message-edit-history starts with an {!admin-only.md!}, and has a link
@@ -68,17 +83,19 @@ class OpenGraphTest(ZulipTestCase):
self.check_title_and_description(
'/help/disable-message-edit-history',
"Disable message edit history (Zulip Help Center)",
"By default, Zulip displays messages that have been edited with an EDITED tag, " +
"and users can view the edit history of a message.")
["By default, Zulip displays messages",
"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|your-account}
self.check_title_and_description(
'/help/deactivate-your-account',
"Deactivate your account (Zulip Help Center)",
# Ideally, we'd grab the second and third paragraphs as well, if
# the first paragraph is this short
"Go to Your account.")
["Go to Your account. Under Deactivate account, click"], [])
def test_tabs(self) -> None:
# logging-out starts with {start_tabs}
@@ -86,22 +103,20 @@ class OpenGraphTest(ZulipTestCase):
'/help/logging-out',
"Logging out (Zulip Help Center)",
# Ideally we'd do something better here
"")
["Click on the gear () icon in", "Click Log out. Tap the menu"], [])
def test_index_pages(self) -> None:
self.check_title_and_description(
'/help/',
"Zulip Help Center",
("Zulip is a group chat app. Its most distinctive characteristic is that "
"conversation within an organization is divided into “streams” and further "
"subdivided into “topics”, so that much finer-grained conversations are possible "
"than with IRC or other chat tools."))
[("Zulip is a group chat app. Its most distinctive characteristic is that "
"conversation within an organization is divided into “streams” and further ")], [])
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:"))
[("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:
response = self.client_get('/help/not-a-real-page')
@@ -110,4 +125,6 @@ class OpenGraphTest(ZulipTestCase):
self.assert_in_response(
# Probably we should make this "Zulip Help Center"
'<meta property="og:title" content="No such article. (Zulip Help Center)">', response)
self.assert_in_response('<meta property="og:description" content="No such article.">', response)
self.assert_in_response('<meta property="og:description" content="No such article. '
'We\'re here to help! Email us at zulip-admin@example.com with questions, '
'feedback, or feature requests.">', response)