-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added bitbucket merge requests collector
- Loading branch information
1 parent
b7dbe63
commit 1e4e878
Showing
5 changed files
with
131 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
components/collector/src/source_collectors/bitbucket/merge_requests.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| """Bitbucket merge requests collector.""" | ||
|
|
||
| from typing import cast | ||
|
|
||
| from collector_utilities.functions import match_string_or_regular_expression | ||
| from collector_utilities.type import URL, Value | ||
| from model import Entities, Entity, SourceResponses | ||
|
|
||
| from .base import BitbucketProjectBase | ||
|
|
||
| class BitbucketMergeRequests(BitbucketProjectBase): | ||
| """Collector for pull requests in Bitbucket.""" | ||
|
|
||
| PAGE_SIZE = 100 # Page size for Bitbucket pagination | ||
|
|
||
| async def _api_url(self) -> URL: | ||
| """Override to return the pull requests API.""" | ||
| return await self._bitbucket_api_url("pull-requests") | ||
|
|
||
| async def _landing_url(self, responses: SourceResponses) -> URL: | ||
| """Extend to add the project pull requests.""" | ||
| project = f"projects/{self._parameter('owner')}/repos/{self._parameter('repository')}" | ||
| return URL(f"{await super()._landing_url(responses)}/{project}/pull-requests") | ||
|
|
||
| async def _get_source_responses(self, *urls: URL) -> SourceResponses: | ||
| """Extend to use Bitbucket pagination, if necessary.""" | ||
| nr_merge_requests_to_skip = 0 | ||
| responses = await super()._get_source_responses(*urls) | ||
| while len((await responses[-1].json())["values"]) == self.PAGE_SIZE: | ||
| nr_merge_requests_to_skip += self.PAGE_SIZE | ||
| responses.extend(await super()._get_source_responses(URL(f"{urls[0]}&start={nr_merge_requests_to_skip}"))) | ||
| return responses | ||
|
|
||
| async def _parse_entities(self, responses: SourceResponses) -> Entities: | ||
| """Override to parse the pull requests from the responses.""" | ||
| merge_requests = [] | ||
| for response in responses: | ||
| merge_requests.extend((await response.json())["values"]) | ||
| landing_url = (await self._landing_url(responses)) | ||
| return Entities([self._create_entity(mr, landing_url) for mr in merge_requests]) | ||
|
|
||
| async def _parse_total(self, responses: SourceResponses) -> Value: | ||
| """Override to parse the total number of merge requests from the responses.""" | ||
| merge_requests = [len((await response.json())["values"]) for response in responses] | ||
| return str(sum(merge_requests)) | ||
|
|
||
| def _create_entity(self, merge_request, landing_url: str) -> Entity: | ||
| """Create an entity from a Bitbucket JSON result.""" | ||
| return Entity( | ||
| key=merge_request["id"], | ||
| title=merge_request["title"], | ||
| target_branch=merge_request["toRef"], | ||
| url=f"{landing_url}/{merge_request['id']}", | ||
| state=merge_request["state"], | ||
| created=merge_request.get("createdDate"), | ||
| closed=merge_request.get("closedDate"), | ||
| downvotes=str(self._downvotes(merge_request)), | ||
| upvotes=str(self._upvotes(merge_request)), | ||
| ) | ||
|
|
||
| def _include_entity(self, entity: Entity) -> bool: | ||
| """Return whether the merge request should be counted.""" | ||
| request_matches_state = entity["state"] in self._parameter("merge_request_state") | ||
| branches = self._parameter("target_branches_to_include") | ||
| target_branch = entity["target_branch"] | ||
| request_matches_branches = match_string_or_regular_expression(target_branch, branches) if branches else True | ||
| # If the required number of upvotes is zero, merge requests are included regardless of how many upvotes they | ||
| # actually have. If the required number of upvotes is more than zero then only merge requests that have fewer | ||
| # than the minimum number of upvotes are included in the count: | ||
| required_upvotes = int(cast(str, self._parameter("upvotes"))) | ||
| request_has_fewer_than_min_upvotes = required_upvotes == 0 or int(entity["upvotes"]) < required_upvotes | ||
| return request_matches_state and request_matches_branches and request_has_fewer_than_min_upvotes | ||
|
|
||
| @staticmethod | ||
| def _downvotes(merge_request) -> int: | ||
| """Return the number of downvotes the merge request has.""" | ||
| return len([r for r in merge_request.get("reviewers", []) if not r.get("approved", True)]) | ||
|
|
||
| @staticmethod | ||
| def _upvotes(merge_request) -> int: | ||
| """Return the number of upvotes the merge request has.""" | ||
| return len([r for r in merge_request.get("reviewers", []) if r.get("vote", True)]) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters