feat: add password and timeout configuration for connecting to redis (#20)

* feat: add password and timeout configuration for connecting to redis

Signed-off-by: “seriouszyx” <[email protected]>

* docs: add timeout and password configuration example

Signed-off-by: “seriouszyx” <[email protected]>

Author: seriouszyx

.github/workflows/maven-ci.yml

@@ -9,13 +9,22 @@ jobs:
       redis:
         image: redis
         ports:
-          - 6379:6379
+          - 6378:6378
+
     steps:
       - name: Checkout
         uses: actions/checkout@v2
         with:
           fetch-depth: '0'
 
+      - name: Set up Redis with password
+        uses: getong/redis-action@v1
+        with:
+          redis version: 'latest'
+          host port: 6379
+          container port: 6379
+          redis password: 'foobared'
+
       - name: Set up JDK 1.8
         uses: actions/setup-java@v1
         with:

README.md

@@ -3,10 +3,10 @@ Redis Watcher
 
 [![GitHub Actions](https://github.com/jcasbin/redis-watcher/actions/workflows/maven-ci.yml/badge.svg)](https://github.com/jcasbin/redis-watcher/actions/workflows/maven-ci.yml)
 ![License](https://img.shields.io/github/license/jcasbin/redis-watcher)
-[![Javadoc](https://javadoc.io/badge2/org.casbin/redis-watcher/javadoc.svg)](https://javadoc.io/doc/org.casbin/redis-watcher)
+[![Javadoc](https://javadoc.io/badge2/org.casbin/jcasbin-redis-watcher/javadoc.svg)](https://javadoc.io/doc/org.casbin/jcasbin-redis-watcher)
 [![codecov](https://codecov.io/gh/jcasbin/redis-watcher/branch/master/graph/badge.svg?token=ENt9xr4nFg)](https://codecov.io/gh/jcasbin/redis-watcher)
 [![codebeat badge](https://codebeat.co/badges/8b3da1c4-3a61-4123-a3d4-002b2598a297)](https://codebeat.co/projects/github-com-jcasbin-redis-watcher-master)
-[![Maven Central](https://img.shields.io/maven-central/v/org.casbin/redis-watcher.svg)](https://mvnrepository.com/artifact/org.casbin/redis-watcher/latest)
+[![Maven Central](https://img.shields.io/maven-central/v/org.casbin/jcasbin-redis-watcher.svg)](https://mvnrepository.com/artifact/org.casbin/jcasbin-redis-watcher/latest)
 [![Release](https://img.shields.io/github/release/jcasbin/redis-watcher.svg)](https://github.com/jcasbin/redis-watcher/releases/latest)
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/casbin/lobby)
 
@@ -40,6 +40,8 @@ if you have two casbin instances A and B
 ```java
 String redisTopic="jcasbin-topic";
 RedisWatcher redisWatcher = new RedisWatcher("127.0.0.1",6379, redisTopic);
+// Support for connecting to redis with timeout and password
+// RedisWatcher redisWatcher = new RedisWatcher("127.0.0.1",6379, redisTopic, 2000, "foobared");
 
 Enforcer enforcer = new SyncedEnforcer("examples/rbac_model.conf", "examples/rbac_policy.csv");
 enforcer.setWatcher(redisWatcher);

src/main/java/org/casbin/watcher/RedisWatcher.java

@@ -15,13 +15,17 @@ public class RedisWatcher implements Watcher {
     private final String redisChannelName;
     private SubThread subThread;
 
-    public RedisWatcher(String redisIp, int redisPort,String redisChannelName){
-        this.jedisPool = new JedisPool(new JedisPoolConfig(), redisIp, redisPort);
+    public RedisWatcher(String redisIp, int redisPort, String redisChannelName, int timeout, String password) {
+        this.jedisPool = new JedisPool(new JedisPoolConfig(), redisIp, redisPort, timeout, password);
         this.localId = UUID.randomUUID().toString();
-        this.redisChannelName=redisChannelName;
+        this.redisChannelName = redisChannelName;
         startSub();
     }
 
+    public RedisWatcher(String redisIp, int redisPort, String redisChannelName) {
+        this(redisIp, redisPort, redisChannelName, 2000, (String)null);
+    }
+
     @Override
     public void setUpdateCallback(Runnable runnable) {
         this.updateCallback=runnable;

src/test/java/org/casbin/test/RedisWatcherTest.java

@@ -12,10 +12,13 @@ public class RedisWatcherTest {
     private RedisWatcher redisWatcher;
     private final String expect="update msg";
 
+    /**
+     * You should replace the initWatcher() method's content with your own Redis instance.
+     */
     @Before
     public void initWatcher(){
         String redisTopic = "jcasbin-topic";
-        redisWatcher = new RedisWatcher("127.0.0.1",6379, redisTopic);
+        redisWatcher = new RedisWatcher("127.0.0.1",6379, redisTopic, 2000, "foobared");
         Enforcer enforcer = new Enforcer();
         enforcer.setWatcher(redisWatcher);
     }
@@ -38,4 +41,11 @@ public void testConsumerCallback() throws InterruptedException {
         redisWatcher.update();
         Thread.sleep(100);
     }
+
+    @Test
+    public void testConnectWatcherWithoutPassword() {
+        String redisTopic = "jcasbin-topic";
+        RedisWatcher redisWatcherWithoutPassword = new RedisWatcher("127.0.0.1", 6378, redisTopic);
+        Assert.assertNotNull(redisWatcherWithoutPassword);
+    }
 }