rename github.py to firebase_github.py (#1377)

Co-authored-by: Cynthia Jiang <cynthiajiang@google.com>

Author: cynthiajoan

scripts/gha/create_pull_request.py

@@ -32,7 +32,7 @@
 from absl import flags
 from absl import logging
 
-import github
+import firebase_github
 
 FLAGS = flags.FLAGS
 _DEFAULT_MESSAGE = "Creating pull request."
@@ -60,9 +60,9 @@
 def main(argv):
   if len(argv) > 1:
     raise app.UsageError("Too many command-line arguments.")
-  if github.create_pull_request(FLAGS.token, FLAGS.head, FLAGS.base, FLAGS.title, FLAGS.body, True):
+  if firebase_github.create_pull_request(FLAGS.token, FLAGS.head, FLAGS.base, FLAGS.title, FLAGS.body, True):
     # Find the most recent pull_request with the given base and head, that's ours.
-    pull_requests = github.list_pull_requests(FLAGS.token, "open", FLAGS.head, FLAGS.base)
+    pull_requests = firebase_github.list_pull_requests(FLAGS.token, "open", FLAGS.head, FLAGS.base)
     print(pull_requests[0]['number'])
   else:
     exit(1)

scripts/gha/dismiss_reviews.py

@@ -30,7 +30,7 @@
 from absl import flags
 from absl import logging
 
-import github
+import firebase_github
 
 FLAGS = flags.FLAGS
 _DEFAULT_MESSAGE = "Dismissing stale review."
@@ -60,7 +60,7 @@ def main(argv):
   if len(argv) > 1:
     raise app.UsageError("Too many command-line arguments.")
   # Get list of reviews from PR.
-  reviews = github.get_reviews(FLAGS.token, FLAGS.pull_number)
+  reviews = firebase_github.get_reviews(FLAGS.token, FLAGS.pull_number)
   logging.debug("Found %d reviews", len(reviews))
 
   # Filter out already-dismissed reviews.
@@ -76,7 +76,7 @@ def main(argv):
     review_ids = [r['id'] for r in reviews]
     logging.debug("Dismissing reviews: %s", review_ids)
     for review_id in review_ids:
-      github.dismiss_review(FLAGS.token, FLAGS.pull_number,
+      firebase_github.dismiss_review(FLAGS.token, FLAGS.pull_number,
                             review_id, FLAGS.message)
 
 if __name__ == "__main__":

scripts/gha/github.py renamed to scripts/gha/firebase_github.py

@@ -47,7 +47,7 @@
 from absl import flags
 from absl import logging
 
-import github
+import firebase_github
 import summarize_test_results as summarize
 
 _REPORT_LABEL = "nightly-testing"
@@ -144,9 +144,9 @@
 
 def test_start(token, issue_number, actor, commit, run_id):
   """In PR, when start testing, add comment and label \"tests: in-progress\""""
-  github.add_label(token, issue_number, _LABEL_PROGRESS)
+  firebase_github.add_label(token, issue_number, _LABEL_PROGRESS)
   for label in [_LABEL_TRIGGER_FULL, _LABEL_TRIGGER_QUICK, _LABEL_FAILED, _LABEL_SUCCEED]:
-    github.delete_label(token, issue_number, label)
+    firebase_github.delete_label(token, issue_number, label)
 
   comment = (_COMMENT_TITLE_PROGESS +
              _get_description(actor, commit, run_id) +
@@ -168,7 +168,7 @@ def test_progress(token, issue_number, actor, commit, run_id):
     else:
       # failures/errors still exist after retry
       title = _COMMENT_TITLE_PROGESS_FAIL
-      github.add_label(token, issue_number, _LABEL_FAILED)
+      firebase_github.add_label(token, issue_number, _LABEL_FAILED)
     comment = (title +
                _get_description(actor, commit, run_id) +
                log_summary +
@@ -184,7 +184,7 @@ def test_end(token, issue_number, actor, commit, run_id, new_token):
   success_or_only_flakiness, log_summary = _get_summary_table(token, run_id)
   if success_or_only_flakiness and not log_summary:
     # succeeded (without flakiness)
-    github.add_label(token, issue_number, _LABEL_SUCCEED)
+    firebase_github.add_label(token, issue_number, _LABEL_SUCCEED)
     comment = (_COMMENT_TITLE_SUCCEED +
                _get_description(actor, commit, run_id) +
                _COMMENT_HIDDEN_DIVIDER)
@@ -193,19 +193,19 @@ def test_end(token, issue_number, actor, commit, run_id, new_token):
     if success_or_only_flakiness:
       # all failures/errors are due to flakiness (succeeded after retry)
       title = _COMMENT_TITLE_FLAKY
-      github.add_label(token, issue_number, _LABEL_SUCCEED)
+      firebase_github.add_label(token, issue_number, _LABEL_SUCCEED)
     else:
       # failures/errors still exist after retry
       title = _COMMENT_TITLE_FAIL
-      github.add_label(token, issue_number, _LABEL_FAILED)
+      firebase_github.add_label(token, issue_number, _LABEL_FAILED)
     comment = (title +
                _get_description(actor, commit, run_id) +
                log_summary +
                _COMMENT_FLAKY_TRACKER +
                _COMMENT_HIDDEN_DIVIDER)
     _update_comment(token, issue_number, comment)
 
-  github.delete_label(new_token, issue_number, _LABEL_PROGRESS)
+  firebase_github.delete_label(new_token, issue_number, _LABEL_PROGRESS)
 
 
 def test_report(token, actor, commit, run_id, build_against, build_apis):
@@ -232,7 +232,7 @@ def test_report(token, actor, commit, run_id, build_against, build_apis):
     prefix = "Note: This report excludes Firestore. Please also check **[the report for Firestore](%s).**\n***\n" % firestore_issue_url
 
   issue_number = _get_issue_number(token, report_title, _REPORT_LABEL)
-  previous_comment = github.get_issue_body(token, issue_number)
+  previous_comment = firebase_github.get_issue_body(token, issue_number)
   [previous_prefix, previous_comment_repo, previous_comment_sdk,
    previous_comment_tip] = previous_comment.split(_COMMENT_HIDDEN_DIVIDER)
   logging.info("Previous prefix: %s", previous_prefix)
@@ -284,15 +284,15 @@ def test_report(token, actor, commit, run_id, build_against, build_apis):
     comment = prefix + _COMMENT_HIDDEN_DIVIDER + previous_comment_repo + _COMMENT_HIDDEN_DIVIDER + previous_comment_sdk + _COMMENT_HIDDEN_DIVIDER + comment
 
   if (_COMMENT_TITLE_SUCCEED_REPO in comment) and (_COMMENT_TITLE_SUCCEED_SDK in comment) and (build_apis != _BUILD_API_FIRESTORE or _COMMENT_TITLE_SUCCEED_TIP in comment):
-    github.close_issue(token, issue_number)
+    firebase_github.close_issue(token, issue_number)
   else:
-    github.open_issue(token, issue_number)
+    firebase_github.open_issue(token, issue_number)
 
-  github.update_issue_comment(token, issue_number, comment)
+  firebase_github.update_issue_comment(token, issue_number, comment)
 
 
 def _get_issue_number(token, title, label):
-  issues = github.search_issues_by_label(label)
+  issues = firebase_github.search_issues_by_label(label)
   for issue in issues:
     if issue["title"] == title:
       return issue["number"]
@@ -303,19 +303,19 @@ def _get_issue_number(token, title, label):
                    _COMMENT_HIDDEN_DIVIDER + " " +
                    _COMMENT_HIDDEN_DIVIDER + " "
                    )
-  return github.create_issue(token, title, label, empty_comment)["number"]
+  return firebase_github.create_issue(token, title, label, empty_comment)["number"]
 
 
 def _update_comment(token, issue_number, comment):
   comment_id = _get_comment_id(token, issue_number, _COMMENT_HIDDEN_DIVIDER)
   if not comment_id:
-    github.add_comment(token, issue_number, comment)
+    firebase_github.add_comment(token, issue_number, comment)
   else:
-    github.update_comment(token, comment_id, comment)
+    firebase_github.update_comment(token, comment_id, comment)
 
 
 def _get_comment_id(token, issue_number, comment_identifier):
-  comments = github.list_comments(token, issue_number)
+  comments = firebase_github.list_comments(token, issue_number)
   for comment in comments:
     if comment_identifier in comment['body']:
       return comment['id']
@@ -342,7 +342,7 @@ def _get_summary_table(token, run_id):
 
 
 def _get_artifact_id(token, run_id, name):
-  artifacts = github.list_artifacts(token, run_id)
+  artifacts = firebase_github.list_artifacts(token, run_id)
   for artifact in artifacts:
     if artifact["name"] == name:
       return artifact["id"]

scripts/gha/it_workflow.py

@@ -46,7 +46,7 @@
 from absl import flags
 from absl import logging
 
-import github
+import firebase_github
 import summarize_test_results
 
 FLAGS = flags.FLAGS
@@ -369,7 +369,7 @@ def main(argv):
 
     with progress.bar.Bar('Reading jobs...', max=3) as bar:
       workflow_id = _WORKFLOW_TESTS
-      all_runs = github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'schedule', _LIMIT)
+      all_runs = firebase_github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'schedule', _LIMIT)
       bar.next()
       source_tests = {}
       for run in reversed(all_runs):
@@ -387,7 +387,7 @@ def main(argv):
         #   firestore_tests[day] = run
 
       workflow_id = _WORKFLOW_PACKAGING
-      all_runs = github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'schedule', _LIMIT)
+      all_runs = firebase_github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'schedule', _LIMIT)
       bar.next()
       packaging_runs = {}
       packaging_run_ids = set()
@@ -404,7 +404,7 @@ def main(argv):
         packaging_run_ids.add(str(run['id']))
 
       workflow_id = _WORKFLOW_TESTS
-      all_runs = github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'workflow_dispatch', _LIMIT)
+      all_runs = firebase_github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'workflow_dispatch', _LIMIT)
       bar.next()
       package_tests_all = []
       for run in reversed(all_runs):
@@ -456,10 +456,10 @@ def main(argv):
           run = tests[day]
           run['log_success'] = True
           run['log_results'] = ''
-          artifacts = github.list_artifacts(FLAGS.token, run['id'])
+          artifacts = firebase_github.list_artifacts(FLAGS.token, run['id'])
           if 'log-artifact' in [a['name'] for a in artifacts]:
             artifact_id = [a['id'] for a in artifacts if a['name'] == 'log-artifact'][0]
-            artifact_contents = github.download_artifact(FLAGS.token, artifact_id)
+            artifact_contents = firebase_github.download_artifact(FLAGS.token, artifact_id)
             if artifact_contents:
               artifact_data = io.BytesIO(artifact_contents)
               artifact_zip = zipfile.ZipFile(artifact_data)

scripts/gha/report_build_status.py

@@ -32,30 +32,30 @@
 import subprocess
 import time
 import urllib.parse
-import github
+import firebase_github
 
 def main():
   args = parse_cmdline_args()
   if args.branch is None:
     args.branch=subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD']).decode('utf-8').rstrip('\n')
     print('autodetected branch: %s' % args.branch)
   if args.repo: # else use default firebase/firebase-cpp-sdk repo
-    if not github.set_repo_url(args.repo):
+    if not firebase_github.set_repo_url(args.repo):
       exit(2)
     else:
-      print('set repo url to: %s' % github.GITHUB_API_URL)
+      print('set repo url to: %s' % firebase_github.GITHUB_API_URL)
 
   json_params = {}
   for param in args.param:
     json_params[param[0]] = param[1]
   if args.verbose or args.dryrun:
-    print(f'request_url: {github.GITHUB_API_URL}/actions/workflows/{args.workflow}/dispatches')
+    print(f'request_url: {firebase_github.GITHUB_API_URL}/actions/workflows/{args.workflow}/dispatches')
     print(f'request_body: ref: {args.branch}, inputs: {json_params}')
   if args.dryrun:
     return(0)
 
   print('Sending request to GitHub API...')
-  if not github.create_workflow_dispatch(args.token, args.workflow, args.branch, json_params):
+  if not firebase_github.create_workflow_dispatch(args.token, args.workflow, args.branch, json_params):
     print('%sFailed to trigger workflow %s' % (
       '::error ::' if args.in_github_action else '', args.workflow))
     return(-1)
@@ -64,7 +64,7 @@ def main():
   time.sleep(args.sleep)  # Give a few seconds for the job to become queued.
   # Unfortunately, the GitHub REST API doesn't return the new workflow's run ID.
   # Query the list of workflows to find the one we just added.
-  workflows = github.list_workflows(args.token, args.workflow, args.branch)
+  workflows = firebase_github.list_workflows(args.token, args.workflow, args.branch)
   run_id = 0
   if "workflow_runs" in workflows:
     branch_sha = subprocess.check_output(['git', 'rev-parse', args.branch]).decode('utf-8').rstrip('\n')
@@ -82,7 +82,7 @@ def main():
   else:
     # Couldn't get a run ID, use a generic URL.
     workflow_url = '%s/actions/workflows/%s?query=%s+%s' % (
-      github.GITHUB_API_URL, args.workflow,
+      firebase_github.GITHUB_API_URL, args.workflow,
       urllib.parse.quote('event:workflow_dispatch', safe=''),
       urllib.parse.quote('branch:'+args.branch, safe=''))
   print('%sStarted workflow %s: %s' % ('::warning ::' if args.in_github_action else '',

scripts/gha/trigger_workflow.py

@@ -35,7 +35,7 @@
 from absl import flags
 from absl import logging
 
-import github
+import firebase_github
 
 FLAGS = flags.FLAGS
 
@@ -62,7 +62,7 @@
 
 def get_issue_number(token, title, label):
   """Get the GitHub isssue number for a given issue title and label"""
-  issues = github.search_issues_by_label(label)
+  issues = firebase_github.search_issues_by_label(label)
   for issue in issues:
     if issue["title"] == title:
       return issue["number"]
@@ -83,7 +83,7 @@ def main(argv):
                   FLAGS.issue_title)
   logging.info("Found issue number: %d", issue_number)
 
-  previous_comment = github.get_issue_body(FLAGS.token, issue_number)
+  previous_comment = firebase_github.get_issue_body(FLAGS.token, issue_number)
   if comment_start not in previous_comment:
     logging.fatal("Couldn't find start tag '%s' in previous comment", comment_start)
   if comment_end not in previous_comment:
@@ -98,7 +98,7 @@ def main(argv):
   new_text = sys.stdin.read()
   comment = prefix + comment_start + new_text + comment_end + suffix
 
-  github.update_issue_comment(FLAGS.token, issue_number, comment)
+  firebase_github.update_issue_comment(FLAGS.token, issue_number, comment)