2 # -*- coding: utf-8 -*-
4 # This script computes the new "current" toolstate for the toolstate repo (not to be
5 # confused with publishing the test results, which happens in `src/bootstrap/toolstate.rs`).
6 # It gets called from `src/ci/publish_toolstate.sh` when a new commit lands on `master`
7 # (i.e., after it passed all checks on `auto`).
9 from __future__ import print_function
21 import urllib.request as urllib2
23 # List of people to ping when the status of a tool or a book changed.
24 # These should be collaborators of the rust-lang/rust repository (with at least
25 # read privileges on it). CI will fail otherwise.
27 'miri': {'oli-obk', 'RalfJung', 'eddyb'},
29 'rustfmt': {'topecongiro'},
30 'book': {'carols10cents', 'steveklabnik'},
31 'nomicon': {'frewsxcv', 'Gankra'},
32 'reference': {'steveklabnik', 'Havvy', 'matthewjasper', 'ehuss'},
33 'rust-by-example': {'steveklabnik', 'marioidival'},
35 'adamgreig', 'andre-richter', 'jamesmunns', 'korken89',
36 'ryankurte', 'thejpster', 'therealprof',
38 'edition-guide': {'ehuss', 'steveklabnik'},
39 'rustc-dev-guide': {'mark-i-m', 'spastorino', 'amanjeev', 'JohnTitor'},
43 'miri': 'https://github.com/rust-lang/miri',
44 'rls': 'https://github.com/rust-lang/rls',
45 'rustfmt': 'https://github.com/rust-lang/rustfmt',
46 'book': 'https://github.com/rust-lang/book',
47 'nomicon': 'https://github.com/rust-lang/nomicon',
48 'reference': 'https://github.com/rust-lang/reference',
49 'rust-by-example': 'https://github.com/rust-lang/rust-by-example',
50 'embedded-book': 'https://github.com/rust-embedded/book',
51 'edition-guide': 'https://github.com/rust-lang/edition-guide',
52 'rustc-dev-guide': 'https://github.com/rust-lang/rustc-dev-guide',
55 def load_json_from_response(resp):
57 if isinstance(content, bytes):
58 content = content.decode('utf-8')
60 print("Refusing to decode " + str(type(content)) + " to str")
61 return json.loads(content)
63 def validate_maintainers(repo, github_token):
64 '''Ensure all maintainers are assignable on a GitHub repo'''
65 next_link_re = re.compile(r'<([^>]+)>; rel="next"')
67 # Load the list of assignable people in the GitHub repo
69 url = 'https://api.github.com/repos/%s/collaborators?per_page=100' % repo
70 while url is not None:
71 response = urllib2.urlopen(urllib2.Request(url, headers={
72 'Authorization': 'token ' + github_token,
73 # Properly load nested teams.
74 'Accept': 'application/vnd.github.hellcat-preview+json',
76 assignable.extend(user['login'] for user in load_json_from_response(response))
77 # Load the next page if available
79 link_header = response.headers.get('Link')
81 matches = next_link_re.match(link_header)
82 if matches is not None:
83 url = matches.group(1)
86 for tool, maintainers in MAINTAINERS.items():
87 for maintainer in maintainers:
88 if maintainer not in assignable:
91 "error: %s maintainer @%s is not assignable in the %s repo"
92 % (tool, maintainer, repo),
97 print(" To be assignable, a person needs to be explicitly listed as a")
98 print(" collaborator in the repository settings. The simple way to")
99 print(" fix this is to ask someone with 'admin' privileges on the repo")
100 print(" to add the person or whole team as a collaborator with 'read'")
101 print(" privileges. Those privileges don't grant any extra permissions")
102 print(" so it's safe to apply them.")
104 print("The build will fail due to this.")
108 def read_current_status(current_commit, path):
109 '''Reads build status of `current_commit` from content of `history/*.tsv`
111 with open(path, 'rU') as f:
113 (commit, status) = line.split('\t', 1)
114 if commit == current_commit:
115 return json.loads(status)
120 return os.environ['TOOLSTATE_ISSUES_API_URL']
123 def maybe_delink(message):
124 if os.environ.get('TOOLSTATE_SKIP_MENTIONS') is not None:
125 return message.replace("@", "")
136 # Open an issue about the toolstate failure.
137 if status == 'test-fail':
138 status_description = 'has failing tests'
140 status_description = 'no longer builds'
141 request = json.dumps({
142 'body': maybe_delink(textwrap.dedent('''\
143 Hello, this is your friendly neighborhood mergebot.
144 After merging PR {}, I observed that the tool {} {}.
145 A follow-up PR to the repository {} is needed to fix the fallout.
147 cc @{}, do you think you would have time to do the follow-up work?
148 If so, that would be great!
150 And nominating for compiler team prioritization.
153 relevant_pr_number, tool, status_description,
154 REPOS.get(tool), relevant_pr_user
156 'title': '`{}` no longer builds after {}'.format(tool, relevant_pr_number),
157 'assignees': list(assignees),
159 print("Creating issue:\n{}".format(request))
160 response = urllib2.urlopen(urllib2.Request(
164 'Authorization': 'token ' + github_token,
165 'Content-Type': 'application/json',
179 '''Updates `_data/latest.json` to match build result of the given commit.
181 with open('_data/latest.json', 'r+') as f:
182 latest = json.load(f, object_pairs_hook=collections.OrderedDict)
185 os: read_current_status(current_commit, 'history/' + os + '.tsv')
186 for os in ['windows', 'linux']
189 slug = 'rust-lang/rust'
190 message = textwrap.dedent('''\
191 📣 Toolstate changed by {}!
193 Tested on commit {}@{}.
194 Direct link to PR: <{}>
196 ''').format(relevant_pr_number, slug, current_commit, relevant_pr_url)
197 anything_changed = False
198 for status in latest:
199 tool = status['tool']
201 create_issue_for_status = None # set to the status that caused the issue
203 for os, s in current_status.items():
205 new = s.get(tool, old)
207 maintainers = ' '.join('@'+name for name in MAINTAINERS.get(tool, ()))
208 # comparing the strings, but they are ordered appropriately:
209 # "test-pass" > "test-fail" > "build-fail"
211 # things got fixed or at least the status quo improved
213 message += '🎉 {} on {}: {} → {} (cc {}).\n' \
214 .format(tool, os, old, new, maintainers)
216 # tests or builds are failing and were not failing before
218 title = '💔 {} on {}: {} → {}' \
219 .format(tool, os, old, new)
220 message += '{} (cc {}).\n' \
221 .format(title, maintainers)
222 # See if we need to create an issue.
224 # Create issue if tests used to pass before. Don't open a *second*
225 # issue when we regress from "test-fail" to "build-fail".
226 if old == 'test-pass':
227 create_issue_for_status = new
229 # Create issue if things no longer build.
230 # (No issue for mere test failures to avoid spurious issues.)
231 if new == 'build-fail':
232 create_issue_for_status = new
234 if create_issue_for_status is not None:
237 tool, create_issue_for_status, MAINTAINERS.get(tool, ''),
238 relevant_pr_number, relevant_pr_user,
240 except urllib2.HTTPError as e:
241 # network errors will simply end up not creating an issue, but that's better
242 # than failing the entire build job
243 print("HTTPError when creating issue for status regression: {0}\n{1}"
244 .format(e, e.read()))
246 print("I/O error when creating issue for status regression: {0}".format(e))
248 print("Unexpected error when creating issue for status regression: {0}"
249 .format(sys.exc_info()[0]))
253 status['commit'] = current_commit
254 status['datetime'] = current_datetime
255 anything_changed = True
257 if not anything_changed:
262 json.dump(latest, f, indent=4, separators=(',', ': '))
266 if __name__ == '__main__':
267 repo = os.environ.get('TOOLSTATE_VALIDATE_MAINTAINERS_REPO')
269 github_token = os.environ.get('TOOLSTATE_REPO_ACCESS_TOKEN')
271 validate_maintainers(repo, github_token)
273 print('skipping toolstate maintainers validation since no GitHub token is present')
274 # When validating maintainers don't run the full script.
277 cur_commit = sys.argv[1]
278 cur_datetime = datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ')
279 cur_commit_msg = sys.argv[2]
280 save_message_to_path = sys.argv[3]
281 github_token = sys.argv[4]
283 # assume that PR authors are also owners of the repo where the branch lives
284 relevant_pr_match = re.search(
285 r'Auto merge of #([0-9]+) - ([^:]+):[^,]+, r=(\S+)',
288 if relevant_pr_match:
289 number = relevant_pr_match.group(1)
290 relevant_pr_user = relevant_pr_match.group(2)
291 relevant_pr_number = 'rust-lang/rust#' + number
292 relevant_pr_url = 'https://github.com/rust-lang/rust/pull/' + number
293 pr_reviewer = relevant_pr_match.group(3)
296 relevant_pr_user = 'ghost'
297 relevant_pr_number = '<unknown PR>'
298 relevant_pr_url = '<unknown>'
299 pr_reviewer = 'ghost'
301 message = update_latest(
310 print('<Nothing changed>')
316 print('Dry run only, not committing anything')
319 with open(save_message_to_path, 'w') as f:
322 # Write the toolstate comment on the PR as well.
323 issue_url = gh_url() + '/{}/comments'.format(number)
324 response = urllib2.urlopen(urllib2.Request(
326 json.dumps({'body': maybe_delink(message)}),
328 'Authorization': 'token ' + github_token,
329 'Content-Type': 'application/json',