import re from django.core.exceptions import ValidationError from zerver.lib.test_classes import ZulipTestCase from zerver.models import RealmFilter, filter_format_validator class RealmFilterTest(ZulipTestCase): def test_list(self) -> None: self.login("iago") data = { "pattern": "#(?P[123])", "url_format_string": "https://realm.com/my_realm_filter/%(id)s", } result = self.client_post("/json/realm/filters", info=data) self.assert_json_success(result) result = self.client_get("/json/realm/linkifiers") self.assert_json_success(result) linkifiers = result.json()["linkifiers"] self.assert_length(linkifiers, 1) self.assertEqual(linkifiers[0]["pattern"], "#(?P[123])") self.assertEqual(linkifiers[0]["url_format"], "https://realm.com/my_realm_filter/%(id)s") def test_create(self) -> None: self.login("iago") data = {"pattern": "", "url_format_string": "https://realm.com/my_realm_filter/%(id)s"} 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_format_string"] = "$fgfg" result = self.client_post("/json/realm/filters", info=data) self.assert_json_error(result, "Enter a valid URL.") data["pattern"] = r"ZUL-(?P\d+)" data["url_format_string"] = "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 format string." ) data["url_format_string"] = "https://realm.com/my_realm_filter/#hashtag/%(id)s" 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_format_string"] = "https://realm.com/my_realm_filter/?value=%(id)s" 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_format_string"] = "https://example.com/product/%(id)s/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_format_string" ] = "https://example.com/~user/web#view_type=type&model=model&action=12345&id=%(id)s" 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_format_string"] = "https://realm.com/my_realm_filter/?value=%(id)s&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_format_string"] = "https://realm.com/my_realm_filter/?sort=reverse&value=%(id)s" 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_format_string" ] = "https://realm.com/index.pl?Action=AgentTicketZoom;TicketNumber=%(id)s" 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_format_string"] = r"https://realm.com/my_realm_filter/%(hello)s" result = self.client_post("/json/realm/filters", info=data) self.assert_json_error( result, "Group 'hello' in URL format string is not present in linkifier pattern." ) data["pattern"] = r"ZUL-(?P\d+)-(?P\d+)" data["url_format_string"] = r"https://realm.com/my_realm_filter/%(hello)s" result = self.client_post("/json/realm/filters", info=data) self.assert_json_error( result, "Group 'id' in linkifier pattern is not present in URL format string." ) data["pattern"] = r"ZULZ-(?P\d+)-(?P\d+)" data["url_format_string"] = r"https://realm.com/my_realm_filter/%(hello)s/%(world)s" 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_format_string"] = r"https://realm.com/my_realm_filter/%(hello)s" result = self.client_post("/json/realm/filters", info=data) self.assert_json_error( result, "Group 'id' in linkifier pattern is not present in URL format string." ) data["pattern"] = r"ZUL-ESCAPE-(?P\d+)" data["url_format_string"] = r"https://realm.com/my_realm_filter/%%(ignored)s/%(id)s" result = self.client_post("/json/realm/filters", info=data) self.assert_json_success(result) data["pattern"] = r"ZUL-URI-(?P\d+)" data["url_format_string"] = "https://example.com/%ba/%(id)s" 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_format_string"] = "https://github.com/%(org)s/%(repo)s/issue/%(id)s" result = self.client_post("/json/realm/filters", info=data) self.assert_json_success(result) self.assertIsNotNone(re.match(data["pattern"], "zulip/zulip#123")) 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_format_string": "https://realm.com/my_realm_filter/%(id)s", } result = self.client_post("/json/realm/filters", info=data) self.assert_json_success(result) linkifier_id = result.json()["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_format_string": "https://realm.com/my_realm_filter/%(id)s", } result = self.client_post("/json/realm/filters", info=data) self.assert_json_success(result) linkifier_id = result.json()["id"] data = { "pattern": "#(?P[0-9]+)", "url_format_string": "https://realm.com/my_realm_filter/issues/%(id)s", } 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") self.assert_json_success(result) linkifier = result.json()["linkifiers"] self.assert_length(linkifier, 1) self.assertEqual(linkifier[0]["pattern"], "#(?P[0-9]+)") self.assertEqual( linkifier[0]["url_format"], "https://realm.com/my_realm_filter/issues/%(id)s" ) data = { "pattern": r"ZUL-(?P\d????)", "url_format_string": "https://realm.com/my_realm_filter/%(id)s", } 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_format_string"] = "$fgfg" result = self.client_patch(f"/json/realm/filters/{linkifier_id}", info=data) self.assert_json_error(result, "Enter a valid URL.") data["pattern"] = r"#(?P[123])" data["url_format_string"] = "https://realm.com/my_realm_filter/%(id)s" result = self.client_patch(f"/json/realm/filters/{linkifier_id + 1}", info=data) self.assert_json_error(result, "Linkifier not found.") 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)s", "https://example.com/%(foo)s%(bars)s", "https://example.com/%(foo)s/and/%(bar)s", "https://example.com/?foo=%(foo)s", "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)s", "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", ] for url in valid_urls: filter_format_validator(url) invalid_urls = [ "file:///etc/passwd", "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==", "https://example.com/%(foo)", "https://example.com/%()s", "https://example.com/%4!", "https://example.com/%(foo", "https://example.com/%2(foo)s", ] for url in invalid_urls: with self.assertRaises(ValidationError): filter_format_validator(url)