rename cli option "--pr-number" to "--branch-name"; accept build for branches in valid branches not only PRs

Author: saklar13

scripts/cli.py

@@ -83,7 +83,11 @@ def trigger_auto_tests(
     ),
 )
 @click.option("--vcs-root-url", required=True, help="VCS URL")
-@click.option("--pr-number", required=True, help="PR number")
+@click.option(
+    "--branch-name",
+    required=True,
+    help="The branch name. Branch contains pull request id or branch name",
+)
 @click.option(
     "--valid-branches",
     default="master",
@@ -103,14 +107,14 @@ def trigger_auto_tests(
 )
 def verify_user_can_trigger(
     vcs_root_url: str,
-    pr_number: str,
+    branch_name: str,
     valid_branches: str,
     token: str,
 ):
     verify_user_can_trigger_build(
         vcs_root_url=vcs_root_url,
-        pr_number=pr_number,
-        valid_branches=valid_branches,
+        branch_name=branch_name,
+        valid_branches=valid_branches.split(","),
         token=token,
     )
 

scripts/pr_check/pr_check.py

@@ -18,32 +18,66 @@ def validate_author_pr_is_member_of_org(
     # repo.organization.has_in_members(user) always returns false ¯\_(ツ)_/¯
     if not org.has_in_members(pull.user):
         raise ValueError(
-            f"PR {pull.number} was created by user that is not a member of the "
+            f"PR {pull.number} was created by a user that is not a member of the "
             f"repo organization"
         )
 
 
-def validate_pr_target_branch_in_valid_branches(pull: PullRequest, valid_branches: str):
+def validate_pr_target_branch_in_valid_branches(
+    pull: PullRequest, valid_branches: list[str]
+):
     target_branch = pull.base.ref
-    if target_branch not in map(str.strip, valid_branches.split(",")):
-        raise ValueError(
-            f"Target branch {target_branch} is not in valid branches {valid_branches}"
+    if target_branch not in map(str.strip, valid_branches):
+        emsg = (
+            f"The target branch {target_branch} is not in valid "
+            f"branches {valid_branches}"
         )
+        raise ValueError(emsg)
+
+
+def get_pull_request_number(branch_name: str) -> int:
+    return int(branch_name.removeprefix("pull/"))
+
+
+def is_pull_request_branch(branch_name: str) -> bool:
+    try:
+        get_pull_request_number(branch_name)
+    except ValueError:
+        result = False
+    else:
+        result = True
+    return result
+
+
+def get_branch_name(branch_name: str) -> str:
+    return branch_name.removeprefix("refs/heads/")
+
+
+def print_stop_tc_build_msg(comment: str, re_add_to_queue: bool = False):
+    str_re_add = str(re_add_to_queue).lower()
+    click.echo(f"##teamcity[buildStop comment='{comment}' readdToQueue='{str_re_add}']")
 
 
 def verify_user_can_trigger_build(
     vcs_root_url: str,
-    pr_number: str,
-    valid_branches: str,
+    branch_name: str,
+    valid_branches: list[str],
     token: str,
 ):
     _, owner, repo_name = vcs_root_url.removesuffix(".git").rsplit("/", 2)
     github = Github(token)
     repo = github.get_repo(f"{owner}/{repo_name}")
-    pull = repo.get_pull(int(pr_number))
 
-    try:
-        validate_pr_target_branch_in_valid_branches(pull, valid_branches)
-        validate_author_pr_is_member_of_org(repo, github, pull)
-    except ValueError as e:
-        click.echo(f"##teamcity[buildStop comment='{str(e)}' readdToQueue='false']")
+    if is_pull_request_branch(branch_name):
+        pull = repo.get_pull(get_pull_request_number(branch_name))
+        try:
+            validate_pr_target_branch_in_valid_branches(pull, valid_branches)
+            validate_author_pr_is_member_of_org(repo, github, pull)
+        except ValueError as e:
+            print_stop_tc_build_msg(str(e))
+    else:
+        if get_branch_name(branch_name) not in valid_branches:
+            print_stop_tc_build_msg(
+                f"The branch '{branch_name}' is not in valid branches "
+                f"'{valid_branches}'"
+            )

version.txt

@@ -1 +1 @@
-1.0.5
+2.0.0