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

🎉 New Source: Visma e-conomic [python cdk] #18595

Merged
merged 19 commits into from
Nov 7, 2022

Conversation

sofiehellmark
Copy link
Contributor

@sofiehellmark sofiehellmark commented Oct 28, 2022

What

Adding Visma e-conomic as a source. See issue airbytehq/connector-contest#162.

How

Using python cdk
Streams implemented:

Recommended reading order

  1. spec.yaml
  2. schemas

🚨 User Impact 🚨

N/A

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.
Screenshot 2022-10-30 at 17 20 59

Integration

Put your integration tests output here.

Screenshot 2022-10-31 at 17 50 32

Acceptance

Put your acceptance tests output here.
Same as integration tests above
Screenshot 2022-10-31 at 17 50 32

@CLAassistant
Copy link

CLAassistant commented Oct 28, 2022

CLA assistant check
All committers have signed the CLA.

@marcosmarxm
Copy link
Member

Thanks for your contribution @sofiehellmark ! Please request my review when the code is ready to review. If you have any questions feel free to ask them in our Slack channel #hacktoberfest-2022. You can get a link to access Slack here: https://airbyte.com/connector-contest

@marcosmarxm
Copy link
Member

@sofiehellmark can you sign the CLA?

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Oct 30, 2022
@sofiehellmark sofiehellmark marked this pull request as ready for review October 30, 2022 16:13
@sofiehellmark
Copy link
Contributor Author

sofiehellmark commented Oct 30, 2022

Hi @marcosmarxm ! Ready for review on my first PR here 😄 I have updated the documentation now, let me know if I missed something. About the tests - could you please guide me if there is more I need to implement/provide?

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Hello @sofiehellmark, Marcos from Airbyte here 👋 . We received more than 25 new contributions along the weekend. One is yours 🎉 thank so much for! Our team is limited and maybe the review process can take longer than expected. As described in the Airbyte's Hacktoberfest your contribution was submitted before November 2nd and it is eligible to win the prize. The review process will validate other requirements. I ask to you patience until someone from the team review it.

Because I reviewed some contributions for Hacktoberfest so far I saw some common patterns you can check in advance:

  • Make sure you have added connector documentation to /docs/integrations/
  • Remove the file catalog from /integration_tests
  • Edit the sample_config.json inside /integration_tests
  • For the configured_catalog you can use only json_schema: {}
  • Add title to all properties in the spec.yaml
  • Make sure the documentationUrl in the spec.yaml redirect to Airbyte's future connector page, eg: connector Airtable the documentationUrl: https://docs.airbyte.com/integrations/sources/airtable
  • Review now new line at EOF (end-of-file) for all files.

If possible send to me a DM in Slack with the tests credentials, this process will make easier to us run integration tests and publish your connector. If you only has production keys, make sure to create a bootstrap.md explaining how to get the keys.

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

Some comments.

airbyte-integrations/builds.md Outdated Show resolved Hide resolved
@@ -0,0 +1,17 @@
documentationUrl: https://apis.e-conomic.com/
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 the Airbyte's connector page: https://docs.airbyte.com/integrations/sources/visma-economic

docs/integrations/README.md Outdated Show resolved Hide resolved
@sofiehellmark
Copy link
Contributor Author

Hi @marcosmarxm, I have pushed requested changes. Thanks!

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

@sofiehellmark I read the Visma documentation (https://restdocs.e-conomic.com/#filtering) and found the API allows filtering. This allows to implement incremental syncs, which is much better to use the connector. What do you think about implementing this? I can help you whenever you need

@sofiehellmark
Copy link
Contributor Author

Sounds good! I'll have a go at it, will let you know if any questions

@marcosmarxm
Copy link
Member

Hello! I'm going to be out of the office this Friday and won't be able to review your contribution again today, I return next Monday. So far, most contributions look solid and are almost done to be approved. As said in Chris' comment all contributions made before 2-November are eligible to receive the prize and have 2 weeks to merge the contributions. But I ensure next week we're going to have your contribution merged. If you have questions about the implementation you can send them in #hacktoberfest-2022 in Airbyte's Slack.

Sorry the inconvenience and see you again next week, thank you so much for your contribution!

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 7, 2022

/test connector=connectors/source-visma-economic

🕑 connectors/source-visma-economic https://github.com/airbytehq/airbyte/actions/runs/3414545272
✅ connectors/source-visma-economic https://github.com/airbytehq/airbyte/actions/runs/3414545272
Python tests coverage:

Name                                Stmts   Miss  Cover
-------------------------------------------------------
source_visma_economic/__init__.py       2      0   100%
source_visma_economic/source.py        87     22    75%
-------------------------------------------------------
TOTAL                                  89     22    75%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          12      4    67%   16-19
	 source_acceptance_test/config.py                       133      3    98%   87, 93, 230
	 source_acceptance_test/conftest.py                     196     92    53%   35, 41-43, 48, 54, 60, 66, 72-74, 93, 98-100, 106-108, 114-115, 120-121, 126, 132, 141-150, 156-161, 176, 200, 231, 237, 243-248, 256-261, 269-282, 287-293, 300-311, 318-334
	 source_acceptance_test/plugin.py                        69     25    64%   22-23, 31, 36, 120-140, 144-148
	 source_acceptance_test/tests/test_core.py              345    110    68%   53, 64-72, 77-84, 88-89, 93-94, 178, 216-233, 242-250, 254-259, 265, 298-303, 341-348, 391-393, 396, 461-469, 481-484, 489, 545-546, 552, 555, 591-601, 614-639
	 source_acceptance_test/tests/test_incremental.py       145     20    86%   21-23, 29-31, 36-43, 48-61, 224
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  94     10    89%   16-17, 32-38, 72, 75
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/config_migration.py        23     23     0%   5-37
	 source_acceptance_test/utils/connector_runner.py       112     50    55%   23-26, 32, 36, 39-68, 71-73, 76-78, 81-83, 86-88, 91-93, 96-114, 148-150
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1512    375    75%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestIncremental.test_two_sequential_reads: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:65: The previous connector image could not be retrieved.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:243: The previous connector image could not be retrieved.
============ 24 passed, 3 skipped, 27 warnings in 96.19s (0:01:36) =============

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 7, 2022

/test connector=connectors/source-visma-economic

🕑 connectors/source-visma-economic https://github.com/airbytehq/airbyte/actions/runs/3414572199
❌ connectors/source-visma-economic https://github.com/airbytehq/airbyte/actions/runs/3414572199
🐛

Build Failed

Test summary info:

Could not find result summary

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 7, 2022

/publish connector=connectors/source-visma-economic

🕑 Publishing the following connectors:
connectors/source-visma-economic
https://github.com/airbytehq/airbyte/actions/runs/3414772042


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

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

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

@marcosmarxm marcosmarxm merged commit 2b52b53 into airbytehq:master Nov 7, 2022
letiescanciano added a commit that referenced this pull request Nov 8, 2022
…nent

* master:
  🪟 🎉 Enable frontend validation for <1hr syncs (cloud) #19028
  Stream returns AirbyteMessages (#18572)
  🎉 New Source - Recruitee [low-code SDK] (#18671)
  🎉 New source: Breezometer [low-code cdk] (#18650)
  Check disabled connections after protocol update (#18990)
  Simple default replication worker refactor (#19002)
  🎉 New Source: Visma e-conomic (#18595)
  🎉 New Source: Fastbill (#18593)
  Bmoric/extract state api (#18980)
  🎉 New Source: Zapier Supported Storage (#18442)
  🎉 New source: Klarna (#18385)
  `AirbyteEstimateTraceMessage` (#18875)
  Extract source definition api (#18977)
  [low-code cdk] Allow for spec file to be defined in the yaml manifest instead of an external file (#18411)
  🐛 Source HubSpot: fix property scopes (#18624)
  Ensure that only 6-character hex values are passed to monaco editor (#18943)
@RealChrisSean RealChrisSean added the python Pull requests that update Python code label Nov 15, 2022
@marcosmarxm marcosmarxm changed the title 🎉 New Source: Visma e-conomic 🎉 New Source: Visma e-conomic [python cdk] Nov 18, 2022
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 bounty community connectors/source/visma-economic hacktober python Pull requests that update Python code
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

7 participants