source-braze

Braze Source

This is the repository for the Braze configuration based source connector. For information about how to use this connector within Airbyte, see the documentation.

Local development

Create credentials

If you are a community contributor, follow the instructions in the documentation to generate the necessary credentials. Then create a file secrets/config.json conforming to the source_braze/spec.yaml file. Note that any directory named secrets is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information. See integration_tests/sample_config.json for a sample config file.

If you are an Airbyte core member, copy the credentials in Lastpass under the secret name source braze test creds and place them into secrets/config.json.

Locally running the connector docker image

Build

Via airbyte-ci (recommended):

airbyte-ci connectors --name=source-braze build

An image will be built with the tag airbyte/source-braze:dev.

Via docker build:

docker build -t airbyte/source-braze:dev .

Run

Then run any of the connector commands as follows:

docker run --rm airbyte/source-braze:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-braze:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-braze:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-braze:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json

Testing

You can run our full test suite locally using airbyte-ci:

airbyte-ci connectors --name=source-braze test

Customizing acceptance Tests

Customize acceptance-test-config.yml file to configure tests. See Connector Acceptance Tests for more information. If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.

Dependency Management

All of your dependencies should go in setup.py, NOT requirements.txt. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development. We split dependencies between two groups, dependencies that are:

• required for your connector to work need to go to MAIN_REQUIREMENTS list.
• required for the testing need to go to TEST_REQUIREMENTS list

Publishing a new version of the connector

You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?

1. Make sure your changes are passing our test suite: airbyte-ci connectors --name=source-braze test
2. Bump the connector version in metadata.yaml: increment the dockerImageTag value. Please follow semantic versioning for connectors.
3. Make sure the metadata.yaml content is up to date.
4. Make the connector documentation and its changelog is up to date (docs/integrations/sources/braze.md).
5. Create a Pull Request: use our PR naming conventions.
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.