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

Enhance Github workflows module #1683

Merged
merged 1 commit into from
Aug 20, 2024
Merged

Enhance Github workflows module #1683

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
74 changes: 72 additions & 2 deletions bbot/modules/github_workflows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ class github_workflows(github):
produced_events = ["FILESYSTEM"]
flags = ["passive", "safe", "code-enum"]
meta = {
"description": "Download a github repositories workflow logs",
"description": "Download a github repositories workflow logs and workflow artifacts",
"created_date": "2024-04-29",
"author": "@domwhewell-sage",
}
Expand Down Expand Up @@ -46,9 +46,9 @@ async def handle_event(self, event):
self.log.debug(f"Looking up runs for {workflow_name} in {owner}/{repo}")
for run in await self.get_workflow_runs(owner, repo, workflow_id):
run_id = run.get("id")
workflow_url = f"https://github.com/{owner}/{repo}/actions/runs/{run_id}"
self.log.debug(f"Downloading logs for {workflow_name}/{run_id} in {owner}/{repo}")
for log in await self.download_run_logs(owner, repo, run_id):
workflow_url = f"https://github.com/{owner}/{repo}/actions/runs/{run_id}"
logfile_event = self.make_event(
{
"path": str(log),
Expand All @@ -62,6 +62,28 @@ async def handle_event(self, event):
logfile_event,
context=f"{{module}} downloaded workflow run logs from {workflow_url} to {{event.type}}: {log}",
)
artifacts = await self.get_run_artifacts(owner, repo, run_id)
if artifacts:
for artifact in artifacts:
artifact_id = artifact.get("id")
artifact_name = artifact.get("name")
expired = artifact.get("expired")
if not expired:
filepath = await self.download_run_artifacts(owner, repo, artifact_id, artifact_name)
if filepath:
artifact_event = self.make_event(
{
"path": str(filepath),
"description": f"Workflow run artifact from {workflow_url}",
},
"FILESYSTEM",
tags=["zipfile"],
parent=event,
)
await self.emit_event(
artifact_event,
context=f"{{module}} downloaded workflow run artifact from {workflow_url} to {{event.type}}: {filepath}",
)

async def get_workflows(self, owner, repo):
workflows = []
Expand Down Expand Up @@ -150,3 +172,51 @@ async def download_run_logs(self, owner, repo, run_id):
return main_logs
else:
return []

async def get_run_artifacts(self, owner, repo, run_id):
artifacts = []
url = f"{self.base_url}/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"
r = await self.helpers.request(url, headers=self.headers)
if r is None:
return artifacts
status_code = getattr(r, "status_code", 0)
if status_code == 403:
self.warning("Github is rate-limiting us (HTTP status: 403)")
return artifacts
if status_code != 200:
return artifacts
try:
j = r.json().get("artifacts", [])
except Exception as e:
self.warning(f"Failed to decode JSON for {r.url} (HTTP status: {status_code}): {e}")
return artifacts
if not j:
return artifacts
for item in j:
artifacts.append(item)
return artifacts

async def download_run_artifacts(self, owner, repo, artifact_id, artifact_name):
folder = self.output_dir / owner / repo
self.helpers.mkdir(folder)
file_destination = folder / artifact_name
try:
await self.helpers.download(
f"{self.base_url}/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/zip",
filename=file_destination,
headers=self.headers,
raise_error=True,
warn=False,
)
self.info(
f"Downloaded workflow artifact {owner}/{repo}/{artifact_id}/{artifact_name} to {file_destination}"
)
except Exception as e:
file_destination = None
response = getattr(e, "response", None)
status_code = getattr(response, "status_code", 0)
if status_code == 403:
self.warning(
f"The current access key does not have access to workflow artifacts {owner}/{repo}/{artifact_id} (status: {status_code})"
)
return file_destination
42 changes: 40 additions & 2 deletions bbot/test/test_step_2/module_tests/test_module_github_workflows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,9 +437,47 @@ async def setup_before_prep(self, module_test):
url="https://productionresultssa10.blob.core.windows.net/actions-results/7beb304e-f42c-4830-a027-4f5dec53107d/workflow-job-run-3a559e2a-952e-58d2-b8db-2e604a9266d7/logs/steps/step-logs-0e34a19a-18b0-4208-b27a-f8c031db2d17.txt?rsct=text%2Fplain&se=2024-04-26T16%3A25%3A39Z&sig=a%2FiN8dOw0e3tiBQZAfr80veI8OYChb9edJ1eFY136B4%3D&sp=r&spr=https&sr=b&st=2024-04-26T16%3A15%3A34Z&sv=2021-12-02",
content=self.zip_content,
)
module_test.httpx_mock.add_response(
url="https://api.github.com/repos/blacklanternsecurity/bbot/actions/runs/8839360698/artifacts",
json={
"total_count": 1,
"artifacts": [
{
"id": 1829832535,
"node_id": "MDg6QXJ0aWZhY3QxODI5ODMyNTM1",
"name": "build.tar.gz",
"size_in_bytes": 245770648,
"url": "https://api.github.com/repos/blacklanternsecurity/bbot/actions/artifacts/1829832535",
"archive_download_url": "https://api.github.com/repos/blacklanternsecurity/bbot/actions/artifacts/1829832535/zip",
"expired": False,
"created_at": "2024-08-19T22:32:17Z",
"updated_at": "2024-08-19T22:32:18Z",
"expires_at": "2024-09-02T22:21:59Z",
"workflow_run": {
"id": 10461468466,
"repository_id": 89290483,
"head_repository_id": 799444840,
"head_branch": "not-a-real-branch",
"head_sha": "1eeb5354ab7b1e4141b8a6473846e2a5ea0dd2c6",
},
}
],
},
)
module_test.httpx_mock.add_response(
url="https://api.github.com/repos/blacklanternsecurity/bbot/actions/artifacts/1829832535/zip",
headers={
"location": "https://pipelinesghubeus22.actions.githubusercontent.com/uYHz4cw2WwYcB2EU57uoCs3MaEDiz8veiVlAtReP3xevBriD1h/_apis/pipelines/1/runs/214601/signedartifactscontent?artifactName=build.tar.gz&urlExpires=2024-08-20T14%3A41%3A41.8000556Z&urlSigningMethod=HMACV2&urlSignature=OOBxLx4eE5A8uHjxOIvQtn3cLFQOBW927mg0hcTHO6U%3D"
},
status_code=302,
)
module_test.httpx_mock.add_response(
url="https://pipelinesghubeus22.actions.githubusercontent.com/uYHz4cw2WwYcB2EU57uoCs3MaEDiz8veiVlAtReP3xevBriD1h/_apis/pipelines/1/runs/214601/signedartifactscontent?artifactName=build.tar.gz&urlExpires=2024-08-20T14%3A41%3A41.8000556Z&urlSigningMethod=HMACV2&urlSignature=OOBxLx4eE5A8uHjxOIvQtn3cLFQOBW927mg0hcTHO6U%3D",
content=self.zip_content,
)

def check(self, module_test, events):
assert len(events) == 7
assert len(events) == 8
assert 1 == len(
[
e
Expand Down Expand Up @@ -473,7 +511,7 @@ def check(self, module_test, events):
]
), "Failed to find blacklanternsecurity github repo"
filesystem_events = [e for e in events if e.type == "FILESYSTEM"]
assert 2 == len(filesystem_events), filesystem_events
assert 3 == len(filesystem_events), filesystem_events
for filesystem_event in filesystem_events:
file = Path(filesystem_event.data["path"])
assert file.is_file(), "Destination file does not exist"
Loading