Skip to content
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

Jump to bottom

Gracefully Handle Missing Permissions #11

Merged
merged 4 commits into from
Aug 28, 2020
Merged

Gracefully Handle Missing Permissions #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0327989
Add status badge for the lineage_scan action
mcdonnnj Aug 27, 2020
5b3126b
Update so a lack of push permissions is not fatal to an Action job
mcdonnnj Aug 27, 2020
4eb817f
Replace ERROR with WARNING based on feedback
mcdonnnj Aug 27, 2020
207c23c
Adjusted two more logging statements based on feedback
mcdonnnj Aug 27, 2020
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: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# action-lineage #

[![GitHub Build Status](https://github.com/cisagov/action-lineage/workflows/build/badge.svg)](https://github.com/cisagov/action-lineage/actions)
[![Lineage Scan Status](https://github.com/cisagov/action-lineage/workflows/lineage_scan/badge.svg)](https://github.com/cisagov/action-lineage/actions?query=workflow%3Alineage_scan)
[![Coverage Status](https://coveralls.io/repos/github/cisagov/action-lineage/badge.svg?branch=develop)](https://coveralls.io/github/cisagov/action-lineage?branch=develop)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/cisagov/action-lineage.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/cisagov/action-lineage/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/cisagov/action-lineage.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/cisagov/action-lineage/context:python)
Expand Down
98 changes: 57 additions & 41 deletions src/lineage/entrypoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def run(
logging.info(f"✅ (error ok) return code: {proc.returncode}")
elif on_error == OnError.WARN:
logging.warning(proc.stdout.decode())
logging.warning(f"⚠️ ERROR! return code: {proc.returncode}")
logging.warning(f"⚠️ WARNING! return code: {proc.returncode}")
else: # OnError.FAIL
logging.fatal(proc.stdout.decode())
logging.fatal(f"❌ ERROR! return code: {proc.returncode}")
Expand Down Expand Up @@ -180,14 +180,25 @@ def merge(repo: Repository.Repository, github_actor: str) -> Tuple[bool, List[st
return True, conflict_file_list


def push(repo: Repository.Repository, branch_name: str, username: str, password: str):
def push(
repo: Repository.Repository, branch_name: str, username: str, password: str
) -> bool:
"""Push changes to remote."""
parts: ParseResult = urlparse(repo.clone_url)
cred_url = parts._replace(netloc=f"{username}:{password}@{parts.netloc}").geturl()
logging.info("Assigning credentials for push.")
run([GIT, "remote", "set-url", "origin", cred_url], cwd=repo.full_name)
logging.info(f"Pushing {branch_name} to remote.")
run([GIT, "push", "--set-upstream", "origin", branch_name], cwd=repo.full_name)
if not repo.permissions.push:
logging.warning(
f"⚠️ WARNING! Missing 'push' permission on '{repo.owner.login}/{repo.name}'"
)
return False
else:
parts: ParseResult = urlparse(repo.clone_url)
cred_url = parts._replace(
netloc=f"{username}:{password}@{parts.netloc}"
).geturl()
logging.info("Assigning credentials for push.")
run([GIT, "remote", "set-url", "origin", cred_url], cwd=repo.full_name)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some point we should replace these git commands with GitPython.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #12, which I just created.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@felddy Do you remember why you didn't leverage that when you first wrote this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably didn't know about it yet. Not a technical reason.

logging.info(f"Pushing {branch_name} to remote.")
run([GIT, "push", "--set-upstream", "origin", branch_name], cwd=repo.full_name)
return True


def create_pull_request(
Expand Down Expand Up @@ -333,42 +344,47 @@ def main() -> int:
f"Already up to date with: {remote_url} {remote_branch or ''} "
)
continue
push(repo, pr_branch_name, "git", access_token)
# Display instructions for ignoring incoming Lineage config changes
display_lineage_config_skip: bool = CONFIG_FILENAME in conflict_file_list
if display_lineage_config_skip:
# This will no longer be a conflict, we tell user how to ignore.
conflict_file_list.remove(CONFIG_FILENAME)
if branch_is_new:
logging.info("Creating a new pull request since branch is new.")
template_data = {
"conflict_file_list": conflict_file_list,
"display_lineage_config_skip": display_lineage_config_skip,
"lineage_config_filename": CONFIG_FILENAME,
"lineage_id": lineage_id,
"local_branch": local_branch,
"metadata": PR_METADATA,
"pr_branch_name": pr_branch_name,
"remote_branch": remote_branch,
"remote_url": remote_url,
"repo_name": repo.name,
"ssh_url": repo.ssh_url,
}
if conflict_file_list:
title = f"⚠️ CONFLICT! Lineage pull request for: {lineage_id}"
body = pystache.render(conflict_template, template_data)
create_pull_request(
repo, pr_branch_name, local_branch, title, body, draft=True
)
# If we can successfully push, continue with generating a PR
if push(repo, pr_branch_name, "git", access_token):
# Display instructions for ignoring incoming Lineage config changes
display_lineage_config_skip: bool = CONFIG_FILENAME in conflict_file_list
if display_lineage_config_skip:
# This will no longer be a conflict, we tell user how to ignore.
conflict_file_list.remove(CONFIG_FILENAME)
if branch_is_new:
logging.info("Creating a new pull request since branch is new.")
template_data = {
"conflict_file_list": conflict_file_list,
"display_lineage_config_skip": display_lineage_config_skip,
"lineage_config_filename": CONFIG_FILENAME,
"lineage_id": lineage_id,
"local_branch": local_branch,
"metadata": PR_METADATA,
"pr_branch_name": pr_branch_name,
"remote_branch": remote_branch,
"remote_url": remote_url,
"repo_name": repo.name,
"ssh_url": repo.ssh_url,
}
if conflict_file_list:
title = f"⚠️ CONFLICT! Lineage pull request for: {lineage_id}"
body = pystache.render(conflict_template, template_data)
create_pull_request(
repo, pr_branch_name, local_branch, title, body, draft=True
)
else:
title = f"Lineage pull request for: {lineage_id}"
body = pystache.render(clean_template, template_data)
create_pull_request(
repo, pr_branch_name, local_branch, title, body, draft=False
)
else:
title = f"Lineage pull request for: {lineage_id}"
body = pystache.render(clean_template, template_data)
create_pull_request(
repo, pr_branch_name, local_branch, title, body, draft=False
logging.warning(
"Not creating a new pull request because the branch already exists."
)
else:
logging.info(
"Not creating a new pull request since the branch already existed."
logging.warning(
"Not creating a new pull request because of insufficient permissions."
)

logging.info("Completed.")
Expand Down