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.

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

[integration][gitlab-v2] - gitlab data sync using APIs and Webhook #1125

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

Sir-heed
Copy link

@Sir-heed Sir-heed commented Nov 6, 2024

Description

What - A gitlab integration for Ocean for syncing Groups, Projects, Merge Requests and Issues.

Why - As part of the round 1 requirement for Port Interview, here's an integration of Gitlab entity including Groups. Projects, Merge Requests and Issues with port.

How - Integration is done with Organisation Id - org_wCqtgjXGDwuwMm6T. The integration includes the following steps:

  • Fetching data from gitlab using Gitlab API
  • Creating webhook for groups
  • Handling webhook events for each entity.
  • Syncing the fetched data with port using ocean framework

Type of change

Please leave one option from the following and delete the rest:

  • New Integration (non-breaking change which adds a new integration)

All tests should be run against the port production environment(using a testing org).

Core testing checklist

  • Integration able to create all default resources from scratch
  • Resync finishes successfully
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Scheduled resync able to abort existing resync and start a new one
  • Tested with at least 2 integrations from scratch
  • Tested with Kafka and Polling event listeners
  • Tested deletion of entities that don't pass the selector

Integration testing checklist

  • Integration able to create all default resources from scratch
  • Resync able to create entities
  • Resync able to update entities
  • Resync able to detect and delete entities
  • Resync finishes successfully
  • If new resource kind is added or updated in the integration, add example raw data, mapping and expected result to the examples folder in the integration directory.
  • If resource kind is updated, run the integration with the example data and check if the expected result is achieved
  • If new resource kind is added or updated, validate that live-events for that resource are working as expected
  • Docs PR link here

Preflight checklist

  • Handled rate limiting
  • Handled pagination
  • Implemented the code in async
  • Support Multi account

Screenshots

Include screenshots from your environment showing how the resources of the integration will look.
Screenshot from 2024-11-06 21-24-08
Screenshot from 2024-11-06 21-23-57
Screenshot from 2024-11-06 21-23-42
Screenshot from 2024-11-06 21-23-23

API Documentation

Provide links to the API documentation used for this integration.

@Sir-heed Sir-heed changed the title [gitlab][gitlab-v2] - Added gitlab data sync using APIs and Webhook [gitlab][gitlab-v2] - gitlab data sync using APIs and Webhook Nov 6, 2024
@Sir-heed Sir-heed changed the title [gitlab][gitlab-v2] - gitlab data sync using APIs and Webhook [integration][gitlab-v2] - gitlab data sync using APIs and Webhook Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant