Merge pull request #274 from tekktrik/dev/cli-tools

Turn some tools into CLI tools

Author: evaherrada

tools/ci_status.py

@@ -15,11 +15,12 @@
 """
 
 from typing import Optional
+import argparse
 from github.Repository import Repository
 from github.Workflow import Workflow
 from github.GithubException import GithubException
-from tools.library_functions import StrPath
-from tools.iterate_libraries import (
+from library_functions import StrPath
+from iterate_libraries import (
     iter_remote_bundle_with_func,
     RemoteLibFunc_IterResult,
 )
@@ -28,22 +29,27 @@
 def run_gh_rest_check(
     lib_repo: Repository,
     user: Optional[str] = None,
+    branch: Optional[str] = None,
     workflow_filename: Optional[str] = "build.yml",
 ) -> str:
     """Uses ``PyGithub`` to check the CI status of a repository
 
     :param Repository lib_repo: The repo as a github.Repository.Repository object
     :param str|None user: The user that triggered the run; if `None` is
         provided, any user is acceptable
+    :param str|None branch: The branch name to specifically check; if `None` is
+        provided, all branches are allowed; this is the default
     :param str|None workflow_filename: The filename of the workflow; if `None` is
-        provided, any workflow name is acceptable; the default is `"build.yml"`
+        provided, any workflow name is acceptable; the default is ``"build.yml"``
     :return: The requested runs conclusion
     :rtype: str
     """
 
     arg_dict = {}
     if user is not None:
         arg_dict["actor"] = user
+    if branch is not None:
+        arg_dict["branch"] = branch
 
     workflow: Workflow = lib_repo.get_workflow(workflow_filename)
     workflow_runs = workflow.get_runs(**arg_dict)
@@ -53,6 +59,7 @@ def run_gh_rest_check(
 def check_build_status(
     lib_repo: Repository,
     user: Optional[str] = None,
+    branch: Optional[str] = None,
     workflow_filename: Optional[str] = "build.yml",
     debug: bool = False,
 ) -> Optional[str]:
@@ -62,6 +69,8 @@ def check_build_status(
     :param Repository lib_repo: The repo as a github.Repository.Repository object
     :param str|None user: The user that triggered the run; if `None` is
         provided, any user is acceptable
+    :param str|None branch: The branch name to specifically check; if `None` is
+        provided, all branches are allowed; this is the default
     :param str|None workflow_filename: The filename of the workflow; if `None`
         is provided, any workflow name is acceptable; the defail is `"build.yml"`
     :param bool debug: Whether debug statements should be printed to the standard
@@ -74,8 +83,13 @@ def check_build_status(
     if debug:
         print("Checking", lib_repo.name)
 
+    if lib_repo.archived:
+        return True
+
     try:
-        result = run_gh_rest_check(lib_repo, user, workflow_filename) == "success"
+        result = (
+            run_gh_rest_check(lib_repo, user, branch, workflow_filename) == "success"
+        )
         if debug and not result:
             print("***", "Library", lib_repo.name, "failed the patch!", "***")
         return result
@@ -94,6 +108,7 @@ def check_build_status(
 def check_build_statuses(
     gh_token: str,
     user: Optional[str] = None,
+    branch: Optional[str] = "main",
     workflow_filename: Optional[str] = "build.yml",
     *,
     debug: bool = False,
@@ -104,6 +119,8 @@ def check_build_statuses(
     :param str gh_token: The Github token to be used for with the Github API
     :param str|None user: The user that triggered the run; if `None` is
         provided, any user is acceptable
+    :param str|None branch: The branch name to specifically check; if `None` is
+        provided, all branches are allowed; this is the default
     :param str|None workflow_filename: The filename of the workflow; if `None` is
         provided, any workflow name is acceptable; the defail is `"build.yml"`
     :param bool debug: Whether debug statements should be printed to
@@ -113,9 +130,10 @@ def check_build_statuses(
     :rtype: list
     """
 
-    args = (user, workflow_filename)
-    kwargs = {"debug": debug}
-    return iter_remote_bundle_with_func(gh_token, [(check_build_status, args, kwargs)])
+    return iter_remote_bundle_with_func(
+        gh_token,
+        [(check_build_status, (user, branch, workflow_filename), {"debug": debug})],
+    )
 
 
 def save_build_statuses(
@@ -138,3 +156,60 @@ def save_build_statuses(
         with open(failures_filepath, mode="w", encoding="utf-8") as outputfile:
             for build in bad_builds:
                 outputfile.write(build + "\n")
+
+
+if __name__ == "__main__":
+
+    parser = argparse.ArgumentParser(
+        description="Check the CI status of the Bundle libraries"
+    )
+    parser.add_argument(
+        "gh_token", metavar="GH_TOKEN", type=str, help="GitHub token with proper scopes"
+    )
+    parser.add_argument(
+        "--user",
+        metavar="U",
+        type=str,
+        dest="user",
+        default=None,
+        help="Select a specific user that triggered the workflow",
+    )
+    parser.add_argument(
+        "--branch",
+        metavar="B",
+        type=str,
+        dest="branch",
+        default=None,
+        help='Branch name; default is "main"',
+    )
+    parser.add_argument(
+        "--workflow",
+        metavar="W",
+        type=str,
+        dest="workflow",
+        default="build.yml",
+        help='Workflow name; default is "build.yml"',
+    )
+    parser.add_argument(
+        "--debug", action="store_true", help="Print debug text during execution"
+    )
+
+    args = parser.parse_args()
+
+    results = check_build_statuses(
+        args.gh_token, args.user, args.branch, args.workflow, debug=args.debug
+    )
+    fail_list = [
+        repo_name.name for repo_name, repo_results in results if not repo_results[0]
+    ]
+
+    if fail_list:
+        print(f'Failures for CI workflow "{args.workflow}":')
+        for failure in fail_list:
+            print(failure)
+        RETURN_CODE = 1
+    else:
+        print(f"No failures for CI workflow: {args.workflow}!")
+        RETURN_CODE = 0
+
+    raise SystemExit(RETURN_CODE)

tools/docs_status.py

@@ -15,11 +15,12 @@
 """
 
 from typing import Any, Optional
+import argparse
 import parse
 import requests
 from github.Repository import Repository
 from github.ContentFile import ContentFile
-from tools.iterate_libraries import (
+from iterate_libraries import (
     iter_remote_bundle_with_func,
     RemoteLibFunc_IterResult,
 )
@@ -87,6 +88,39 @@ def check_docs_statuses(
     :rtype: list
     """
 
-    args = (rtd_token,)
-    kwargs = {}
-    return iter_remote_bundle_with_func(gh_token, [(check_docs_status, args, kwargs)])
+    return iter_remote_bundle_with_func(
+        gh_token, [(check_docs_status, (rtd_token,), {})]
+    )
+
+
+if __name__ == "__main__":
+
+    parser = argparse.ArgumentParser(
+        description="Check the RTD docs build status of the Bundle libraries"
+    )
+    parser.add_argument(
+        "gh_token", metavar="GH_TOKEN", type=str, help="GitHub token with proper scopes"
+    )
+    parser.add_argument(
+        "rtd_token", metavar="RTD_TOKEN", type=str, help="ReadTheDocs token"
+    )
+
+    args = parser.parse_args()
+
+    results = check_docs_statuses(args.gh_token, args.rtd_token)
+    fail_list = [
+        repo_name.name
+        for repo_name, repo_results in results
+        if repo_results[0] == False  # pylint: disable=singleton-comparison
+    ]
+
+    if fail_list:
+        print("Failures for RTD builds:")
+        for failure in fail_list:
+            print(failure)
+        RETURN_CODE = 1
+    else:
+        print("No failures for RTD builds!")
+        RETURN_CODE = 0
+
+    raise SystemExit(RETURN_CODE)

tools/git_functionality.py

@@ -19,7 +19,7 @@
 import git
 import git.repo
 import git.index.base
-from tools.library_functions import StrPath
+from library_functions import StrPath
 
 
 def _get_repo_and_remote(

tools/iterate_libraries.py

@@ -23,7 +23,7 @@
 from github import Github
 from github.Repository import Repository
 from github.ContentFile import ContentFile
-from tools.library_functions import StrPath, LocalLibFunc, RemoteLibFunc
+from library_functions import StrPath, LocalLibFunc, RemoteLibFunc
 
 # Helpful type annotapython generic type aliastion definitions