connector-tester

Connector Tester

Pre-requisites

• Docker Desktop >= 4.23.0 or Rancher Desktop >= 1.12.1
• gRPC server is running for the particular example (see example readme's)

How To Run

1. Pull the latest docker image from public-docker-us/sdktesters/sdk-tester Google Artifact Registry, use the following commands:

   • Authenticate Docker to Google Artifact Registry: Run the following command to allow Docker to use your Google credentials

       gcloud auth configure-docker us-docker.pkg.dev
   

   • Pull the Image:

       docker pull us-docker.pkg.dev/build-286712/public-docker-us/sdktesters/sdk-tester   
   

NOTE: If using V2 proto versions, use the latest docker image of the public-docker-us/sdktesters-v2/sdk-tester artifact in Google Artifact Registry.

2. Run a container using the image with the following command. Make sure to map a local directory for storing files that the tool generates by replacing <local-data-folder> in the command, and replace with the version of the image you pulled.

docker run --mount type=bind,source=<local-data-folder>,target=/data -a STDIN -a STDOUT -a STDERR -it -e GRPC_HOSTNAME=host.docker.internal --network=host fivetrandocker/fivetran-sdk-tester:<version> --tester-type source --port <port>

3. Once the sync is done running, it will persist the records in a warehouse.db database file. This is an instance of DuckDB database. You can connect to it to validate the results of your sync using DuckDB CLI or DBeaver

4. To rerun the container from step #2, use the following command:

docker start -i <container-id>

CLI Arguments

The tester supports the following optional CLI arguments to alter its default behavior. You can append these options to the end of the docker run command provided in step 2 of How To Run section above.

--port

This option defines the port the tester should run on.

--destination-schema

With this option, you can alter the schema name used in the destination from the default default_schema.