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

Throw exception for multiGet operation on corrupted database. #12766

Open
wants to merge 3 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
2 changes: 2 additions & 0 deletions java/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,7 @@ set(JAVA_TEST_CLASSES
src/test/java/org/rocksdb/MergeVariantsTest.java
src/test/java/org/rocksdb/MixedOptionsTest.java
src/test/java/org/rocksdb/MultiColumnRegressionTest.java
src/test/java/org/rocksdb/MultiGetCorruptionTest.java
src/test/java/org/rocksdb/MultiGetManyKeysTest.java
src/test/java/org/rocksdb/MultiGetTest.java
src/test/java/org/rocksdb/MutableColumnFamilyOptionsTest.java
Expand Down Expand Up @@ -477,6 +478,7 @@ set(JAVA_TEST_RUNNING_CLASSES
org.rocksdb.MergeVariantsTest
org.rocksdb.MixedOptionsTest
org.rocksdb.MultiColumnRegressionTest
org.rocksdb.MultiGetCorruptionTest
org.rocksdb.MultiGetManyKeysTest
org.rocksdb.MultiGetTest
org.rocksdb.MutableColumnFamilyOptionsTest
Expand Down
3 changes: 3 additions & 0 deletions java/rocksjni/jni_multiget_helpers.cc
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,9 @@ jobjectArray MultiGetJNIValues::byteArrays(
}

env->DeleteLocalRef(jentry_value);
} else if (s[i].code() == ROCKSDB_NAMESPACE::Status::Code::kCorruption) {
ROCKSDB_NAMESPACE::RocksDBExceptionJni::ThrowNew(env, s[i]);
return nullptr;
} else if (s[i].code() != ROCKSDB_NAMESPACE::Status::Code::kNotFound) {
// The only way to return an error for a single key is to exception the
// entire multiGet() Previous behaviour was to return a nullptr value for
Expand Down
92 changes: 92 additions & 0 deletions java/src/test/java/org/rocksdb/MultiGetCorruptionTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
package org.rocksdb;

import static java.nio.charset.StandardCharsets.UTF_8;
import static org.assertj.core.api.Assertions.assertThat;

import java.io.File;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.util.ArrayList;
import java.util.List;
import org.hamcrest.CustomTypeSafeMatcher;
import org.hamcrest.Description;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;

public class MultiGetCorruptionTest {
private static final byte[] KEY = "key".getBytes(UTF_8);
private static final byte[] VALUE;

static {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 100; i++) {
sb.append("value" + i + "\n");
}
VALUE = sb.toString().getBytes(UTF_8);
}

@ClassRule
public static final RocksNativeLibraryResource ROCKS_NATIVE_LIBRARY_RESOURCE =
new RocksNativeLibraryResource();

@Rule public TemporaryFolder dbFolder = new TemporaryFolder();

@Rule public ExpectedException exception = ExpectedException.none();

@Test
public void getKeyException() throws RocksDBException, IOException {
createCorruptedDatabase();
try (Options options = new Options().setCreateIfMissing(true).setParanoidChecks(true);
RocksDB db = RocksDB.openReadOnly(options, dbFolder.getRoot().getAbsolutePath())) {
exception.expect(RocksDBException.class); // We need to be sure, exception is thrown only
db.get(KEY); // on GET operation. Require careful data corruption.
}
}

@Test
public void multiGetKeyException() throws RocksDBException, IOException {
createCorruptedDatabase();
try (Options options = new Options().setCreateIfMissing(true).setParanoidChecks(true);
RocksDB db = RocksDB.openReadOnly(options, dbFolder.getRoot().getAbsolutePath())) {
exception.expect(RocksDBException.class);
exception.expect(new CustomTypeSafeMatcher<RocksDBException>(
"Status.Code equal to Corruption") {
@Override
protected boolean matchesSafely(RocksDBException e) {
return e.getStatus().getCode() == Status.Code.Corruption;
}

@Override
protected void describeMismatchSafely(RocksDBException e, Description mismatchDescription) {
mismatchDescription.appendText(
"was " + e.getStatus().getCodeString() + " " + e.getMessage());
}
});

List<byte[]> keys = new ArrayList<>();
keys.add(KEY);
db.multiGetAsList(keys);
}
}

private void createCorruptedDatabase() throws RocksDBException, IOException {
try (Options options = new Options().setCreateIfMissing(true).setParanoidChecks(true);
RocksDB db = RocksDB.open(options, dbFolder.getRoot().getAbsolutePath())) {
db.put(KEY, VALUE);
try (FlushOptions flushOptions = new FlushOptions().setWaitForFlush(true)) {
db.flush(flushOptions);
}
}

File[] files = dbFolder.getRoot().listFiles((dir, name) -> name.endsWith("sst"));
assertThat(files).hasSize(1);

try (RandomAccessFile file = new RandomAccessFile(files[0], "rw")) {
file.seek(30);
file.write("corrupted".getBytes(UTF_8));
}
}
}
Loading