/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* http://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.apache.kafka.streams.state.internals;
import org.apache.kafka.streams.KeyValue;
import org.apache.kafka.streams.processor.ProcessorContext;
import org.apache.kafka.streams.state.KeyValueIterator;
import org.apache.kafka.streams.state.KeyValueStore;
import org.apache.kafka.streams.state.KeyValueStoreTestDriver;
import org.apache.kafka.test.MockProcessorContext;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;
public abstract class AbstractKeyValueStoreTest {
protected abstract <K, V> KeyValueStore<K, V> createKeyValueStore(ProcessorContext context,
Class<K> keyClass, Class<V> valueClass,
boolean useContextSerdes);
protected MockProcessorContext context;
protected KeyValueStore<Integer, String> store;
protected KeyValueStoreTestDriver<Integer, String> driver;
@Before
public void before() {
driver = KeyValueStoreTestDriver.create(Integer.class, String.class);
context = (MockProcessorContext) driver.context();
context.setTime(10);
store = createKeyValueStore(context, Integer.class, String.class, false);
}
@After
public void after() {
store.close();
context.close();
driver.clear();
}
@Test
public void testPutGetRange() {
// Verify that the store reads and writes correctly ...
store.put(0, "zero");
store.put(1, "one");
store.put(2, "two");
store.put(4, "four");
store.put(5, "five");
assertEquals(5, driver.sizeOf(store));
assertEquals("zero", store.get(0));
assertEquals("one", store.get(1));
assertEquals("two", store.get(2));
assertNull(store.get(3));
assertEquals("four", store.get(4));
assertEquals("five", store.get(5));
store.delete(5);
// Flush the store and verify all current entries were properly flushed ...
store.flush();
assertEquals("zero", driver.flushedEntryStored(0));
assertEquals("one", driver.flushedEntryStored(1));
assertEquals("two", driver.flushedEntryStored(2));
assertEquals("four", driver.flushedEntryStored(4));
assertEquals(null, driver.flushedEntryStored(5));
assertEquals(false, driver.flushedEntryRemoved(0));
assertEquals(false, driver.flushedEntryRemoved(1));
assertEquals(false, driver.flushedEntryRemoved(2));
assertEquals(false, driver.flushedEntryRemoved(4));
assertEquals(true, driver.flushedEntryRemoved(5));
// Check range iteration ...
try (KeyValueIterator<Integer, String> iter = store.range(2, 4)) {
while (iter.hasNext()) {
KeyValue<Integer, String> entry = iter.next();
if (entry.key.equals(2))
assertEquals("two", entry.value);
else if (entry.key.equals(4))
assertEquals("four", entry.value);
else
fail("Unexpected entry: " + entry);
}
}
// Check range iteration ...
try (KeyValueIterator<Integer, String> iter = store.range(2, 6)) {
while (iter.hasNext()) {
KeyValue<Integer, String> entry = iter.next();
if (entry.key.equals(2))
assertEquals("two", entry.value);
else if (entry.key.equals(4))
assertEquals("four", entry.value);
else
fail("Unexpected entry: " + entry);
}
}
}
@Test
public void testPutGetRangeWithDefaultSerdes() {
// Verify that the store reads and writes correctly ...
store.put(0, "zero");
store.put(1, "one");
store.put(2, "two");
store.put(4, "four");
store.put(5, "five");
assertEquals(5, driver.sizeOf(store));
assertEquals("zero", store.get(0));
assertEquals("one", store.get(1));
assertEquals("two", store.get(2));
assertNull(store.get(3));
assertEquals("four", store.get(4));
assertEquals("five", store.get(5));
store.delete(5);
// Flush the store and verify all current entries were properly flushed ...
store.flush();
assertEquals("zero", driver.flushedEntryStored(0));
assertEquals("one", driver.flushedEntryStored(1));
assertEquals("two", driver.flushedEntryStored(2));
assertEquals("four", driver.flushedEntryStored(4));
assertEquals(null, driver.flushedEntryStored(5));
assertEquals(false, driver.flushedEntryRemoved(0));
assertEquals(false, driver.flushedEntryRemoved(1));
assertEquals(false, driver.flushedEntryRemoved(2));
assertEquals(false, driver.flushedEntryRemoved(4));
assertEquals(true, driver.flushedEntryRemoved(5));
}
@Test
public void testRestore() {
store.close();
// Add any entries that will be restored to any store
// that uses the driver's context ...
driver.addEntryToRestoreLog(0, "zero");
driver.addEntryToRestoreLog(1, "one");
driver.addEntryToRestoreLog(2, "two");
driver.addEntryToRestoreLog(3, "three");
// Create the store, which should register with the context and automatically
// receive the restore entries ...
store = createKeyValueStore(driver.context(), Integer.class, String.class, false);
context.restore(store.name(), driver.restoredEntries());
// Verify that the store's contents were properly restored ...
assertEquals(0, driver.checkForRestoredEntries(store));
// and there are no other entries ...
assertEquals(4, driver.sizeOf(store));
}
@Test
public void testRestoreWithDefaultSerdes() {
store.close();
// Add any entries that will be restored to any store
// that uses the driver's context ...
driver.addEntryToRestoreLog(0, "zero");
driver.addEntryToRestoreLog(1, "one");
driver.addEntryToRestoreLog(2, "two");
driver.addEntryToRestoreLog(3, "three");
// Create the store, which should register with the context and automatically
// receive the restore entries ...
store = createKeyValueStore(driver.context(), Integer.class, String.class, true);
context.restore(store.name(), driver.restoredEntries());
// Verify that the store's contents were properly restored ...
assertEquals(0, driver.checkForRestoredEntries(store));
// and there are no other entries ...
assertEquals(4, driver.sizeOf(store));
}
@Test
public void testPutIfAbsent() {
// Verify that the store reads and writes correctly ...
assertNull(store.putIfAbsent(0, "zero"));
assertNull(store.putIfAbsent(1, "one"));
assertNull(store.putIfAbsent(2, "two"));
assertNull(store.putIfAbsent(4, "four"));
assertEquals("four", store.putIfAbsent(4, "unexpected value"));
assertEquals(4, driver.sizeOf(store));
assertEquals("zero", store.get(0));
assertEquals("one", store.get(1));
assertEquals("two", store.get(2));
assertNull(store.get(3));
assertEquals("four", store.get(4));
// Flush the store and verify all current entries were properly flushed ...
store.flush();
assertEquals("zero", driver.flushedEntryStored(0));
assertEquals("one", driver.flushedEntryStored(1));
assertEquals("two", driver.flushedEntryStored(2));
assertEquals("four", driver.flushedEntryStored(4));
assertEquals(false, driver.flushedEntryRemoved(0));
assertEquals(false, driver.flushedEntryRemoved(1));
assertEquals(false, driver.flushedEntryRemoved(2));
assertEquals(false, driver.flushedEntryRemoved(4));
}
@Test
public void testSize() {
assertEquals("A newly created store should have no entries", 0, store.approximateNumEntries());
store.put(0, "zero");
store.put(1, "one");
store.put(2, "two");
store.put(4, "four");
store.put(5, "five");
assertEquals(5, store.approximateNumEntries());
}
}