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 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
|
import os
import re
import json
import time
import logging
from glob import glob
import subprocess
from pathlib import Path
from functools import wraps
from typing import List, Any, Dict
from packaging.version import Version
from ghapi.all import GhApi
from azure.storage.blob import BlobServiceClient, ContainerClient
from util import add_certificate
_LOG = logging.getLogger()
def return_origin_path(func):
@wraps(func)
def wrapper(*args, **kwargs):
current_path = os.getcwd()
result = func(*args, **kwargs)
os.chdir(current_path)
return result
return wrapper
def log(cmd: str):
_LOG.info('==' + cmd + ' ==\n')
def print_exec(cmd: str):
log(cmd)
subprocess.call(cmd, shell=True)
def print_exec_output(cmd: str) -> List[str]:
log(cmd)
return subprocess.getoutput(cmd).split('\n')
def print_check(cmd):
log(cmd)
subprocess.check_call(cmd, shell=True)
def preview_version_plus(preview_label: str, last_version: str) -> str:
num = last_version.split(preview_label)
num[1] = str(int(num[1]) + 1)
return f'{num[0]}{preview_label}{num[1]}'
def stable_version_plus(changelog: str, last_version: str):
flag = [False, False, False] # breaking, feature, bugfix
flag[0] = '### Breaking Changes' in changelog
flag[1] = '### Features Added' in changelog
flag[2] = '### Bugs Fixed' in changelog
num = last_version.split('.')
if flag[0]:
return f'{int(num[0]) + 1}.0.0'
elif flag[1]:
return f'{num[0]}.{int(num[1]) + 1}.0'
elif flag[2]:
return f'{num[0]}.{num[1]}.{int(num[2]) + 1}'
else:
return '0.0.0'
# find all the files of one folder, including files in subdirectory
def all_files(path: str, files: List[str]):
all_folder = os.listdir(path)
for item in all_folder:
folder = str(Path(f'{path}/{item}'))
if os.path.isdir(folder):
all_files(folder, files)
else:
files.append(folder)
def modify_file(file_path: str, func: Any):
with open(file_path, 'r') as file_in:
content = file_in.readlines()
func(content)
with open(file_path, 'w') as file_out:
file_out.writelines(content)
def current_time() -> str:
date = time.localtime(time.time())
return '{}-{:02d}-{:02d}'.format(date.tm_year, date.tm_mon, date.tm_mday)
def current_time_month() -> str:
date = time.localtime(time.time())
return '{}-{:02d}'.format(date.tm_year, date.tm_mon)
def set_test_env_var():
setting_path = str(Path(os.getenv('SCRIPT_PATH')) / 'mgmt_settings_real_.py')
# edit mgmt_settings_real.py
with open(setting_path, 'r') as file_in:
list_in = file_in.readlines()
for i in range(0, len(list_in)):
list_in[i] = list_in[i].replace('ENV_TENANT_ID', os.environ['TENANT_ID'])
list_in[i] = list_in[i].replace('ENV_CLIENT_ID', os.environ['CLIENT_ID'])
list_in[i] = list_in[i].replace('ENV_CLIENT_SECRET', os.environ['CLIENT_SECRET'])
list_in[i] = list_in[i].replace('ENV_SUBSCRIPTION_ID', os.environ['SUBSCRIPTION_ID'])
with open(str(Path('tools/azure-sdk-tools/devtools_testutils/mgmt_settings_real.py')), 'w') as file_out:
file_out.writelines(list_in)
def start_test_proxy():
print_check('pwsh eng/common/testproxy/docker-start-proxy.ps1 \"start\"')
class CodegenTestPR:
"""
This class can generate SDK code, run live test and create RP
"""
def __init__(self):
self.issue_link = os.getenv('ISSUE_LINK')
self.pipeline_link = os.getenv('PIPELINE_LINK')
self.bot_token = os.getenv('AZURESDK_BOT_TOKEN')
self.spec_readme = os.getenv('SPEC_README', '')
self.spec_repo = os.getenv('SPEC_REPO', '')
self.conn_str = os.getenv('STORAGE_CONN_STR')
self.storage_endpoint = os.getenv('STORAGE_ENDPOINT').strip('/')
self.package_name = ''
self.new_branch = ''
self.sdk_folder = '' # 'compute' in 'sdk/compute/azure-mgmt-dns'
self.autorest_result = ''
self.next_version = ''
self.test_result = ''
self.pr_number = 0
self.container_name = ''
self.private_package_link = [] # List[str]
self.tag_is_stable = False
@return_origin_path
def get_latest_commit_in_swagger_repo(self) -> str:
os.chdir(Path(self.spec_repo))
head_sha = print_exec_output('git rev-parse HEAD')[0]
return head_sha
def readme_local_folder(self) -> Path:
result = re.findall('specification/[a-zA-Z-]+/resource-manager', self.spec_readme)
if len(result) == 0:
service_name = self.spec_readme
else:
service_name = result[0].split('/')[1]
return Path(f'specification/{service_name}/resource-manager/readme.md')
def get_sdk_folder_with_autorest_result(self):
generate_result = self.get_autorest_result()
self.sdk_folder = generate_result["packages"][0]["path"][0].split('/')[-1]
@staticmethod
def checkout_branch(env_key: str, repo: str):
env_var = os.getenv(env_key, "")
usr = env_var.split(":")[0] or "Azure"
branch = env_var.split(":")[-1] or "main"
print_exec(f'git remote add {usr} https://github.com/{usr}/{repo}.git')
print_check(f'git fetch {usr} {branch}')
print_check(f'git checkout {usr}/{branch}')
@return_origin_path
def checkout_azure_default_branch(self):
# checkout branch in sdk repo
self.checkout_branch("DEBUG_SDK_BRANCH", "azure-sdk-for-python")
# checkout branch in rest repo
if self.spec_repo:
os.chdir(Path(self.spec_repo))
self.checkout_branch("DEBUG_REST_BRANCH", "azure-rest-api-specs")
def generate_code(self):
self.checkout_azure_default_branch()
# prepare input data
input_data = {
'headSha': self.get_latest_commit_in_swagger_repo(),
'repoHttpsUrl': "https://github.com/Azure/azure-rest-api-specs",
'specFolder': self.spec_repo,
'relatedReadmeMdFiles': [str(self.readme_local_folder())]
}
# if Python tag exists
if os.getenv('PYTHON_TAG'):
input_data['python_tag'] = os.getenv('PYTHON_TAG')
self.autorest_result = str(Path(os.getenv('TEMP_FOLDER')) / 'temp.json')
with open(self.autorest_result, 'w') as file:
json.dump(input_data, file)
# generate code(be careful about the order)
print_exec('python scripts/dev_setup.py -p azure-core')
print_check(f'python -m packaging_tools.sdk_generator {self.autorest_result} {self.autorest_result}')
generate_result = self.get_autorest_result()
self.tag_is_stable = list(generate_result.values())[0]['tagIsStable']
log(f"tag_is_stable is {self.tag_is_stable}")
print_check(f'python -m packaging_tools.sdk_package {self.autorest_result} {self.autorest_result}')
def get_package_name_with_autorest_result(self):
generate_result = self.get_autorest_result()
self.package_name = generate_result["packages"][0]["packageName"].split('-', 2)[-1]
def prepare_branch_with_readme(self):
self.generate_code()
self.get_package_name_with_autorest_result()
self.get_sdk_folder_with_autorest_result()
self.create_new_branch()
def get_package_name_with_branch(self) -> (str, str):
origin_base_branch = os.getenv('BASE_BRANCH')
# e.g. AzureSDKAutomation:sdkAuto/track2_azure-mgmt-network or azclibot:t2-network-2022-01-05-26928
branch_info = origin_base_branch.split(':')
split_str = 'azure-mgmt-'
if 'azure-mgmt-' in branch_info[1]:
self.package_name = branch_info[1].split(split_str)[-1]
else:
self.package_name = branch_info[1].split('-')[1]
return branch_info[0], branch_info[1]
def create_new_branch(self):
self.new_branch = f't2-{self.package_name}-{current_time()}-{str(time.time())[-5:]}'
print_check(f'git checkout -b {self.new_branch}')
def create_branch_with_base_branch(self, github_usr: str, base_branch: str):
# checkout base branch
print_exec(f'git remote add {github_usr} https://github.com/{github_usr}/azure-sdk-for-python.git')
print_check(f'git fetch {github_usr} {base_branch}')
print_check(f'git checkout {github_usr}/{base_branch}')
# create new branch
self.create_new_branch()
def prepare_branch_with_base_branch(self):
github_usr, base_branch = self.get_package_name_with_branch()
self.create_branch_with_base_branch(github_usr, base_branch)
self.get_sdk_folder_with_package_name()
def get_sdk_folder_with_package_name(self):
folder_info = glob(f'sdk/*/azure-mgmt-{self.package_name}')[0]
self.sdk_folder = Path(folder_info).parts[1]
def check_sdk_readme(self):
sdk_readme = str(Path(f'sdk/{self.sdk_folder}/azure-mgmt-{self.package_name}/README.md'))
def edit_sdk_readme(content: List[str]):
for i in range(0, len(content)):
if content[i].find('MyService') > 0:
content[i] = content[i].replace('MyService', self.package_name.capitalize())
modify_file(sdk_readme, edit_sdk_readme)
# Use the template to update readme and setup by packaging_tools
@return_origin_path
def check_file_with_packaging_tool(self):
os.chdir(Path(f'sdk/{self.sdk_folder}'))
print_check(f'python -m packaging_tools --build-conf azure-mgmt-{self.package_name}')
log('packaging_tools --build-conf successfully ')
def check_pprint_name(self):
pprint_name = self.package_name.capitalize()
def edit_file_for_pprint_name(content: List[str]):
for i in range(0, len(content)):
content[i] = content[i].replace('MyService', pprint_name)
for file in os.listdir(self.sdk_code_path()):
file_path = str(Path(self.sdk_code_path()) / file)
if os.path.isfile(file_path):
modify_file(file_path, edit_file_for_pprint_name)
log(f' replace \"MyService\" with \"{pprint_name}\" successfully ')
def get_all_files_under_package_folder(self) -> List[str]:
files = []
all_files(self.sdk_code_path(), files)
return files
def calculate_next_version_proc(self, last_version: str):
preview_tag = not self.tag_is_stable
changelog = self.get_changelog()
if changelog == '':
msg = 'it should be stable' if self.tag_is_stable else 'it should be perview'
return f'0.0.0 ({msg})'
preview_version = 'rc' in last_version or 'b' in last_version
# | preview tag | stable tag
# preview version(1.0.0rc1/1.0.0b1) | 1.0.0rc2(track1)/1.0.0b2(track2) | 1.0.0
# stable version (1.0.0) (breaking change) | 2.0.0rc1(track1)/2.0.0b1(track2) | 2.0.0
# stable version (1.0.0) (feature) | 1.1.0rc1(track1)/1.1.0b1(track2) | 1.1.0
# stable version (1.0.0) (bugfix) | 1.0.1rc1(track1)/1.0.1b1(track2) | 1.0.1
preview_label = 'b'
if preview_version and preview_tag:
next_version = preview_version_plus(preview_label, last_version)
elif preview_version and not preview_tag:
next_version = last_version.split(preview_label)[0]
elif not preview_version and preview_tag:
next_version = stable_version_plus(changelog, last_version) + preview_label + '1'
else:
next_version = stable_version_plus(changelog, last_version)
return next_version
def get_autorest_result(self) -> Dict[Any, Any]:
with open(self.autorest_result, 'r') as file_in:
content = json.load(file_in)
return content
def get_changelog(self) -> str:
content = self.get_autorest_result()
return content["packages"][0]["changelog"]["content"]
def get_last_release_version(self) -> str:
content = self.get_autorest_result()
last_version = content["packages"][0]["version"]
try:
return str(Version(last_version))
except:
return ''
def calculate_next_version(self):
last_version = self.get_last_release_version()
if last_version:
self.next_version = self.calculate_next_version_proc(last_version)
else:
self.next_version = '1.0.0b1'
def edit_all_version_file(self):
files = self.get_all_files_under_package_folder()
def edit_version_file(content: List[str]):
for i in range(0, len(content)):
if content[i].find('VERSION') > -1:
content[i] = f'VERSION = "{self.next_version}"\n'
break
for file in files:
if '_version.py' in file:
modify_file(file, edit_version_file)
def check_version(self):
self.calculate_next_version()
self.edit_all_version_file()
def edit_changelog_for_new_service(self):
def edit_changelog_for_new_service_proc(content: List[str]):
for i in range(0, len(content)):
if '##' in content[i]:
content[i] = f'## {self.next_version} ({current_time()})\n'
break
modify_file(str(Path(self.sdk_code_path()) / 'CHANGELOG.md'), edit_changelog_for_new_service_proc)
def edit_changelog(self):
def edit_changelog_proc(content: List[str]):
content[1:1] = ['\n', f'## {self.next_version} ({current_time()})\n\n', self.get_changelog(), '\n']
modify_file(str(Path(self.sdk_code_path()) / 'CHANGELOG.md'), edit_changelog_proc)
def check_changelog_file(self):
if self.next_version == '1.0.0b1':
self.edit_changelog_for_new_service()
else:
self.edit_changelog()
@staticmethod
def get_need_dependency() -> List[str]:
template_path = Path('tools/azure-sdk-tools/packaging_tools/templates/packaging_files/setup.py')
items = ["msrest>", "azure-mgmt-core", "typing-extensions"]
with open(template_path, 'r') as fr:
content = fr.readlines()
dependencies = []
for i in range(len(content)):
if "install_requires" not in content[i]:
continue
for j in range(i, len(content)):
for item in items:
if item in content[j]:
dependencies.append(content[j].strip().strip(',').strip('\"'))
break
return dependencies
@staticmethod
def insert_line_num(content: List[str]) -> int:
start_num = 0
end_num = len(content)
for i in range(end_num):
if content[i].find("#override azure-mgmt-") > -1:
start_num = i
break
return (int(str(time.time()).split('.')[-1]) % max(end_num - start_num, 1)) + start_num
def check_ci_file_proc(self, dependency: str):
def edit_ci_file(content: List[str]):
new_line = f'#override azure-mgmt-{self.package_name} {dependency}'
dependency_name = re.compile("[a-zA-Z-]*").findall(dependency)[0]
for i in range(len(content)):
if new_line in content[i]:
return
if f'azure-mgmt-{self.package_name} {dependency_name}' in content[i]:
content[i] = new_line + '\n'
return
content.insert(self.insert_line_num(content), new_line + '\n')
modify_file(str(Path('shared_requirements.txt')), edit_ci_file)
print_exec('git add shared_requirements.txt')
def check_ci_file(self):
# eg: 'msrest>=0.6.21', 'azure-mgmt-core>=1.3.0,<2.0.0'
for item in self.get_need_dependency():
self.check_ci_file_proc(item)
def check_dev_requirement(self):
file = Path(f'sdk/{self.sdk_folder}/azure-mgmt-{self.package_name}/dev_requirements.txt')
content = [
"-e ../../../tools/azure-sdk-tools\n",
"-e ../../../tools/azure-devtools\n",
"../../identity/azure-identity\n"
]
if not file.exists():
with open(file, "w") as file_out:
file_out.writelines(content)
def check_file(self):
self.check_file_with_packaging_tool()
self.check_pprint_name()
self.check_sdk_readme()
self.check_version()
self.check_changelog_file()
self.check_ci_file()
self.check_dev_requirement()
def sdk_code_path(self) -> str:
return str(Path(f'sdk/{self.sdk_folder}/azure-mgmt-{self.package_name}'))
@property
def is_single_path(self) -> bool:
path = str(Path(f'sdk/{self.sdk_folder}'))
num = sum([os.path.isdir(str(Path(f'{path}/{listx}'))) for listx in os.listdir(path)])
return num == 1
@return_origin_path
def install_package_locally(self):
os.chdir(self.sdk_code_path())
print_check('pip install -e .')
print_exec('pip install -r dev_requirements.txt')
def prepare_test_env(self):
self.install_package_locally()
set_test_env_var()
add_certificate()
start_test_proxy()
@return_origin_path
def run_test_proc(self):
# run test
os.chdir(self.sdk_code_path())
test_mode = "Live test" if os.getenv("AZURE_TEST_RUN_LIVE") else "Recording test"
succeeded_result = f'{test_mode} success'
failed_result = f'{test_mode} fail, detailed info is in pipeline log(search keyword FAILED)!!!'
try:
print_check(f'pytest --collect-only')
except:
log(f'{test_mode} run done, do not find any test !!!')
self.test_result = succeeded_result
return
try:
print_check(f'pytest -s')
except:
log('some test failed, please fix it locally')
self.test_result = failed_result
else:
log(f'{test_mode} run done, do not find failure !!!')
self.test_result = succeeded_result
def run_test(self):
self.prepare_test_env()
self.run_test_proc()
def create_pr_proc(self):
api = GhApi(owner='Azure', repo='azure-sdk-for-python', token=self.bot_token)
pr_title = "[AutoRelease] {}(can only be merged by SDK owner)".format(self.new_branch)
pr_head = "{}:{}".format(os.getenv('USR_NAME'), self.new_branch)
pr_base = 'main'
pr_body = "{} \n{} \n{}".format(self.issue_link, self.test_result, self.pipeline_link)
if not self.is_single_path:
pr_body += f'\nBuildTargetingString\n azure-mgmt-{self.package_name}\nSkip.CreateApiReview\ntrue'
res_create = api.pulls.create(pr_title, pr_head, pr_base, pr_body)
# Add issue link on PR
api = GhApi(owner='Azure', repo='azure-sdk-for-python', token=self.bot_token)
api.issues.create_comment(issue_number=res_create.number, body='issue link:{}'.format(self.issue_link))
self.pr_number = res_create.number
def zero_version_policy(self):
if re.match(re.compile('0\.0\.0'), self.next_version):
api_request = GhApi(owner='Azure', repo='sdk-release-request', token=self.bot_token)
issue_number = int(self.issue_link.split('/')[-1])
api_request.issues.add_labels(issue_number=issue_number, labels=['base-branch-attention'])
def get_container_name(self) -> str:
container_name = current_time_month()
service_client = BlobServiceClient.from_connection_string(conn_str=self.conn_str)
containers_exist = [container for container in service_client.list_containers()]
containers_name = {container.name for container in containers_exist}
# create new container if it does not exist
if container_name not in containers_name:
container_client = service_client.get_container_client(container=container_name)
container_client.create_container(public_access='container', timeout=60 * 24 * 3600)
return container_name
def get_private_package(self) -> List[str]:
content = self.get_autorest_result()
return content["packages"][0]["artifacts"]
def upload_private_package_proc(self, container_name: str):
container_client = ContainerClient.from_connection_string(conn_str=self.conn_str, container_name=container_name)
private_package = self.get_private_package()
for package in private_package:
package_name = Path(package).parts[-1]
# package will be uploaded to storage account in the folder : container_name / pr_number / package_name
blob_name = f'sdk_pr_{self.pr_number}/{package_name}'
blob_client = container_client.get_blob_client(blob=blob_name)
with open(package, 'rb') as data:
blob_client.upload_blob(data, overwrite=True)
self.private_package_link.append(f'{self.storage_endpoint}/{container_name}/{blob_name}')
def upload_private_package(self):
container_name = self.get_container_name()
self.upload_private_package_proc(container_name)
def get_private_package_link(self) -> str:
self.upload_private_package()
result = []
# it is for markdown
for link in self.private_package_link:
package_name = link.split('/')[-1]
result.append(f'* [{package_name}]({link})\n')
return ''.join(result)
def ask_check_policy(self):
changelog = self.get_changelog()
if changelog == '':
changelog = 'no new content found by changelog tools!'
# comment to ask for check from users
issue_number = int(self.issue_link.split('/')[-1])
api = GhApi(owner='Azure', repo='sdk-release-request', token=self.bot_token)
author = api.issues.get(issue_number=issue_number).user.login
body = f'Hi @{author}, Please check whether the package works well and the CHANGELOG info is as below:\n' \
f'{self.get_private_package_link()}' \
f'```\n' \
f'CHANGELOG:\n' \
f'{changelog}\n' \
f'```\n' \
f'* (If you are not a Python User, you can mainly check whether the changelog meets your requirements)\n\n' \
f'* (The version of the package is only a temporary version for testing)\n\n' \
f'https://github.com/Azure/azure-sdk-for-python/pull/{self.pr_number}'
api.issues.create_comment(issue_number=issue_number, body=body)
# comment for hint
body = 'Tips: If you have special needs for release date or other things, please let us know. ' \
'Otherwise we will follow ' \
'[Management-SDK-Release-Cycle](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/761/Management-SDK-Release-Cycle) ' \
'to release it before target date'
api.issues.create_comment(issue_number=issue_number, body=body)
def issue_comment(self):
self.zero_version_policy()
self.ask_check_policy()
def create_pr(self):
# commit all code
print_exec('git add sdk/')
print_exec('git commit -m \"code and test\"')
print_check('git push origin HEAD -f')
# create PR
self.create_pr_proc()
# create release issue comment
self.issue_comment()
def run(self):
if "https:" in self.spec_readme:
self.prepare_branch_with_readme()
self.check_file()
self.run_test()
self.create_pr()
else:
self.sdk_folder = self.spec_readme.split('/')[0]
self.package_name = self.spec_readme.split('/')[-1].split('-')[-1]
self.checkout_branch("DEBUG_SDK_BRANCH", "azure-sdk-for-python")
self.run_test()
if __name__ == '__main__':
main_logger = logging.getLogger()
logging.basicConfig()
main_logger.setLevel(logging.INFO)
instance = CodegenTestPR()
instance.run()
|