ocean icon indicating copy to clipboard operation
ocean copied to clipboard

feat: adding support for ingesting opsgenie notification and alert po…

Open em0ney opened this issue 7 months ago • 3 comments

User description

…licies

Description

What -

Why -

How -

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.


PR Type

Enhancement


Description

  • Added support for ingesting OpsGenie alert and notification policies.

  • Introduced new resource kinds ALERT_POLICY and NOTIFICATION_POLICY.

  • Updated API handling for OpsGenie resources with suffix adjustments.

  • Enhanced blueprint and configuration files for new policy types.


Changes walkthrough 📝

Relevant files
Enhancement
client.py
Adjusted API client for resource suffix handling                 

integrations/opsgenie/client.py

  • Added _should_add_suffix method to handle resource suffix logic.
  • Updated get_paginated_resources to use suffix logic for URLs.
  • +11/-1   
    main.py
    Added resync handlers for alert and notification policies

    integrations/opsgenie/main.py

  • Added on_alert_policy_resync for alert policy resync handling.
  • Added on_notification_policy_resync for notification policy resync
    handling.
  • +45/-0   
    utils.py
    Defined new resource kinds for policies                                   

    integrations/opsgenie/utils.py

  • Added ALERT_POLICY and NOTIFICATION_POLICY to ObjectKind.
  • Updated API version mapping for new resource kinds.
  • +6/-0     
    blueprints.json
    Added blueprint for OpsGenie policies                                       

    integrations/opsgenie/.port/resources/blueprints.json

  • Added a new blueprint for OpsGenie policies.
  • Defined schema and relations for policy blueprint.
  • +37/-0   
    port-app-config.yaml
    Updated app configuration for new policy types                     

    integrations/opsgenie/.port/resources/port-app-config.yaml

  • Added mappings for policies/alert and policies/notification.
  • Configured relations and properties for new policy types.
  • +28/-0   
    spec.yaml
    Updated spec file with new policy kinds                                   

    integrations/opsgenie/.port/spec.yaml

  • Added policies/alert and policies/notification to resource features.
  • +2/-0     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • em0ney avatar Mar 10 '25 02:03 em0ney