From d73b7b42ef4a537e501c7244b5789ce17bd51219 Mon Sep 17 00:00:00 2001 From: aashikam Date: Thu, 8 Feb 2024 09:11:04 +0530 Subject: [PATCH] Add README.md for tests --- ballerina/tests/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 ballerina/tests/README.md diff --git a/ballerina/tests/README.md b/ballerina/tests/README.md new file mode 100644 index 0000000..dd75c56 --- /dev/null +++ b/ballerina/tests/README.md @@ -0,0 +1,28 @@ +# 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/) as 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/)