Skip to content

Commit

Permalink
Add README.md for tests
Browse files Browse the repository at this point in the history
  • Loading branch information
aashikam committed Feb 8, 2024
1 parent a842d1f commit 2f557df
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions ballerina/tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Ballerina AWS Redshift Connector Test Module

This test module is written to test the functionality of the Ballerina AWS Redshift Connector.

## Docker Image
For testing purposes, this [docker-pgredshift](https://github.com/HearthSim/docker-pgredshift/pkgs/container/docker-pgredshift) Docker image is used. It emulates AWS Redshift but with limited features, and it does not support SSL.

## Emulated AWS Redshift Features
The docker-pgredshift image provides a simulated environment resembling AWS Redshift. However, it is essential to be aware of the limited features and the absence of SSL support in this emulation.

## Connection Details
To establish a connection with the emulated AWS Redshift, the Ballerina AWS Redshift Connector uses the [Ballerina PostgreSQL Driver](https://github.com/ballerina-platform/module-ballerinax-postgresql.driver/) because the docker-pgredshift image is based on PostgreSQL and does not connect with the Redshift driver.

## Usage
Follow these steps to manually run the test module:

1. Pull the docker-pgredshift image from [here](https://github.com/HearthSim/docker-pgredshift/pkgs/container/docker-pgredshift).
2. Set up the docker-pgredshift container to emulate AWS Redshift.
3. Use the Ballerina AWS Redshift Connector in your Ballerina programs to interact with the emulated AWS Redshift instance.

## Reference Links
- [docker-pgredshift Image](https://github.com/HearthSim/docker-pgredshift/pkgs/container/docker-pgredshift)
- [Ballerina PostgreSQL Driver](https://github.com/ballerina-platform/module-ballerinax-postgresql.driver/)

0 comments on commit 2f557df

Please sign in to comment.