Skip to content

HDDS-16097. Add unit tests for OzoneManagerRatisServer.checkRetryCache #10985

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
jojochuang wants to merge 6 commits into
base: master
Choose a base branch
from
+109 −0
Open

HDDS-16097. Add unit tests for OzoneManagerRatisServer.checkRetryCache #10985

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9d7d807
HDDS-16097. Add tests for OzoneManagerRatisServer.checkRetryCache
jojochuang Aug 6, 2026
9e73e8c
HDDS-16097. Fix checkstyle import order in retry cache tests
jojochuang Aug 6, 2026
3721a7b
HDDS-16097. Fix HiddenField checkstyle in retry cache unit tests
jojochuang Aug 6, 2026
06ed409
HDDS-16097. Fix retry cache unit test and drop HA integration test
jojochuang Aug 6, 2026
b83bd1a
HDDS-16097. Retrigger CI
jojochuang Aug 6, 2026
b3c339a
HDDS-16097. Retrigger CI after cancelled run
jojochuang Aug 6, 2026
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
109 changes: 109 additions & 0 deletions ...e-manager/src/test/java/org/apache/hadoop/ozone/om/ratis/TestOzoneManagerRatisServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,12 @@
import static org.apache.hadoop.ozone.OzoneConsts.TRANSACTION_INFO_KEY;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.when;

import java.io.IOException;
Expand All @@ -30,12 +35,15 @@
import java.nio.file.Path;
import java.util.Collections;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import org.apache.hadoop.hdds.HddsConfigKeys;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
import org.apache.hadoop.hdds.security.SecurityConfig;
import org.apache.hadoop.hdds.utils.TransactionInfo;
import org.apache.hadoop.ipc_.RPC;
import org.apache.hadoop.ipc_.Server;
import org.apache.hadoop.ozone.OmUtils;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.om.OMConfigKeys;
Expand All @@ -45,11 +53,21 @@
import org.apache.hadoop.ozone.om.OmMetadataManagerImpl;
import org.apache.hadoop.ozone.om.OzoneManager;
import org.apache.hadoop.ozone.om.helpers.OMNodeDetails;
import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos;
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMRequest;
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.OMResponse;
import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.Status;
import org.apache.hadoop.ozone.security.OMCertificateClient;
import org.apache.ozone.test.GenericTestUtils.LogCapturer;
import org.apache.ratis.protocol.ClientId;
import org.apache.ratis.protocol.Message;
import org.apache.ratis.protocol.RaftClientReply;
import org.apache.ratis.protocol.RaftGroupId;
import org.apache.ratis.protocol.RaftGroupMemberId;
import org.apache.ratis.protocol.exceptions.NotLeaderException;
import org.apache.ratis.server.RaftServer;
import org.apache.ratis.server.RetryCache;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.ratis.statemachine.SnapshotInfo;
import org.apache.ratis.util.ExitUtils;
Expand Down Expand Up @@ -145,6 +163,97 @@ public void testStartOMRatisServer() throws Exception {
"Ratis Server should be in running state");
}

/**
* HDDS-13621: a failed Raft reply in RetryCache must not be converted via
* getOMResponse (no response message), so checkRetryCache returns null.
*/
@Test
public void checkRetryCacheReturnsNullWhenCachedReplyFailed() throws Exception {
when(ozoneManager.isTestSecureOmFlag()).thenReturn(true);
ClientId ratisClientId = ClientId.randomId();
int callId = 42;
RaftGroupMemberId memberId = RaftGroupMemberId.valueOf(
omRatisServer.getRaftPeerId(), omRatisServer.getRaftGroup().getGroupId());
RaftClientReply failedReply = RaftClientReply.newBuilder()
.setClientId(ratisClientId)
.setServerId(memberId)
.setGroupId(omRatisServer.getRaftGroup().getGroupId())
.setCallId(callId)
.setSuccess(false)
.setMessage(Message.EMPTY)
.setException(new NotLeaderException(memberId, null, Collections.emptyList()))
.build();

OzoneManagerRatisServer spyServer = spy(omRatisServer);
injectRetryCacheEntry(spyServer, ratisClientId, callId, failedReply);

Server.Call previousCall = Server.getCurCall().get();
try {
Server.getCurCall().set(new Server.Call(callId, 0, null, null,
RPC.RpcKind.RPC_BUILTIN, ratisClientId.toByteString().toByteArray()));
assertNull(spyServer.checkRetryCache());
} finally {
Server.getCurCall().set(previousCall);
}
Comment on lines +173 to +197
}

/**
* HDDS-13621: successful RetryCache hits must still return the cached OMResponse.
*/
@Test
public void checkRetryCacheReturnsOmResponseWhenCachedReplySucceeded()
throws Exception {
when(ozoneManager.isTestSecureOmFlag()).thenReturn(true);
ClientId ratisClientId = ClientId.randomId();
int callId = 43;
OMResponse expected = OMResponse.newBuilder()
.setCmdType(OzoneManagerProtocolProtos.Type.CreateVolume)
.setStatus(Status.OK)
.setSuccess(true)
.build();
RaftGroupMemberId memberId = RaftGroupMemberId.valueOf(
omRatisServer.getRaftPeerId(), omRatisServer.getRaftGroup().getGroupId());
RaftClientReply successReply = RaftClientReply.newBuilder()
.setClientId(ratisClientId)
.setServerId(memberId)
.setGroupId(omRatisServer.getRaftGroup().getGroupId())
.setCallId(callId)
.setSuccess(true)
.setMessage(OMRatisHelper.convertResponseToMessage(expected))
.build();

OzoneManagerRatisServer spyServer = spy(omRatisServer);
injectRetryCacheEntry(spyServer, ratisClientId, callId, successReply);
doReturn(omRatisServer.getRaftPeerId()).when(spyServer).getLeaderId();

Server.Call previousCall = Server.getCurCall().get();
try {
Server.getCurCall().set(new Server.Call(callId, 0, null, null,
RPC.RpcKind.RPC_BUILTIN, ratisClientId.toByteString().toByteArray()));
OMResponse cached = spyServer.checkRetryCache();
assertTrue(cached.getSuccess());
assertEquals(Status.OK, cached.getStatus());
assertEquals(OzoneManagerProtocolProtos.Type.CreateVolume, cached.getCmdType());
} finally {
Server.getCurCall().set(previousCall);
}
}

private static void injectRetryCacheEntry(OzoneManagerRatisServer spyServer,
ClientId clientId, int callId, RaftClientReply reply) throws Exception {
RetryCache.Entry cacheEntry = mock(RetryCache.Entry.class);
when(cacheEntry.getReplyFuture())
.thenReturn(CompletableFuture.completedFuture(reply));

RetryCache retryCache = mock(RetryCache.class);
when(retryCache.getIfPresent(any())).thenReturn(cacheEntry);

RaftServer.Division division = mock(RaftServer.Division.class);
when(division.getRetryCache()).thenReturn(retryCache);

doReturn(division).when(spyServer).getServerDivision();
}

/**
* RaftPeer.address must preserve the configured host string
* verbatim -- not a Java-resolved {@code InetSocketAddress} form. When
Expand Down
Loading