2ee250e238
* #11248 Source Gitlab: fetch groups along with subgroups * #11248 source gitlab: upd changelog * #11248 source gitlab: fix build * #11248 source gitlab: fix build * auto-bump connector version Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
133 lines
6.0 KiB
Python
133 lines
6.0 KiB
Python
#
|
|
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
|
|
#
|
|
|
|
|
|
from typing import Any, List, Mapping, MutableMapping, Optional, Tuple, Union
|
|
|
|
from airbyte_cdk.models import SyncMode
|
|
from airbyte_cdk.sources import AbstractSource
|
|
from airbyte_cdk.sources.streams import Stream
|
|
from airbyte_cdk.sources.streams.http.auth import TokenAuthenticator
|
|
|
|
from .streams import (
|
|
Branches,
|
|
Commits,
|
|
EpicIssues,
|
|
Epics,
|
|
GitlabStream,
|
|
GroupIssueBoards,
|
|
GroupLabels,
|
|
GroupMembers,
|
|
GroupMilestones,
|
|
GroupProjects,
|
|
Groups,
|
|
GroupsList,
|
|
IncludeDescendantGroups,
|
|
Issues,
|
|
Jobs,
|
|
MergeRequestCommits,
|
|
MergeRequests,
|
|
Pipelines,
|
|
PipelinesExtended,
|
|
ProjectLabels,
|
|
ProjectMembers,
|
|
ProjectMilestones,
|
|
Projects,
|
|
Releases,
|
|
Tags,
|
|
Users,
|
|
)
|
|
|
|
|
|
class SourceGitlab(AbstractSource):
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.__auth_params: Mapping[str, Any] = {}
|
|
self.__groups_stream: Optional[GitlabStream] = None
|
|
self.__projects_stream: Optional[GitlabStream] = None
|
|
|
|
def _groups_stream(self, config: MutableMapping[str, Any]) -> Groups:
|
|
if not self.__groups_stream:
|
|
auth_params = self._auth_params(config)
|
|
group_ids = list(map(lambda x: x["id"], self._get_group_list(config)))
|
|
self.__groups_stream = Groups(group_ids=group_ids, **auth_params)
|
|
return self.__groups_stream
|
|
|
|
def _projects_stream(self, config: MutableMapping[str, Any]) -> Union[Projects, GroupProjects]:
|
|
if not self.__projects_stream:
|
|
auth_params = self._auth_params(config)
|
|
project_ids = list(filter(None, config.get("projects", "").split(" ")))
|
|
groups_stream = self._groups_stream(config)
|
|
if groups_stream.group_ids:
|
|
self.__projects_stream = GroupProjects(project_ids=project_ids, parent_stream=groups_stream, **auth_params)
|
|
return self.__projects_stream
|
|
self.__projects_stream = Projects(project_ids=project_ids, **auth_params)
|
|
return self.__projects_stream
|
|
|
|
def _auth_params(self, config: MutableMapping[str, Any]) -> Mapping[str, Any]:
|
|
if not self.__auth_params:
|
|
auth = TokenAuthenticator(token=config["private_token"])
|
|
self.__auth_params = dict(authenticator=auth, api_url=config["api_url"])
|
|
return self.__auth_params
|
|
|
|
def _get_group_list(self, config: MutableMapping[str, Any]) -> List[str]:
|
|
group_ids = list(filter(None, config.get("groups", "").split(" ")))
|
|
# Gitlab exposes different APIs to get a list of groups.
|
|
# We use https://docs.gitlab.com/ee/api/groups.html#list-groups in case there's no group IDs in the input config.
|
|
# This API provides full information about all available groups, including subgroups.
|
|
#
|
|
# In case there is a definitive list of groups IDs in the input config, the above API can not be used since
|
|
# it does not support filtering by group ID, so we use
|
|
# https://docs.gitlab.com/ee/api/groups.html#details-of-a-group and
|
|
# https: //docs.gitlab.com/ee/api/groups.html#list-a-groups-descendant-groups for each group ID. The latter one does not
|
|
# provide full group info so can only be used to retrieve alist of group IDs and pass it further to init a corresponding stream.
|
|
auth_params = self._auth_params(config)
|
|
stream = GroupsList(**auth_params) if not group_ids else IncludeDescendantGroups(group_ids=group_ids, **auth_params)
|
|
for stream_slice in stream.stream_slices(sync_mode=SyncMode.full_refresh):
|
|
yield from stream.read_records(sync_mode=SyncMode.full_refresh, stream_slice=stream_slice)
|
|
|
|
def check_connection(self, logger, config) -> Tuple[bool, any]:
|
|
try:
|
|
projects = self._projects_stream(config)
|
|
for stream_slice in projects.stream_slices(sync_mode=SyncMode.full_refresh):
|
|
next(projects.read_records(sync_mode=SyncMode.full_refresh, stream_slice=stream_slice))
|
|
return True, None
|
|
except Exception as error:
|
|
return False, f"Unable to connect to Gitlab API with the provided credentials - {repr(error)}"
|
|
|
|
def streams(self, config: MutableMapping[str, Any]) -> List[Stream]:
|
|
auth_params = self._auth_params(config)
|
|
|
|
groups, projects = self._groups_stream(config), self._projects_stream(config)
|
|
pipelines = Pipelines(parent_stream=projects, start_date=config["start_date"], **auth_params)
|
|
merge_requests = MergeRequests(parent_stream=projects, start_date=config["start_date"], **auth_params)
|
|
epics = Epics(parent_stream=groups, **auth_params)
|
|
|
|
streams = [
|
|
groups,
|
|
projects,
|
|
Branches(parent_stream=projects, repository_part=True, **auth_params),
|
|
Commits(parent_stream=projects, repository_part=True, start_date=config["start_date"], **auth_params),
|
|
epics,
|
|
EpicIssues(parent_stream=epics, **auth_params),
|
|
GroupIssueBoards(parent_stream=groups, **auth_params),
|
|
Issues(parent_stream=projects, start_date=config["start_date"], **auth_params),
|
|
Jobs(parent_stream=pipelines, **auth_params),
|
|
ProjectMilestones(parent_stream=projects, **auth_params),
|
|
GroupMilestones(parent_stream=groups, **auth_params),
|
|
ProjectMembers(parent_stream=projects, **auth_params),
|
|
GroupMembers(parent_stream=groups, **auth_params),
|
|
ProjectLabels(parent_stream=projects, **auth_params),
|
|
GroupLabels(parent_stream=groups, **auth_params),
|
|
merge_requests,
|
|
MergeRequestCommits(parent_stream=merge_requests, **auth_params),
|
|
Releases(parent_stream=projects, **auth_params),
|
|
Tags(parent_stream=projects, repository_part=True, **auth_params),
|
|
pipelines,
|
|
PipelinesExtended(parent_stream=pipelines, **auth_params),
|
|
Users(parent_stream=projects, **auth_params),
|
|
]
|
|
|
|
return streams
|