mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 21:43:21 +00:00
268f858f39
This swaps out url_format_string from all of our APIs and replaces it
with url_template. Note that the documentation changes in the following
commits will be squashed with this commit.
We change the "url_format" key to "url_template" for the
realm_linkifiers events in event_schema, along with updating
LinkifierDict. "url_template" is the name chosen to normalize
mixed usages of "url_format_string" and "url_format" throughout
the backend.
The markdown processor is updated to stop handling the format string
interpolation and delegate the task template expansion to the uri_template
library instead.
This change affects many test cases. We mostly just replace "%(name)s"
with "{name}", "url_format_string" with "url_template" to make sure that
they still pass. There are some test cases dedicated for testing "%"
escaping, which aren't relevant anymore and are subject to removal.
But for now we keep most of them as-is, and make sure that "%" is always
escaped since we do not use it for variable substitution any more.
Since url_format_string is not populated anymore, a migration is created
to remove this field entirely, and make url_template non-nullable since
we will always populate it. Note that it is possible to have
url_template being null after migration 0422 and before 0424, but
in practice, url_template will not be None after backfilling and the
backend now is always setting url_template.
With the removal of url_format_string, RealmFilter model will now be cleaned
with URL template checks, and the old checks for escapes are removed.
We also modified RealmFilter.clean to skip the validation when the
url_template is invalid. This avoids raising mulitple ValidationError's
when calling full_clean on a linkifier. But we might eventually want to
have a more centric approach to data validation instead of having
the same validation in both the clean method and the validator.
Fixes #23124.
Signed-off-by: Zixuan James Li <p359101898@gmail.com>
263 lines
12 KiB
Python
263 lines
12 KiB
Python
import re
|
|
|
|
from django.core.exceptions import ValidationError
|
|
|
|
from zerver.lib.test_classes import ZulipTestCase
|
|
from zerver.models import RealmFilter, url_template_validator
|
|
|
|
|
|
class RealmFilterTest(ZulipTestCase):
|
|
def test_list(self) -> None:
|
|
self.login("iago")
|
|
data = {
|
|
"pattern": "#(?P<id>[123])",
|
|
"url_template": "https://realm.com/my_realm_filter/{id}",
|
|
}
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
|
|
result = self.client_get("/json/realm/linkifiers")
|
|
linkifiers = self.assert_json_success(result)["linkifiers"]
|
|
self.assert_length(linkifiers, 1)
|
|
self.assertEqual(linkifiers[0]["pattern"], "#(?P<id>[123])")
|
|
self.assertEqual(linkifiers[0]["url_template"], "https://realm.com/my_realm_filter/{id}")
|
|
|
|
def test_create(self) -> None:
|
|
self.login("iago")
|
|
data = {"pattern": "", "url_template": "https://realm.com/my_realm_filter/{id}"}
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(result, "This field cannot be blank.")
|
|
|
|
data["pattern"] = "(foo"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(result, "Bad regular expression: missing ): (foo")
|
|
|
|
data["pattern"] = r"ZUL-(?P<id>\d????)"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(result, "Bad regular expression: bad repetition operator: ????")
|
|
|
|
data["pattern"] = r"ZUL-(?P<id>\d+)"
|
|
data["url_template"] = "$fgfg"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(
|
|
result, "Group 'id' in linkifier pattern is not present in URL template."
|
|
)
|
|
|
|
data["pattern"] = r"ZUL-(?P<id>\d+)"
|
|
data["url_template"] = "https://realm.com/my_realm_filter/"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(
|
|
result, "Group 'id' in linkifier pattern is not present in URL template."
|
|
)
|
|
|
|
data["url_template"] = "https://realm.com/my_realm_filter/#hashtag/{id}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "ZUL-15"))
|
|
|
|
data["pattern"] = r"ZUL2-(?P<id>\d+)"
|
|
data["url_template"] = "https://realm.com/my_realm_filter/?value={id}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "ZUL2-15"))
|
|
|
|
data["pattern"] = r"_code=(?P<id>[0-9a-zA-Z]+)"
|
|
data["url_template"] = "https://example.com/product/{id}/details"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "_code=123abcdZ"))
|
|
|
|
data["pattern"] = r"PR (?P<id>[0-9]+)"
|
|
data[
|
|
"url_template"
|
|
] = "https://example.com/~user/web#view_type=type&model=model&action=12345&id={id}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "PR 123"))
|
|
|
|
data["pattern"] = r"lp/(?P<id>[0-9]+)"
|
|
data["url_template"] = "https://realm.com/my_realm_filter/?value={id}&sort=reverse"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "lp/123"))
|
|
|
|
data["pattern"] = r"lp:(?P<id>[0-9]+)"
|
|
data["url_template"] = "https://realm.com/my_realm_filter/?sort=reverse&value={id}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "lp:123"))
|
|
|
|
data["pattern"] = r"!(?P<id>[0-9]+)"
|
|
data["url_template"] = "https://realm.com/index.pl?Action=AgentTicketZoom;TicketNumber={id}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "!123"))
|
|
|
|
# This block of tests is for mismatches between field sets
|
|
data["pattern"] = r"ZUL-(?P<id>\d+)"
|
|
data["url_template"] = r"https://realm.com/my_realm_filter/{hello}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(
|
|
result, "Group 'hello' in URL template is not present in linkifier pattern."
|
|
)
|
|
|
|
data["pattern"] = r"ZUL-(?P<id>\d+)-(?P<hello>\d+)"
|
|
data["url_template"] = r"https://realm.com/my_realm_filter/{hello}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(
|
|
result, "Group 'id' in linkifier pattern is not present in URL template."
|
|
)
|
|
|
|
data["pattern"] = r"ZULZ-(?P<hello>\d+)-(?P<world>\d+)"
|
|
data["url_template"] = r"https://realm.com/my_realm_filter/{hello}/{world}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
|
|
data["pattern"] = r"ZUL-(?P<id>\d+)-(?P<hello>\d+)-(?P<world>\d+)"
|
|
data["url_template"] = r"https://realm.com/my_realm_filter/{hello}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_error(
|
|
result, "Group 'id' in linkifier pattern is not present in URL template."
|
|
)
|
|
|
|
data["pattern"] = r"ZUL-URL-(?P<id>\d+)"
|
|
data["url_template"] = "https://example.com/%ba/{id}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
|
|
data["pattern"] = r"(?P<org>[a-zA-Z0-9_-]+)/(?P<repo>[a-zA-Z0-9_-]+)#(?P<id>[0-9]+)"
|
|
data["url_template"] = "https://github.com/{org}/{repo}/issue/{id}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "zulip/zulip#123"))
|
|
|
|
data[
|
|
"pattern"
|
|
] = r"FOO_(?P<id>[a-f]{5});(?P<zone>[a-f]);(?P<domain>[a-z]+);(?P<location>[a-z]+);(?P<name>[a-z]{2,8});(?P<chapter>[0-9]{2,3});(?P<fragment>[a-z]{2,8})"
|
|
data[
|
|
"url_template"
|
|
] = "https://zone_{zone}{.domain}.net/ticket{/location}{/id}{?name,chapter}{#fragment:5}"
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
self.assert_json_success(result)
|
|
|
|
def test_not_realm_admin(self) -> None:
|
|
self.login("hamlet")
|
|
result = self.client_post("/json/realm/filters")
|
|
self.assert_json_error(result, "Must be an organization administrator")
|
|
result = self.client_delete("/json/realm/filters/15")
|
|
self.assert_json_error(result, "Must be an organization administrator")
|
|
|
|
def test_delete(self) -> None:
|
|
self.login("iago")
|
|
data = {
|
|
"pattern": "#(?P<id>[123])",
|
|
"url_template": "https://realm.com/my_realm_filter/{id}",
|
|
}
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
linkifier_id = self.assert_json_success(result)["id"]
|
|
linkifiers_count = RealmFilter.objects.count()
|
|
result = self.client_delete(f"/json/realm/filters/{linkifier_id + 1}")
|
|
self.assert_json_error(result, "Linkifier not found.")
|
|
|
|
result = self.client_delete(f"/json/realm/filters/{linkifier_id}")
|
|
self.assert_json_success(result)
|
|
self.assertEqual(RealmFilter.objects.count(), linkifiers_count - 1)
|
|
|
|
def test_update(self) -> None:
|
|
self.login("iago")
|
|
data = {
|
|
"pattern": "#(?P<id>[123])",
|
|
"url_template": "https://realm.com/my_realm_filter/{id}",
|
|
}
|
|
result = self.client_post("/json/realm/filters", info=data)
|
|
linkifier_id = self.assert_json_success(result)["id"]
|
|
data = {
|
|
"pattern": "#(?P<id>[0-9]+)",
|
|
"url_template": "https://realm.com/my_realm_filter/issues/{id}",
|
|
}
|
|
result = self.client_patch(f"/json/realm/filters/{linkifier_id}", info=data)
|
|
self.assert_json_success(result)
|
|
self.assertIsNotNone(re.match(data["pattern"], "#1234"))
|
|
|
|
# Verify that the linkifier is updated accordingly.
|
|
result = self.client_get("/json/realm/linkifiers")
|
|
linkifier = self.assert_json_success(result)["linkifiers"]
|
|
self.assert_length(linkifier, 1)
|
|
self.assertEqual(linkifier[0]["pattern"], "#(?P<id>[0-9]+)")
|
|
self.assertEqual(
|
|
linkifier[0]["url_template"], "https://realm.com/my_realm_filter/issues/{id}"
|
|
)
|
|
|
|
data = {
|
|
"pattern": r"ZUL-(?P<id>\d????)",
|
|
"url_template": "https://realm.com/my_realm_filter/{id}",
|
|
}
|
|
result = self.client_patch(f"/json/realm/filters/{linkifier_id}", info=data)
|
|
self.assert_json_error(result, "Bad regular expression: bad repetition operator: ????")
|
|
|
|
data["pattern"] = r"ZUL-(?P<id>\d+)"
|
|
data["url_template"] = "$fgfg"
|
|
result = self.client_patch(f"/json/realm/filters/{linkifier_id}", info=data)
|
|
self.assert_json_error(
|
|
result, "Group 'id' in linkifier pattern is not present in URL template."
|
|
)
|
|
|
|
data["pattern"] = r"#(?P<id>[123])"
|
|
data["url_template"] = "https://realm.com/my_realm_filter/{id}"
|
|
result = self.client_patch(f"/json/realm/filters/{linkifier_id + 1}", info=data)
|
|
self.assert_json_error(result, "Linkifier not found.")
|
|
|
|
data["pattern"] = r"#(?P<id>[123])"
|
|
data["url_template"] = "{id"
|
|
result = self.client_patch(f"/json/realm/filters/{linkifier_id}", info=data)
|
|
self.assert_json_error(result, "Invalid URL template.")
|
|
|
|
def test_valid_urls(self) -> None:
|
|
valid_urls = [
|
|
"http://example.com/",
|
|
"https://example.com/",
|
|
"https://user:password@example.com/",
|
|
"https://example.com/@user/thing",
|
|
"https://example.com/!path",
|
|
"https://example.com/foo.bar",
|
|
"https://example.com/foo[bar]",
|
|
"https://example.com/{foo}",
|
|
"https://example.com/{foo}{bars}",
|
|
"https://example.com/{foo}/and/{bar}",
|
|
"https://example.com/?foo={foo}",
|
|
"https://example.com/%ab",
|
|
"https://example.com/%ba",
|
|
"https://example.com/%21",
|
|
"https://example.com/words%20with%20spaces",
|
|
"https://example.com/back%20to%20{back}",
|
|
"https://example.com/encoded%2fwith%2fletters",
|
|
"https://example.com/encoded%2Fwith%2Fupper%2Fcase%2Fletters",
|
|
"https://example.com/%%",
|
|
"https://example.com/%%(",
|
|
"https://example.com/%%()",
|
|
"https://example.com/%%(foo",
|
|
"https://example.com/%%(foo)",
|
|
"https://example.com/%%(foo)s",
|
|
"https://example.com{/foo,bar,baz}",
|
|
"https://example.com/{?foo*}",
|
|
"https://example.com/{+foo,bar}",
|
|
"https://chat{.domain}.com/{#foo}",
|
|
"https://zone_{zone}{.domain}.net/ticket{/location}{/id}{?name,chapter}{#fragment:5}",
|
|
"$not_a_url$",
|
|
]
|
|
for url in valid_urls:
|
|
url_template_validator(url)
|
|
|
|
# No need to test this extensively, because most of the invalid
|
|
# cases should be handled and tested in the uri_template library
|
|
# we used for validation.
|
|
invalid_urls = [
|
|
"https://example.com/{foo",
|
|
"https://example.com/{{}",
|
|
"https://example.com/{//foo}",
|
|
"https://example.com/{bar++}",
|
|
]
|
|
for url in invalid_urls:
|
|
with self.assertRaises(ValidationError):
|
|
url_template_validator(url)
|