Add support for ACL DRYRUN command #1992

redis · Jul 1, 2022 · 6e5018b · 6e5018b
1 parent b46dfd5
commit 6e5018b
Show file tree

Hide file tree

Showing 13 changed files with 107 additions and 1 deletion.
diff --git a/src/main/java/io/lettuce/core/AbstractRedisAsyncCommands.java b/src/main/java/io/lettuce/core/AbstractRedisAsyncCommands.java
@@ -95,6 +95,11 @@ public RedisFuture<Long> aclDeluser(String... usernames) {
         return dispatch(commandBuilder.aclDeluser(usernames));
     }
 
+    @Override
+    public RedisFuture<String> aclDryRun(String username, String command, V... args) {
+        return dispatch(commandBuilder.aclDryRun(username, command, args));
+    }
+
     @Override
     public RedisFuture<String> aclGenpass() {
         return dispatch(commandBuilder.aclGenpass());

diff --git a/src/main/java/io/lettuce/core/AbstractRedisReactiveCommands.java b/src/main/java/io/lettuce/core/AbstractRedisReactiveCommands.java
@@ -127,6 +127,11 @@ public Mono<Long> aclDeluser(String... usernames) {
         return createMono(() -> commandBuilder.aclDeluser(usernames));
     }
 
+    @Override
+    public Mono<String> aclDryRun(String username, String command, V... args) {
+        return createMono(() -> commandBuilder.aclDryRun(username, command, args));
+    }
+
     @Override
     public Mono<String> aclGenpass() {
         return createMono(commandBuilder::aclGenpass);

diff --git a/src/main/java/io/lettuce/core/RedisCommandBuilder.java b/src/main/java/io/lettuce/core/RedisCommandBuilder.java
@@ -93,6 +93,15 @@ Command<K, V, Long> aclDeluser(String... usernames) {
         return createCommand(ACL, new IntegerOutput<>(codec), args);
     }
 
+    Command<K, V, String> aclDryRun(String username, String command, V... commandArgs) {
+        LettuceAssert.notNull(username, "username " + MUST_NOT_BE_NULL);
+        LettuceAssert.notNull(command, "command " + MUST_NOT_BE_NULL);
+
+        CommandArgs<K, V> args = new CommandArgs<>(codec);
+        args.add(DRYRUN).add(username).add(command).addValues(commandArgs);
+        return createCommand(ACL, new StatusOutput<>(codec), args);
+    }
+
     Command<K, V, String> aclGenpass() {
         CommandArgs<K, V> args = new CommandArgs<>(codec);
         args.add(GENPASS);

diff --git a/src/main/java/io/lettuce/core/api/async/RedisAclAsyncCommands.java b/src/main/java/io/lettuce/core/api/async/RedisAclAsyncCommands.java
@@ -56,6 +56,17 @@ public interface RedisAclAsyncCommands<K, V> {
      */
     RedisFuture<Long> aclDeluser(String... usernames);
 
+    /**
+     * Simulate the execution of a given command by a given user.
+     *
+     * @param username the specified username
+     * @param command the specified command
+     * @param args the specified args of command
+     * @return String reply: OK on success.
+     * @since 6.2
+     */
+    RedisFuture<String> aclDryRun(String username, String command, V... args);
+
     /**
      * The command generates a password.
      *

diff --git a/src/main/java/io/lettuce/core/api/reactive/RedisAclReactiveCommands.java b/src/main/java/io/lettuce/core/api/reactive/RedisAclReactiveCommands.java
@@ -57,6 +57,17 @@ public interface RedisAclReactiveCommands<K, V> {
      */
     Mono<Long> aclDeluser(String... usernames);
 
+    /**
+     * Simulate the execution of a given command by a given user.
+     *
+     * @param username the specified username
+     * @param command the specified command
+     * @param args the specified args of command
+     * @return String reply: OK on success.
+     * @since 6.2
+     */
+    Mono<String> aclDryRun(String username, String command, V... args);
+
     /**
      * The command generates a password.
      *

diff --git a/src/main/java/io/lettuce/core/api/sync/RedisAclCommands.java b/src/main/java/io/lettuce/core/api/sync/RedisAclCommands.java
@@ -55,6 +55,17 @@ public interface RedisAclCommands<K, V> {
      */
     Long aclDeluser(String... usernames);
 
+    /**
+     * Simulate the execution of a given command by a given user.
+     *
+     * @param username the specified username
+     * @param command the specified command
+     * @param args the specified args of command
+     * @return String reply: OK on success.
+     * @since 6.2
+     */
+    String aclDryRun(String username, String command, V... args);
+
     /**
      * The command generates a password.
      *

diff --git a/src/main/java/io/lettuce/core/cluster/api/async/NodeSelectionAclAsyncCommands.java b/src/main/java/io/lettuce/core/cluster/api/async/NodeSelectionAclAsyncCommands.java
@@ -55,6 +55,17 @@ public interface NodeSelectionAclAsyncCommands<K, V> {
      */
     AsyncExecutions<Long> aclDeluser(String... usernames);
 
+    /**
+     * Simulate the execution of a given command by a given user.
+     *
+     * @param username the specified username
+     * @param command the specified command
+     * @param args the specified args of command
+     * @return String reply: OK on success.
+     * @since 6.2
+     */
+    AsyncExecutions<String> aclDryRun(String username, String command, V... args);
+
     /**
      * The command generates a password.
      *

diff --git a/src/main/java/io/lettuce/core/cluster/api/sync/NodeSelectionAclCommands.java b/src/main/java/io/lettuce/core/cluster/api/sync/NodeSelectionAclCommands.java
@@ -55,6 +55,17 @@ public interface NodeSelectionAclCommands<K, V> {
      */
     Executions<Long> aclDeluser(String... usernames);
 
+    /**
+     * Simulate the execution of a given command by a given user.
+     *
+     * @param username the specified username
+     * @param command the specified command
+     * @param args the specified args of command
+     * @return String reply: OK on success.
+     * @since 6.2
+     */
+    Executions<String> aclDryRun(String username, String command, V... args);
+
     /**
      * The command generates a password.
      *

diff --git a/src/main/java/io/lettuce/core/protocol/CommandKeyword.java b/src/main/java/io/lettuce/core/protocol/CommandKeyword.java
@@ -29,7 +29,7 @@ public enum CommandKeyword implements ProtocolKeyword {
 
     ABSTTL, ADDR, ADDSLOTS, ADDSLOTSRANGE, AFTER, AGGREGATE, ALLCHANNELS, ALLCOMMANDS, ALLKEYS, ALPHA, AND, ASK, ASC, ASYNC, BEFORE, BLOCK, BUMPEPOCH,
 
-    BY, BYLEX, BYSCORE, CACHING, CAT, CH, CHANNELS, COPY, COUNT, COUNTKEYSINSLOT, CONSUMERS, CREATE, DB, DELSLOTS, DELSLOTSRANGE, DELUSER, DESC, SOFT, HARD, ENCODING,
+    BY, BYLEX, BYSCORE, CACHING, CAT, CH, CHANNELS, COPY, COUNT, COUNTKEYSINSLOT, CONSUMERS, CREATE, DB, DELSLOTS, DELSLOTSRANGE, DELUSER, DESC, DRYRUN, SOFT, HARD, ENCODING,
 
     FAILOVER, FORGET, FLUSH, FORCE, FREQ, FLUSHSLOTS, GENPASS, GETNAME, GETUSER, GETKEYSINSLOT, GETREDIR, GROUP, GROUPS, HTSTATS, ID, IDLE,
 

diff --git a/src/main/kotlin/io/lettuce/core/api/coroutines/RedisAclCoroutinesCommands.kt b/src/main/kotlin/io/lettuce/core/api/coroutines/RedisAclCoroutinesCommands.kt
@@ -55,6 +55,17 @@ interface RedisAclCoroutinesCommands<K : Any, V : Any> {
      */
     suspend fun aclDeluser(vararg usernames: String): Long?
 
+    /**
+     * Simulate the execution of a given command by a given user.
+     *
+     * @param username the specified username
+     * @param command the specified command
+     * @param args the specified args of command
+     * @return String reply: OK on success.
+     * @since 6.2
+     */
+    suspend fun aclDryRun(username: String, command: String, vararg args: V): String?
+
     /**
      * The command generates a password.
      *

diff --git a/src/main/kotlin/io/lettuce/core/api/coroutines/RedisAclCoroutinesCommandsImpl.kt b/src/main/kotlin/io/lettuce/core/api/coroutines/RedisAclCoroutinesCommandsImpl.kt
@@ -47,6 +47,8 @@ internal class RedisAclCoroutinesCommandsImpl<K : Any, V : Any>(internal val ops
 
     override suspend fun aclDeluser(vararg usernames: String): Long? = ops.aclDeluser(*usernames).awaitFirstOrNull()
 
+    override suspend fun aclDryRun(username: String, command: String, vararg args: V): String? = ops.aclDryRun(username, command, *args).awaitFirstOrNull()
+
     override suspend fun aclGenpass(): String? = ops.aclGenpass().awaitFirstOrNull()
 
     override suspend fun aclGenpass(bits: Int): String? = ops.aclGenpass(bits).awaitFirstOrNull()

diff --git a/src/main/templates/io/lettuce/core/api/RedisAclCommands.java b/src/main/templates/io/lettuce/core/api/RedisAclCommands.java
@@ -53,6 +53,17 @@ public interface RedisAclCommands<K, V> {
      */
     Long aclDeluser(String... usernames);
 
+    /**
+     * Simulate the execution of a given command by a given user.
+     *
+     * @param username the specified username
+     * @param command the specified command
+     * @param args the specified args of command
+     * @return String reply: OK on success.
+     * @since 6.2
+     */
+    String aclDryRun(String username, String command, V... args);
+
     /**
      * The command generates a password.
      *

diff --git a/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java b/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java
@@ -69,6 +69,14 @@ void aclDeluser() {
         assertThat(redis.aclDeluser("non-existing")).isZero();
     }
 
+    @Test
+    @EnabledOnCommand("EVAL_RO")    // Redis 7.0
+    void aclDryRun() {
+        assertThatThrownBy(() -> redis.aclDryRun("non-existing", "GET", "foo", "bar"))
+                .isInstanceOf(RedisCommandExecutionException.class).hasMessageContaining("ERR User 'non-existing' not found");
+        assertThat(redis.aclDryRun("default", "GET", "foo", "bar")).isEqualTo("OK");
+    }
+
     @Test
     void aclGenpass() {
         assertThat(redis.aclGenpass()).hasSize(64);