Skip to content

Commit

Permalink
Add: Add most important parts of the GitHub code scanning API
Browse files Browse the repository at this point in the history
Implement getting and updating code scanning alerts.
  • Loading branch information
bjoernricks committed Oct 11, 2023
1 parent 4124aab commit 3ebc073
Show file tree
Hide file tree
Showing 3 changed files with 1,151 additions and 8 deletions.
26 changes: 18 additions & 8 deletions pontos/github/api/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,16 @@

from contextlib import AbstractAsyncContextManager
from types import TracebackType
from typing import Any, AsyncContextManager, AsyncIterator, Dict, Optional, Type
from typing import (
Any,
AsyncContextManager,
AsyncIterator,
Dict,
Mapping,
Optional,
Type,
Union,
)

import httpx

Expand All @@ -31,8 +40,9 @@
)
from pontos.github.models.base import GitHubModel

Headers = Dict[str, str]
Params = Dict[str, str]
Headers = Mapping[str, str]
ParamValue = Union[str, None]
Params = Mapping[str, ParamValue]

# supported GitHub API version
# https://docs.github.com/en/rest/overview/api-versions
Expand Down Expand Up @@ -303,12 +313,12 @@ async def _get_paged_items(
Internal method to get the paged items information from different REST
URLs.
"""
if not params:
params = {}

params["per_page"] = "100" # max number
request_params: dict[str, ParamValue] = {}
if params:
request_params.update(params)
request_params["per_page"] = "100" # max number

async for response in self._client.get_all(api, params=params):
async for response in self._client.get_all(api, params=request_params):
response.raise_for_status()
data: JSON_OBJECT = response.json()
for item in data.get(name, []): # type: ignore
Expand Down
309 changes: 309 additions & 0 deletions pontos/github/api/code_scanning.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,309 @@
# SPDX-FileCopyrightText: 2023 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later

from typing import AsyncIterator, Optional, Union

from pontos.github.api.client import GitHubAsyncREST
from pontos.github.models.base import SortOrder
from pontos.github.models.code_scanning import (
AlertSort,
AlertState,
CodeScanningAlert,
DismissedReason,
Instance,
Severity,
)
from pontos.helper import enum_or_value


class GitHubAsyncRESTCodeScanning(GitHubAsyncREST):
async def _alerts(
self,
api: str,
*,
tool_name: Optional[str] = None,
tool_guid: Optional[str] = "",
severity: Union[Severity, str, None] = None,
state: Union[AlertState, str, None] = None,
sort: Union[AlertSort, str] = AlertSort.CREATED,
direction: Union[str, SortOrder] = SortOrder.DESC,
) -> AsyncIterator[CodeScanningAlert]:
params: dict[str, Union[str, None]] = {"per_page": "100"}

if tool_name:
params["tool_name"] = tool_name
if tool_guid or tool_guid is None:
params["tool_guid"] = tool_guid
if severity:
params["severity"] = enum_or_value(severity)
if state:
params["state"] = enum_or_value(state)
if sort:
params["sort"] = enum_or_value(sort)
if direction:
params["direction"] = enum_or_value(direction)

async for response in self._client.get_all(api, params=params):
for alert in response.json():
yield CodeScanningAlert.from_dict(alert)

async def organization_alerts(
self,
organization: str,
*,
tool_name: Optional[str] = None,
tool_guid: Optional[str] = "",
severity: Union[Severity, str, None] = None,
state: Union[AlertState, str, None] = None,
sort: Union[AlertSort, str] = AlertSort.CREATED,
direction: Union[str, SortOrder] = SortOrder.DESC,
) -> AsyncIterator[CodeScanningAlert]:
"""
Get the list of code scanning alerts for all repositories of a GitHub
organization
https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
Args:
organization: Name of the organization
tool_name: The name of a code scanning tool. Only results by this
tool will be listed. You can specify the tool by using either
tool_name or tool_guid, but not both.
tool_guid: The GUID of a code scanning tool. Only results by this
tool will be listed. Note that some code scanning tools may not
include a GUID in their analysis data. You can specify the tool
by using either tool_guid or tool_name, but not both
severity: If specified, only code scanning alerts with this severity
will be returned
state: Filter alerts by state
resolutions
sort: The property by which to sort the results. Default is to sort
alerts by creation date.
direction: The direction to sort the results by. Default is desc.
Raises:
HTTPStatusError: A httpx.HTTPStatusError is raised if the request
failed.
Returns:
An async iterator yielding the code scanning alerts
Example:
.. code-block:: python
from pontos.github.api import GitHubAsyncRESTApi
async with GitHubAsyncRESTApi(token) as api:
async for alert in api.code_scanning.organization_alerts(
"my-org"
):
print(alert)
"""

api = f"/orgs/{organization}/code-scanning/alerts"
async for alert in self._alerts(
api,
state=state,
severity=severity,
tool_guid=tool_guid,
tool_name=tool_name,
sort=sort,
direction=direction,
):
yield alert

async def alerts(
self,
repo: str,
*,
tool_name: Optional[str] = None,
tool_guid: Optional[str] = "",
severity: Union[Severity, str, None] = None,
state: Union[AlertState, str, None] = None,
sort: Union[AlertSort, str] = AlertSort.CREATED,
direction: Union[str, SortOrder] = SortOrder.DESC,
) -> AsyncIterator[CodeScanningAlert]:
"""
Get the list of code scanning alerts for a repository
https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
Args:
repo: GitHub repository (owner/name)
Raises:
HTTPStatusError: A httpx.HTTPStatusError is raised if the request
failed.
Returns:
An async iterator yielding the code scanning alerts
Example:
.. code-block:: python
from pontos.github.api import GitHubAsyncRESTApi
async with GitHubAsyncRESTApi(token) as api:
async for alert in api.code_scanning.alerts(
"org/repo"
):
print(alert)
"""

api = f"/repos/{repo}/code-scanning/alerts"
async for alert in self._alerts(
api,
state=state,
severity=severity,
tool_guid=tool_guid,
tool_name=tool_name,
sort=sort,
direction=direction,
):
yield alert

async def alert(
self,
repo: str,
alert_number: Union[str, int],
) -> CodeScanningAlert:
"""
Get a single code scanning alert
https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-alert
Args:
repo: GitHub repository (owner/name)
alert_number: The number that identifies a code scanning alert in
its repository
Raises:
HTTPStatusError: A httpx.HTTPStatusError is raised if the request
failed.
Returns:
Code scanning alert information
Example:
.. code-block:: python
from pontos.github.api import GitHubAsyncRESTApi
async with GitHubAsyncRESTApi(token) as api:
alert = await api.code_scanning.alert("foo/bar", 123)
"""
api = f"/repos/{repo}/code-scanning/alerts/{alert_number}"
response = await self._client.get(api)
response.raise_for_status()
return CodeScanningAlert.from_dict(response.json())

async def update_alert(
self,
repo: str,
alert_number: Union[str, int],
state: Union[AlertState, str],
*,
dismissed_reason: Union[DismissedReason, str, None] = None,
dismissed_comment: Optional[str] = None,
) -> CodeScanningAlert:
"""
Update a single code scanning alert
https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-alert
Args:
repo: GitHub repository (owner/name)
alert_number: The number that identifies a code scanning alert in
its repository
state: The state of the alert
dismissed_reason: The reason for dismissing or closing the alert
dismissed_comment: The dismissal comment associated with the
dismissal of the alert.
Raises:
HTTPStatusError: A httpx.HTTPStatusError is raised if the request
failed.
Returns:
Code scanning alert information
Example:
.. code-block:: python
from pontos.github.api import GitHubAsyncRESTApi
from pontos.github.models.code_scanning import (
AlertState,
DismissedReason,
)
async with GitHubAsyncRESTApi(token) as api:
alert = await api.code_scanning.update_alert(
"foo/bar",
123,
AlertState.DISMISSED,
dismissed_reason=DismissedReason.WONT_FIX,
dismissed_comment="Not applicable",
)
"""
api = f"/repos/{repo}/code-scanning/alerts/{alert_number}"

data = {"state": enum_or_value(state)}
if dismissed_reason:
data["dismissed_reason"] = enum_or_value(dismissed_reason)
if dismissed_comment:
data["dismissed_comment"] = dismissed_comment

response = await self._client.patch(api, data=data)
response.raise_for_status()
return CodeScanningAlert.from_dict(response.json())

async def instances(
self,
repo: str,
alert_number: Union[str, int],
*,
ref: Optional[str] = None,
) -> AsyncIterator[Instance]:
"""
Lists all instances of the specified code scanning alert
https://docs.github.com/en/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
Args:
repo: GitHub repository (owner/name)
alert_number: The number that identifies a code scanning alert in
its repository
ref: The Git reference for the results you want to list. The ref
for a branch can be formatted either as refs/heads/<branch name>
or simply <branch name>. To reference a pull request use
refs/pull/<number>/merge.
Raises:
HTTPStatusError: A httpx.HTTPStatusError is raised if the request
failed.
Returns:
An async iterator yielding the code scanning alert instances
Example:
.. code-block:: python
from pontos.github.api import GitHubAsyncRESTApi
async with GitHubAsyncRESTApi(token) as api:
async for instance in api.code_scanning.instances(
"org/repo", 1
):
print(instance)
"""

api = f"/repos/{repo}/code-scanning/alerts/{alert_number}/instances"
params = {"per_page": "100"}

if ref:
params["ref"] = ref

async for response in self._client.get_all(api, params=params):
for alert in response.json():
yield Instance.from_dict(alert)
Loading

0 comments on commit 3ebc073

Please sign in to comment.