Basic github check_suite webhook

irccloud · Nov 27, 2019 · a02072e · a02072e
1 parent 573057a
commit a02072e
Show file tree

Hide file tree

Showing 3 changed files with 234 additions and 1 deletion.
diff --git a/httplistener/github.go b/httplistener/github.go
@@ -31,7 +31,7 @@ func (hl *HTTPListener) githubHandler(w http.ResponseWriter, request *http.Reque
 	// All valid events we want to receive need to be listed here.
 	payload, err := hook.Parse(request,
 		github.ReleaseEvent, github.PushEvent, github.IssuesEvent, github.IssueCommentEvent,
-		github.PullRequestEvent)
+		github.PullRequestEvent, github.CheckSuiteEvent)
 
 	if err != nil {
 		if err == github.ErrEventNotFound {
@@ -81,6 +81,13 @@ func (hl *HTTPListener) githubHandler(w http.ResponseWriter, request *http.Reque
 			msgs, err = hl.renderTemplate("github.pullrequest", payload)
 			repo = pl.Repository.Name
 		}
+	case github.CheckSuitePayload:
+		pl := payload.(github.CheckSuitePayload)
+		if pl.CheckSuite.Status == "completed" && pl.CheckSuite.Conclusion == "failure" {
+			send = true
+			msgs, err = hl.renderTemplate("github.checksuite", payload)
+			repo = pl.Repository.Name
+		}
 	}
 
 	if err != nil {

diff --git a/httplistener/templates.go b/httplistener/templates.go
@@ -18,6 +18,7 @@ var defaultTemplates = map[string]string{
 	"github.issue":        "[{{b .Repository.Name}}] {{g .Sender.Login}} {{.Action}} issue #{{.Issue.Number}}: {{.Issue.Title}} {{.Issue.HTMLURL}}",
 	"github.issuecomment": "[{{b .Repository.Name}}] {{g .Comment.User.Login}} commented on issue #{{.Issue.Number}}: {{trunc .Comment.Body 150}} {{.Comment.HTMLURL}}",
 	"github.pullrequest":  "[{{b .Repository.Name}}] {{g .Sender.Login}} {{if .PullRequest.Merged}}merged{{else}}{{.Action}}{{end}} pull request #{{.PullRequest.Number}} (\x0303{{.PullRequest.Base.Ref}}…{{.PullRequest.Head.Ref}}\x0f): {{.PullRequest.Title}} {{.PullRequest.HTMLURL}}",
+	"github.checksuite":   "[{{b .Repository.Name}}] check suite {{b .CheckSuite.Conclusion}}",
 	"prometheus.alert": `{{range .Alerts}}[{{b "Prometheus"}}] {{if (eq .Status "firing")}}{{b "alerting"}}{{else}}{{h "resolved"}}{{end}}: {{.Annotations.summary}}
 {{end}}`,
 }

diff --git a/webhook_test_data/github/check_suite.json b/webhook_test_data/github/check_suite.json
@@ -0,0 +1,225 @@
+{
+  "action": "completed",
+  "check_suite": {
+    "id": 118578147,
+    "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=",
+    "head_branch": "changes",
+    "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+    "status": "completed",
+    "conclusion": "failure",
+    "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147",
+    "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
+    "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+    "pull_requests": [
+      {
+        "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2",
+        "id": 279147437,
+        "number": 2,
+        "head": {
+          "ref": "changes",
+          "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+          "repo": {
+            "id": 186853002,
+            "url": "https://api.github.com/repos/Codertocat/Hello-World",
+            "name": "Hello-World"
+          }
+        },
+        "base": {
+          "ref": "master",
+          "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e",
+          "repo": {
+            "id": 186853002,
+            "url": "https://api.github.com/repos/Codertocat/Hello-World",
+            "name": "Hello-World"
+          }
+        }
+      }
+    ],
+    "app": {
+      "id": 29310,
+      "node_id": "MDM6QXBwMjkzMTA=",
+      "owner": {
+        "login": "Octocoders",
+        "id": 38302899,
+        "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5",
+        "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/Octocoders",
+        "html_url": "https://github.com/Octocoders",
+        "followers_url": "https://api.github.com/users/Octocoders/followers",
+        "following_url": "https://api.github.com/users/Octocoders/following{/other_user}",
+        "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions",
+        "organizations_url": "https://api.github.com/users/Octocoders/orgs",
+        "repos_url": "https://api.github.com/users/Octocoders/repos",
+        "events_url": "https://api.github.com/users/Octocoders/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/Octocoders/received_events",
+        "type": "Organization",
+        "site_admin": false
+      },
+      "name": "octocoders-linter",
+      "description": "",
+      "external_url": "https://octocoders.io",
+      "html_url": "https://github.com/apps/octocoders-linter",
+      "created_at": "2019-04-19T19:36:24Z",
+      "updated_at": "2019-04-19T19:36:56Z",
+      "permissions": {
+        "administration": "write",
+        "checks": "write",
+        "contents": "write",
+        "deployments": "write",
+        "issues": "write",
+        "members": "write",
+        "metadata": "read",
+        "organization_administration": "write",
+        "organization_hooks": "write",
+        "organization_plan": "read",
+        "organization_projects": "write",
+        "organization_user_blocking": "write",
+        "pages": "write",
+        "pull_requests": "write",
+        "repository_hooks": "write",
+        "repository_projects": "write",
+        "statuses": "write",
+        "team_discussions": "write",
+        "vulnerability_alerts": "read"
+      },
+      "events": [
+
+      ]
+    },
+    "created_at": "2019-05-15T15:20:31Z",
+    "updated_at": "2019-05-15T15:21:14Z",
+    "latest_check_runs_count": 1,
+    "check_runs_url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147/check-runs",
+    "head_commit": {
+      "id": "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+      "tree_id": "31b122c26a97cf9af023e9ddab94a82c6e77b0ea",
+      "message": "Update README.md",
+      "timestamp": "2019-05-15T15:20:30Z",
+      "author": {
+        "name": "Codertocat",
+        "email": "21031067+Codertocat@users.noreply.github.com"
+      },
+      "committer": {
+        "name": "Codertocat",
+        "email": "21031067+Codertocat@users.noreply.github.com"
+      }
+    }
+  },
+  "repository": {
+    "id": 186853002,
+    "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=",
+    "name": "Hello-World",
+    "full_name": "Codertocat/Hello-World",
+    "private": false,
+    "owner": {
+      "login": "Codertocat",
+      "id": 21031067,
+      "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/Codertocat",
+      "html_url": "https://github.com/Codertocat",
+      "followers_url": "https://api.github.com/users/Codertocat/followers",
+      "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+      "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+      "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+      "repos_url": "https://api.github.com/users/Codertocat/repos",
+      "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "html_url": "https://github.com/Codertocat/Hello-World",
+    "description": null,
+    "fork": false,
+    "url": "https://api.github.com/repos/Codertocat/Hello-World",
+    "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks",
+    "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}",
+    "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}",
+    "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams",
+    "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks",
+    "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}",
+    "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events",
+    "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}",
+    "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}",
+    "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags",
+    "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}",
+    "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}",
+    "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}",
+    "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}",
+    "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}",
+    "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages",
+    "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers",
+    "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors",
+    "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers",
+    "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription",
+    "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}",
+    "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}",
+    "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}",
+    "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}",
+    "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}",
+    "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}",
+    "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges",
+    "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}",
+    "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads",
+    "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}",
+    "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}",
+    "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}",
+    "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}",
+    "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}",
+    "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}",
+    "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments",
+    "created_at": "2019-05-15T15:19:25Z",
+    "updated_at": "2019-05-15T15:21:14Z",
+    "pushed_at": "2019-05-15T15:20:57Z",
+    "git_url": "git://github.com/Codertocat/Hello-World.git",
+    "ssh_url": "git@github.com:Codertocat/Hello-World.git",
+    "clone_url": "https://github.com/Codertocat/Hello-World.git",
+    "svn_url": "https://github.com/Codertocat/Hello-World",
+    "homepage": null,
+    "size": 0,
+    "stargazers_count": 0,
+    "watchers_count": 0,
+    "language": "Ruby",
+    "has_issues": true,
+    "has_projects": true,
+    "has_downloads": true,
+    "has_wiki": true,
+    "has_pages": true,
+    "forks_count": 0,
+    "mirror_url": null,
+    "archived": false,
+    "disabled": false,
+    "open_issues_count": 2,
+    "license": null,
+    "forks": 0,
+    "open_issues": 2,
+    "watchers": 0,
+    "default_branch": "master"
+  },
+  "sender": {
+    "login": "Codertocat",
+    "id": 21031067,
+    "node_id": "MDQ6VXNlcjIxMDMxMDY3",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/Codertocat",
+    "html_url": "https://github.com/Codertocat",
+    "followers_url": "https://api.github.com/users/Codertocat/followers",
+    "following_url": "https://api.github.com/users/Codertocat/following{/other_user}",
+    "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions",
+    "organizations_url": "https://api.github.com/users/Codertocat/orgs",
+    "repos_url": "https://api.github.com/users/Codertocat/repos",
+    "events_url": "https://api.github.com/users/Codertocat/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/Codertocat/received_events",
+    "type": "User",
+    "site_admin": false
+  }
+}