Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

github: Strengthen types using WildValue.

This commit is contained in:
Christopher Chong 2022-04-03 09:08:49 +00:00 committed by Tim Abbott
parent 2f097c524e
commit 76b1a682b7
4 changed files with 485 additions and 164 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
zerver/webhooks/github/fixtures/page_build__errored.json Normal file
View File

@ -0,0 +1,139 @@
{
"id": 15995382,
"build": {
"url": "https://api.github.com/repos/baxterthehacker/public-repo/pages/builds/15995382",
"status": "errored",
"error": {
"message": "Something went wrong."
},
"pusher": {
"login": "baxterthehacker",
"id": 6752317,
"avatar_url": "https://avatars.githubusercontent.com/u/6752317?v=3",
"gravatar_id": "",
"url": "https://api.github.com/users/baxterthehacker",
"html_url": "https://github.com/baxterthehacker",
"followers_url": "https://api.github.com/users/baxterthehacker/followers",
"following_url": "https://api.github.com/users/baxterthehacker/following{/other_user}",
"gists_url": "https://api.github.com/users/baxterthehacker/gists{/gist_id}",
"starred_url": "https://api.github.com/users/baxterthehacker/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/baxterthehacker/subscriptions",
"organizations_url": "https://api.github.com/users/baxterthehacker/orgs",
"repos_url": "https://api.github.com/users/baxterthehacker/repos",
"events_url": "https://api.github.com/users/baxterthehacker/events{/privacy}",
"received_events_url": "https://api.github.com/users/baxterthehacker/received_events",
"type": "User",
"site_admin": false
},
"commit": "053b99542c83021d6b202d1a1f5ecd5ef7084e55",
"duration": 3790,
"created_at": "2015-05-05T23:40:13Z",
"updated_at": "2015-05-05T23:40:17Z"
},
"repository": {
"id": 35129377,
"name": "public-repo",
"full_name": "baxterthehacker/public-repo",
"owner": {
"login": "baxterthehacker",
"id": 6752317,
"avatar_url": "https://avatars.githubusercontent.com/u/6752317?v=3",
"gravatar_id": "",
"url": "https://api.github.com/users/baxterthehacker",
"html_url": "https://github.com/baxterthehacker",
"followers_url": "https://api.github.com/users/baxterthehacker/followers",
"following_url": "https://api.github.com/users/baxterthehacker/following{/other_user}",
"gists_url": "https://api.github.com/users/baxterthehacker/gists{/gist_id}",
"starred_url": "https://api.github.com/users/baxterthehacker/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/baxterthehacker/subscriptions",
"organizations_url": "https://api.github.com/users/baxterthehacker/orgs",
"repos_url": "https://api.github.com/users/baxterthehacker/repos",
"events_url": "https://api.github.com/users/baxterthehacker/events{/privacy}",
"received_events_url": "https://api.github.com/users/baxterthehacker/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/baxterthehacker/public-repo",
"description": "",
"fork": false,
"url": "https://api.github.com/repos/baxterthehacker/public-repo",
"forks_url": "https://api.github.com/repos/baxterthehacker/public-repo/forks",
"keys_url": "https://api.github.com/repos/baxterthehacker/public-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/baxterthehacker/public-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/baxterthehacker/public-repo/teams",
"hooks_url": "https://api.github.com/repos/baxterthehacker/public-repo/hooks",
"issue_events_url": "https://api.github.com/repos/baxterthehacker/public-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/baxterthehacker/public-repo/events",
"assignees_url": "https://api.github.com/repos/baxterthehacker/public-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/baxterthehacker/public-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/baxterthehacker/public-repo/tags",
"blobs_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/baxterthehacker/public-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/baxterthehacker/public-repo/languages",
"stargazers_url": "https://api.github.com/repos/baxterthehacker/public-repo/stargazers",
"contributors_url": "https://api.github.com/repos/baxterthehacker/public-repo/contributors",
"subscribers_url": "https://api.github.com/repos/baxterthehacker/public-repo/subscribers",
"subscription_url": "https://api.github.com/repos/baxterthehacker/public-repo/subscription",
"commits_url": "https://api.github.com/repos/baxterthehacker/public-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/baxterthehacker/public-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/baxterthehacker/public-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/baxterthehacker/public-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/baxterthehacker/public-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/baxterthehacker/public-repo/merges",
"archive_url": "https://api.github.com/repos/baxterthehacker/public-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/baxterthehacker/public-repo/downloads",
"issues_url": "https://api.github.com/repos/baxterthehacker/public-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/baxterthehacker/public-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/baxterthehacker/public-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/baxterthehacker/public-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/baxterthehacker/public-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/baxterthehacker/public-repo/releases{/id}",
"created_at": "2015-05-05T23:40:12Z",
"updated_at": "2015-05-05T23:40:12Z",
"pushed_at": "2015-05-05T23:40:17Z",
"git_url": "git://github.com/baxterthehacker/public-repo.git",
"ssh_url": "git@github.com:baxterthehacker/public-repo.git",
"clone_url": "https://github.com/baxterthehacker/public-repo.git",
"svn_url": "https://github.com/baxterthehacker/public-repo",
"homepage": null,
"size": 0,
"stargazers_count": 0,
"watchers_count": 0,
"language": null,
"has_issues": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": true,
"forks_count": 0,
"mirror_url": null,
"open_issues_count": 0,
"forks": 0,
"open_issues": 0,
"watchers": 0,
"default_branch": "master"
},
"sender": {
"login": "baxterthehacker",
"id": 6752317,
"avatar_url": "https://avatars.githubusercontent.com/u/6752317?v=3",
"gravatar_id": "",
"url": "https://api.github.com/users/baxterthehacker",
"html_url": "https://github.com/baxterthehacker",
"followers_url": "https://api.github.com/users/baxterthehacker/followers",
"following_url": "https://api.github.com/users/baxterthehacker/following{/other_user}",
"gists_url": "https://api.github.com/users/baxterthehacker/gists{/gist_id}",
"starred_url": "https://api.github.com/users/baxterthehacker/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/baxterthehacker/subscriptions",
"organizations_url": "https://api.github.com/users/baxterthehacker/orgs",
"repos_url": "https://api.github.com/users/baxterthehacker/repos",
"events_url": "https://api.github.com/users/baxterthehacker/events{/privacy}",
"received_events_url": "https://api.github.com/users/baxterthehacker/received_events",
"type": "User",
"site_admin": false
}
}

148
zerver/webhooks/github/fixtures/release__with_name.json Normal file
View File

@ -0,0 +1,148 @@
{
"action": "published",
"release": {
"url": "https://api.github.com/repos/baxterthehacker/public-repo/releases/1261438",
"assets_url": "https://api.github.com/repos/baxterthehacker/public-repo/releases/1261438/assets",
"upload_url": "https://uploads.github.com/repos/baxterthehacker/public-repo/releases/1261438/assets{?name}",
"html_url": "https://github.com/baxterthehacker/public-repo/releases/tag/0.0.1",
"id": 1261438,
"tag_name": "0.0.1",
"target_commitish": "master",
"name": "0.0.1",
"draft": false,
"author": {
"login": "baxterthehacker",
"id": 6752317,
"avatar_url": "https://avatars.githubusercontent.com/u/6752317?v=3",
"gravatar_id": "",
"url": "https://api.github.com/users/baxterthehacker",
"html_url": "https://github.com/baxterthehacker",
"followers_url": "https://api.github.com/users/baxterthehacker/followers",
"following_url": "https://api.github.com/users/baxterthehacker/following{/other_user}",
"gists_url": "https://api.github.com/users/baxterthehacker/gists{/gist_id}",
"starred_url": "https://api.github.com/users/baxterthehacker/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/baxterthehacker/subscriptions",
"organizations_url": "https://api.github.com/users/baxterthehacker/orgs",
"repos_url": "https://api.github.com/users/baxterthehacker/repos",
"events_url": "https://api.github.com/users/baxterthehacker/events{/privacy}",
"received_events_url": "https://api.github.com/users/baxterthehacker/received_events",
"type": "User",
"site_admin": false
},
"prerelease": false,
"created_at": "2015-05-05T23:40:12Z",
"published_at": "2015-05-05T23:40:38Z",
"assets": [
],
"tarball_url": "https://api.github.com/repos/baxterthehacker/public-repo/tarball/0.0.1",
"zipball_url": "https://api.github.com/repos/baxterthehacker/public-repo/zipball/0.0.1",
"body": null
},
"repository": {
"id": 35129377,
"name": "public-repo",
"full_name": "baxterthehacker/public-repo",
"owner": {
"login": "baxterthehacker",
"id": 6752317,
"avatar_url": "https://avatars.githubusercontent.com/u/6752317?v=3",
"gravatar_id": "",
"url": "https://api.github.com/users/baxterthehacker",
"html_url": "https://github.com/baxterthehacker",
"followers_url": "https://api.github.com/users/baxterthehacker/followers",
"following_url": "https://api.github.com/users/baxterthehacker/following{/other_user}",
"gists_url": "https://api.github.com/users/baxterthehacker/gists{/gist_id}",
"starred_url": "https://api.github.com/users/baxterthehacker/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/baxterthehacker/subscriptions",
"organizations_url": "https://api.github.com/users/baxterthehacker/orgs",
"repos_url": "https://api.github.com/users/baxterthehacker/repos",
"events_url": "https://api.github.com/users/baxterthehacker/events{/privacy}",
"received_events_url": "https://api.github.com/users/baxterthehacker/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/baxterthehacker/public-repo",
"description": "",
"fork": false,
"url": "https://api.github.com/repos/baxterthehacker/public-repo",
"forks_url": "https://api.github.com/repos/baxterthehacker/public-repo/forks",
"keys_url": "https://api.github.com/repos/baxterthehacker/public-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/baxterthehacker/public-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/baxterthehacker/public-repo/teams",
"hooks_url": "https://api.github.com/repos/baxterthehacker/public-repo/hooks",
"issue_events_url": "https://api.github.com/repos/baxterthehacker/public-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/baxterthehacker/public-repo/events",
"assignees_url": "https://api.github.com/repos/baxterthehacker/public-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/baxterthehacker/public-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/baxterthehacker/public-repo/tags",
"blobs_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/baxterthehacker/public-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/baxterthehacker/public-repo/languages",
"stargazers_url": "https://api.github.com/repos/baxterthehacker/public-repo/stargazers",
"contributors_url": "https://api.github.com/repos/baxterthehacker/public-repo/contributors",
"subscribers_url": "https://api.github.com/repos/baxterthehacker/public-repo/subscribers",
"subscription_url": "https://api.github.com/repos/baxterthehacker/public-repo/subscription",
"commits_url": "https://api.github.com/repos/baxterthehacker/public-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/baxterthehacker/public-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/baxterthehacker/public-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/baxterthehacker/public-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/baxterthehacker/public-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/baxterthehacker/public-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/baxterthehacker/public-repo/merges",
"archive_url": "https://api.github.com/repos/baxterthehacker/public-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/baxterthehacker/public-repo/downloads",
"issues_url": "https://api.github.com/repos/baxterthehacker/public-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/baxterthehacker/public-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/baxterthehacker/public-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/baxterthehacker/public-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/baxterthehacker/public-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/baxterthehacker/public-repo/releases{/id}",
"created_at": "2015-05-05T23:40:12Z",
"updated_at": "2015-05-05T23:40:30Z",
"pushed_at": "2015-05-05T23:40:38Z",
"git_url": "git://github.com/baxterthehacker/public-repo.git",
"ssh_url": "git@github.com:baxterthehacker/public-repo.git",
"clone_url": "https://github.com/baxterthehacker/public-repo.git",
"svn_url": "https://github.com/baxterthehacker/public-repo",
"homepage": null,
"size": 0,
"stargazers_count": 0,
"watchers_count": 0,
"language": null,
"has_issues": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": true,
"forks_count": 0,
"mirror_url": null,
"open_issues_count": 2,
"forks": 0,
"open_issues": 2,
"watchers": 0,
"default_branch": "master"
},
"sender": {
"login": "baxterthehacker",
"id": 6752317,
"avatar_url": "https://avatars.githubusercontent.com/u/6752317?v=3",
"gravatar_id": "",
"url": "https://api.github.com/users/baxterthehacker",
"html_url": "https://github.com/baxterthehacker",
"followers_url": "https://api.github.com/users/baxterthehacker/followers",
"following_url": "https://api.github.com/users/baxterthehacker/following{/other_user}",
"gists_url": "https://api.github.com/users/baxterthehacker/gists{/gist_id}",
"starred_url": "https://api.github.com/users/baxterthehacker/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/baxterthehacker/subscriptions",
"organizations_url": "https://api.github.com/users/baxterthehacker/orgs",
"repos_url": "https://api.github.com/users/baxterthehacker/repos",
"events_url": "https://api.github.com/users/baxterthehacker/events{/privacy}",
"received_events_url": "https://api.github.com/users/baxterthehacker/received_events",
"type": "User",
"site_admin": false
}
}

8
zerver/webhooks/github/tests.py
View File

@ -217,12 +217,20 @@ class GitHubWebhookTest(WebhookTestCase):
expected_message = "baxterthehacker published release [0.0.1](https://github.com/baxterthehacker/public-repo/releases/tag/0.0.1) for tag 0.0.1." expected_message = "baxterthehacker published release [0.0.1](https://github.com/baxterthehacker/public-repo/releases/tag/0.0.1) for tag 0.0.1."
self.check_webhook("release", TOPIC_REPO, expected_message) self.check_webhook("release", TOPIC_REPO, expected_message)
def test_release_msg_with_name(self) -> None:
expected_message = "baxterthehacker published release [0.0.1](https://github.com/baxterthehacker/public-repo/releases/tag/0.0.1) for tag 0.0.1."
self.check_webhook("release__with_name", TOPIC_REPO, expected_message)
def test_page_build_msg(self) -> None: def test_page_build_msg(self) -> None:
expected_message = ( expected_message = (
"GitHub Pages build, triggered by baxterthehacker, has finished building." "GitHub Pages build, triggered by baxterthehacker, has finished building."
) )
self.check_webhook("page_build", TOPIC_REPO, expected_message) self.check_webhook("page_build", TOPIC_REPO, expected_message)
def test_page_build_errored_msg(self) -> None:
expected_message = "GitHub Pages build, triggered by baxterthehacker, has failed: \n~~~ quote\nSomething went wrong.\n~~~."
self.check_webhook("page_build__errored", TOPIC_REPO, expected_message)
def test_status_msg(self) -> None: def test_status_msg(self) -> None:
expected_message = "[9049f12](https://github.com/baxterthehacker/public-repo/commit/9049f1265b7d61be4a8904a9a27120d2064dab3b) changed its status to success." expected_message = "[9049f12](https://github.com/baxterthehacker/public-repo/commit/9049f1265b7d61be4a8904a9a27120d2064dab3b) changed its status to success."
self.check_webhook("status", TOPIC_REPO, expected_message) self.check_webhook("status", TOPIC_REPO, expected_message)

354
zerver/webhooks/github/view.py
View File

@ -1,6 +1,6 @@
import re import re
from functools import partial from functools import partial
from typing import Any, Callable, Dict, Optional from typing import Callable, Dict, Optional
from django.http import HttpRequest, HttpResponse from django.http import HttpRequest, HttpResponse
@ -8,6 +8,7 @@ from zerver.decorator import log_unsupported_webhook_event, webhook_view
from zerver.lib.exceptions import UnsupportedWebhookEventType from zerver.lib.exceptions import UnsupportedWebhookEventType
from zerver.lib.request import REQ, has_request_variables from zerver.lib.request import REQ, has_request_variables
from zerver.lib.response import json_success from zerver.lib.response import json_success
from zerver.lib.validator import WildValue, check_bool, check_int, check_string, to_wild_value
from zerver.lib.webhooks.common import ( from zerver.lib.webhooks.common import (
check_send_webhook_message, check_send_webhook_message,
get_http_headers_from_filename, get_http_headers_from_filename,
@ -37,7 +38,7 @@ DISCUSSION_COMMENT_TEMPLATE = "{author} [commented]({comment_url}) on [discussio
class Helper: class Helper:
def __init__( def __init__(
self, self,
payload: Dict[str, Any], payload: WildValue,
include_title: bool, include_title: bool,
) -> None: ) -> None:
self.payload = payload self.payload = payload
@ -54,27 +55,27 @@ def get_opened_or_update_pull_request_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
include_title = helper.include_title include_title = helper.include_title
pull_request = payload["pull_request"] pull_request = payload["pull_request"]
action = payload["action"] action = payload["action"].tame(check_string)
if action == "synchronize": if action == "synchronize":
action = "updated" action = "updated"
assignee = None assignee = None
if pull_request.get("assignee"): if pull_request.get("assignee"):
assignee = pull_request["assignee"]["login"] assignee = pull_request["assignee"]["login"].tame(check_string)
description = None description = None
changes = payload.get("changes", {}) changes = payload.get("changes", {})
if "body" in changes or action == "opened": if "body" in changes or action == "opened":
description = pull_request["body"] description = pull_request["body"].tame(check_string)
return get_pull_request_event_message( return get_pull_request_event_message(
get_sender_name(payload), get_sender_name(payload),
action, action,
pull_request["html_url"], pull_request["html_url"].tame(check_string),
target_branch=pull_request["head"]["ref"], target_branch=pull_request["head"]["ref"].tame(check_string),
base_branch=pull_request["base"]["ref"], base_branch=pull_request["base"]["ref"].tame(check_string),
message=description, message=description,
assignee=assignee, assignee=assignee,
number=pull_request["number"], number=pull_request["number"].tame(check_int),
title=pull_request["title"] if include_title else None, title=pull_request["title"].tame(check_string) if include_title else None,
) )
@ -83,18 +84,18 @@ def get_assigned_or_unassigned_pull_request_body(helper: Helper) -> str:
include_title = helper.include_title include_title = helper.include_title
pull_request = payload["pull_request"] pull_request = payload["pull_request"]
assignee = pull_request.get("assignee") assignee = pull_request.get("assignee")
if assignee is not None: if assignee:
assignee = assignee.get("login") stringified_assignee = assignee.get("login").tame(check_string)
base_message = get_pull_request_event_message( base_message = get_pull_request_event_message(
get_sender_name(payload), get_sender_name(payload),
payload["action"], payload["action"].tame(check_string),
pull_request["html_url"], pull_request["html_url"].tame(check_string),
number=pull_request["number"], number=pull_request["number"].tame(check_int),
title=pull_request["title"] if include_title else None, title=pull_request["title"].tame(check_string) if include_title else None,
) )
if assignee is not None: if assignee:
return f"{base_message[:-1]} to {assignee}." return f"{base_message[:-1]} to {stringified_assignee}."
return base_message return base_message
@ -102,27 +103,27 @@ def get_closed_pull_request_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
include_title = helper.include_title include_title = helper.include_title
pull_request = payload["pull_request"] pull_request = payload["pull_request"]
action = "merged" if pull_request["merged"] else "closed without merge" action = "merged" if pull_request["merged"].tame(check_bool) else "closed without merge"
return get_pull_request_event_message( return get_pull_request_event_message(
get_sender_name(payload), get_sender_name(payload),
action, action,
pull_request["html_url"], pull_request["html_url"].tame(check_string),
number=pull_request["number"], number=pull_request["number"].tame(check_int),
title=pull_request["title"] if include_title else None, title=pull_request["title"].tame(check_string) if include_title else None,
) )
def get_membership_body(helper: Helper) -> str: def get_membership_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
action = payload["action"] action = payload["action"].tame(check_string)
member = payload["member"] member = payload["member"]
team_name = payload["team"]["name"] team_name = payload["team"]["name"].tame(check_string)
return "{sender} {action} [{username}]({html_url}) {preposition} the {team_name} team.".format( return "{sender} {action} [{username}]({html_url}) {preposition} the {team_name} team.".format(
sender=get_sender_name(payload), sender=get_sender_name(payload),
action=action, action=action,
username=member["login"], username=member["login"].tame(check_string),
html_url=member["html_url"], html_url=member["html_url"].tame(check_string),
preposition="from" if action == "removed" else "to", preposition="from" if action == "removed" else "to",
team_name=team_name, team_name=team_name,
) )
@ -132,35 +133,35 @@ def get_member_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
return "{} {} [{}]({}) to [{}]({}).".format( return "{} {} [{}]({}) to [{}]({}).".format(
get_sender_name(payload), get_sender_name(payload),
payload["action"], payload["action"].tame(check_string),
payload["member"]["login"], payload["member"]["login"].tame(check_string),
payload["member"]["html_url"], payload["member"]["html_url"].tame(check_string),
get_repository_name(payload), get_repository_name(payload),
payload["repository"]["html_url"], payload["repository"]["html_url"].tame(check_string),
) )
def get_issue_body(helper: Helper) -> str: def get_issue_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
include_title = helper.include_title include_title = helper.include_title
action = payload["action"] action = payload["action"].tame(check_string)
issue = payload["issue"] issue = payload["issue"]
assignee = issue["assignee"] assignee = issue["assignee"]
return get_issue_event_message( return get_issue_event_message(
get_sender_name(payload), get_sender_name(payload),
action, action,
issue["html_url"], issue["html_url"].tame(check_string),
issue["number"], issue["number"].tame(check_int),
issue["body"], issue["body"].tame(check_string),
assignee=assignee["login"] if assignee else None, assignee=assignee["login"].tame(check_string) if assignee else None,
title=issue["title"] if include_title else None, title=issue["title"].tame(check_string) if include_title else None,
) )
def get_issue_comment_body(helper: Helper) -> str: def get_issue_comment_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
include_title = helper.include_title include_title = helper.include_title
action = payload["action"] action = payload["action"].tame(check_string)
comment = payload["comment"] comment = payload["comment"]
issue = payload["issue"] issue = payload["issue"]
@ -168,15 +169,15 @@ def get_issue_comment_body(helper: Helper) -> str:
action = "[commented]" action = "[commented]"
else: else:
action = f"{action} a [comment]" action = f"{action} a [comment]"
action += "({}) on".format(comment["html_url"]) action += "({}) on".format(comment["html_url"].tame(check_string))
return get_issue_event_message( return get_issue_event_message(
get_sender_name(payload), get_sender_name(payload),
action, action,
issue["html_url"], issue["html_url"].tame(check_string),
issue["number"], issue["number"].tame(check_int),
comment["body"], comment["body"].tame(check_string),
title=issue["title"] if include_title else None, title=issue["title"].tame(check_string) if include_title else None,
) )
@ -185,8 +186,8 @@ def get_fork_body(helper: Helper) -> str:
forkee = payload["forkee"] forkee = payload["forkee"]
return "{} forked [{}]({}).".format( return "{} forked [{}]({}).".format(
get_sender_name(payload), get_sender_name(payload),
forkee["name"], forkee["name"].tame(check_string),
forkee["html_url"], forkee["html_url"].tame(check_string),
) )
@ -198,33 +199,33 @@ def get_deployment_body(helper: Helper) -> str:
def get_change_deployment_status_body(helper: Helper) -> str: def get_change_deployment_status_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
return "Deployment changed status to {}.".format( return "Deployment changed status to {}.".format(
payload["deployment_status"]["state"], payload["deployment_status"]["state"].tame(check_string),
) )
def get_create_or_delete_body(helper: Helper, action: str) -> str: def get_create_or_delete_body(helper: Helper, action: str) -> str:
payload = helper.payload payload = helper.payload
ref_type = payload["ref_type"] ref_type = payload["ref_type"].tame(check_string)
return "{} {} {} {}.".format( return "{} {} {} {}.".format(
get_sender_name(payload), get_sender_name(payload),
action, action,
ref_type, ref_type,
payload["ref"], payload["ref"].tame(check_string),
).rstrip() ).rstrip()
def get_commit_comment_body(helper: Helper) -> str: def get_commit_comment_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
comment = payload["comment"] comment = payload["comment"]
comment_url = comment["html_url"] comment_url = comment["html_url"].tame(check_string)
commit_url = comment_url.split("#", 1)[0] commit_url = comment_url.split("#", 1)[0]
action = f"[commented]({comment_url})" action = f"[commented]({comment_url})"
return get_commits_comment_action_message( return get_commits_comment_action_message(
get_sender_name(payload), get_sender_name(payload),
action, action,
commit_url, commit_url,
comment.get("commit_id"), comment.get("commit_id").tame(check_string),
comment["body"], comment["body"].tame(check_string),
) )
@ -232,28 +233,33 @@ def get_push_tags_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
return get_push_tag_event_message( return get_push_tag_event_message(
get_sender_name(payload), get_sender_name(payload),
get_tag_name_from_ref(payload["ref"]), get_tag_name_from_ref(payload["ref"].tame(check_string)),
action="pushed" if payload.get("created") else "removed", action="pushed" if payload.get("created").tame(check_bool) else "removed",
) )
def get_push_commits_body(helper: Helper) -> str: def get_push_commits_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
commits_data = [ commits_data = []
{ for commit in payload["commits"]:
"name": (commit.get("author").get("username") or commit.get("author").get("name")), if commit.get("author").get("username"):
"sha": commit["id"], name = commit.get("author").get("username").tame(check_string)
"url": commit["url"], else:
"message": commit["message"], name = commit.get("author").get("name").tame(check_string)
} commits_data.append(
for commit in payload["commits"] {
] "name": name,
"sha": commit["id"].tame(check_string),
"url": commit["url"].tame(check_string),
"message": commit["message"].tame(check_string),
}
)
return get_push_commits_event_message( return get_push_commits_event_message(
get_sender_name(payload), get_sender_name(payload),
payload["compare"], payload["compare"].tame(check_string),
get_branch_name_from_ref(payload["ref"]), get_branch_name_from_ref(payload["ref"].tame(check_string)),
commits_data, commits_data,
deleted=payload["deleted"], deleted=payload["deleted"].tame(check_bool),
) )
@ -261,11 +267,11 @@ def get_discussion_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
return DISCUSSION_TEMPLATE.format( return DISCUSSION_TEMPLATE.format(
author=get_sender_name(payload), author=get_sender_name(payload),
url=payload["discussion"]["html_url"], url=payload["discussion"]["html_url"].tame(check_string),
body=payload["discussion"]["body"], body=payload["discussion"]["body"].tame(check_string),
category=payload["discussion"]["category"]["name"], category=payload["discussion"]["category"]["name"].tame(check_string),
discussion_id=payload["discussion"]["number"], discussion_id=payload["discussion"]["number"].tame(check_int),
title=payload["discussion"]["title"], title=payload["discussion"]["title"].tame(check_string),
) )
@ -273,10 +279,10 @@ def get_discussion_comment_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
return DISCUSSION_COMMENT_TEMPLATE.format( return DISCUSSION_COMMENT_TEMPLATE.format(
author=get_sender_name(payload), author=get_sender_name(payload),
body=payload["comment"]["body"], body=payload["comment"]["body"].tame(check_string),
discussion_url=payload["discussion"]["html_url"], discussion_url=payload["discussion"]["html_url"].tame(check_string),
comment_url=payload["comment"]["html_url"], comment_url=payload["comment"]["html_url"].tame(check_string),
discussion_id=payload["discussion"]["number"], discussion_id=payload["discussion"]["number"].tame(check_int),
) )
@ -285,7 +291,7 @@ def get_public_body(helper: Helper) -> str:
return "{} made the repository [{}]({}) public.".format( return "{} made the repository [{}]({}) public.".format(
get_sender_name(payload), get_sender_name(payload),
get_repository_full_name(payload), get_repository_full_name(payload),
payload["repository"]["html_url"], payload["repository"]["html_url"].tame(check_string),
) )
@ -295,9 +301,9 @@ def get_wiki_pages_body(helper: Helper) -> str:
wiki_info = "" wiki_info = ""
for page in payload["pages"]: for page in payload["pages"]:
wiki_info += wiki_page_info_template.format( wiki_info += wiki_page_info_template.format(
action=page["action"], action=page["action"].tame(check_string),
title=page["title"], title=page["title"].tame(check_string),
url=page["html_url"], url=page["html_url"].tame(check_string),
) )
return f"{get_sender_name(payload)}:\n{wiki_info.rstrip()}" return f"{get_sender_name(payload)}:\n{wiki_info.rstrip()}"
@ -307,7 +313,7 @@ def get_watch_body(helper: Helper) -> str:
return "{} starred the repository [{}]({}).".format( return "{} starred the repository [{}]({}).".format(
get_sender_name(payload), get_sender_name(payload),
get_repository_full_name(payload), get_repository_full_name(payload),
payload["repository"]["html_url"], payload["repository"]["html_url"].tame(check_string),
) )
@ -315,9 +321,9 @@ def get_repository_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
return "{} {} the repository [{}]({}).".format( return "{} {} the repository [{}]({}).".format(
get_sender_name(payload), get_sender_name(payload),
payload.get("action"), payload.get("action").tame(check_string),
get_repository_full_name(payload), get_repository_full_name(payload),
payload["repository"]["html_url"], payload["repository"]["html_url"].tame(check_string),
) )
@ -325,8 +331,8 @@ def get_add_team_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
return "The repository [{}]({}) was added to team {}.".format( return "The repository [{}]({}) was added to team {}.".format(
get_repository_full_name(payload), get_repository_full_name(payload),
payload["repository"]["html_url"], payload["repository"]["html_url"].tame(check_string),
payload["team"]["name"], payload["team"]["name"].tame(check_string),
) )
@ -334,15 +340,15 @@ def get_team_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
changes = payload["changes"] changes = payload["changes"]
if "description" in changes: if "description" in changes:
actor = payload["sender"]["login"] actor = payload["sender"]["login"].tame(check_string)
new_description = payload["team"]["description"] new_description = payload["team"]["description"].tame(check_string)
return f"**{actor}** changed the team description to:\n```quote\n{new_description}\n```" return f"**{actor}** changed the team description to:\n```quote\n{new_description}\n```"
if "name" in changes: if "name" in changes:
original_name = changes["name"]["from"] original_name = changes["name"]["from"].tame(check_string)
new_name = payload["team"]["name"] new_name = payload["team"]["name"].tame(check_string)
return f"Team `{original_name}` was renamed to `{new_name}`." return f"Team `{original_name}` was renamed to `{new_name}`."
if "privacy" in changes: if "privacy" in changes:
new_visibility = payload["team"]["privacy"] new_visibility = payload["team"]["privacy"].tame(check_string)
return f"Team visibility changed to `{new_visibility}`" return f"Team visibility changed to `{new_visibility}`"
missing_keys = "/".join(sorted(list(changes.keys()))) missing_keys = "/".join(sorted(list(changes.keys())))
@ -357,13 +363,17 @@ def get_team_body(helper: Helper) -> str:
def get_release_body(helper: Helper) -> str: def get_release_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
if payload["release"]["name"]:
release_name = payload["release"]["name"].tame(check_string)
else:
release_name = payload["release"]["tag_name"].tame(check_string)
data = { data = {
"user_name": get_sender_name(payload), "user_name": get_sender_name(payload),
"action": payload["action"], "action": payload["action"].tame(check_string),
"tagname": payload["release"]["tag_name"], "tagname": payload["release"]["tag_name"].tame(check_string),
# Not every GitHub release has a "name" set; if not there, use the tag name. # Not every GitHub release has a "name" set; if not there, use the tag name.
"release_name": payload["release"]["name"] or payload["release"]["tag_name"], "release_name": release_name,
"url": payload["release"]["html_url"], "url": payload["release"]["html_url"].tame(check_string),
} }
return get_release_event_message(**data) return get_release_event_message(**data)
@ -372,21 +382,22 @@ def get_release_body(helper: Helper) -> str:
def get_page_build_body(helper: Helper) -> str: def get_page_build_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
build = payload["build"] build = payload["build"]
status = build["status"] status = build["status"].tame(check_string)
actions = { actions = {
"null": "has yet to be built", "null": "has yet to be built",
"building": "is being built", "building": "is being built",
"errored": "has failed{}", "errored": "has failed: {}",
"built": "has finished building", "built": "has finished building",
} }
action = actions.get(status, f"is {status}") action = actions.get(status, f"is {status}")
action.format( if build["error"]["message"]:
CONTENT_MESSAGE_TEMPLATE.format(message=build["error"]["message"]), action = action.format(
) CONTENT_MESSAGE_TEMPLATE.format(message=build["error"]["message"].tame(check_string)),
)
return "GitHub Pages build, triggered by {}, {}.".format( return "GitHub Pages build, triggered by {}, {}.".format(
payload["build"]["pusher"]["login"], payload["build"]["pusher"]["login"].tame(check_string),
action, action,
) )
@ -395,14 +406,14 @@ def get_status_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
if payload["target_url"]: if payload["target_url"]:
status = "[{}]({})".format( status = "[{}]({})".format(
payload["state"], payload["state"].tame(check_string),
payload["target_url"], payload["target_url"].tame(check_string),
) )
else: else:
status = payload["state"] status = payload["state"].tame(check_string)
return "[{}]({}) changed its status to {}.".format( return "[{}]({}) changed its status to {}.".format(
payload["sha"][:7], # TODO payload["sha"].tame(check_string)[:7], # TODO
payload["commit"]["html_url"], payload["commit"]["html_url"].tame(check_string),
status, status,
) )
@ -410,31 +421,35 @@ def get_status_body(helper: Helper) -> str:
def get_locked_or_unlocked_pull_request_body(helper: Helper) -> str: def get_locked_or_unlocked_pull_request_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
action = payload["action"] action = payload["action"].tame(check_string)
message = "{sender} has locked [PR #{pr_number}]({pr_url}) as {reason} and limited conversation to collaborators." message = "{sender} has locked [PR #{pr_number}]({pr_url}) as {reason} and limited conversation to collaborators."
if action == "unlocked": if action == "unlocked":
message = "{sender} has unlocked [PR #{pr_number}]({pr_url})." message = "{sender} has unlocked [PR #{pr_number}]({pr_url})."
if payload["pull_request"]["active_lock_reason"]:
active_lock_reason = payload["pull_request"]["active_lock_reason"].tame(check_string)
else:
active_lock_reason = None
return message.format( return message.format(
sender=get_sender_name(payload), sender=get_sender_name(payload),
pr_number=payload["pull_request"]["number"], pr_number=payload["pull_request"]["number"].tame(check_int),
pr_url=payload["pull_request"]["html_url"], pr_url=payload["pull_request"]["html_url"].tame(check_string),
reason=payload["pull_request"]["active_lock_reason"], reason=active_lock_reason,
) )
def get_pull_request_auto_merge_body(helper: Helper) -> str: def get_pull_request_auto_merge_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
action = payload["action"] action = payload["action"].tame(check_string)
message = "{sender} has enabled auto merge for [PR #{pr_number}]({pr_url})." message = "{sender} has enabled auto merge for [PR #{pr_number}]({pr_url})."
if action == "auto_merge_disabled": if action == "auto_merge_disabled":
message = "{sender} has disabled auto merge for [PR #{pr_number}]({pr_url})." message = "{sender} has disabled auto merge for [PR #{pr_number}]({pr_url})."
return message.format( return message.format(
sender=get_sender_name(payload), sender=get_sender_name(payload),
pr_number=payload["pull_request"]["number"], pr_number=payload["pull_request"]["number"].tame(check_int),
pr_url=payload["pull_request"]["html_url"], pr_url=payload["pull_request"]["html_url"].tame(check_string),
) )
@ -444,8 +459,8 @@ def get_pull_request_ready_for_review_body(helper: Helper) -> str:
message = "**{sender}** has marked [PR #{pr_number}]({pr_url}) as ready for review." message = "**{sender}** has marked [PR #{pr_number}]({pr_url}) as ready for review."
return message.format( return message.format(
sender=get_sender_name(payload), sender=get_sender_name(payload),
pr_number=payload["pull_request"]["number"], pr_number=payload["pull_request"]["number"].tame(check_int),
pr_url=payload["pull_request"]["html_url"], pr_url=payload["pull_request"]["html_url"].tame(check_string),
) )
@ -453,13 +468,13 @@ def get_pull_request_review_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
include_title = helper.include_title include_title = helper.include_title
title = "for #{} {}".format( title = "for #{} {}".format(
payload["pull_request"]["number"], payload["pull_request"]["number"].tame(check_int),
payload["pull_request"]["title"], payload["pull_request"]["title"].tame(check_string),
) )
return get_pull_request_event_message( return get_pull_request_event_message(
get_sender_name(payload), get_sender_name(payload),
"submitted", "submitted",
payload["review"]["html_url"], payload["review"]["html_url"].tame(check_string),
type="PR review", type="PR review",
title=title if include_title else None, title=title if include_title else None,
) )
@ -468,20 +483,20 @@ def get_pull_request_review_body(helper: Helper) -> str:
def get_pull_request_review_comment_body(helper: Helper) -> str: def get_pull_request_review_comment_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
include_title = helper.include_title include_title = helper.include_title
action = payload["action"] action = payload["action"].tame(check_string)
message = None message = None
if action == "created": if action == "created":
message = payload["comment"]["body"] message = payload["comment"]["body"].tame(check_string)
title = "on #{} {}".format( title = "on #{} {}".format(
payload["pull_request"]["number"], payload["pull_request"]["number"].tame(check_int),
payload["pull_request"]["title"], payload["pull_request"]["title"].tame(check_string),
) )
return get_pull_request_event_message( return get_pull_request_event_message(
get_sender_name(payload), get_sender_name(payload),
action, action,
payload["comment"]["html_url"], payload["comment"]["html_url"].tame(check_string),
message=message, message=message,
type="PR review comment", type="PR review comment",
title=title if include_title else None, title=title if include_title else None,
@ -496,8 +511,8 @@ def get_pull_request_review_requested_body(helper: Helper) -> str:
requested_team = [payload["requested_team"]] if "requested_team" in payload else [] requested_team = [payload["requested_team"]] if "requested_team" in payload else []
sender = get_sender_name(payload) sender = get_sender_name(payload)
pr_number = payload["pull_request"]["number"] pr_number = payload["pull_request"]["number"].tame(check_int)
pr_url = payload["pull_request"]["html_url"] pr_url = payload["pull_request"]["html_url"].tame(check_string)
message = "**{sender}** requested {reviewers} for a review on [PR #{pr_number}]({pr_url})." message = "**{sender}** requested {reviewers} for a review on [PR #{pr_number}]({pr_url})."
message_with_title = ( message_with_title = (
"**{sender}** requested {reviewers} for a review on [PR #{pr_number} {title}]({pr_url})." "**{sender}** requested {reviewers} for a review on [PR #{pr_number} {title}]({pr_url})."
@ -507,10 +522,20 @@ def get_pull_request_review_requested_body(helper: Helper) -> str:
all_reviewers = [] all_reviewers = []
for reviewer in requested_reviewer: for reviewer in requested_reviewer:
all_reviewers.append("[{login}]({html_url})".format(**reviewer)) all_reviewers.append(
"[{login}]({html_url})".format(
login=reviewer["login"].tame(check_string),
html_url=reviewer["html_url"].tame(check_string),
)
)
for team_reviewer in requested_team: for team_reviewer in requested_team:
all_reviewers.append("[{name}]({html_url})".format(**team_reviewer)) all_reviewers.append(
"[{name}]({html_url})".format(
name=team_reviewer["name"].tame(check_string),
html_url=team_reviewer["html_url"].tame(check_string),
)
)
reviewers = "" reviewers = ""
reviewers = all_reviewers[0] reviewers = all_reviewers[0]
@ -520,7 +545,7 @@ def get_pull_request_review_requested_body(helper: Helper) -> str:
reviewers=reviewers, reviewers=reviewers,
pr_number=pr_number, pr_number=pr_number,
pr_url=pr_url, pr_url=pr_url,
title=payload["pull_request"]["title"] if include_title else None, title=payload["pull_request"]["title"].tame(check_string) if include_title else None,
) )
@ -531,15 +556,15 @@ Check [{name}]({html_url}) {status} ({conclusion}). ([{short_hash}]({commit_url}
""".strip() """.strip()
kwargs = { kwargs = {
"name": payload["check_run"]["name"], "name": payload["check_run"]["name"].tame(check_string),
"html_url": payload["check_run"]["html_url"], "html_url": payload["check_run"]["html_url"].tame(check_string),
"status": payload["check_run"]["status"], "status": payload["check_run"]["status"].tame(check_string),
"short_hash": payload["check_run"]["head_sha"][:7], "short_hash": payload["check_run"]["head_sha"].tame(check_string)[:7],
"commit_url": "{}/commit/{}".format( "commit_url": "{}/commit/{}".format(
payload["repository"]["html_url"], payload["repository"]["html_url"].tame(check_string),
payload["check_run"]["head_sha"], payload["check_run"]["head_sha"].tame(check_string),
), ),
"conclusion": payload["check_run"]["conclusion"], "conclusion": payload["check_run"]["conclusion"].tame(check_string),
} }
return template.format(**kwargs) return template.format(**kwargs)
@ -549,10 +574,10 @@ def get_star_body(helper: Helper) -> str:
payload = helper.payload payload = helper.payload
template = "{user} {action} the repository [{repo}]({url})." template = "{user} {action} the repository [{repo}]({url})."
return template.format( return template.format(
user=payload["sender"]["login"], user=payload["sender"]["login"].tame(check_string),
action="starred" if payload["action"] == "created" else "unstarred", action="starred" if payload["action"].tame(check_string) == "created" else "unstarred",
repo=get_repository_full_name(payload), repo=get_repository_full_name(payload),
url=payload["repository"]["html_url"], url=payload["repository"]["html_url"].tame(check_string),
) )
@ -561,20 +586,20 @@ def get_ping_body(helper: Helper) -> str:
return get_setup_webhook_message("GitHub", get_sender_name(payload)) return get_setup_webhook_message("GitHub", get_sender_name(payload))
def get_repository_name(payload: Dict[str, Any]) -> str: def get_repository_name(payload: WildValue) -> str:
return payload["repository"]["name"] return payload["repository"]["name"].tame(check_string)
def get_repository_full_name(payload: Dict[str, Any]) -> str: def get_repository_full_name(payload: WildValue) -> str:
return payload["repository"]["full_name"] return payload["repository"]["full_name"].tame(check_string)
def get_organization_name(payload: Dict[str, Any]) -> str: def get_organization_name(payload: WildValue) -> str:
return payload["organization"]["login"] return payload["organization"]["login"].tame(check_string)
def get_sender_name(payload: Dict[str, Any]) -> str: def get_sender_name(payload: WildValue) -> str:
return payload["sender"]["login"] return payload["sender"]["login"].tame(check_string)
def get_branch_name_from_ref(ref_string: str) -> str: def get_branch_name_from_ref(ref_string: str) -> str:
@ -585,38 +610,38 @@ def get_tag_name_from_ref(ref_string: str) -> str:
return re.sub(r"^refs/tags/", "", ref_string) return re.sub(r"^refs/tags/", "", ref_string)
def is_commit_push_event(payload: Dict[str, Any]) -> bool: def is_commit_push_event(payload: WildValue) -> bool:
return bool(re.match(r"^refs/heads/", payload["ref"])) return bool(re.match(r"^refs/heads/", payload["ref"].tame(check_string)))
def get_subject_based_on_type(payload: Dict[str, Any], event: str) -> str: def get_subject_based_on_type(payload: WildValue, event: str) -> str:
if "pull_request" in event: if "pull_request" in event:
return TOPIC_WITH_PR_OR_ISSUE_INFO_TEMPLATE.format( return TOPIC_WITH_PR_OR_ISSUE_INFO_TEMPLATE.format(
repo=get_repository_name(payload), repo=get_repository_name(payload),
type="PR", type="PR",
id=payload["pull_request"]["number"], id=payload["pull_request"]["number"].tame(check_int),
title=payload["pull_request"]["title"], title=payload["pull_request"]["title"].tame(check_string),
) )
elif event.startswith("issue"): elif event.startswith("issue"):
return TOPIC_WITH_PR_OR_ISSUE_INFO_TEMPLATE.format( return TOPIC_WITH_PR_OR_ISSUE_INFO_TEMPLATE.format(
repo=get_repository_name(payload), repo=get_repository_name(payload),
type="issue", type="issue",
id=payload["issue"]["number"], id=payload["issue"]["number"].tame(check_int),
title=payload["issue"]["title"], title=payload["issue"]["title"].tame(check_string),
) )
elif event.startswith("deployment"): elif event.startswith("deployment"):
return "{} / Deployment on {}".format( return "{} / Deployment on {}".format(
get_repository_name(payload), get_repository_name(payload),
payload["deployment"]["environment"], payload["deployment"]["environment"].tame(check_string),
) )
elif event == "membership": elif event == "membership":
return "{} organization".format(payload["organization"]["login"]) return "{} organization".format(payload["organization"]["login"].tame(check_string))
elif event == "team": elif event == "team":
return "team {}".format(payload["team"]["name"]) return "team {}".format(payload["team"]["name"].tame(check_string))
elif event == "push_commits": elif event == "push_commits":
return TOPIC_WITH_BRANCH_TEMPLATE.format( return TOPIC_WITH_BRANCH_TEMPLATE.format(
repo=get_repository_name(payload), repo=get_repository_name(payload),
branch=get_branch_name_from_ref(payload["ref"]), branch=get_branch_name_from_ref(payload["ref"].tame(check_string)),
) )
elif event == "gollum": elif event == "gollum":
return TOPIC_WITH_BRANCH_TEMPLATE.format( return TOPIC_WITH_BRANCH_TEMPLATE.format(
@ -624,15 +649,15 @@ def get_subject_based_on_type(payload: Dict[str, Any], event: str) -> str:
branch="wiki pages", branch="wiki pages",
) )
elif event == "ping": elif event == "ping":
if payload.get("repository") is None: if not payload.get("repository"):
return get_organization_name(payload) return get_organization_name(payload)
elif event == "check_run": elif event == "check_run":
return f"{get_repository_name(payload)} / checks" return f"{get_repository_name(payload)} / checks"
elif event.startswith("discussion"): elif event.startswith("discussion"):
return TOPIC_FOR_DISCUSSION.format( return TOPIC_FOR_DISCUSSION.format(
repo=get_repository_name(payload), repo=get_repository_name(payload),
number=payload["discussion"]["number"], number=payload["discussion"]["number"].tame(check_int),
title=payload["discussion"]["title"], title=payload["discussion"]["title"].tame(check_string),
) )
return get_repository_name(payload) return get_repository_name(payload)
@ -714,7 +739,7 @@ ALL_EVENT_TYPES = list(EVENT_FUNCTION_MAPPER.keys())
def api_github_webhook( def api_github_webhook(
request: HttpRequest, request: HttpRequest,
user_profile: UserProfile, user_profile: UserProfile,
payload: Dict[str, Any] = REQ(argument_type="body"), payload: WildValue = REQ(argument_type="body", converter=to_wild_value),
branches: Optional[str] = REQ(default=None), branches: Optional[str] = REQ(default=None),
user_specified_topic: Optional[str] = REQ("topic", default=None), user_specified_topic: Optional[str] = REQ("topic", default=None),
) -> HttpResponse: ) -> HttpResponse:
@ -734,7 +759,6 @@ def api_github_webhook(
# for events that are valid but not yet handled by us. # for events that are valid but not yet handled by us.
# See IGNORED_EVENTS, for example. # See IGNORED_EVENTS, for example.
return json_success(request) return json_success(request)
subject = get_subject_based_on_type(payload, event) subject = get_subject_based_on_type(payload, event)
body_function = EVENT_FUNCTION_MAPPER[event] body_function = EVENT_FUNCTION_MAPPER[event]
@ -751,7 +775,7 @@ def api_github_webhook(
def get_zulip_event_name( def get_zulip_event_name(
header_event: str, header_event: str,
payload: Dict[str, Any], payload: WildValue,
branches: Optional[str], branches: Optional[str],
) -> Optional[str]: ) -> Optional[str]:
""" """
@ -760,7 +784,7 @@ def get_zulip_event_name(
We return None for an event that we know we don't want to handle. We return None for an event that we know we don't want to handle.
""" """
if header_event == "pull_request": if header_event == "pull_request":
action = payload["action"] action = payload["action"].tame(check_string)
if action in ("opened", "synchronize", "reopened", "edited"): if action in ("opened", "synchronize", "reopened", "edited"):
return "opened_or_update_pull_request" return "opened_or_update_pull_request"
if action in ("assigned", "unassigned"): if action in ("assigned", "unassigned"):
@ -780,18 +804,18 @@ def get_zulip_event_name(
elif header_event == "push": elif header_event == "push":
if is_commit_push_event(payload): if is_commit_push_event(payload):
if branches is not None: if branches is not None:
branch = get_branch_name_from_ref(payload["ref"]) branch = get_branch_name_from_ref(payload["ref"].tame(check_string))
if branches.find(branch) == -1: if branches.find(branch) == -1:
return None return None
return "push_commits" return "push_commits"
else: else:
return "push_tags" return "push_tags"
elif header_event == "check_run": elif header_event == "check_run":
if payload["check_run"]["status"] != "completed": if payload["check_run"]["status"].tame(check_string) != "completed":
return None return None
return header_event return header_event
elif header_event == "team": elif header_event == "team":
action = payload["action"] action = payload["action"].tame(check_string)
if action == "edited": if action == "edited":
return "team" return "team"
if action in IGNORED_TEAM_ACTIONS: if action in IGNORED_TEAM_ACTIONS:
@ -806,5 +830,7 @@ def get_zulip_event_name(
elif header_event in IGNORED_EVENTS: elif header_event in IGNORED_EVENTS:
return None return None
complete_event = "{}:{}".format(header_event, payload.get("action", "???")) # nocoverage complete_event = "{}:{}".format(
header_event, payload.get("action", "???").tame(check_string)
) # nocoverage
raise UnsupportedWebhookEventType(complete_event) raise UnsupportedWebhookEventType(complete_event)