-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This sends a message to `secrets.DISCORD_WEBHOOK` when a commit is detected on apache/tvm that is failing CI.
- Loading branch information
Showing
5 changed files
with
369 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
|
||
name: monitor-failures | ||
|
||
on: | ||
workflow_dispatch: | ||
schedule: | ||
- cron: "*/15 * * * *" | ||
|
||
concurrency: | ||
group: monitor-failures | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
monitor-failures: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
submodules: "recursive" | ||
- name: Ping Discord on failures | ||
env: | ||
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
set -eux | ||
python tests/scripts/ping_on_failure.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__pycache__/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
#!/usr/bin/env python3 | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
|
||
import json | ||
import subprocess | ||
import re | ||
from urllib import request | ||
from typing import Dict, Tuple, Any | ||
|
||
|
||
class GitHubRepo: | ||
def __init__(self, user, repo, token): | ||
self.token = token | ||
self.user = user | ||
self.repo = repo | ||
self.base = f"https://api.github.com/repos/{user}/{repo}/" | ||
|
||
def headers(self): | ||
return { | ||
"Authorization": f"Bearer {self.token}", | ||
} | ||
|
||
def graphql(self, query: str) -> Dict[str, Any]: | ||
return self._post("https://api.github.com/graphql", {"query": query}) | ||
|
||
def _post(self, full_url: str, body: Dict[str, Any]) -> Dict[str, Any]: | ||
print("Requesting POST to", full_url, "with", body) | ||
req = request.Request(full_url, headers=self.headers(), method="POST") | ||
req.add_header("Content-Type", "application/json; charset=utf-8") | ||
data = json.dumps(body) | ||
data = data.encode("utf-8") | ||
req.add_header("Content-Length", len(data)) | ||
|
||
with request.urlopen(req, data) as response: | ||
response = json.loads(response.read()) | ||
return response | ||
|
||
def post(self, url: str, data: Dict[str, Any]) -> Dict[str, Any]: | ||
return self._post(self.base + url, data) | ||
|
||
def get(self, url: str) -> Dict[str, Any]: | ||
url = self.base + url | ||
print("Requesting GET to", url) | ||
req = request.Request(url, headers=self.headers()) | ||
with request.urlopen(req) as response: | ||
response = json.loads(response.read()) | ||
return response | ||
|
||
def delete(self, url: str) -> Dict[str, Any]: | ||
url = self.base + url | ||
print("Requesting DELETE to", url) | ||
req = request.Request(url, headers=self.headers(), method="DELETE") | ||
with request.urlopen(req) as response: | ||
response = json.loads(response.read()) | ||
return response | ||
|
||
|
||
def parse_remote(remote: str) -> Tuple[str, str]: | ||
""" | ||
Get a GitHub (user, repo) pair out of a git remote | ||
""" | ||
if remote.startswith("https://"): | ||
# Parse HTTP remote | ||
parts = remote.split("/") | ||
if len(parts) < 2: | ||
raise RuntimeError(f"Unable to parse remote '{remote}'") | ||
return parts[-2], parts[-1].replace(".git", "") | ||
else: | ||
# Parse SSH remote | ||
m = re.search(r":(.*)/(.*)\.git", remote) | ||
if m is None or len(m.groups()) != 2: | ||
raise RuntimeError(f"Unable to parse remote '{remote}'") | ||
return m.groups() | ||
|
||
|
||
def git(command): | ||
command = ["git"] + command | ||
print("Running", command) | ||
proc = subprocess.run(command, stdout=subprocess.PIPE, check=True) | ||
return proc.stdout.decode().strip() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,230 @@ | ||
#!/usr/bin/env python3 | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
|
||
import os | ||
import json | ||
import argparse | ||
import tempfile | ||
import requests | ||
from pathlib import Path | ||
from urllib import request | ||
from typing import Any, Dict | ||
|
||
from git_utils import git, GitHubRepo, parse_remote | ||
|
||
REPO_ROOT = Path(__file__).resolve().parent | ||
|
||
|
||
_commit_query_fields = """ | ||
messageHeadline | ||
oid | ||
statusCheckRollup { | ||
contexts(last:100) { | ||
nodes { | ||
... on CheckRun { | ||
conclusion | ||
status | ||
name | ||
detailsUrl | ||
checkSuite { | ||
workflowRun { | ||
workflow { | ||
name | ||
} | ||
} | ||
} | ||
} | ||
... on StatusContext { | ||
context | ||
state | ||
targetUrl | ||
} | ||
} | ||
} | ||
} | ||
""" | ||
|
||
|
||
def commits_query(user: str, repo: str, cursor: str = None): | ||
""" | ||
Create a GraphQL query to find the last N commits along with their statuses | ||
and some metadata (paginated after 'cursor') | ||
""" | ||
after = "" | ||
if cursor is not None: | ||
after = f', after:"{cursor}"' | ||
|
||
return f""" | ||
{{ | ||
repository(name: "{repo}", owner: "{user}") {{ | ||
defaultBranchRef {{ | ||
target {{ | ||
... on Commit {{ | ||
history(first: 15{after}) {{ | ||
edges {{ cursor }} | ||
nodes {{ | ||
{_commit_query_fields} | ||
}} | ||
}} | ||
}} | ||
}} | ||
}} | ||
}} | ||
}} | ||
""" | ||
|
||
|
||
def check_commit(commit: Dict[str, Any]) -> bool: | ||
""" | ||
Check the commit and message discord if necessary | ||
""" | ||
statuses = commit["statusCheckRollup"]["contexts"]["nodes"] | ||
|
||
# GitHub Actions statuses are different from external GitHub statuses, so | ||
# unify them into 1 representation | ||
unified_statuses = [] | ||
for status in statuses: | ||
if "context" in status: | ||
# Parse non-GHA status | ||
unified_statuses.append( | ||
{ | ||
"name": status["context"], | ||
"status": status["state"], | ||
"url": status["targetUrl"], | ||
} | ||
) | ||
else: | ||
# Parse GitHub Actions item | ||
workflow = status["checkSuite"]["workflowRun"]["workflow"]["name"] | ||
name = f"{workflow} / {status['name']}" | ||
unified_statuses.append( | ||
{ | ||
"name": name, | ||
"status": status["conclusion"], | ||
"url": status["detailsUrl"], | ||
} | ||
) | ||
|
||
return { | ||
"oid": commit["oid"], | ||
"statuses": unified_statuses, | ||
"messageHeadline": commit["messageHeadline"], | ||
} | ||
|
||
|
||
def message_diff(old, new): | ||
def find_old(oid): | ||
for c in old: | ||
if c == old["oid"]: | ||
return c | ||
return None | ||
|
||
for commit in new: | ||
old_commit = find_old(commit["oid"]) | ||
if old_commit is not None: | ||
# find which jobs to message | ||
old_names = {x["name"] for x in old_commit["statuses"]} | ||
to_message = [x for x in commit["statuses"] if x["name"] not in old_names] | ||
else: | ||
# message about all jobs | ||
to_message = commit["statuses"] | ||
|
||
to_message = [ | ||
x | ||
for x in to_message | ||
if x["status"] != "SUCCESS" and x["status"] != "PENDING" | ||
] | ||
|
||
for m in to_message: | ||
msg = f"Job `{m['name']}` failed on commit `{commit['oid']}`: {commit['messageHeadline']}" | ||
discord( | ||
{ | ||
"content": msg, | ||
"embeds": [ | ||
{ | ||
"title": m["url"], | ||
"url": m["url"], | ||
} | ||
], | ||
} | ||
) | ||
|
||
|
||
def discord(body: Dict[str, Any]) -> Dict[str, Any]: | ||
url = os.environ["DISCORD_WEBHOOK"] | ||
r = requests.post(url, json=body) | ||
print(r.content) | ||
|
||
|
||
if __name__ == "__main__": | ||
help = "Ping discord on CI failures" | ||
parser = argparse.ArgumentParser(description=help) | ||
parser.add_argument("--user", default="apache", help="ssh remote to parse") | ||
parser.add_argument("--repo", default="tvm", help="ssh remote to parse") | ||
args = parser.parse_args() | ||
|
||
user = args.user | ||
repo = args.repo | ||
|
||
github = GitHubRepo(token=os.environ["GITHUB_TOKEN"], user=user, repo=repo) | ||
q = commits_query(user, repo) | ||
r = github.graphql(q) | ||
|
||
commits = r["data"]["repository"]["defaultBranchRef"]["target"]["history"]["nodes"] | ||
|
||
# Limit GraphQL pagination | ||
MAX_COMMITS_TO_CHECK = 10 | ||
i = 0 | ||
|
||
all_data = [] | ||
|
||
with open(REPO_ROOT / "statuses.json") as f: | ||
old_all_data = json.load(f) | ||
|
||
while i < MAX_COMMITS_TO_CHECK: | ||
# Check each commit | ||
for commit in commits: | ||
all_data.append(check_commit(commit)) | ||
|
||
# No good commit found, proceed to next page of results | ||
edges = r["data"]["repository"]["defaultBranchRef"]["target"]["history"][ | ||
"edges" | ||
] | ||
if len(edges) == 0: | ||
break | ||
else: | ||
q = commits_query(user, repo, cursor=edges[-1]["cursor"]) | ||
r = github.graphql(q) | ||
commits = r["data"]["repository"]["defaultBranchRef"]["target"]["history"][ | ||
"nodes" | ||
] | ||
|
||
# Backstop to prevent looking through all the past commits | ||
i += len(commits) | ||
|
||
if old_all_data != all_data: | ||
message_diff(old_all_data, all_data) | ||
|
||
with open(REPO_ROOT / "statuses.json", "w") as f: | ||
json.dump(all_data, f) | ||
|
||
git(["add", "statuses.json"]) | ||
git(["config", "user.email", "[email protected]"]) | ||
git(["config", "user.name", "Your Name"]) | ||
git(["commit", "-mupdate status"]) | ||
git(["push"]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{} |