Skip to content

Refactor stream option conversion tests for Lettuce #3280

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.

Sign up for GitHub

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

Open
Jimin730 wants to merge 2 commits into
base: main
Choose a base branch
from
+127 −144
Open

Refactor stream option conversion tests for Lettuce #3280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1950f55
test: simplify LettuceConnectionUnitTests to verify option delegation…
Jimin730 Dec 16, 2025
312b9ba
test: add StreamConvertersUnitTests for Lettuce stream options (#3276)
Jimin730 Dec 16, 2025
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
156 changes: 12 additions & 144 deletions ...st/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionUnitTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,11 @@
import org.springframework.dao.InvalidDataAccessResourceUsageException;
import org.springframework.data.redis.connection.AbstractConnectionUnitTestBase;
import org.springframework.data.redis.connection.RedisServerCommands.ShutdownOption;
import org.springframework.data.redis.connection.RedisStreamCommands;
import org.springframework.data.redis.connection.RedisStreamCommands.TrimOptions;
import org.springframework.data.redis.connection.RedisStreamCommands.XAddOptions;
import org.springframework.data.redis.connection.RedisStreamCommands.XClaimOptions;
import org.springframework.data.redis.connection.RedisStreamCommands.XTrimOptions;
import org.springframework.data.redis.connection.stream.MapRecord;
import org.springframework.data.redis.connection.stream.RecordId;
import org.springframework.data.redis.connection.zset.Tuple;
import org.springframework.data.redis.core.Cursor;
import org.springframework.data.redis.core.KeyScanOptions;
Expand Down Expand Up @@ -201,15 +199,25 @@ void translatesPipelineUnknownExceptions() {
}

@Test // DATAREDIS-1122
void xaddShouldHonorMaxlen() {
void xaddShouldPassOptionsToConverter() {

MapRecord<byte[], byte[], byte[]> record = MapRecord.create("key".getBytes(), Collections.emptyMap());

connection.streamCommands().xAdd(record, XAddOptions.maxlen(100));
ArgumentCaptor<XAddArgs> args = ArgumentCaptor.forClass(XAddArgs.class);
verify(asyncCommandsMock).xadd(any(), args.capture(), anyMap());

assertThat(args.getValue()).extracting("maxlen").isEqualTo(100L);
assertThat(args.getValue()).isNotNull();
}

@Test // GH-3232
void xtrimShouldPassOptionsToConverter() {

connection.streamCommands().xTrim("key".getBytes(), XTrimOptions.trim(TrimOptions.maxLen(100)));
ArgumentCaptor<XTrimArgs> args = ArgumentCaptor.forClass(XTrimArgs.class);
verify(asyncCommandsMock).xtrim(any(), args.capture());

assertThat(args.getValue()).isNotNull();
}

@Test // DATAREDIS-1226
Expand Down Expand Up @@ -251,146 +259,6 @@ void executeShouldPassThruCustomCommands() {
verify(asyncCommandsMock).dispatch(eq(command.getType()), eq(command.getOutput()), any(CommandArgs.class));
}

@Test // GH-2047
void xaddShouldHonorNoMkStream() {

MapRecord<byte[], byte[], byte[]> record = MapRecord.create("key".getBytes(), Collections.emptyMap());

connection.streamCommands().xAdd(record, XAddOptions.makeNoStream());
ArgumentCaptor<XAddArgs> args = ArgumentCaptor.forClass(XAddArgs.class);
verify(asyncCommandsMock).xadd(any(), args.capture(), anyMap());

assertThat(args.getValue()).extracting("nomkstream").isEqualTo(true);
}

@Test // GH-3232
void xaddShouldHonorMinId() {

MapRecord<byte[], byte[], byte[]> record = MapRecord.create("key".getBytes(), Collections.emptyMap());

XAddOptions options = XAddOptions.none();
connection.streamCommands().xAdd(record, options.minId(RecordId.of("1234567890-0")));
ArgumentCaptor<XAddArgs> args = ArgumentCaptor.forClass(XAddArgs.class);
verify(asyncCommandsMock).xadd(any(), args.capture(), anyMap());

assertThat(ReflectionTestUtils.getField(args.getValue(), "minid")).isEqualTo("1234567890-0");
}

@Test // GH-3232
void xaddShouldHonorLimit() {

MapRecord<byte[], byte[], byte[]> record = MapRecord.create("key".getBytes(), Collections.emptyMap());

connection.streamCommands().xAdd(record, XAddOptions.trim(TrimOptions.maxLen(100).approximate().limit(50)));
ArgumentCaptor<XAddArgs> args = ArgumentCaptor.forClass(XAddArgs.class);
verify(asyncCommandsMock).xadd(any(), args.capture(), anyMap());

assertThat(args.getValue()).extracting("limit").isEqualTo(50L);
}

@Test // GH-3232
void xaddShouldHonorExactTrimming() {

MapRecord<byte[], byte[], byte[]> record = MapRecord.create("key".getBytes(), Collections.emptyMap());

connection.streamCommands().xAdd(record, XAddOptions.trim(TrimOptions.maxLen(100).exact()));
ArgumentCaptor<XAddArgs> args = ArgumentCaptor.forClass(XAddArgs.class);
verify(asyncCommandsMock).xadd(any(), args.capture(), anyMap());

assertThat(args.getValue()).extracting("exactTrimming").isEqualTo(true);
}

@Test // GH-3232
void xaddShouldHonorApproximateTrimming() {

MapRecord<byte[], byte[], byte[]> record = MapRecord.create("key".getBytes(), Collections.emptyMap());

connection.streamCommands().xAdd(record, XAddOptions.maxlen(100).approximateTrimming(true));
ArgumentCaptor<XAddArgs> args = ArgumentCaptor.forClass(XAddArgs.class);
verify(asyncCommandsMock).xadd(any(), args.capture(), anyMap());

assertThat(args.getValue()).extracting("approximateTrimming").isEqualTo(true);
}

@Test // GH-3232
void xaddShouldHonorDeletionPolicy() {

MapRecord<byte[], byte[], byte[]> record = MapRecord.create("key".getBytes(), Collections.emptyMap());

connection.streamCommands().xAdd(record,
XAddOptions.trim(TrimOptions.maxLen(100).deletionPolicy(RedisStreamCommands.StreamDeletionPolicy.keep())));
ArgumentCaptor<XAddArgs> args = ArgumentCaptor.forClass(XAddArgs.class);
verify(asyncCommandsMock).xadd(any(), args.capture(), anyMap());

assertThat(args.getValue()).extracting("trimmingMode").isEqualTo(io.lettuce.core.StreamDeletionPolicy.KEEP_REFERENCES);
}

@Test // GH-3232
void xtrimShouldHonorMaxlen() {

connection.streamCommands().xTrim("key".getBytes(), XTrimOptions.trim(TrimOptions.maxLen(100)));
ArgumentCaptor<XTrimArgs> args = ArgumentCaptor.forClass(XTrimArgs.class);
verify(asyncCommandsMock).xtrim(any(), args.capture());

assertThat(args.getValue()).extracting("maxlen").isEqualTo(100L);
}

@Test // GH-3232
void xtrimShouldHonorMinId() {

connection.streamCommands().xTrim("key".getBytes(),
XTrimOptions.trim(TrimOptions.minId(RecordId.of("1234567890-0"))));
ArgumentCaptor<XTrimArgs> args = ArgumentCaptor.forClass(XTrimArgs.class);
verify(asyncCommandsMock).xtrim(any(), args.capture());

assertThat(ReflectionTestUtils.getField(args.getValue(), "minId")).isEqualTo("1234567890-0");
}

@Test // GH-3232
void xtrimShouldHonorApproximateTrimming() {

connection.streamCommands().xTrim("key".getBytes(),
XTrimOptions.trim(TrimOptions.maxLen(100).approximate()));
ArgumentCaptor<XTrimArgs> args = ArgumentCaptor.forClass(XTrimArgs.class);
verify(asyncCommandsMock).xtrim(any(), args.capture());

assertThat(args.getValue()).extracting("approximateTrimming").isEqualTo(true);
}

@Test // GH-3232
void xtrimShouldHonorExactTrimming() {

connection.streamCommands().xTrim("key".getBytes(),
XTrimOptions.trim(TrimOptions.maxLen(100).exact()));
ArgumentCaptor<XTrimArgs> args = ArgumentCaptor.forClass(XTrimArgs.class);
verify(asyncCommandsMock).xtrim(any(), args.capture());

assertThat(args.getValue()).extracting("exactTrimming").isEqualTo(true);
}

@Test // GH-3232
void xtrimShouldHonorLimit() {

connection.streamCommands().xTrim("key".getBytes(),
XTrimOptions.trim(TrimOptions.maxLen(100).approximate().limit(50)));
ArgumentCaptor<XTrimArgs> args = ArgumentCaptor.forClass(XTrimArgs.class);
verify(asyncCommandsMock).xtrim(any(), args.capture());

assertThat(args.getValue()).extracting("limit").isEqualTo(50L);
}

@Test // GH-3232
void xtrimShouldHonorDeletionPolicy() {

connection.streamCommands().xTrim("key".getBytes(), XTrimOptions.trim(TrimOptions.maxLen(100)
.deletionPolicy(RedisStreamCommands.StreamDeletionPolicy.keep())));
ArgumentCaptor<XTrimArgs> args = ArgumentCaptor.forClass(XTrimArgs.class);
verify(asyncCommandsMock).xtrim(any(), args.capture());

assertThat(args.getValue()).extracting("trimmingMode")
.isEqualTo(io.lettuce.core.StreamDeletionPolicy.KEEP_REFERENCES);
}

@Test // GH-2796
void scanShouldOperateUponUnsigned64BitCursorId() {

Expand Down
115 changes: 115 additions & 0 deletions ...est/java/org/springframework/data/redis/connection/lettuce/StreamConvertersUnitTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/*
* Copyright 2025-present the original author or authors.
*
* 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 org.springframework.data.redis.connection.lettuce;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.params.provider.Arguments.*;

import io.lettuce.core.XAddArgs;
import java.util.stream.Stream;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import org.springframework.data.redis.connection.RedisStreamCommands.StreamDeletionPolicy;
import org.springframework.data.redis.connection.RedisStreamCommands.TrimOptions;
import org.springframework.data.redis.connection.RedisStreamCommands.XAddOptions;
import org.springframework.data.redis.connection.RedisStreamCommands.XDelOptions;
import org.springframework.data.redis.connection.RedisStreamCommands.XTrimOptions;
import org.springframework.data.redis.connection.stream.RecordId;

/**
* @author Christoph Strobl
* @author Mark Paluch
* @author Jimin Sin
*/
class StreamConvertersUnitTests {

@Nested // GH-3232
class ToXAddArgsShould {

@ParameterizedTest
@DisplayName("ConvertXAddOptions")
@MethodSource
void convertXAddOptions(XAddOptions options, String paramsFieldToCheck, Object paramsFieldExpectedValue) {
assertThat(StreamConverters.toXAddArgs(RecordId.autoGenerate(), options)).hasFieldOrPropertyWithValue(paramsFieldToCheck, paramsFieldExpectedValue);
}

static Stream<Arguments> convertXAddOptions() {
return Stream.of(
argumentSet("withMaxLen", XAddOptions.trim(TrimOptions.maxLen(100)), "maxlen", 100L),
argumentSet("withMinId", XAddOptions.trim(TrimOptions.minId(RecordId.of("1234567890-0"))), "minid", "1234567890-0"),
argumentSet("withApproximateTrimming", XAddOptions.trim(TrimOptions.maxLen(100).approximate()), "approximateTrimming", true),
argumentSet("withExactTrimming", XAddOptions.trim(TrimOptions.maxLen(100).exact()), "exactTrimming", true),
argumentSet("withLimit", XAddOptions.trim(TrimOptions.maxLen(100).approximate().limit(50)), "limit", 50L),
argumentSet("withDeletionPolicy", XAddOptions.trim(TrimOptions.maxLen(100).deletionPolicy(StreamDeletionPolicy.keep())), "trimmingMode", io.lettuce.core.StreamDeletionPolicy.KEEP_REFERENCES)
);
}

@Test // GH-2047
void convertXAddOptionsWithNoMkStream() {

XAddOptions options = XAddOptions.makeNoStream();

XAddArgs args = StreamConverters.toXAddArgs(RecordId.autoGenerate(), options);

assertThat(args).hasFieldOrPropertyWithValue("nomkstream", true);
}
}

@Nested // GH-3232
class ToXTrimArgsShould {

@ParameterizedTest
@DisplayName("ToXTrimArgsShouldConvertXTrimOptions")
@MethodSource
void toXTrimArgsShouldConvertXTrimOptions(XTrimOptions options, String paramsFieldToCheck, Object paramsFieldExpectedValue) {
assertThat(StreamConverters.toXTrimArgs(options)).hasFieldOrPropertyWithValue(paramsFieldToCheck, paramsFieldExpectedValue);
}

static Stream<Arguments> toXTrimArgsShouldConvertXTrimOptions() {
return Stream.of(
argumentSet("withMaxLen", XTrimOptions.trim(TrimOptions.maxLen(100)), "maxlen", 100L),
argumentSet("withMinId", XTrimOptions.trim(TrimOptions.minId(RecordId.of("1234567890-0"))), "minId", "1234567890-0"),
argumentSet("withApproximateTrimming", XTrimOptions.trim(TrimOptions.maxLen(100).approximate()), "approximateTrimming", true),
argumentSet("withExactTrimming", XTrimOptions.trim(TrimOptions.maxLen(100).exact()), "exactTrimming", true),
argumentSet("withLimit", XTrimOptions.trim(TrimOptions.maxLen(100).approximate().limit(50)), "limit", 50L),
argumentSet("withDeletionPolicy", XTrimOptions.trim(TrimOptions.maxLen(100).deletionPolicy(StreamDeletionPolicy.keep())), "trimmingMode", io.lettuce.core.StreamDeletionPolicy.KEEP_REFERENCES)
);
}
}

@ParameterizedTest // GH-3232
@DisplayName("ToStreamDeletionPolicyShouldConvertXDelOptions")
@MethodSource
void toStreamDeletionPolicyShouldConvertXDelOptions(XDelOptions options, io.lettuce.core.StreamDeletionPolicy expectedDeletionPolicy) {
assertThat(StreamConverters.toXDelArgs(options)).isEqualTo(expectedDeletionPolicy);
}

static Stream<Arguments> toStreamDeletionPolicyShouldConvertXDelOptions() {
return Stream.of(
argumentSet("withDefaultOptions", XDelOptions.defaults(), io.lettuce.core.StreamDeletionPolicy.KEEP_REFERENCES),
argumentSet("withKeepReferencesPolicy", XDelOptions.deletionPolicy(StreamDeletionPolicy.keep()), io.lettuce.core.StreamDeletionPolicy.KEEP_REFERENCES),
argumentSet("withDeleteReferencesPolicy", XDelOptions.deletionPolicy(StreamDeletionPolicy.delete()), io.lettuce.core.StreamDeletionPolicy.DELETE_REFERENCES),
argumentSet("withRemoveAcknowledgedPolicy", XDelOptions.deletionPolicy(StreamDeletionPolicy.removeAcknowledged()), io.lettuce.core.StreamDeletionPolicy.ACKNOWLEDGED)
);
}

}