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/[email protected]
+        with:
+          compose-file: ./docker/standalone-compose.yml
+
+      - name: Run docker-compose for redis replication instance
+        uses: hoverkraft-tech/[email protected]
+        with:
+          compose-file: ./docker/sentinel-compose.yml
+
+      - name: Run docker-compose for redis cluster instance
+        uses: hoverkraft-tech/[email protected]
+        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,13 +56,19 @@ jobs:
 
       - name: Install dependencies
         run: poetry install --no-interaction
+
+      - name: install docker module for python
+        run: poetry add docker
+
+      - name: wait for nodes to connect to each other
+        run: while true;do (docker logs node0 | grep succeeded ) && ( docker logs node1 | grep succeeded ) && ( docker logs node2 | grep succeeded ) && break ;done
 
       - name: Run Tests
         run: poetry run pytest --cov --cov-report=xml
-
+          
       - name: Upload coverage
         uses: codecov/codecov-action@v5
         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,124 @@
+services:
+  node0:
+    image: falkordb/falkordb:latest
+    container_name: node0
+    hostname: node0
+    ports:
+      - 5000:5000
+    networks:
+      - redis-cluster
+    volumes:
+      - node0-data:/data
+    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: 1s
+    environment:
+      REDIS_ARGS: "--port 5000 --cluster-enabled yes --cluster-port 16379 --cluster-preferred-endpoint-type hostname --cluster-config-file /data/nodes.conf --cluster-node-timeout 500 --cluster-announce-hostname node0"
+
+  node1:
+    image: falkordb/falkordb:latest
+    container_name: node1
+    hostname: node1
+    ports:
+      - 6000:6000
+    networks:
+      - redis-cluster
+    volumes:
+      - node1-data:/data
+    environment:
+      REDIS_ARGS: "--port 6000 --cluster-enabled yes --cluster-port 16379 --cluster-preferred-endpoint-type hostname --cluster-config-file /data/nodes.conf --cluster-node-timeout 500 --cluster-announce-hostname node1"
+
+  node2:
+    image: falkordb/falkordb:latest
+    container_name: node2
+    hostname: node2
+    ports:
+      - 7000:7000
+    networks:
+      - redis-cluster
+    volumes:
+      - node2-data:/data
+    environment:
+      REDIS_ARGS: "--port 7000 --cluster-enabled yes --cluster-port 16379 --cluster-preferred-endpoint-type hostname --cluster-config-file /data/nodes.conf --cluster-node-timeout 500 --cluster-announce-hostname node2"
+
+  node3:
+    image: falkordb/falkordb:latest
+    container_name: node3
+    hostname: node3
+    ports:
+      - 8000:8000
+    networks:
+      - redis-cluster
+    volumes:
+      - node3-data:/data
+    healthcheck:
+      test: |
+        #!/bin/bash
+        ip=$(getent hosts node2 |awk '{print $1}'| tr -d '\r\n')
+        redis-cli -p 8000 cluster meet $$ip 7000 || echo failed && exit 1
+      interval: 3s
+      timeout: 10s
+      retries: 10
+      start_period: 30s
+    environment:
+      REDIS_ARGS: "--port 8000 --cluster-enabled yes --cluster-port 16379 --cluster-preferred-endpoint-type hostname --cluster-config-file /data/nodes.conf --cluster-node-timeout 500 --cluster-announce-hostname node3"
+
+  node4:
+    image: falkordb/falkordb:latest
+    container_name: node4
+    hostname: node4
+    ports:
+      - 9000:9000
+    networks:
+      - redis-cluster
+    volumes:
+      - node4-data:/data
+    healthcheck:
+      test: |
+        #!/bin/bash
+        ip=$(getent hosts node0 |awk '{print $1}'| tr -d '\r\n')
+        redis-cli -p 9000 cluster meet $$ip 5000 || echo failed && exit 1
+      interval: 3s
+      timeout: 10s
+      retries: 10
+      start_period: 30s
+    environment:
+      REDIS_ARGS: "--port 9000 --cluster-enabled yes --cluster-port 16379 --cluster-preferred-endpoint-type hostname --cluster-config-file /data/nodes.conf --cluster-node-timeout 500 --cluster-announce-hostname node4"
+
+  node5:
+    image: falkordb/falkordb:latest
+    container_name: node5
+    hostname: node5
+    ports:
+      - 10000:10000
+    networks:
+      - redis-cluster
+    volumes:
+      - node5-data:/data
+    healthcheck:
+      test: |
+        #!/bin/bash
+        ip=$(getent hosts node1 |awk '{print $1}'| tr -d '\r\n')
+        redis-cli -p 10000 cluster meet $$ip 6000|| echo failed && exit 1
+      interval: 3s
+      timeout: 10s
+      retries: 10
+      start_period: 30s
+    environment:
+      REDIS_ARGS: "--port 10000 --cluster-enabled yes --cluster-port 16379 --cluster-preferred-endpoint-type hostname --cluster-config-file /data/nodes.conf --cluster-node-timeout 500 --cluster-announce-hostname node5"
+
+networks:
+  redis-cluster:
+
+volumes:
+  node0-data:
+  node1-data:
+  node2-data:
+  node3-data:
+  node4-data:
+  node5-data:

docker/sentinel-compose.yml

@@ -0,0 +1,91 @@
+services:
+  sentinel-1:
+    image: bitnami/redis-sentinel
+    container_name: sentinel-1
+    hostname: sentinel-1
+    restart: always
+    networks:
+      - redis-sentinel
+    ports:
+      - 26379:26379
+    environment:
+      REDIS_MASTER_SET: master
+      REDIS_MASTER_HOST: redis-server-1
+      REDIS_MASTER_PORT_NUMBER: 6380
+      REDIS_SENTINEL_ANNOUNCE_PORT: "yes"
+      REDIS_SENTINEL_ANNOUNCE_HOSTNAMES: "yes"
+      REDIS_SENTINEL_ANNOUNCE_IP: sentinel-1
+      REDIS_SENTINEL_PORT_NUMBER: 26379
+      REDIS_SENTINEL_DOWN_AFTER_MILLISECONDS: 500
+      REDIS_SENTINEL_FAILOVER_TIMEOUT: 500
+      ALLOW_EMPTY_PASSWORD: "yes"
+
+  sentinel-2:
+    image: bitnami/redis-sentinel
+    container_name: sentinel-2
+    hostname: sentinel-2
+    restart: always
+    networks:
+      - redis-sentinel
+    ports:
+      - 26380:26380
+    environment:
+      REDIS_MASTER_SET: master
+      REDIS_MASTER_HOST: redis-server-1
+      REDIS_MASTER_PORT_NUMBER: 6380
+      REDIS_SENTINEL_ANNOUNCE_PORT: "yes"
+      REDIS_SENTINEL_ANNOUNCE_HOSTNAMES: "yes"
+      REDIS_SENTINEL_ANNOUNCE_IP: sentinel-2
+      REDIS_SENTINEL_PORT_NUMBER: 26380
+      REDIS_SENTINEL_DOWN_AFTER_MILLISECONDS: 500
+      REDIS_SENTINEL_FAILOVER_TIMEOUT: 500
+      ALLOW_EMPTY_PASSWORD: "yes"
+
+  sentinel-3:
+    image: bitnami/redis-sentinel
+    container_name: sentinel-3
+    hostname: sentinel-3
+    restart: always
+    networks:
+      - redis-sentinel
+    ports:
+      - 26381:26381
+    environment:
+      REDIS_MASTER_SET: master
+      REDIS_MASTER_HOST: redis-server-1
+      REDIS_MASTER_PORT_NUMBER: 6380
+      REDIS_SENTINEL_ANNOUNCE_PORT: "yes"
+      REDIS_SENTINEL_ANNOUNCE_HOSTNAMES: "yes"
+      REDIS_SENTINEL_ANNOUNCE_IP: sentinel-3
+      REDIS_SENTINEL_PORT_NUMBER: 26381
+      REDIS_SENTINEL_DOWN_AFTER_MILLISECONDS: 500
+      REDIS_SENTINEL_FAILOVER_TIMEOUT: 500
+      ALLOW_EMPTY_PASSWORD: "yes"
+
+  redis-server-1:
+    image: falkordb/falkordb:latest
+    hostname: redis-server-1
+    container_name: redis-server-1
+    ports:
+      - 6380:6380
+    networks:
+      - redis-sentinel
+    environment:
+      REDIS_ARGS:  "--port 6380 --replica-announce-ip redis-server-1 --replica-announce-port 6380"
+      BROWSER: 0
+
+
+  redis-server-2:
+    image: falkordb/falkordb:latest
+    hostname: redis-server-2
+    container_name: redis-server-2
+    ports:
+      - 6381:6381
+    networks:
+      - redis-sentinel
+    environment:
+      REDIS_ARGS:  "--port 6381 --replica-announce-ip redis-server-2 --replica-announce-port 6381 --replicaof redis-server-1 6380"
+      BROWSER: 0
+
+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

@@ -227,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:
+                    return replica_hostnames
+                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:
+                    return data
+                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.