From 2c83186c12c29dcd72c537592c79b1d12a167758 Mon Sep 17 00:00:00 2001 From: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com> Date: Thu, 26 Dec 2024 16:23:04 +0600 Subject: [PATCH 1/6] Test HASH module ACL support --- .../lettuce/core/models/command/CommandDetailParser.java | 1 + .../core/commands/AclCommandIntegrationTests.java | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java b/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java index 0f4c03325c..695c8cbecf 100644 --- a/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java +++ b/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java @@ -86,6 +86,7 @@ public class CommandDetailParser { aclCategoriesMap.put("@hyperloglog", AclCategory.HYPERLOGLOG); aclCategoriesMap.put("@geo", AclCategory.GEO); aclCategoriesMap.put("@stream", AclCategory.STREAM); + // TODO: aclCategoriesMap.put("@pubsub", AclCategory.PUBSUB); aclCategoriesMap.put("@admin", AclCategory.ADMIN); aclCategoriesMap.put("@fast", AclCategory.FAST); diff --git a/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java b/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java index 7fbeb7cf9f..439dd99480 100644 --- a/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java +++ b/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java @@ -169,4 +169,13 @@ void aclWhoami() { assertThat(redis.aclWhoami()).isEqualTo("default"); } + @Test + void aclHashCommands() { + assertThat(redis.aclDeluser("foo")).isNotNull(); + AclSetuserArgs args = AclSetuserArgs.Builder.on().addCategory(AclCategory.HASH); + assertThat(redis.aclSetuser("foo", args)).isEqualTo("OK"); + assertThat(redis.aclGetuser("foo")).contains("-@all +@hash"); + assertThat(redis.aclDeluser("foo")).isNotNull(); + } + } From 65531d9ffabe4e1c0e8cf0d8464f7ab8032da807 Mon Sep 17 00:00:00 2001 From: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com> Date: Thu, 23 Jan 2025 23:30:03 +0600 Subject: [PATCH 2/6] Support consolidated CONFIG according to design doc with Redis 8.0-M03 --- .../java/io/lettuce/core/AclCategory.java | 42 +++++- .../models/command/CommandDetailParser.java | 10 +- .../commands/AclCommandIntegrationTests.java | 9 -- ...onsolidatedAclCommandIntegrationTests.java | 127 ++++++++++++++++++ 4 files changed, 177 insertions(+), 11 deletions(-) create mode 100644 src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java diff --git a/src/main/java/io/lettuce/core/AclCategory.java b/src/main/java/io/lettuce/core/AclCategory.java index db4066d6b3..bc04372fca 100644 --- a/src/main/java/io/lettuce/core/AclCategory.java +++ b/src/main/java/io/lettuce/core/AclCategory.java @@ -111,5 +111,45 @@ public enum AclCategory { /** * scripting command */ - SCRIPTING + SCRIPTING, + + /** + * bloom command + */ + BLOOM, + + /** + * cuckoo command + */ + CUCKOO, + + /** + * count-min-sketch command + */ + CMS, + + /** + * top-k command + */ + TOPK, + + /** + * t-digest command + */ + TDIGEST, + + /** + * search command + */ + SEARCH, + + /** + * timeseries command + */ + TIMESERIES, + + /** + * json command + */ + JSON } diff --git a/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java b/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java index 695c8cbecf..5dcd3a2b46 100644 --- a/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java +++ b/src/main/java/io/lettuce/core/models/command/CommandDetailParser.java @@ -86,7 +86,6 @@ public class CommandDetailParser { aclCategoriesMap.put("@hyperloglog", AclCategory.HYPERLOGLOG); aclCategoriesMap.put("@geo", AclCategory.GEO); aclCategoriesMap.put("@stream", AclCategory.STREAM); - // TODO: aclCategoriesMap.put("@pubsub", AclCategory.PUBSUB); aclCategoriesMap.put("@admin", AclCategory.ADMIN); aclCategoriesMap.put("@fast", AclCategory.FAST); @@ -96,6 +95,15 @@ public class CommandDetailParser { aclCategoriesMap.put("@connection", AclCategory.CONNECTION); aclCategoriesMap.put("@transaction", AclCategory.TRANSACTION); aclCategoriesMap.put("@scripting", AclCategory.SCRIPTING); + aclCategoriesMap.put("@bloom", AclCategory.BLOOM); + aclCategoriesMap.put("@cuckoo", AclCategory.CUCKOO); + aclCategoriesMap.put("@cms", AclCategory.CMS); + aclCategoriesMap.put("@topk", AclCategory.TOPK); + aclCategoriesMap.put("@tdigest", AclCategory.TDIGEST); + aclCategoriesMap.put("@search", AclCategory.SEARCH); + aclCategoriesMap.put("@timeseries", AclCategory.TIMESERIES); + aclCategoriesMap.put("@json", AclCategory.JSON); + ACL_CATEGORY_MAPPING = Collections.unmodifiableMap(aclCategoriesMap); } diff --git a/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java b/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java index f8b1ec1226..4d154dc0f7 100644 --- a/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java +++ b/src/test/java/io/lettuce/core/commands/AclCommandIntegrationTests.java @@ -169,13 +169,4 @@ void aclWhoami() { assertThat(redis.aclWhoami()).isEqualTo("default"); } - @Test - void aclHashCommands() { - assertThat(redis.aclDeluser("foo")).isNotNull(); - AclSetuserArgs args = AclSetuserArgs.Builder.on().addCategory(AclCategory.HASH); - assertThat(redis.aclSetuser("foo", args)).isEqualTo("OK"); - assertThat(redis.aclGetuser("foo")).contains("-@all +@hash"); - assertThat(redis.aclDeluser("foo")).isNotNull(); - } - } diff --git a/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java new file mode 100644 index 0000000000..216f70a651 --- /dev/null +++ b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java @@ -0,0 +1,127 @@ +/* + * Copyright 2011-Present, Redis Ltd. and Contributors + * All rights reserved. + * + * Licensed under the MIT License. + * + * This file contains contributions from third-party contributors + * licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package io.lettuce.core.commands; + +import io.lettuce.core.AclCategory; +import io.lettuce.core.AclSetuserArgs; +import io.lettuce.core.RedisCommandExecutionException; +import io.lettuce.core.TestSupport; +import io.lettuce.core.api.sync.RedisCommands; +import io.lettuce.core.codec.StringCodec; +import io.lettuce.core.output.StatusOutput; +import io.lettuce.core.protocol.Command; +import io.lettuce.core.protocol.CommandArgs; +import io.lettuce.core.protocol.CommandType; +import io.lettuce.test.LettuceExtension; +import io.lettuce.test.condition.EnabledOnCommand; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Tag; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.TestInstance; +import org.junit.jupiter.api.extension.ExtendWith; + +import javax.inject.Inject; + +import java.util.Arrays; + +import static io.lettuce.TestTags.INTEGRATION_TEST; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +/** + * Integration tests for ACL commands with Redis modules since Redis 8.0. + * + * @author M Sazzadul Hoque + */ +@Tag(INTEGRATION_TEST) +@ExtendWith(LettuceExtension.class) +@TestInstance(TestInstance.Lifecycle.PER_CLASS) +@EnabledOnCommand("ACL") +public class ConsolidatedAclCommandIntegrationTests extends TestSupport { + + private final RedisCommands redis; + + @Inject + protected ConsolidatedAclCommandIntegrationTests(RedisCommands redis) { + this.redis = redis; + } + + @BeforeEach + void setUp() { + redis.flushall(); + redis.aclUsers().stream().filter(o -> !"default".equals(o)).forEach(redis::aclDeluser); + redis.aclLogReset(); + } + + @Test + public void listACLCategoriesTest() { + assertThat(redis.aclCat()).containsAll(Arrays.asList(AclCategory.BLOOM, AclCategory.CUCKOO, AclCategory.CMS, + AclCategory.TOPK, AclCategory.TDIGEST, AclCategory.SEARCH, AclCategory.TIMESERIES, AclCategory.JSON)); + } + + @Test + void grantBloomCommandCatTest() { + grantModuleCommandCatTest(AclCategory.BLOOM, "bloom"); + } + + @Test + void grantCuckooCommandCatTest() { + grantModuleCommandCatTest(AclCategory.CUCKOO, "cuckoo"); + } + + @Test + void grantCmsCommandCatTest() { + grantModuleCommandCatTest(AclCategory.CMS, "cms"); + } + + @Test + void grantTopkCommandCatTest() { + grantModuleCommandCatTest(AclCategory.TOPK, "topk"); + } + + @Test + void grantTdigestCommandCatTest() { + grantModuleCommandCatTest(AclCategory.TDIGEST, "tdigest"); + } + + @Test + void grantSearchCommandCatTest() { + grantModuleCommandCatTest(AclCategory.SEARCH, "search"); + } + + @Test + void grantTimeseriesCommandCatTest() { + grantModuleCommandCatTest(AclCategory.TIMESERIES, "timeseries"); + } + + @Test + void grantJsonCommandCatTest() { + grantModuleCommandCatTest(AclCategory.JSON, "json"); + } + + private void grantModuleCommandCatTest(AclCategory category, String categoryStr) { + assertThat(redis.aclDeluser("foo")).isNotNull(); + AclSetuserArgs args = AclSetuserArgs.Builder.on().addCategory(category); + assertThat(redis.aclSetuser("foo", args)).isEqualTo("OK"); + assertThat(redis.aclGetuser("foo")).contains("-@all +@" + categoryStr); + assertThat(redis.aclDeluser("foo")).isNotNull(); + } + +} From 1259913da0591ce6239a21b6aaf7dbb554f1d546 Mon Sep 17 00:00:00 2001 From: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com> Date: Thu, 23 Jan 2025 23:31:43 +0600 Subject: [PATCH 3/6] format imports --- .../commands/ConsolidatedAclCommandIntegrationTests.java | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java index 216f70a651..26484177d1 100644 --- a/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java +++ b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java @@ -21,16 +21,11 @@ import io.lettuce.core.AclCategory; import io.lettuce.core.AclSetuserArgs; -import io.lettuce.core.RedisCommandExecutionException; import io.lettuce.core.TestSupport; import io.lettuce.core.api.sync.RedisCommands; -import io.lettuce.core.codec.StringCodec; -import io.lettuce.core.output.StatusOutput; -import io.lettuce.core.protocol.Command; -import io.lettuce.core.protocol.CommandArgs; -import io.lettuce.core.protocol.CommandType; import io.lettuce.test.LettuceExtension; import io.lettuce.test.condition.EnabledOnCommand; + import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Tag; import org.junit.jupiter.api.Test; @@ -43,7 +38,6 @@ import static io.lettuce.TestTags.INTEGRATION_TEST; import static org.assertj.core.api.Assertions.assertThat; -import static org.assertj.core.api.Assertions.assertThatThrownBy; /** * Integration tests for ACL commands with Redis modules since Redis 8.0. From 83903a85119d14f71b263ad72909b7860f760c9c Mon Sep 17 00:00:00 2001 From: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com> Date: Wed, 29 Jan 2025 15:44:09 +0600 Subject: [PATCH 4/6] Based on RedisContainerIntegrationTests --- ...onsolidatedAclCommandIntegrationTests.java | 39 +++++++++---------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java index 26484177d1..0db7af94de 100644 --- a/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java +++ b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java @@ -19,20 +19,10 @@ */ package io.lettuce.core.commands; -import io.lettuce.core.AclCategory; -import io.lettuce.core.AclSetuserArgs; -import io.lettuce.core.TestSupport; +import io.lettuce.core.*; import io.lettuce.core.api.sync.RedisCommands; -import io.lettuce.test.LettuceExtension; -import io.lettuce.test.condition.EnabledOnCommand; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Tag; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.TestInstance; -import org.junit.jupiter.api.extension.ExtendWith; - -import javax.inject.Inject; +import org.junit.jupiter.api.*; import java.util.Arrays; @@ -45,16 +35,25 @@ * @author M Sazzadul Hoque */ @Tag(INTEGRATION_TEST) -@ExtendWith(LettuceExtension.class) -@TestInstance(TestInstance.Lifecycle.PER_CLASS) -@EnabledOnCommand("ACL") -public class ConsolidatedAclCommandIntegrationTests extends TestSupport { +public class ConsolidatedAclCommandIntegrationTests extends RedisContainerIntegrationTests { + + private static RedisClient client; + + private static RedisCommands redis; - private final RedisCommands redis; + @BeforeAll + public static void setup() { + RedisURI redisURI = RedisURI.Builder.redis("127.0.0.1").withPort(16379).build(); + + client = RedisClient.create(redisURI); + redis = client.connect().sync(); + } - @Inject - protected ConsolidatedAclCommandIntegrationTests(RedisCommands redis) { - this.redis = redis; + @AfterAll + static void teardown() { + if (client != null) { + client.shutdown(); + } } @BeforeEach From 85e947b2520c81f1f8c0a4ad3ce29169a88fc523 Mon Sep 17 00:00:00 2001 From: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com> Date: Wed, 29 Jan 2025 15:55:41 +0600 Subject: [PATCH 5/6] Use 8.0-M04-pre image --- .github/workflows/integration.yml | 6 +++--- .../io/lettuce/core/RedisContainerIntegrationTests.java | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index 9f061d0cdb..80a807f64a 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -19,10 +19,10 @@ on: redis_version: description: "Redis stack version to use for testing" required: false - default: "8.0-M02" + default: "8.0-M04-pre" type: choice options: - - "8.0-M02" + - "8.0-M04-pre" - "rs-7.4.0-v1" - "rs-7.2.0-v13" @@ -61,7 +61,7 @@ jobs: run: | make test-coverage env: - REDIS_STACK_VERSION: ${{ inputs.redis_version || '8.0-M02' }} + REDIS_STACK_VERSION: ${{ inputs.redis_version || '8.0-M04-pre' }} JVM_OPTS: -Xmx3200m TERM: dumb - name: Upload coverage reports to Codecov diff --git a/src/test/java/io/lettuce/core/RedisContainerIntegrationTests.java b/src/test/java/io/lettuce/core/RedisContainerIntegrationTests.java index 5eda44ffd9..f276e37ee8 100644 --- a/src/test/java/io/lettuce/core/RedisContainerIntegrationTests.java +++ b/src/test/java/io/lettuce/core/RedisContainerIntegrationTests.java @@ -26,7 +26,7 @@ public class RedisContainerIntegrationTests { private static final String REDIS_STACK_CLUSTER = "clustered-stack"; - private static final String REDIS_STACK_VERSION = System.getProperty("REDIS_STACK_VERSION", "8.0-M02");; + private static final String REDIS_STACK_VERSION = System.getProperty("REDIS_STACK_VERSION", "8.0-M04-pre");; private static Exception initializationException; From 9d94206cf3b3229132ccdded6c89f4d13cad0a28 Mon Sep 17 00:00:00 2001 From: M Sazzadul Hoque <7600764+sazzad16@users.noreply.github.com> Date: Wed, 29 Jan 2025 19:42:19 +0600 Subject: [PATCH 6/6] add version condition --- .../core/commands/ConsolidatedAclCommandIntegrationTests.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java index 0db7af94de..f0519af54e 100644 --- a/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java +++ b/src/test/java/io/lettuce/core/commands/ConsolidatedAclCommandIntegrationTests.java @@ -22,12 +22,14 @@ import io.lettuce.core.*; import io.lettuce.core.api.sync.RedisCommands; +import io.lettuce.test.condition.RedisConditions; import org.junit.jupiter.api.*; import java.util.Arrays; import static io.lettuce.TestTags.INTEGRATION_TEST; import static org.assertj.core.api.Assertions.assertThat; +import static org.junit.jupiter.api.Assumptions.assumeTrue; /** * Integration tests for ACL commands with Redis modules since Redis 8.0. @@ -47,6 +49,7 @@ public static void setup() { client = RedisClient.create(redisURI); redis = client.connect().sync(); + assumeTrue(RedisConditions.of(redis).hasVersionGreaterOrEqualsTo("7.9")); } @AfterAll