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.

Sign up for GitHub

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

Jump to bottom

[Core] Add support for choosing default resources integration will create dynamically #1129

Merged
merged 15 commits into from
Nov 12, 2024
Merged

[Core] Add support for choosing default resources integration will create dynamically #1129

merged 15 commits into from
Nov 12, 2024

Conversation

shalev007
Copy link
Contributor

@shalev007 shalev007 commented Nov 7, 2024 •
edited
Loading

Description

What - Add the option to create custom type of resources for an integration

Why - Ocean Saas is the only type of Ocean integrations that can use secrets

How - added a new config parameter to the integration settings

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.

@shalev007 shalev007 requested a review from a team as a code owner November 7, 2024 13:55
@github-actions github-actions bot added the size/M label Nov 7, 2024
@github-actions github-actions bot added size/L and removed size/M labels Nov 11, 2024
erikzaadi
erikzaadi reviewed Nov 11, 2024
View reviewed changes
port_ocean/tests/test_smoke.py Outdated Show resolved Hide resolved
port_ocean/core/defaults/common.py Outdated Show resolved Hide resolved
@Tankilevitch Tankilevitch reopened this Nov 11, 2024
Tankilevitch
Tankilevitch requested changes Nov 11, 2024
View reviewed changes
port_ocean/core/defaults/common.py Outdated Show resolved Hide resolved
port_ocean/core/defaults/common.py Outdated Show resolved Hide resolved
@shalev007 shalev007 changed the title feat: add new env to read resources from [Core] add new env to read resources from Nov 11, 2024
erikzaadi
erikzaadi approved these changes Nov 11, 2024
View reviewed changes
Copy link
Member

@erikzaadi erikzaadi left a comment

Choose a reason for hiding this comment

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

port_ocean/tests/core/defaults/test_common.py
default_dir.mkdir(parents=True, exist_ok=True)

# Create mock JSON and YAML files with expected content
(default_dir / "blueprints.json").write_text(
Copy link
Member

Choose a reason for hiding this comment

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

This is cool, didn't know of this, #TIL worthy

Tankilevitch
Tankilevitch approved these changes Nov 12, 2024
View reviewed changes
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

@shalev007 shalev007 changed the title [Core] add new env to read resources from [Core] Add support for choosing default resources integration will create dynamically Nov 12, 2024
@shalev007 shalev007 changed the title [Core] Add support for choosing default resources integration will create dynamically [Core] added a new config parameter to the integration settings Nov 12, 2024
@shalev007 shalev007 changed the title [Core] added a new config parameter to the integration settings [Core] Add support for choosing default resources integration will create dynamically Nov 12, 2024
@shalev007 shalev007 merged commit 9fae538 into main Nov 12, 2024
14 of 16 checks passed
@shalev007 shalev007 deleted the PORT-11239-make-the-ocean-app-read-the-saas-resources-files branch November 12, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Tankilevitch Tankilevitch Tankilevitch approved these changes

@erikzaadi erikzaadi erikzaadi approved these changes

Assignees
No one assigned
Labels
size/L
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shalev007 @erikzaadi @Tankilevitch