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

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

Author: cynthiajoan

scripts/gha/create_pull_request.py

@@ -25,17 +25,12 @@
   Creates the pull request, and outputs the new PR number to stdout.
 """
 
-import datetime
-import shutil
-
 from absl import app
 from absl import flags
-from absl import logging
 
-import github
+import firebase_github
 
 FLAGS = flags.FLAGS
-_DEFAULT_MESSAGE = "Creating pull request."
 
 flags.DEFINE_string(
     "token", None,
@@ -60,9 +55,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/github.py scripts/gha/firebase_github.pyscripts/gha/github.py renamed to scripts/gha/firebase_github.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""A utility for GitHub REST API.
+"""A utility for GitHub REST API for firebase repos.
 
 This script handles GitHub Issue, Pull Request, Comment, Label and Artifact
 

scripts/gha/it_workflow.py

@@ -41,13 +41,11 @@
 
 import datetime
 import pytz
-import shutil
 
 from absl import app
 from absl import flags
-from absl import logging
 
-import github
+import firebase_github
 import summarize_test_results as summarize
 
 _REPORT_LABEL = "nightly-testing"
@@ -112,9 +110,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) +
@@ -136,7 +134,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 +
@@ -151,7 +149,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_SUFFIX)
@@ -160,18 +158,18 @@ 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_SUFFIX)
     _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):
@@ -194,32 +192,32 @@ def test_report(token, actor, commit, run_id):
     comment = title + _get_description(actor, commit, run_id) + log_summary
 
   if title == _COMMENT_TITLE_SUCCEED:
-    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"]
 
-  return github.create_issue(token, title, label, _COMMENT_SUFFIX)["number"]
+  return firebase_github.create_issue(token, title, label, _COMMENT_SUFFIX)["number"]
 
 
 def _update_comment(token, issue_number, comment):
   comment_id = _get_comment_id(token, issue_number, _COMMENT_SUFFIX)
   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']
@@ -245,7 +243,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/trigger_workflow.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-unity-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:
     for workflow in workflows['workflow_runs']:
@@ -80,7 +80,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 '',