Skip to content

Revert "Trigger workflow move github api cod to github.py" #766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Revert "Trigger workflow move github api cod to github.py" #766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/cpp-packaging.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -784,7 +784,6 @@ jobs:
- name: Use GitHub API to start workflow
shell: bash
run: |
pip install -r scripts/gha/requirements.txt
if [[ -z ${USE_EXPANDED_MATRIX} ]]; then
USE_EXPANDED_MATRIX=0
fi
Expand Down
69 changes: 19 additions & 50 deletions scripts/gha/github.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import requests
import json
import shutil
import re

from absl import logging
from requests.adapters import HTTPAdapter
Expand All @@ -36,24 +35,9 @@
REPO = 'firebase-cpp-sdk'

BASE_URL = 'https://api.github.com'
GITHUB_API_URL = '%s/repos/%s/%s' % (BASE_URL, OWNER, REPO)
FIREBASE_URL = '%s/repos/%s/%s' % (BASE_URL, OWNER, REPO)
logging.set_verbosity(logging.INFO)


def set_repo_url(repo):
match = re.match(r'https://github\.com/([^/]+)/([^/.]+)', repo)
if not match:
logging.info('Error, only pattern https://github.com/\{repo_owner\}/\{repo_name\} are allowed.')
return False

(repo_owner, repo_name) = match.groups()
global OWNER, REPO, GITHUB_API_URL
OWNER = repo_owner
REPO = repo_name
GITHUB_API_URL = '%s/repos/%s/%s' % (BASE_URL, OWNER, REPO)
return True


def requests_retry_session(retries=RETRIES,
backoff_factor=BACKOFF,
status_forcelist=RETRY_STATUS):
Expand All @@ -70,7 +54,7 @@ def requests_retry_session(retries=RETRIES,

def create_issue(token, title, label, body):
"""Create an issue: https://docs.github.com/en/rest/reference/issues#create-an-issue"""
url = f'{GITHUB_API_URL}/issues'
url = f'{FIREBASE_URL}/issues'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = {'title': title, 'labels': [label], 'body': body}
with requests.post(url, headers=headers, data=json.dumps(data), timeout=TIMEOUT) as response:
Expand All @@ -80,7 +64,7 @@ def create_issue(token, title, label, body):

def get_issue_body(token, issue_number):
"""https://docs.github.com/en/rest/reference/issues#get-an-issue-comment"""
url = f'{GITHUB_API_URL}/issues/{issue_number}'
url = f'{FIREBASE_URL}/issues/{issue_number}'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
with requests_retry_session().get(url, headers=headers, timeout=TIMEOUT) as response:
logging.info("get_issue_body: %s response: %s", url, response)
Expand All @@ -89,7 +73,7 @@ def get_issue_body(token, issue_number):

def update_issue(token, issue_number, data):
"""Update an issue: https://docs.github.com/en/rest/reference/issues#update-an-issue"""
url = f'{GITHUB_API_URL}/issues/{issue_number}'
url = f'{FIREBASE_URL}/issues/{issue_number}'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
with requests_retry_session().patch(url, headers=headers, data=json.dumps(data), timeout=TIMEOUT) as response:
logging.info("update_issue: %s response: %s", url, response)
Expand Down Expand Up @@ -118,7 +102,7 @@ def search_issues_by_label(label):

def list_comments(token, issue_number):
"""https://docs.github.com/en/rest/reference/issues#list-issue-comments"""
url = f'{GITHUB_API_URL}/issues/{issue_number}/comments'
url = f'{FIREBASE_URL}/issues/{issue_number}/comments'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
with requests_retry_session().get(url, headers=headers, timeout=TIMEOUT) as response:
logging.info("list_comments: %s response: %s", url, response)
Expand All @@ -127,7 +111,7 @@ def list_comments(token, issue_number):

def add_comment(token, issue_number, comment):
"""https://docs.github.com/en/rest/reference/issues#create-an-issue-comment"""
url = f'{GITHUB_API_URL}/issues/{issue_number}/comments'
url = f'{FIREBASE_URL}/issues/{issue_number}/comments'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = {'body': comment}
with requests.post(url, headers=headers, data=json.dumps(data), timeout=TIMEOUT) as response:
Expand All @@ -136,7 +120,7 @@ def add_comment(token, issue_number, comment):

def update_comment(token, comment_id, comment):
"""https://docs.github.com/en/rest/reference/issues#update-an-issue-comment"""
url = f'{GITHUB_API_URL}/issues/comments/{comment_id}'
url = f'{FIREBASE_URL}/issues/comments/{comment_id}'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = {'body': comment}
with requests_retry_session().patch(url, headers=headers, data=json.dumps(data), timeout=TIMEOUT) as response:
Expand All @@ -145,15 +129,15 @@ def update_comment(token, comment_id, comment):

def delete_comment(token, comment_id):
"""https://docs.github.com/en/rest/reference/issues#delete-an-issue-comment"""
url = f'{GITHUB_API_URL}/issues/comments/{comment_id}'
url = f'{FIREBASE_URL}/issues/comments/{comment_id}'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
with requests.delete(url, headers=headers, timeout=TIMEOUT) as response:
logging.info("delete_comment: %s response: %s", url, response)


def add_label(token, issue_number, label):
"""https://docs.github.com/en/rest/reference/issues#add-labels-to-an-issue"""
url = f'{GITHUB_API_URL}/issues/{issue_number}/labels'
url = f'{FIREBASE_URL}/issues/{issue_number}/labels'
headers={}
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = [label]
Expand All @@ -163,15 +147,15 @@ def add_label(token, issue_number, label):

def delete_label(token, issue_number, label):
"""https://docs.github.com/en/rest/reference/issues#delete-a-label"""
url = f'{GITHUB_API_URL}/issues/{issue_number}/labels/{label}'
url = f'{FIREBASE_URL}/issues/{issue_number}/labels/{label}'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
with requests.delete(url, headers=headers, timeout=TIMEOUT) as response:
logging.info("delete_label: %s response: %s", url, response)


def list_artifacts(token, run_id):
"""https://docs.github.com/en/rest/reference/actions#list-workflow-run-artifacts"""
url = f'{GITHUB_API_URL}/actions/runs/{run_id}/artifacts'
url = f'{FIREBASE_URL}/actions/runs/{run_id}/artifacts'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
with requests_retry_session().get(url, headers=headers, timeout=TIMEOUT) as response:
logging.info("list_artifacts: %s response: %s", url, response)
Expand All @@ -180,7 +164,7 @@ def list_artifacts(token, run_id):

def download_artifact(token, artifact_id, output_path):
"""https://docs.github.com/en/rest/reference/actions#download-an-artifact"""
url = f'{GITHUB_API_URL}/actions/artifacts/{artifact_id}/zip'
url = f'{FIREBASE_URL}/actions/artifacts/{artifact_id}/zip'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
with requests.get(url, headers=headers, stream=True, timeout=TIMEOUT) as response:
logging.info("download_artifact: %s response: %s", url, response)
Expand All @@ -190,18 +174,17 @@ def download_artifact(token, artifact_id, output_path):

def dismiss_review(token, pull_number, review_id, message):
"""https://docs.github.com/en/rest/reference/pulls#dismiss-a-review-for-a-pull-request"""
url = f'{GITHUB_API_URL}/pulls/{pull_number}/reviews/{review_id}/dismissals'
url = f'{FIREBASE_URL}/pulls/{pull_number}/reviews/{review_id}/dismissals'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = {'message': message}
with requests_retry_session().put(url, headers=headers, data=json.dumps(data),
stream=True, timeout=TIMEOUT) as response:
logging.info("dismiss_review: %s response: %s", url, response)
return response.json()


def get_reviews(token, pull_number):
"""https://docs.github.com/en/rest/reference/pulls#list-reviews-for-a-pull-request"""
url = f'{GITHUB_API_URL}/pulls/{pull_number}/reviews'
url = f'{FIREBASE_URL}/pulls/{pull_number}/reviews'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
page = 1
per_page = 100
Expand All @@ -220,32 +203,19 @@ def get_reviews(token, pull_number):
return results


def create_workflow_dispatch(token, workflow_id, ref, inputs):
def workflow_dispatch(token, workflow_id, ref, inputs):
"""https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event"""
url = f'{GITHUB_API_URL}/actions/workflows/{workflow_id}/dispatches'
url = f'{FIREBASE_URL}/actions/workflows/{workflow_id}/dispatches'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = {'ref': ref, 'inputs': inputs}
with requests.post(url, headers=headers, data=json.dumps(data),
stream=True, timeout=TIMEOUT) as response:
logging.info("create_workflow_dispatch: %s response: %s", url, response)
# Response Status: 204 No Content
return True if response.status_code == 204 else False


def list_workflows(token, workflow_id, branch):
"""https://docs.github.com/en/rest/reference/actions#list-workflow-runs-for-a-repository"""
url = f'{GITHUB_API_URL}/actions/workflows/{workflow_id}/runs'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = {'event': 'workflow_dispatch', 'branch': branch}
with requests.get(url, headers=headers, data=json.dumps(data),
stream=True, timeout=TIMEOUT) as response:
logging.info("list_workflows: %s response: %s", url, response)
return response.json()
logging.info("workflow_dispatch: %s response: %s", url, response)


def create_pull_request(token, head, base, title, body, maintainer_can_modify):
"""https://docs.github.com/en/rest/reference/pulls#create-a-pull-request"""
url = f'{GITHUB_API_URL}/pulls'
url = f'{FIREBASE_URL}/pulls'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
data = {'head': head, 'base': base, 'title': title, 'body': body,
'maintainer_can_modify': maintainer_can_modify}
Expand All @@ -254,10 +224,9 @@ def create_pull_request(token, head, base, title, body, maintainer_can_modify):
logging.info("create_pull_request: %s response: %s", head, response)
return True if response.status_code == 201 else False


def list_pull_requests(token, state, head, base):
"""https://docs.github.com/en/rest/reference/pulls#list-pull-requests"""
url = f'{GITHUB_API_URL}/pulls'
url = f'{FIREBASE_URL}/pulls'
headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': f'token {token}'}
page = 1
per_page = 100
Expand Down
59 changes: 43 additions & 16 deletions scripts/gha/trigger_workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,43 +29,70 @@
"""

import argparse
import json
import os
import re
import subprocess
import time
import urllib.parse
import github

def main():
args = parse_cmdline_args()
if args.repo is None:
args.repo=subprocess.check_output(['git', 'config', '--get', 'remote.origin.url']).decode('utf-8').rstrip('\n').lower()
print('autodetected repo: %s' % args.repo)
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):
args.branch=subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD']).decode('utf-8').rstrip('\n')
print('autodetected branch: %s' % args.branch)
if not args.repo.startswith('https://github.com/'):
print('Error, only https://github.com/ repositories are allowed.')
exit(2)
else:
print('set repo url to: %s' % github.GITHUB_API_URL)
(repo_owner, repo_name) = re.match(r'https://github\.com/([^/]+)/([^/.]+)', args.repo).groups()

# POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
request_url = 'https://api.github.com/repos/%s/%s/actions/workflows/%s/dispatches' % (repo_owner, repo_name, args.workflow)
json_params = {}
for param in args.param:
json_params[param[0]] = param[1]
json_params[param[0]] = param[1]
json_text = '{"ref":%s,"inputs":%s}' % (json.dumps(args.branch), json.dumps(json_params))
if args.verbose or args.dryrun:
print(f'request_url: {github.GITHUB_API_URL}/actions/workflows/{args.workflow}/dispatches')
print(f'request_body: ref: {args.branch}, inputs: {json_params}')
print('request_url: %s' % request_url)
print('request_body: %s' % json_text)
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):
print('%sFailed to trigger workflow %s' % (
'::error ::' if args.in_github_action else '', args.workflow))
run_output = subprocess.check_output([args.curl,
'-s', '-o', '-', '-w', '\nHTTP status %{http_code}\n',
'-X', 'POST',
'-H', 'Accept: application/vnd.github.v3+json',
'-H', 'Authorization: token %s' % args.token,
request_url, '-d', json_text]
+ ([] if not args.verbose else ['-v'])).decode('utf-8').rstrip('\n')
if args.verbose:
print(run_output)
if not re.search('HTTP status 2[0-9][0-9]$', run_output):
if not args.verbose:
print(run_output)
# Super quick and dirty way to get the message text since the appended status code means that
# the contents are not valid JSON.
error_message = re.search(r'"message": "([^"]+)"', run_output).group(1)
print('%sFailed to trigger workflow %s: %s' % (
'::error ::' if args.in_github_action else '', args.workflow, error_message))
return(-1)

print('Success!')
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)
request_url = 'https://api.github.com/repos/%s/%s/actions/workflows/%s/runs?event=workflow_dispatch&branch=%s' % (repo_owner, repo_name, args.workflow, args.branch)
run_output = subprocess.check_output([args.curl,
'-s', '-X', 'GET',
'-H', 'Accept: application/vnd.github.v3+json',
'-H', 'Authorization: token %s' % args.token,
request_url]).decode('utf-8').rstrip('\n')
run_id = 0
workflows = json.loads(run_output)
if "workflow_runs" in workflows:
branch_sha = subprocess.check_output(['git', 'rev-parse', args.branch]).decode('utf-8').rstrip('\n')
for workflow in workflows['workflow_runs']:
Expand All @@ -81,8 +108,8 @@ def main():
workflow_url = 'https://github.com/firebase/firebase-cpp-sdk/actions/runs/%s' % (run_id)
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,
workflow_url = 'https://github.com/%s/%s/actions/workflows/%s?query=%s+%s' % (
repo_owner, repo_name, 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 '',
Expand Down