Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add modules ACL support #3102

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion src/main/java/io/lettuce/core/AclCategory.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Original file line number Diff line number Diff line change
Expand Up @@ -95,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);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
/*
* 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.TestSupport;
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 java.util.Arrays;

import static io.lettuce.TestTags.INTEGRATION_TEST;
import static org.assertj.core.api.Assertions.assertThat;

/**
* 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<String, String> redis;

@Inject
protected ConsolidatedAclCommandIntegrationTests(RedisCommands<String, String> 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();
}

}
Loading