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.

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

HDDS-12139. Refactor TestSnapshotChainRepair #7752

Merged
merged 17 commits into from
Jan 28, 2025
Merged

HDDS-12139. Refactor TestSnapshotChainRepair #7752

Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
d66eb7d
IOUtils can close mocks, too
adoroszlai Jan 25, 2025
fd58f94
create constants for volume and bucket names
adoroszlai Jan 25, 2025
16c9ac4
inline snapshotName
adoroszlai Jan 25, 2025
2b7e000
extract utility to create newSnapshot
adoroszlai Jan 25, 2025
caa4a5b
reuse newSnapshot for prev instances
adoroszlai Jan 25, 2025
6a7c6b2
remove unnecessary local variables
adoroszlai Jan 25, 2025
89a157f
do not catch IOException
adoroszlai Jan 25, 2025
84dcd7c
use assertThat(...).contains()
adoroszlai Jan 25, 2025
ee3eeb7
collapse duplicate verify
adoroszlai Jan 25, 2025
5219a04
extract method for verifying DB write
adoroszlai Jan 25, 2025
316d247
verify lack of write in error cases
adoroszlai Jan 25, 2025
67970ed
inline output variables
adoroszlai Jan 25, 2025
bc822b1
use Arrays.fill
adoroszlai Jan 25, 2025
8d08dd1
use varargs for setupDB
adoroszlai Jan 25, 2025
544af93
no need to pass snapshotInfo twice
adoroszlai Jan 25, 2025
3a07f38
move constant to top, private method to bottom
adoroszlai Jan 25, 2025
2fef817
rename to nonexistent
adoroszlai Jan 25, 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
246 changes: 87 additions & 159 deletions ...-ozone/tools/src/test/java/org/apache/hadoop/ozone/repair/om/TestSnapshotChainRepair.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@

package org.apache.hadoop.ozone.repair.om;

import org.apache.commons.lang3.RandomStringUtils;
import org.apache.hadoop.hdds.utils.IOUtils;
import org.apache.hadoop.hdds.utils.db.StringCodec;
import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB;
import org.apache.hadoop.ozone.debug.RocksDBUtils;
import org.apache.hadoop.ozone.om.helpers.SnapshotInfo;
import org.apache.hadoop.ozone.repair.OzoneRepair;
import org.apache.ozone.test.GenericTestUtils;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
Expand All @@ -34,6 +34,7 @@
import org.mockito.MockedStatic;
import org.rocksdb.ColumnFamilyHandle;
import org.rocksdb.RocksDB;
import org.rocksdb.RocksDBException;
import org.rocksdb.RocksIterator;
import org.rocksdb.ColumnFamilyDescriptor;

Expand All @@ -47,13 +48,13 @@

import static org.apache.ozone.test.IntLambda.withTextFromSystemIn;
import static org.apache.hadoop.ozone.OzoneConsts.SNAPSHOT_INFO_TABLE;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.anyList;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

Expand All @@ -62,12 +63,14 @@
*/
public class TestSnapshotChainRepair {

private static final String VOLUME_NAME = "vol1";
private static final String BUCKET_NAME = "bucket1";
private static final String DB_PATH = "testDBPath";

private ManagedRocksDB managedRocksDB;
private RocksDB rocksDB;
private ColumnFamilyHandle columnFamilyHandle;

private static final String DB_PATH = "testDBPath";

private MockedStatic<ManagedRocksDB> mockedDB;
private MockedStatic<RocksDBUtils> mockedUtils;

Expand All @@ -86,18 +89,11 @@ public void setup() throws Exception {

@AfterEach
public void tearDown() {
IOUtils.closeQuietly(out, err);

if (mockedDB != null) {
mockedDB.close();
}
if (mockedUtils != null) {
mockedUtils.close();
}
IOUtils.closeQuietly(out, err, mockedDB, mockedUtils);
}

private void setupMockDB(SnapshotInfo snapshotInfo,
List<SnapshotInfo> iteratorSnapshots) throws Exception {
SnapshotInfo... snapshots) throws Exception {

managedRocksDB = mock(ManagedRocksDB.class);
rocksDB = mock(RocksDB.class);
Expand Down Expand Up @@ -134,28 +130,22 @@ private void setupMockDB(SnapshotInfo snapshotInfo,
when(rocksDB.newIterator(columnFamilyHandle)).thenReturn(rocksIterator);

// Setup iterator behavior based on provided snapshots
if (iteratorSnapshots.isEmpty()) {
if (snapshots.length == 0) {
when(rocksIterator.isValid()).thenReturn(false);
} else {
Boolean[] remainingValidResponses = new Boolean[iteratorSnapshots.size()];
for (int i = 0; i < iteratorSnapshots.size() - 1; i++) {
remainingValidResponses[i] = true;
}
remainingValidResponses[iteratorSnapshots.size() - 1] = false;
Boolean[] remainingValidResponses = new Boolean[snapshots.length + 1];
Arrays.fill(remainingValidResponses, true);
remainingValidResponses[remainingValidResponses.length - 1] = false;

when(rocksIterator.isValid())
.thenReturn(true, remainingValidResponses);

ArrayList<byte[]> valueResponses = new ArrayList<>();
for (SnapshotInfo snap : iteratorSnapshots) {
try {
valueResponses.add(SnapshotInfo.getCodec().toPersistedFormat(snap));
} catch (IOException e) {
Assertions.fail("Failed to serialize snapshot info");
}
for (SnapshotInfo snap : snapshots) {
valueResponses.add(SnapshotInfo.getCodec().toPersistedFormat(snap));
}
byte[] firstValue = valueResponses.get(0);
byte[][] remainingValueResponses = valueResponses.subList(1, valueResponses.size()).toArray(new byte[0][]);
byte[] firstValue = SnapshotInfo.getCodec().toPersistedFormat(snapshotInfo);
byte[][] remainingValueResponses = valueResponses.toArray(new byte[0][]);
when(rocksIterator.value())
.thenReturn(firstValue, remainingValueResponses);
}
Expand All @@ -164,213 +154,151 @@ private void setupMockDB(SnapshotInfo snapshotInfo,
@ParameterizedTest
@ValueSource(booleans = {true, false})
public void testSuccessfulRepair(boolean dryRun) throws Exception {
String volumeName = "vol1";
String bucketName = "bucket1";
String snapshotName = "snap1";
String globalPrevSnapshotName = "global-prev-snap1";
String pathPrevSnapshotName = "path-prev-snap1";

UUID snapshotId = UUID.randomUUID();
UUID globalPrevSnapshotId = UUID.randomUUID();
UUID pathPrevSnapshotId = UUID.randomUUID();

SnapshotInfo snapshotInfo = SnapshotInfo.newInstance(volumeName, bucketName, snapshotName, snapshotId, 0);
SnapshotInfo globalPrevSnapshot = SnapshotInfo.newInstance(volumeName, bucketName, globalPrevSnapshotName,
globalPrevSnapshotId, 0);
SnapshotInfo pathPrevSnapshot = SnapshotInfo.newInstance(volumeName, bucketName, pathPrevSnapshotName,
pathPrevSnapshotId, 0);

List<SnapshotInfo> iteratorSnapshots = Arrays.asList(
snapshotInfo, globalPrevSnapshot, pathPrevSnapshot);
SnapshotInfo snapshotInfo = newSnapshot();
SnapshotInfo globalPrevSnapshot = newSnapshot();
SnapshotInfo pathPrevSnapshot = newSnapshot();

List<String> argsList = new ArrayList<>(Arrays.asList(
"om", "snapshot", "chain",
volumeName + "/" + bucketName,
snapshotName,
VOLUME_NAME + "/" + BUCKET_NAME,
snapshotInfo.getName(),
"--db", DB_PATH,
"--global-previous", globalPrevSnapshotId.toString(),
"--path-previous", pathPrevSnapshotId.toString()));
"--global-previous", globalPrevSnapshot.getSnapshotId().toString(),
"--path-previous", pathPrevSnapshot.getSnapshotId().toString()));

if (dryRun) {
argsList.add("--dry-run");
}

setupMockDB(snapshotInfo, iteratorSnapshots);
setupMockDB(snapshotInfo, globalPrevSnapshot, pathPrevSnapshot);

CommandLine cli = new OzoneRepair().getCmd();
withTextFromSystemIn("y")
.execute(() -> cli.execute(argsList.toArray(new String[0])));

String output = out.getOutput();
assertTrue(output.contains("Updating SnapshotInfo to"));
assertThat(out.getOutput()).contains("Updating SnapshotInfo to");

if (dryRun) {
// Verify DB update was NOT called in dry run mode
verify(rocksDB, never()).put(
eq(columnFamilyHandle),
eq(StringCodec.get().toPersistedFormat(snapshotInfo.getTableKey())),
eq(SnapshotInfo.getCodec().toPersistedFormat(snapshotInfo)));
} else {
// Verify DB update was called with correct parameters
verify(rocksDB).put(
eq(columnFamilyHandle),
eq(StringCodec.get().toPersistedFormat(snapshotInfo.getTableKey())),
eq(SnapshotInfo.getCodec().toPersistedFormat(snapshotInfo)));
assertTrue(output.contains("Snapshot Info is updated"));
}
verifyDbWrite(snapshotInfo, !dryRun);
}

@Test
public void testGlobalPreviousMatchesSnapshotId() throws Exception {
String volumeName = "vol1";
String bucketName = "bucket1";
String snapshotName = "snap1";

UUID snapshotId = UUID.randomUUID();
// Use same ID for global previous to trigger error
UUID globalPrevSnapshotId = snapshotId;
UUID pathPrevSnapshotId = UUID.randomUUID();

SnapshotInfo snapshotInfo = SnapshotInfo.newInstance(volumeName, bucketName,
snapshotName, snapshotId, 0);
SnapshotInfo pathPrevSnapshot = SnapshotInfo.newInstance(volumeName, bucketName,
"path-prev", pathPrevSnapshotId, 0);

List<SnapshotInfo> iteratorSnapshots = Arrays.asList(
snapshotInfo, pathPrevSnapshot);
SnapshotInfo snapshotInfo = newSnapshot();
SnapshotInfo pathPrevSnapshot = newSnapshot();

String[] args = new String[] {
"om", "snapshot", "chain",
volumeName + "/" + bucketName,
snapshotName,
VOLUME_NAME + "/" + BUCKET_NAME,
snapshotInfo.getName(),
"--db", DB_PATH,
"--global-previous", globalPrevSnapshotId.toString(),
"--path-previous", pathPrevSnapshotId.toString(),
// Use same ID for global previous to trigger error
"--global-previous", snapshotInfo.getSnapshotId().toString(),
"--path-previous", pathPrevSnapshot.getSnapshotId().toString(),
};

setupMockDB(snapshotInfo, iteratorSnapshots);
setupMockDB(snapshotInfo, pathPrevSnapshot);

CommandLine cli = new OzoneRepair().getCmd();
withTextFromSystemIn("y")
.execute(() -> cli.execute(args));

String errorOutput = err.getOutput();
assertTrue(errorOutput.contains("globalPreviousSnapshotId: '" + globalPrevSnapshotId +
"' is equal to given snapshot's ID"));
assertThat(err.getOutput()).contains("globalPreviousSnapshotId: '" + snapshotInfo.getSnapshotId() +
"' is equal to given snapshot's ID");
verifyDbWrite(snapshotInfo, false);
}

@Test
public void testPathPreviousMatchesSnapshotId() throws Exception {
String volumeName = "vol1";
String bucketName = "bucket1";
String snapshotName = "snap1";

UUID snapshotId = UUID.randomUUID();
UUID globalPrevSnapshotId = UUID.randomUUID();
// Use same ID for path previous to trigger error
UUID pathPrevSnapshotId = snapshotId;

SnapshotInfo snapshotInfo = SnapshotInfo.newInstance(volumeName, bucketName,
snapshotName, snapshotId, 0);
SnapshotInfo globalPrevSnapshot = SnapshotInfo.newInstance(volumeName, bucketName,
"global-prev", globalPrevSnapshotId, 0);

List<SnapshotInfo> iteratorSnapshots = Arrays.asList(
snapshotInfo, globalPrevSnapshot);
SnapshotInfo snapshotInfo = newSnapshot();
SnapshotInfo globalPrevSnapshot = newSnapshot();

String[] args = new String[] {
"om", "snapshot", "chain",
volumeName + "/" + bucketName,
snapshotName,
VOLUME_NAME + "/" + BUCKET_NAME,
snapshotInfo.getName(),
"--db", DB_PATH,
"--global-previous", globalPrevSnapshotId.toString(),
"--path-previous", pathPrevSnapshotId.toString(),
"--global-previous", globalPrevSnapshot.getSnapshotId().toString(),
// Use same ID for path previous to trigger error
"--path-previous", snapshotInfo.getSnapshotId().toString(),
};

setupMockDB(snapshotInfo, iteratorSnapshots);
setupMockDB(snapshotInfo, globalPrevSnapshot);

CommandLine cli = new OzoneRepair().getCmd();
withTextFromSystemIn("y")
.execute(() -> cli.execute(args));

String errorOutput = err.getOutput();
assertTrue(errorOutput.contains("pathPreviousSnapshotId: '" + pathPrevSnapshotId +
"' is equal to given snapshot's ID"));
assertThat(err.getOutput()).contains("pathPreviousSnapshotId: '" + snapshotInfo.getSnapshotId() +
"' is equal to given snapshot's ID");
verifyDbWrite(snapshotInfo, false);
}

@Test
public void testGlobalPreviousDoesNotExist() throws Exception {
String volumeName = "vol1";
String bucketName = "bucket1";
String snapshotName = "snap1";

UUID snapshotId = UUID.randomUUID();
UUID globalPrevSnapshotId = UUID.randomUUID();
UUID pathPrevSnapshotId = UUID.randomUUID();
String nonexistent = UUID.randomUUID().toString();

SnapshotInfo snapshotInfo = SnapshotInfo.newInstance(volumeName, bucketName,
snapshotName, snapshotId, 0);
SnapshotInfo pathPrevSnapshot = SnapshotInfo.newInstance(volumeName, bucketName,
"path-prev", pathPrevSnapshotId, 0);

List<SnapshotInfo> iteratorSnapshots = Arrays.asList(
snapshotInfo, pathPrevSnapshot);
SnapshotInfo snapshotInfo = newSnapshot();
SnapshotInfo pathPrevSnapshot = newSnapshot();

String[] args = new String[] {
"om", "snapshot", "chain",
volumeName + "/" + bucketName,
snapshotName,
VOLUME_NAME + "/" + BUCKET_NAME,
snapshotInfo.getName(),
"--db", DB_PATH,
"--global-previous", globalPrevSnapshotId.toString(),
"--path-previous", pathPrevSnapshotId.toString(),
"--global-previous", nonexistent,
"--path-previous", pathPrevSnapshot.getSnapshotId().toString(),
};

setupMockDB(snapshotInfo, iteratorSnapshots);
setupMockDB(snapshotInfo, pathPrevSnapshot);

CommandLine cli = new OzoneRepair().getCmd();
withTextFromSystemIn("y")
.execute(() -> cli.execute(args));

String errorOutput = err.getOutput();
assertTrue(errorOutput.contains("globalPreviousSnapshotId: '" + globalPrevSnapshotId +
"' does not exist in snapshotInfoTable"));
assertThat(err.getOutput()).contains("globalPreviousSnapshotId: '" + nonexistent +
"' does not exist in snapshotInfoTable");
verifyDbWrite(snapshotInfo, false);
}

@Test
public void testPathPreviousDoesNotExist() throws Exception {
String volumeName = "vol1";
String bucketName = "bucket1";
String snapshotName = "snap1";

UUID snapshotId = UUID.randomUUID();
UUID globalPrevSnapshotId = UUID.randomUUID();
UUID pathPrevSnapshotId = UUID.randomUUID();
String nonexistent = UUID.randomUUID().toString();

SnapshotInfo snapshotInfo = SnapshotInfo.newInstance(volumeName, bucketName,
snapshotName, snapshotId, 0);
SnapshotInfo globalPrevSnapshot = SnapshotInfo.newInstance(volumeName, bucketName,
"global-prev", globalPrevSnapshotId, 0);

List<SnapshotInfo> iteratorSnapshots = Arrays.asList(
snapshotInfo, globalPrevSnapshot);
SnapshotInfo snapshotInfo = newSnapshot();
SnapshotInfo globalPrevSnapshot = newSnapshot();

String[] args = new String[] {
"om", "snapshot", "chain",
volumeName + "/" + bucketName,
snapshotName,
VOLUME_NAME + "/" + BUCKET_NAME,
snapshotInfo.getName(),
"--db", DB_PATH,
"--global-previous", globalPrevSnapshotId.toString(),
"--path-previous", pathPrevSnapshotId.toString(),
"--global-previous", globalPrevSnapshot.getSnapshotId().toString(),
"--path-previous", nonexistent,
};

setupMockDB(snapshotInfo, iteratorSnapshots);
setupMockDB(snapshotInfo, globalPrevSnapshot);

CommandLine cli = new OzoneRepair().getCmd();
withTextFromSystemIn("y")
.execute(() -> cli.execute(args));

String errorOutput = err.getOutput();
assertTrue(errorOutput.contains("pathPreviousSnapshotId: '" + pathPrevSnapshotId +
"' does not exist in snapshotInfoTable"));
assertThat(err.getOutput()).contains("pathPreviousSnapshotId: '" + nonexistent +
"' does not exist in snapshotInfoTable");
verifyDbWrite(snapshotInfo, false);
}

private static SnapshotInfo newSnapshot() {
String name = RandomStringUtils.insecure().nextAlphanumeric(10);
return SnapshotInfo.newInstance(VOLUME_NAME, BUCKET_NAME, name, UUID.randomUUID(), 0);
}

private void verifyDbWrite(SnapshotInfo snapshotInfo, boolean updateExpected) throws RocksDBException, IOException {
verify(rocksDB, times(updateExpected ? 1 : 0)).put(
eq(columnFamilyHandle),
eq(StringCodec.get().toPersistedFormat(snapshotInfo.getTableKey())),
eq(SnapshotInfo.getCodec().toPersistedFormat(snapshotInfo)));
if (updateExpected) {
assertThat(out.get()).contains("Snapshot Info is updated");
}
}
}
Loading