Feature/bitbucket ocean Add initial Bitbucket integration with authe…
User description
…ntication and webhook handling
Description
What - This pull request introduces a Bitbucket Cloud integration for Port's Ocean framework, allowing users to import and manage Bitbucket projects, repositories, pull requests, and components within Port.
Why -
- Establishes a seamless connection between Bitbucket Cloud and Port.
- Enables real-time updates through webhooks.
- Optimizes performance with fully asynchronous API requests.
- Incorporates rate-limit handling and pagination for improved stability.
How -
- Utilizes Ocean’s asynchronous HTTP client for API interactions.
- Implements authentication with the Bitbucket API using App Passwords.
- Supports both scheduled and on-demand synchronization for precise data ingestion.
- Handles webhook events to facilitate real-time updates.
Type of change
Please leave one option from the following and delete the rest:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] New Integration (non-breaking change which adds a new integration)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Non-breaking change (fix of existing functionality that will not change current behavior)
- [ ] Documentation (added/updated documentation)
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
examplesfolder 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.
API Documentation
Provide links to the API documentation used for this integration.
PR Type
Enhancement, Tests
Description
-
Introduced a new Bitbucket integration for Port's Ocean framework.
-
Implemented authentication using Basic Auth with App Passwords.
-
Added support for fetching projects, repositories, and pull requests.
-
Included webhook handling and data ingestion into Port.
-
Provided comprehensive unit tests for authentication, integration, and webhook handling.
Changes walkthrough 📝
| Relevant files | |||
|---|---|---|---|
| Enhancement | |||
| Configuration changes | |||
| Tests | |||
| Dependencies | 1 files
| ||
| Additional files | 1 files
|
Need help?
Type /help how to ...in the comments thread for any questions about Qodo Merge usage.Check out the documentation for more information.
PR Reviewer Guide 🔍
Here are some key observations to aid the review process:
| ⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪ |
| 🧪 PR contains tests |
| 🔒 Security concerns Sensitive information exposure: |
⚡ Recommended focus areas for reviewError Handling
|
PR Code Suggestions ✨
Explore these optional code suggestions:
| Category | Suggestion | Impact |
| Security |
Add input sanitization for securityAdd input sanitization to prevent potential injection attacks in the integrations/bit_bucket/bit_bucket_integration/auth.py [22]
Suggestion importance[1-10]: 8__ Why: The suggestion addresses a potential security vulnerability by sanitizing authentication inputs, which is crucial for preventing injection attacks in authentication tokens. | Medium |
| General |
Add request timeout protectionAdd a timeout parameter to the client.get() request to prevent indefinite integrations/bit_bucket/bit_bucket_integration/integration.py [62]
Suggestion importance[1-10]: 8__ Why: Adding a timeout parameter is critical for preventing the application from hanging indefinitely during network issues, which could impact system stability and resource usage. | Medium |
| Possible issue |
Improve API error handlingAdd response status code validation before processing the response data to integrations/bit_bucket/bit_bucket_integration/integration.py [62-66]
Suggestion importance[1-10]: 7__ Why: The suggestion adds valuable error logging with response details before raising the exception, which would help in debugging API issues. The status code check provides more detailed error information. | Medium |
| ||
This pull request is automatically being deployed by Amplify Hosting (learn more).
Access this pull request here: https://pr-1415.d1ftd8v2gowp8w.amplifyapp.com