Skip to content

Commit

Permalink
added single tester docker repo in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fivetran-abdulsalam committed Jul 26, 2024
1 parent a47236c commit 747bf52
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 8 deletions.
5 changes: 1 addition & 4 deletions tools/connector-tester/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
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 <version> 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/sdk-connector-tester:<version>
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](https://duckdb.org/) database. You can connect to it to validate the results of your sync using [DuckDB CLI](https://duckdb.org/docs/api/cli) or [DBeaver](https://duckdb.org/docs/guides/sql_editors/dbeaver)
Expand All @@ -26,8 +26,5 @@ docker start -i <container-id>

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](https://github.com/fivetran/fivetran_sdk/blob/main/tools/connector-tester/README.md#how-to-run) section above.

#### --port
This option tells the tester to use a different port than the default 50051.

#### --destination-schema
With this option, you can alter the schema name used in the destination from the default `default_schema`.
5 changes: 1 addition & 4 deletions tools/destination-tester/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
2. Run a container using the image with the following command. Make sure to map a local directory for the tool by replacing `<local-data-folder>` placeholders in the command, and replace `<version>` 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 WORKING_DIR=<local-data-folder> -e GRPC_HOSTNAME=host.docker.internal --network=host fivetrandocker/sdk-destination-tester:<version>
docker run --mount type=bind,source=<local-data-folder>,target=/data -a STDIN -a STDOUT -a STDERR -it -e WORKING_DIR=<local-data-folder> -e GRPC_HOSTNAME=host.docker.internal --network=host fivetrandocker/fivetran-sdk-tester:<version> --tester-type destination --port <port>
```

3. To rerun the container from step #2, use the following command:
Expand Down Expand Up @@ -145,9 +145,6 @@ Here is an example input file named `input_1.json`:

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](https://github.com/fivetran/fivetran_sdk/tree/main/tools/destination-tester#how-to-run) section above.

#### --port
This option tells the tester to use a different port than the default 50052.

#### --plain-text
This option disables encryption and compression of batch files for debugging purposes.

Expand Down

0 comments on commit 747bf52

Please sign in to comment.