New Source: Commcare

[siddhant3030]

What

Commcare is a digital data collection platform for front-line workers working in offline settings. For organizations using Commcare having a native Airbyte connector to import data will allow for ingestion into their data warehouses and use of the data for analysis. Current processes involve ingestion with Python scripts, maintaining schemas ad-hoc in the scripts, and through Excel downloads.

How

The current version of the connector provides for ingesting data through Airbyte from multiple forms in an organization's Commcare application. A typical use case of a Commcare system involves a root project space in which multiple applications can be hosted and can be defined for multiple program interventions. The current connector defines the ingestion of data at the application level as that is the most common entry point for Commcare Applications. The implemented version of the connector will allow for all sync modes - full refresh and incremental including de-duped mode. A best-guess normalization is also provided to ease the normalization process using a couple of python libraries to guess the schema from the data fetched back through the API.

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

Integration

Put your integration tests output here.

Acceptance

[geekwhocodes]

@sajarin I can review this PR.

[siddhant3030]

Flake check

[geekwhocodes]

Hi @siddhant3030, Thanks for your amazing contribution!
Could you please delete unused files?

• source-commcare\source_commcare\schemas\TODO.md
• source-commcare\sample_files

Also, can you upload a screenshot of integration tests?

It would be good if you move custom classes to separate file/s.

[sajarin]

@siddhant3030 can you respond to the requested changes ASAP? Thanks!

[siddhant3030]

@geekwhocodes Thank you for the suggestions. I'll work on this. Also we are fixing the acceptance test. As soon as we're done we can let you know. I'll also add the screenshot.

[sajarin]

@siddhant3030 any update here? We're trying to get this merged before the end of the week. Otherwise, the merging might be significantly delayed due to the holidays. We're fairly close to finishing the review here.

[siddhant3030]

@sajarin will try to push this today

[siddhant3030]

@geekwhocodes @sajarin can you help me with this? This is the only test case which is failing in acceptance test

[marcosmarxm]

Hello 👋:skin-tone-2: and thank you for your contribution!

Airbyte has instituted a code freeze between 19 and 30 December, to make sure there are no disruptions during the holidays.
Because of this, reviewing and merging your contribution may take longer than usual.
We apologize for the delay, but we want everyone to have a quiet and happy holiday.

If you have any questions or need further clarification, please don't hesitate to ping via Slack.

[siddhant3030]

@geekwhocodes @sajarin any updates on this? Needed your help the acceptance this. I have posted the query above

[sajarin]

/publish connector=connectors/source-commcare run-tests=false

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

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

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