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

🎉 Source Chargebee: add "custom fields" to the relevant data streams #17056

Conversation

darynaishchenko
Copy link
Collaborator

What

Add Chargebee "custom fields" to the relevant Chargebee source data streams.
Resolving:
#14002

How

Added functionality to define a custom fields.

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@CLAassistant
Copy link

CLAassistant commented Sep 22, 2022

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the area/connectors Connector related issues label Sep 22, 2022
@bazarnov
Copy link
Collaborator

Also, please sign this CLA License Agreement.
Screenshot 2022-09-23 at 12 52 26

@bazarnov
Copy link
Collaborator

bazarnov commented Sep 23, 2022

/test connector=connectors/source-chargebee

🕑 connectors/source-chargebee https://github.com/airbytehq/airbyte/actions/runs/3112888935
✅ connectors/source-chargebee https://github.com/airbytehq/airbyte/actions/runs/3112888935
Python tests coverage:

Name                                Stmts   Miss  Cover
-------------------------------------------------------
source_chargebee/source.py             25      0   100%
source_chargebee/__init__.py            2      0   100%
source_chargebee/streams.py           161      9    94%
source_chargebee/utils.py               9      3    67%
source_chargebee/rate_limiting.py      19      7    63%
-------------------------------------------------------
TOTAL                                 216     19    91%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          10      4    60%   15-18
	 source_acceptance_test/config.py                        83      6    93%   78-80, 84-86
	 source_acceptance_test/conftest.py                     164    164     0%   6-282
	 source_acceptance_test/plugin.py                        48     48     0%   6-104
	 source_acceptance_test/tests/test_core.py              329    111    66%   39, 50-58, 63-70, 74-75, 79-80, 164, 202-219, 228-236, 240-245, 251, 284-289, 327-334, 374-376, 379, 439-448, 477-478, 484, 487, 520-530, 543-568, 573-577
	 source_acceptance_test/tests/test_full_refresh.py       52      2    96%   34, 65
	 source_acceptance_test/tests/test_incremental.py       121     25    79%   21-23, 29-31, 36-43, 48-61, 208-216
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  77     17    78%   15-16, 24-30, 47-54, 64, 67
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/connector_runner.py       110     48    56%   23-26, 32, 36, 39-64, 67-69, 72-74, 77-79, 82-84, 87-89, 92-110, 144-146
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1325    463    65%

Build Passed

Test summary info:

All Passed

@bazarnov
Copy link
Collaborator

Please do the following in addition:

  • bump the version of the Dockerfile to 0.1.14
  • edit the changelog accordingly

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Sep 23, 2022
@darynaishchenko
Copy link
Collaborator Author

darynaishchenko commented Sep 23, 2022

/test connector=connectors/source-chargebee

🕑 connectors/source-chargebee https://github.com/airbytehq/airbyte/actions/runs/3113161775
✅ connectors/source-chargebee https://github.com/airbytehq/airbyte/actions/runs/3113161775
Python tests coverage:

Name                                Stmts   Miss  Cover
-------------------------------------------------------
source_chargebee/source.py             25      0   100%
source_chargebee/__init__.py            2      0   100%
source_chargebee/streams.py           161      9    94%
source_chargebee/utils.py               8      1    88%
source_chargebee/rate_limiting.py      19      7    63%
-------------------------------------------------------
TOTAL                                 215     17    92%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          10      4    60%   15-18
	 source_acceptance_test/config.py                        83      6    93%   78-80, 84-86
	 source_acceptance_test/conftest.py                     164    164     0%   6-282
	 source_acceptance_test/plugin.py                        48     48     0%   6-104
	 source_acceptance_test/tests/test_core.py              329    111    66%   39, 50-58, 63-70, 74-75, 79-80, 164, 202-219, 228-236, 240-245, 251, 284-289, 327-334, 374-376, 379, 439-448, 477-478, 484, 487, 520-530, 543-568, 573-577
	 source_acceptance_test/tests/test_full_refresh.py       52      2    96%   34, 65
	 source_acceptance_test/tests/test_incremental.py       121     25    79%   21-23, 29-31, 36-43, 48-61, 208-216
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  77     17    78%   15-16, 24-30, 47-54, 64, 67
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/connector_runner.py       110     48    56%   23-26, 32, 36, 39-64, 67-69, 72-74, 77-79, 82-84, 87-89, 92-110, 144-146
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1325    463    65%

Build Passed

Test summary info:

All Passed

Copy link
Collaborator

@bazarnov bazarnov left a comment

Choose a reason for hiding this comment

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

Nice!

@darynaishchenko
Copy link
Collaborator Author

darynaishchenko commented Sep 26, 2022

/publish connector=connectors/source-chargebee

🕑 Publishing the following connectors:
connectors/source-chargebee
https://github.com/airbytehq/airbyte/actions/runs/3125769420


Connector Did it publish? Were definitions generated?
connectors/source-chargebee

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@bazarnov bazarnov changed the title Chargebee: Added "custom fields" to the relevant Chargebee source data streams. 🎉 Source Chargebee: add "custom fields" to the relevant data streams Sep 26, 2022
@darynaishchenko darynaishchenko merged commit b8a6472 into master Sep 26, 2022
@darynaishchenko darynaishchenko deleted the daryna/add-chargebee-custom-fields-to-connector-data-streams branch September 26, 2022 08:16
robbinhan pushed a commit to robbinhan/airbyte that referenced this pull request Sep 29, 2022
…a streams. (airbytehq#17056)

* Chargebee: added custom fields

* Chargebee: added value types json schema

* Chargebee: added docs, updated docker label, refactored utils

* auto-bump connector version [ci skip]

Co-authored-by: Octavia Squidington III <[email protected]>
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
…a streams. (airbytehq#17056)

* Chargebee: added custom fields

* Chargebee: added value types json schema

* Chargebee: added docs, updated docker label, refactored utils

* auto-bump connector version [ci skip]

Co-authored-by: Octavia Squidington III <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Chargebee "custom fields" to Chargebee connector data streams
4 participants