added get_replica_connections function

.github/workflows/test.yml

@@ -8,15 +8,7 @@ jobs:
   test:
     name: Test with Python ${{ matrix.python }}
     runs-on: ubuntu-latest
-
-    services:
-      falkordb:
-        # Docker Hub image
-        image: falkordb/falkordb:edge
-        # Map port 6379 on the Docker host to port 6379 on the FalkorDB container
-        ports:
-          - 6379:6379
-
+
     strategy:
       matrix:
         python: ['3.8', '3.10', '3.11']
@@ -25,9 +17,36 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Run docker-compose for redis standalone instance
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        with:
+          compose-file: ./docker/standalone-compose.yml
+
+      - name: Run docker-compose for redis replication instance
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        with:
+          compose-file: ./docker/sentinel-compose.yml
+
+      - name: Run docker-compose for redis cluster instance
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        with:
+          compose-file: ./docker/cluster-compose.yml
+
+      - name: Add entries to the host file to correctly resolve service names
+        run: |
+          sudo echo "127.0.0.1 redis-standalone" | sudo tee -a /etc/hosts
+          sudo echo "127.0.0.1 sentinel-1"       | sudo tee -a /etc/hosts
+          sudo echo "127.0.0.1 sentinel-2"       | sudo tee -a /etc/hosts
+          sudo echo "127.0.0.1 sentinel-3"       | sudo tee -a /etc/hosts
+          sudo echo "127.0.0.1 redis-server-1"   | sudo tee -a /etc/hosts
+          sudo echo "127.0.0.1 redis-server-2"   | sudo tee -a /etc/hosts
+          for i in node{0..5};do
+            echo "127.0.0.1 $i" | sudo tee -a /etc/hosts
+          done
+
       - uses: actions/setup-python@v5
         with:
-          python-version: ${{matrix.python}}
+          python-version: ${{ matrix.python }}
 
       - uses: snok/install-poetry@v1
         with:
@@ -37,6 +56,9 @@ jobs:
 
       - name: Install dependencies
         run: poetry install --no-interaction
+
+      - name: install docker-compose client
+        run: sudo apt update && sudo apt install docker-compose -y
 
       - name: Run Tests
         run: poetry run pytest --cov --cov-report=xml
@@ -46,4 +68,4 @@ jobs:
         if: matrix.python == '3.10' && matrix.platform != 'macos-11'
         with:
           fail_ci_if_error: false
-          token: ${{ secrets.CODECOV_TOKEN }}    
+          token: ${{ secrets.CODECOV_TOKEN }}

docker/cluster-compose.yml

@@ -0,0 +1,146 @@
+services:
+  node0:
+    image: falkordb/falkordb:latest
+    container_name: node0
+    hostname: node0
+    ports:
+      - 5000:5000
+    networks:
+      - redis-cluster
+    healthcheck:
+          test: |
+            redis-cli --cluster create node0:5000 node1:6000 \
+              node2:7000 node3:8000 node4:9000 node5:10000 --cluster-replicas 1 --cluster-yes || echo failed && exit 1
+          interval: 3s
+          timeout: 10s
+          retries: 10
+          start_period: 2s
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 5000" >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so"             >> /data/node.conf
+        echo "cluster-preferred-endpoint-type hostname"             >> /data/node.conf
+        echo "cluster-port 16379"                                   >> /data/node.conf
+        echo "cluster-enabled yes"                                  >> /data/node.conf
+        echo "cluster-config-file /data/nodes.conf"                 >> /data/node.conf
+        echo "cluster-node-timeout 5000"                            >> /data/node.conf
+        echo "cluster-announce-hostname node0"                      >> /data/node.conf
+        redis-server /data/node.conf
+  node1:
+    image: falkordb/falkordb:latest
+    container_name: node1
+    hostname: node1
+    ports:
+      - 6000:6000
+    networks:
+      - redis-cluster
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 6000" >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so"             >> /data/node.conf
+        echo "cluster-preferred-endpoint-type hostname"             >> /data/node.conf
+        echo "cluster-port 16379"                                   >> /data/node.conf
+        echo "cluster-enabled yes"                                  >> /data/node.conf
+        echo "cluster-config-file /data/nodes.conf"                 >> /data/node.conf
+        echo "cluster-node-timeout 5000"                            >> /data/node.conf
+        echo "cluster-announce-hostname node1"                      >> /data/node.conf
+        redis-server /data/node.conf
+  node2:
+    image: falkordb/falkordb:latest
+    container_name: node2
+    hostname: node2
+    ports:
+      - 7000:7000
+    networks:
+      - redis-cluster
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 7000" >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so"            >> /data/node.conf
+        echo "cluster-preferred-endpoint-type hostname"            >> /data/node.conf
+        echo "cluster-port 16379"                                  >> /data/node.conf
+        echo "cluster-enabled yes"                                 >> /data/node.conf
+        echo "cluster-config-file /data/nodes.conf"                >> /data/node.conf
+        echo "cluster-node-timeout 5000"                           >> /data/node.conf
+        echo "cluster-announce-hostname node2"                     >> /data/node.conf
+        redis-server /data/node.conf
+  node3:
+    image: falkordb/falkordb:latest
+    container_name: node3
+    hostname: node3
+    ports:
+      - 8000:8000
+    networks:
+      - redis-cluster
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 8000" >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so"           >> /data/node.conf
+        echo "cluster-preferred-endpoint-type hostname"           >> /data/node.conf
+        echo "cluster-port 16379"                                 >> /data/node.conf
+        echo "cluster-enabled yes"                                >> /data/node.conf
+        echo "cluster-config-file /data/nodes.conf"               >> /data/node.conf
+        echo "cluster-node-timeout 5000"                          >> /data/node.conf
+        echo "cluster-announce-hostname node3"                    >> /data/node.conf
+        redis-server /data/node.conf
+  node4:
+    image: falkordb/falkordb:latest
+    container_name: node4
+    hostname: node4
+    ports:
+      - 9000:9000
+    networks:
+      - redis-cluster
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 9000" >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so"         >> /data/node.conf
+        echo "cluster-preferred-endpoint-type hostname"         >> /data/node.conf
+        echo "cluster-port 16379"                               >> /data/node.conf
+        echo "cluster-enabled yes"                              >> /data/node.conf
+        echo "cluster-config-file /data/nodes.conf"             >> /data/node.conf
+        echo "cluster-node-timeout 5000"                        >> /data/node.conf
+        echo "cluster-announce-hostname node4"                  >> /data/node.conf
+        redis-server /data/node.conf
+
+  node5:
+    image: falkordb/falkordb:latest
+    container_name: node5
+    hostname: node5
+    ports:
+      - 10000:10000
+    networks:
+      - redis-cluster
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 10000" >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so"       >> /data/node.conf
+        echo "cluster-preferred-endpoint-type hostname"       >> /data/node.conf
+        echo "cluster-port 16379"                             >> /data/node.conf
+        echo "cluster-enabled yes"                            >> /data/node.conf
+        echo "cluster-config-file /data/nodes.conf"           >> /data/node.conf
+        echo "cluster-node-timeout 5000"                      >> /data/node.conf
+        echo "cluster-announce-hostname node5"                >> /data/node.conf
+        redis-server /data/node.conf
+
+
+networks:
+  redis-cluster:

docker/sentinel-compose.yml

@@ -0,0 +1,108 @@
+services:
+  sentinel-1:
+    image: falkordb/falkordb:latest
+    container_name: sentinel-1
+    hostname: sentinel-1
+    restart: always
+    networks:
+      - redis-sentinel
+    ports:
+      - 26379:26379
+    entrypoint: /bin/bash
+    command:
+      - -c 
+      - |
+        touch /data/sentinel.conf
+        echo "sentinel monitor master redis-server-1 6380 2" >> /data/sentinel.conf
+        echo "sentinel announce-hostnames yes"               >> /data/sentinel.conf
+        echo "sentinel announce-ip sentinel-1"               >> /data/sentinel.conf
+        echo "sentinel resolve-hostnames yes"                >> /data/sentinel.conf
+        echo "sentinel announce-port 26379"                  >> /data/sentinel.conf
+        echo "port 26379"                                    >> /data/sentinel.conf
+        redis-server /data/sentinel.conf --sentinel
+
+  sentinel-2:
+    image: falkordb/falkordb:latest
+    container_name: sentinel-2
+    hostname: sentinel-2
+    restart: always
+    networks:
+      - redis-sentinel
+    ports:
+      - 26380:26380
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/sentinel.conf
+        echo "sentinel monitor master redis-server-1 6380 2" >> /data/sentinel.conf
+        echo "sentinel announce-hostnames yes"               >> /data/sentinel.conf
+        echo "sentinel announce-ip sentinel-2"               >> /data/sentinel.conf
+        echo "sentinel resolve-hostnames yes"                >> /data/sentinel.conf
+        echo "sentinel announce-port 26380"                  >> /data/sentinel.conf
+        echo "port 26380"                                    >> /data/sentinel.conf
+        redis-server /data/sentinel.conf --sentinel
+
+  sentinel-3:
+    image: falkordb/falkordb:latest
+    container_name: sentinel-3
+    hostname: sentinel-3
+    restart: always
+    networks:
+      - redis-sentinel
+    ports:
+      - 26381:26381
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/sentinel.conf
+        echo "sentinel monitor master redis-server-1 6380 2" >> /data/sentinel.conf
+        echo "sentinel announce-hostnames yes"               >> /data/sentinel.conf
+        echo "sentinel announce-ip sentinel-3"               >> /data/sentinel.conf
+        echo "sentinel resolve-hostnames yes"                >> /data/sentinel.conf
+        echo "sentinel announce-port 26381"                  >> /data/sentinel.conf
+        echo "port 26381"                                    >> /data/sentinel.conf
+        redis-server /data/sentinel.conf --sentinel
+
+  redis-server-1:
+    image: falkordb/falkordb:latest
+    hostname: redis-server-1
+    container_name: redis-server-1
+    ports:
+      - 6380:6380
+    networks:
+      - redis-sentinel
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 6380" >> /data/node.conf 
+        echo "replica-announce-ip redis-server-1"       >> /data/node.conf
+        echo "replica-announce-port 6380"               >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so" >> /data/node.conf
+        redis-server /data/node.conf
+
+  redis-server-2:
+    image: falkordb/falkordb:latest
+    hostname: redis-server-2
+    container_name: redis-server-2
+    ports:
+      - 6381:6381
+    networks:
+      - redis-sentinel
+    entrypoint: /bin/bash
+    command:
+      - -c
+      - |
+        touch /data/node.conf
+        echo "port 6381" >> /data/node.conf 
+        echo "replica-announce-ip redis-server-2"       >> /data/node.conf
+        echo "replica-announce-port 6381"               >> /data/node.conf
+        echo "loadmodule /FalkorDB/bin/src/falkordb.so" >> /data/node.conf
+        echo "replicaof redis-server-1 6380"            >> /data/node.conf
+        redis-server /data/node.conf
+
+networks:
+  redis-sentinel:

docker/standalone-compose.yml

@@ -0,0 +1,7 @@
+services:
+  redis-standalone:
+    container_name: redis-standalone
+    hostname: redis-standalone
+    image: falkordb/falkordb:latest
+    ports:
+    - 6379:6379

falkordb/falkordb.py

@@ -171,10 +171,13 @@ def from_url(cls, url: str, **kwargs) -> "FalkorDB":
         conn = redis.from_url(url, **kwargs)
 
         connection_kwargs = conn.connection_pool.connection_kwargs
+        connection_class = conn.connection_pool.connection_class
         kwargs["host"] = connection_kwargs.get("host", "localhost")
         kwargs["port"] = connection_kwargs.get("port", 6379)
         kwargs["username"] = connection_kwargs.get("username")
         kwargs["password"] = connection_kwargs.get("password")
+        if connection_class is redis.SSLConnection:
+            kwargs["ssl"] = True
 
         # Initialize a FalkorDB instance using the updated kwargs
         db = cls(**kwargs)
@@ -224,7 +227,41 @@ def config_get(self, name: str) -> Union[int, str]:
         """
 
         return self.connection.execute_command(CONFIG_CMD, "GET", name)[1]
+
+    def get_replica_connections(self):
+        """
+        Retrieve a list of connections for FalkorDB replicas.
+
+        Returns:
+            list of tuple: A list of (hostname, port) tuples representing the 
+            replica connections.
 
+        Raises:
+            ConnectionError: If unable to connect or retrieve information from 
+            the FalkorDB setup.
+            ValueError: If the `mode` is neither Sentinel nor Cluster.
+        """
+        if hasattr(self, 'sentinel') and self.sentinel is not None:
+            try:
+                replica_hostnames = self.sentinel.discover_slaves(service_name=self.service_name)
+                if not replica_hostnames:
+                    raise ConnectionError("Unable to get replica hostname.")
+                return [(host, int(port)) for host, port in replica_hostnames]
+            except redis.RedisError as e:
+                raise ConnectionError("Failed to get replica hostnames, no hostnames found.") from e
+
+        elif Is_Cluster(self.connection):
+            try:
+                data = self.connection.get_replicas()
+                if not data:
+                    raise ConnectionError("Unable to get cluster nodes")
+                return [ (i.host, i.port) for i in data]
+            except redis.RedisError as e:
+                raise ConnectionError("Failed to get replica hostnames") from e
+
+        else:
+            raise ValueError(f"Unsupported Redis mode")
+
     def config_set(self, name: str, value=None) -> None:
         """
         Update a DB level configuration.