Add support for ACL SAVE/LOAD commands (#2418)

* Add support for ACL SAVE/LOAD commands * review * Apply suggestions from code review Co-authored-by: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com>
redis · Mar 11, 2021 · 50e03eb · 50e03eb
1 parent c60fd53
commit 50e03eb
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 3 deletions.
diff --git a/src/main/java/redis/clients/jedis/BinaryClient.java b/src/main/java/redis/clients/jedis/BinaryClient.java
@@ -1467,6 +1467,14 @@ public void aclDelUser(final byte[] name) {
     sendCommand(ACL, Keyword.DELUSER.getRaw(), name);
   }
 
+  public void aclLoad() {
+    sendCommand(ACL, Keyword.LOAD.getRaw());
+  }
+
+  public void aclSave() {
+    sendCommand(ACL, Keyword.SAVE.getRaw());
+  }
+
   private List<byte[]> convertGeoCoordinateMapToByteArrays(
       final Map<byte[], GeoCoordinate> memberCoordinateMap) {
     List<byte[]> args = new ArrayList<>(memberCoordinateMap.size() * 3);

diff --git a/src/main/java/redis/clients/jedis/BinaryJedis.java b/src/main/java/redis/clients/jedis/BinaryJedis.java
@@ -3947,6 +3947,20 @@ public byte[] aclLog(byte[] options) {
     return client.getBinaryBulkReply();
   }
 
+  @Override
+  public String aclLoad() {
+    checkIsInMultiOrPipeline();
+    client.aclLoad();
+    return client.getStatusCodeReply();
+  }
+
+  @Override
+  public String aclSave() {
+    checkIsInMultiOrPipeline();
+    client.aclSave();
+    return client.getStatusCodeReply();
+  }
+
   @Override
   public String clientKill(final byte[] ipPort) {
     checkIsInMultiOrPipeline();

diff --git a/src/main/java/redis/clients/jedis/Jedis.java b/src/main/java/redis/clients/jedis/Jedis.java
@@ -3908,6 +3908,20 @@ public String aclGenPass() {
     return client.getStatusCodeReply();
   }
 
+  @Override
+  public String aclLoad() {
+    checkIsInMultiOrPipeline();
+    client.aclLoad();
+    return client.getStatusCodeReply();
+  }
+
+  @Override
+  public String aclSave() {
+    checkIsInMultiOrPipeline();
+    client.aclSave();
+    return client.getStatusCodeReply();
+  }
+
   @Override
   public List<Long> bitfield(final String key, final String... arguments) {
     checkIsInMultiOrPipeline();

diff --git a/src/main/java/redis/clients/jedis/Protocol.java b/src/main/java/redis/clients/jedis/Protocol.java
@@ -282,7 +282,7 @@ public static enum Keyword {
     GETNAME, SETNAME, LIST, MATCH, COUNT, PING, PONG, UNLOAD, REPLACE, KEYS, PAUSE, DOCTOR, BLOCK,
     NOACK, STREAMS, KEY, CREATE, MKSTREAM, SETID, DESTROY, DELCONSUMER, MAXLEN, GROUP, ID, IDLE,
     TIME, RETRYCOUNT, FORCE, USAGE, SAMPLES, STREAM, GROUPS, CONSUMERS, HELP, FREQ, SETUSER,
-    GETUSER, DELUSER, WHOAMI, CAT, GENPASS, USERS, LOG, INCR;
+    GETUSER, DELUSER, WHOAMI, CAT, GENPASS, USERS, LOG, INCR, SAVE;
 
     /**
      * @deprecated This will be private in future. Use {@link #getRaw()}.

diff --git a/src/main/java/redis/clients/jedis/commands/AdvancedBinaryJedisCommands.java b/src/main/java/redis/clients/jedis/commands/AdvancedBinaryJedisCommands.java
@@ -81,5 +81,7 @@ String migrate(String host, int port, int destinationDB, int timeout, MigratePar
 
   byte[] aclLog(byte[] options);
 
-  // TODO: Implements ACL LOAD/SAVE commands
+  String aclLoad();
+
+  String aclSave();
 }
diff --git a/src/main/java/redis/clients/jedis/commands/AdvancedJedisCommands.java b/src/main/java/redis/clients/jedis/commands/AdvancedJedisCommands.java
@@ -82,5 +82,7 @@ String migrate(String host, int port, int destinationDB, int timeout, MigratePar
 
   String aclLog(String options);
 
-  // TODO: Implements ACL LOAD/SAVE commands
+  String aclLoad();
+
+  String aclSave();
 }
diff --git a/src/test/java/redis/clients/jedis/tests/commands/AccessControlListCommandsTest.java b/src/test/java/redis/clients/jedis/tests/commands/AccessControlListCommandsTest.java
@@ -11,6 +11,7 @@
 import redis.clients.jedis.Jedis;
 import redis.clients.jedis.Transaction;
 import redis.clients.jedis.exceptions.JedisAccessControlException;
+import redis.clients.jedis.exceptions.JedisDataException;
 import redis.clients.jedis.tests.utils.RedisVersionUtil;
 import redis.clients.jedis.util.SafeEncoder;
 
@@ -458,4 +459,27 @@ public void aclBinaryCommandsTest() {
     jedis.aclDelUser(USER_ZZZ.getBytes());
   }
 
+  @Test
+  public void aclLoadTest() {
+    try {
+      jedis.aclLoad();
+      fail("Should throw a JedisDataException: ERR This Redis instance is not configured to use an ACL file...");
+    } catch (JedisDataException e) {
+      assertTrue(e.getMessage().contains("ERR This Redis instance is not configured to use an ACL file."));
+    }
+
+    // TODO test with ACL file
+  }
+
+  @Test
+  public void aclSaveTest() {
+    try {
+      jedis.aclSave();
+      fail("Should throw a JedisDataException: ERR This Redis instance is not configured to use an ACL file...");
+    } catch (JedisDataException e) {
+      assertTrue(e.getMessage().contains("ERR This Redis instance is not configured to use an ACL file."));
+    }
+
+    // TODO test with ACL file
+  }
 }