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][SonarQube] Added defensive mechanism to fail resync event when no data is fetched from Sonar API components/search_project #1147

Merged
merged 7 commits into from
Nov 20, 2024

Conversation

mk-armah
Copy link
Member

@mk-armah mk-armah commented Nov 15, 2024

Description

What - Added more logs to track the request and response made to Sonar API mainly for debugging purposes. Also added a mechanism to fail the resync to prevent entity deletion

Why - Entities were deleted in Port for scenarios where the Sonar API returned an empty list for the components/search_project API.

How - Added more logs and failed the resync event for the kind when no data is fetched from sonar API

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 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.

API Documentation

Provide links to the API documentation used for this integration.

@mk-armah mk-armah requested a review from a team as a code owner November 15, 2024 18:28
@mk-armah mk-armah changed the title Added logs for debugging unexpected deletions [Integration][SonarQube] Added logs for debugging unexpected deletions Nov 15, 2024
@github-actions github-actions bot added size/M and removed size/S labels Nov 20, 2024
Copy link
Contributor

@Tankilevitch Tankilevitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@PeyGis PeyGis changed the title [Integration][SonarQube] Added logs for debugging unexpected deletions [Integration][SonarQube] Added defensive mechanism to fail resync event when no data is fetched from Sonar API Nov 20, 2024
@Tankilevitch Tankilevitch changed the title [Integration][SonarQube] Added defensive mechanism to fail resync event when no data is fetched from Sonar API [Integration][SonarQube] Added defensive mechanism to fail resync event when no data is fetched from Sonar API components/search_project Nov 20, 2024
@Tankilevitch Tankilevitch merged commit 9052f6e into main Nov 20, 2024
21 checks passed
@Tankilevitch Tankilevitch deleted the debug/sonar branch November 20, 2024 09:12
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.

3 participants