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[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[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\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\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\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\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[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[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[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[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[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\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\d+)-(?P\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\d+)-(?P\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\d+)-(?P\d+)-(?P\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\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[a-zA-Z0-9_-]+)/(?P[a-zA-Z0-9_-]+)#(?P[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[a-f]{5});(?P[a-f]);(?P[a-z]+);(?P[a-z]+);(?P[a-z]{2,8});(?P[0-9]{2,3});(?P[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[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[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[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[0-9]+)") self.assertEqual( linkifier[0]["url_template"], "https://realm.com/my_realm_filter/issues/{id}" ) data = { "pattern": r"ZUL-(?P\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\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[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[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)