1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
# This script is used to create issues for client libraries failing the vnext of mypy, pyright, and pylint.
from __future__ import annotations
import sys
import os
import subprocess
import logging
import datetime
import re
import calendar
import typing
import pathlib
from typing_extensions import Literal
from github import Github, Auth
from ci_tools.variables import discover_repo_root
logging.getLogger().setLevel(logging.INFO)
CHECK_TYPE = Literal["mypy", "pylint", "pyright", "sphinx"]
def get_version_running(check_type: CHECK_TYPE) -> str:
commands = [sys.executable, "-m", check_type, "--version"]
version = subprocess.run(
commands,
check=True,
capture_output=True,
)
version = version.stdout.rstrip().decode("utf-8")
version_running = re.findall(r"(\d+.\d+.\d+)", version)[0]
logging.info(f"Running {check_type} version {version_running}")
return version_running
def get_build_link(check_type: CHECK_TYPE) -> str:
build_id = os.getenv("BUILD_BUILDID")
job_id = os.getenv("SYSTEM_JOBID")
next_id: str
if check_type == "mypy":
next_id = "c4b2a078-69a7-55a2-d776-67715c71590f"
if check_type == "pyright":
next_id = "d243185e-b901-5eef-29fe-f7943e030451"
if check_type == "pylint":
next_id = "b33d1587-3539-5735-af43-e3e62f02ca4b"
if check_type == "sphinx":
next_id = "82919efa-82d6-5dc4-2e9a-f82117bff292"
return (
f"https://dev.azure.com/azure-sdk/internal/_build/results?buildId={build_id}&view=logs&j={job_id}&t={next_id}"
)
def get_merge_dates(year: str) -> typing.List[datetime.datetime]:
"""We'll merge the latest version of the type checker/linter quarterly
on the Monday after release week. This function returns those 4 Mondays
for the given year.
"""
c = calendar.Calendar(firstweekday=calendar.FRIDAY)
first = c.monthdatescalendar(year, 1)
second = c.monthdatescalendar(year, 4)
third = c.monthdatescalendar(year, 7)
fourth = c.monthdatescalendar(year, 10)
merge_months = [first, second, third, fourth]
merge_dates = []
for month in merge_months:
code_complete = [
day for week in month for day in week if day.weekday() == calendar.FRIDAY and day.month in [1, 4, 7, 10]
][0]
monday_after_release_week = code_complete + datetime.timedelta(days=10)
merge_dates.append(monday_after_release_week)
return merge_dates
def get_date_for_version_bump(today: datetime.datetime) -> str:
merge_dates = get_merge_dates(today.year)
try:
merge_date = min(date for date in merge_dates if date >= today)
except ValueError:
# today's date is after October merge date, so rollover to next year
merge_dates = get_merge_dates(today.year + 1)
merge_date = min(date for date in merge_dates if date >= today)
return merge_date.strftime("%Y-%m-%d")
def get_labels(package_name: str, service: str) -> list[str]:
repo_root = discover_repo_root()
codeowners_path = pathlib.Path(repo_root) / ".github" / "CODEOWNERS"
with open(codeowners_path, "r") as codeowners_file:
codeowners = codeowners_file.readlines()
label = ""
service_label = ""
labels = []
if "mgmt" in package_name:
labels.append("Mgmt")
for line in codeowners:
if line.startswith("# PRLabel:"):
label = line.split("# PRLabel: %")[1].strip()
if label and line.startswith("/sdk/"):
parts = [part for part in line.split("@")[0].split("/") if part.strip()][1:]
if len(parts) > 2:
continue
try:
service_directory = parts[0]
except IndexError:
# it was a single file
continue
try:
library = parts[1]
if package_name == library:
labels.append(label)
return labels
except IndexError:
if service_directory == service:
service_label = label
if service_label:
labels.append(service_label)
return labels
def create_vnext_issue(package_dir: str, check_type: CHECK_TYPE) -> None:
"""This is called when a client library fails a vnext check.
An issue is created with the details or an existing issue is updated with the latest information."""
package_path = pathlib.Path(package_dir)
package_name = package_path.name
service_directory = package_path.parent.name
auth = Auth.Token(os.environ["GH_TOKEN"])
g = Github(auth=auth)
today = datetime.date.today()
repo = g.get_repo("Azure/azure-sdk-for-python")
issues = repo.get_issues(state="open", labels=[check_type], creator="azure-sdk")
vnext_issue = [issue for issue in issues if issue.title.split("needs")[0].strip() == package_name]
version = get_version_running(check_type)
build_link = get_build_link(check_type)
merge_date = get_date_for_version_bump(today)
error_type = "linting" if check_type == "pylint" else "docstring" if check_type == "sphinx" else "typing"
guide_link = (
"[Pylint Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/pylint_checking.md)"
if check_type == "pylint"
else (
"[Sphinx and docstring checker](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#sphinx-and-docstring-checker)"
if check_type == "sphinx"
else "[Typing Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/static_type_checking.md#run-mypy)"
)
)
title = f"{package_name} needs {error_type} updates for {check_type} version {version}"
template = (
f"**ACTION NEEDED:** This version of {check_type} will be merged on **{merge_date}**. "
f"The build will begin to fail for this library if errors are not fixed."
f"\n\n**Library name:** {package_name}"
f"\n**{check_type.capitalize()} version:** {version}"
f"\n**{check_type.capitalize()} Build:** [Link to build ({today.strftime('%Y-%m-%d')})]({build_link})"
f"\n**How to fix:** Run the `next-{check_type}` tox command at the library package-level and resolve "
f"the {error_type} errors.\n"
f'1) `../{package_name}>pip install "tox<5"`\n'
f"2) `../{package_name}>tox run -e next-{check_type} -c ../../../eng/tox/tox.ini --root .`\n\n"
f"See the {guide_link} for more information."
)
# create an issue for the library failing the vnext check
if not vnext_issue:
labels = get_labels(package_name, service_directory)
labels.extend([check_type])
logging.info(f"Issue does not exist for {package_name} with {check_type} version {version}. Creating...")
repo.create_issue(title=title, body=template, labels=labels)
return
# an issue exists, let's update it so it reflects the latest typing/linting errors
logging.info(f"Issue exists for {package_name} with {check_type} version {version}. Updating...")
vnext_issue[0].edit(
title=title,
body=template,
)
def close_vnext_issue(package_name: str, check_type: CHECK_TYPE) -> None:
"""This is called when a client library passes a vnext check. If an issue exists for the library, it is closed."""
auth = Auth.Token(os.environ["GH_TOKEN"])
g = Github(auth=auth)
repo = g.get_repo("Azure/azure-sdk-for-python")
issues = repo.get_issues(state="open", labels=[check_type], creator="azure-sdk")
vnext_issue = [issue for issue in issues if issue.title.split("needs")[0].strip() == package_name]
if vnext_issue:
logging.info(f"{package_name} passes {check_type}. Closing existing GH issue #{vnext_issue[0].number}...")
vnext_issue[0].edit(state="closed")
|
