RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

tools/backport_pr: reformat with black

Browse Source
This commit is contained in:
Alexandre Abadie 2021-09-28 15:10:13 +02:00
parent 43a7c8c8f2
commit 8d4d8f207d
No known key found for this signature in database
GPG Key ID: 1C919A403CAE1405
1 changed files with 107 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

182
dist/tools/backport_pr/backport_pr.py vendored
View File

@ -28,10 +28,10 @@ WORKTREE_SUBDIR = "backport_temp"
RELEASE_PREFIX = ""
RELEASE_SUFFIX = "-branch"
LABELS_REMOVE = ['Process: needs backport', 'Reviewed: ']
LABELS_ADD = ['Process: release backport']
LABELS_REMOVE = ["Process: needs backport", "Reviewed: "]
LABELS_ADD = ["Process: release backport"]
BACKPORT_BRANCH = 'backport/{release}/{origbranch}'
BACKPORT_BRANCH = "backport/{release}/{origbranch}"
def _get_labels(pull_request):
@ -46,22 +46,22 @@ def _get_labels(pull_request):
>>> _get_labels({'labels': [{'name': 'Process: needs backport'}]})
['Process: release backport']
"""
labels = set(label['name'] for label in pull_request['labels']
if all(not label['name'].startswith(remove)
for remove in LABELS_REMOVE))
labels = set(
label["name"]
for label in pull_request["labels"]
if all(not label["name"].startswith(remove) for remove in LABELS_REMOVE)
)
labels.update(LABELS_ADD)
return sorted(list(labels))
def _branch_name_strip(branch_name, prefix=RELEASE_PREFIX,
suffix=RELEASE_SUFFIX):
def _branch_name_strip(branch_name, prefix=RELEASE_PREFIX, suffix=RELEASE_SUFFIX):
"""Strip suffix and prefix.
>>> _branch_name_strip('2018.10-branch')
'2018.10'
"""
if (branch_name.startswith(prefix) and
branch_name.endswith(suffix)):
if branch_name.startswith(prefix) and branch_name.endswith(suffix):
if prefix:
branch_name = branch_name.split(prefix, maxsplit=1)[0]
if suffix:
@ -83,29 +83,29 @@ def _get_latest_release(branches):
('2020.04', '2020.04-branch')
"""
version_latest = 0
release_fullname = ''
release_short = ''
release_fullname = ""
release_short = ""
for branch in branches:
branch_name = _branch_name_strip(branch['name'])
branch_name = _branch_name_strip(branch["name"])
branch_num = 0
try:
branch_num = int(''.join(branch_name.split('.')))
branch_num = int("".join(branch_name.split(".")))
except ValueError:
pass
if branch_num > version_latest:
version_latest = branch_num
release_short = branch_name
release_fullname = branch['name']
release_fullname = branch["name"]
return (release_short, release_fullname)
def _find_remote(repo, user, repo_name):
for remote in repo.remotes:
if (remote.url.endswith(f"{user}/{repo_name}.git") or
remote.url.endswith(f"{user}/{repo_name}")):
if remote.url.endswith(f"{user}/{repo_name}.git") or remote.url.endswith(
f"{user}/{repo_name}"
):
return remote
raise ValueError("Could not find remote with URL ending in "
f"{user}/{repo_name}.git")
raise ValueError(f"Could not find remote with URL ending in {user}/{repo_name}.git")
def _get_upstream(repo):
@ -114,34 +114,55 @@ def _get_upstream(repo):
def _delete_worktree(repo, workdir):
shutil.rmtree(workdir)
repo.git.worktree('prune')
repo.git.worktree("prune")
def main():
# pylint:disable=too-many-locals,too-many-branches,too-many-statements
"""Main function of this script."""
keyfile = os.path.join(os.environ['HOME'], GITHUBTOKEN_FILE)
keyfile = os.path.join(os.environ["HOME"], GITHUBTOKEN_FILE)
parser = argparse.ArgumentParser()
parser.add_argument("-k", "--keyfile", type=argparse.FileType('r'),
default=keyfile,
help="File containing github token")
parser.add_argument("-c", "--comment", action="store_true",
help="Put a comment with a reference under"
"the original PR")
parser.add_argument("-n", "--noop", action="store_true",
help="Limited noop mode, creates branch, but doesn't"
"push and create the PR")
parser.add_argument("-r", "--release-branch", type=str,
help="Base the backport on this branch, "
"default is the latest")
parser.add_argument("--backport-branch-fmt", type=str,
default=BACKPORT_BRANCH,
help="Backport branch format. "
"Fields '{release}' and '{origbranch} will be "
"replaced by the release name and remote branch "
"name.")
parser.add_argument('-d', '--gitdir', type=str, default=os.getcwd(),
help="Base git repo to work from")
parser.add_argument(
"-k",
"--keyfile",
type=argparse.FileType("r"),
default=keyfile,
help="File containing github token",
)
parser.add_argument(
"-c",
"--comment",
action="store_true",
help="Put a comment with a reference under" "the original PR",
)
parser.add_argument(
"-n",
"--noop",
action="store_true",
help="Limited noop mode, creates branch, but doesn't" "push and create the PR",
)
parser.add_argument(
"-r",
"--release-branch",
type=str,
help="Base the backport on this branch, " "default is the latest",
)
parser.add_argument(
"--backport-branch-fmt",
type=str,
default=BACKPORT_BRANCH,
help="Backport branch format. "
"Fields '{release}' and '{origbranch} will be "
"replaced by the release name and remote branch "
"name.",
)
parser.add_argument(
"-d",
"--gitdir",
type=str,
default=os.getcwd(),
help="Base git repo to work from",
)
parser.add_argument("PR", type=int, help="Pull request number to backport")
args = parser.parse_args()
@ -157,25 +178,27 @@ def main():
response_headers = dict(github_api.getheaders())
# agithub documentation says it's lower case header field-names but
# at this moment it's not
if 'X-OAuth-Scopes' in response_headers:
scopes = response_headers['X-OAuth-Scopes']
if "X-OAuth-Scopes" in response_headers:
scopes = response_headers["X-OAuth-Scopes"]
else:
scopes = response_headers['x-oauth-scopes']
scopes_list = [x.strip() for x in scopes.split(',')]
if not ('public_repo' in scopes_list or 'repo' in scopes_list):
print("missing public_repo scope from token settings."
" Please add it on the GitHub webinterface")
scopes = response_headers["x-oauth-scopes"]
scopes_list = [x.strip() for x in scopes.split(",")]
if not ("public_repo" in scopes_list or "repo" in scopes_list):
print(
"missing public_repo scope from token settings."
" Please add it on the GitHub webinterface"
)
sys.exit(1)
username = user['login']
username = user["login"]
status, pulldata = github_api.repos[ORG][REPO].pulls[args.PR].get()
if status != 200:
print(f'Commit #{args.PR} not found: {pulldata["message"]}')
sys.exit(2)
if not pulldata['merged']:
if not pulldata["merged"]:
print("Original PR not yet merged")
sys.exit(0)
print(f'Fetching for commit: #{args.PR}: {pulldata["title"]}')
orig_branch = pulldata['head']['ref']
orig_branch = pulldata["head"]["ref"]
status, commits = github_api.repos[ORG][REPO].pulls[args.PR].commits.get()
if status != 200:
print(f'No commits found for #{args.PR}: {commits["message"]}')
@ -190,8 +213,10 @@ def main():
else:
status, branches = github_api.repos[ORG][REPO].branches.get()
if status != 200:
print(f'Could not retrieve branches for {ORG}/{REPO}: '
f'{branches["message"]}')
print(
f"Could not retrieve branches for {ORG}/{REPO}: "
f'{branches["message"]}'
)
sys.exit(4)
release_shortname, release_fullname = _get_latest_release(branches)
if not release_fullname:
@ -209,23 +234,27 @@ def main():
upstream_remote.fetch()
# Build topic branch in temp dir
new_branch = args.backport_branch_fmt.format(release=release_shortname,
origbranch=orig_branch)
new_branch = args.backport_branch_fmt.format(
release=release_shortname, origbranch=orig_branch
)
if new_branch in repo.branches:
print(f"ERROR: Branch {new_branch} already exists")
sys.exit(1)
worktree_dir = os.path.join(args.gitdir, WORKTREE_SUBDIR)
repo.git.worktree("add", "-b",
new_branch,
WORKTREE_SUBDIR,
f"{upstream_remote}/{release_fullname}")
repo.git.worktree(
"add",
"-b",
new_branch,
WORKTREE_SUBDIR,
f"{upstream_remote}/{release_fullname}",
)
# transform branch name into Head object for later configuring
new_branch = repo.branches[new_branch]
try:
bp_repo = git.Repo(worktree_dir)
# Apply commits
for commit in commits:
bp_repo.git.cherry_pick('-x', commit['sha'])
bp_repo.git.cherry_pick("-x", commit["sha"])
# Push to github
origin = _find_remote(repo, username, REPO)
print(f"Pushing branch {new_branch} to {origin}")
@ -246,33 +275,36 @@ def main():
_delete_worktree(repo, worktree_dir)
labels = _get_labels(pulldata)
merger = pulldata['merged_by']['login']
merger = pulldata["merged_by"]["login"]
if not args.noop:
# Open new PR on github
pull_request = {
'title': f'{pulldata["title"]} [backport {release_shortname}]',
'head': f'{username}:{new_branch}',
'base': release_fullname,
'body': f'# Backport of #{args.PR}\n\n{pulldata["body"]}',
'maintainer_can_modify': True,
"title": f'{pulldata["title"]} [backport {release_shortname}]',
"head": f"{username}:{new_branch}",
"base": release_fullname,
"body": f'# Backport of #{args.PR}\n\n{pulldata["body"]}',
"maintainer_can_modify": True,
}
status, new_pr = github_api.repos[ORG][REPO].pulls.post(
body=pull_request)
status, new_pr = github_api.repos[ORG][REPO].pulls.post(body=pull_request)
if status != 201:
print(f'Error creating the new pr: "{new_pr["message"]}". '
'Is "Public Repo" access enabled for the token?')
pr_number = new_pr['number']
print(
f'Error creating the new pr: "{new_pr["message"]}". '
'Is "Public Repo" access enabled for the token?'
)
pr_number = new_pr["number"]
print(f"Create PR number #{pr_number} for backport")
github_api.repos[ORG][REPO].issues[pr_number].labels.post(body=labels)
review_request = {"reviewers": [merger]}
github_api.repos[ORG][REPO].pulls[pr_number].\
requested_reviewers.post(body=review_request)
github_api.repos[ORG][REPO].pulls[pr_number].requested_reviewers.post(
body=review_request
)
# Put commit under old PR
if args.comment and not args.noop:
comment = {"body": f"Backport provided in #{pr_number}"}
status, res = github_api.repos[ORG][REPO].\
issues[args.PR].comments.post(body=comment)
status, res = (
github_api.repos[ORG][REPO].issues[args.PR].comments.post(body=comment)
)
if status != 201:
print(f'Something went wrong adding the comment: {res["message"]}')
print(f"Added comment to #{args.PR}")