content: /*
   * 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.common.metrics.Metrics;
  import org.apache.kafka.common.serialization.Serde;
  import org.apache.kafka.common.serialization.Serdes;
  import org.apache.kafka.common.utils.LogContext;
  import org.apache.kafka.common.utils.Time;
  import org.apache.kafka.streams.KeyValue;
  import org.apache.kafka.streams.errors.InvalidStateStoreException;
  import org.apache.kafka.streams.processor.internals.MockStreamsMetrics;
  import org.apache.kafka.streams.state.KeyValueIterator;
  import org.apache.kafka.streams.state.KeyValueStore;
  import org.apache.kafka.streams.state.Stores;
  import org.apache.kafka.test.InternalMockProcessorContext;
  import org.apache.kafka.test.MockRecordCollector;
  import org.apache.kafka.test.TestUtils;
  
  import org.junit.jupiter.api.AfterEach;
  import org.junit.jupiter.params.ParameterizedTest;
  import org.junit.jupiter.params.provider.EnumSource;
  
  import java.io.File;
  import java.util.Collections;
  
  import static java.util.Arrays.asList;
  import static org.apache.kafka.test.StreamsTestUtils.toListAndCloseIterator;
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  
  public class ListValueStoreTest {
      public enum StoreType { InMemory, RocksDB }
  
      private KeyValueStore<Integer, String> listStore;
  
      final File baseDir = TestUtils.tempDirectory("test");
  
      public void setup(final StoreType storeType) {
          listStore = buildStore(Serdes.Integer(), Serdes.String(), storeType);
  
          final MockRecordCollector recordCollector = new MockRecordCollector();
          final InternalMockProcessorContext<Integer, String> context = new InternalMockProcessorContext<>(
              baseDir,
              Serdes.String(),
              Serdes.Integer(),
              recordCollector,
              new ThreadCache(
                  new LogContext("testCache"),
                  0,
                  new MockStreamsMetrics(new Metrics())));
          context.setTime(1L);
  
          listStore.init(context, listStore);
      }
  
      @AfterEach
      public void after() {
          listStore.close();
      }
  
      <K, V> KeyValueStore<K, V> buildStore(final Serde<K> keySerde,
                                            final Serde<V> valueSerde,
                                            final StoreType storeType) {
          return new ListValueStoreBuilder<>(
              storeType == StoreType.RocksDB ? Stores.persistentKeyValueStore("rocksDB list store")
                  : Stores.inMemoryKeyValueStore("in-memory list store"),
              keySerde,
              valueSerde,
              Time.SYSTEM)
              .build();
      }
  
      @ParameterizedTest
      @EnumSource(StoreType.class)
      public void shouldGetAll(final StoreType storeType) {
          setup(storeType);
          listStore.put(0, "zero");
          // should retain duplicates
          listStore.put(0, "zero again");
          listStore.put(1, "one");
          listStore.put(2, "two");
  
          final KeyValue<Integer, String> zero = KeyValue.pair(0, "zero");
          final KeyValue<Integer, String> zeroAgain = KeyValue.pair(0, "zero again");
          final KeyValue<Integer, String> one = KeyValue.pair(1, "one");
          final KeyValue<Integer, String> two = KeyValue.pair(2, "two");
  
          assertEquals(
              asList(zero, zeroAgain, one, two),
              toListAndCloseIterator(listStore.all())
          );
      }
  
      @ParameterizedTest
      @EnumSource(StoreType.class)
      public void shouldGetAllNonDeletedRecords(final StoreType storeType) {
          setup(storeType);
          // Add some records
          listStore.put(0, "zero");
          listStore.put(1, "one");
          listStore.put(1, "one again");
          listStore.put(2, "two");
          listStore.put(3, "three");
          listStore.put(4, "four");
  
          // Delete some records
          listStore.put(1, null);
          listStore.put(3, null);
  
          // Only non-deleted records should appear in the all() iterator
          final KeyValue<Integer, String> zero = KeyValue.pair(0, "zero");
          final KeyValue<Integer, String> two = KeyValue.pair(2, "two");
          final KeyValue<Integer, String> four = KeyValue.pair(4, "four");
  
          assertEquals(
              asList(zero, two, four),
              toListAndCloseIterator(listStore.all())
          );
      }
  
      @ParameterizedTest
      @EnumSource(StoreType.class)
      public void shouldGetAllReturnTimestampOrderedRecords(final StoreType storeType) {
          setup(storeType);
          // Add some records in different order
          listStore.put(4, "four");
          listStore.put(0, "zero");
          listStore.put(2, "two1");
          listStore.put(3, "three");
          listStore.put(1, "one");
  
          // Add duplicates
          listStore.put(2, "two2");
  
          // Only non-deleted records should appear in the all() iterator
          final KeyValue<Integer, String> zero = KeyValue.pair(0, "zero");
          final KeyValue<Integer, String> one = KeyValue.pair(1, "one");
          final KeyValue<Integer, String> two1 = KeyValue.pair(2, "two1");
          final KeyValue<Integer, String> two2 = KeyValue.pair(2, "two2");
          final KeyValue<Integer, String> three = KeyValue.pair(3, "three");
          final KeyValue<Integer, String> four = KeyValue.pair(4, "four");
  
          assertEquals(
              asList(zero, one, two1, two2, three, four),
              toListAndCloseIterator(listStore.all())
          );
      }
  
      @ParameterizedTest
      @EnumSource(StoreType.class)
      public void shouldAllowDeleteWhileIterateRecords(final StoreType storeType) {
          setup(storeType);
          listStore.put(0, "zero1");
          listStore.put(0, "zero2");
          listStore.put(1, "one");
  
          final KeyValue<Integer, String> zero1 = KeyValue.pair(0, "zero1");
          final KeyValue<Integer, String> zero2 = KeyValue.pair(0, "zero2");
          final KeyValue<Integer, String> one = KeyValue.pair(1, "one");
  
          final KeyValueIterator<Integer, String> it = listStore.all();
          assertEquals(zero1, it.next());
  
          listStore.put(0, null);
  
          // zero2 should still be returned from the iterator after the delete call
          assertEquals(zero2, it.next());
  
          it.close();
  
          // A new all() iterator after a previous all() iterator was closed should not return deleted records.
          assertEquals(Collections.singletonList(one), toListAndCloseIterator(listStore.all()));
      }
  
      @ParameterizedTest
      @EnumSource(StoreType.class)
      public void shouldNotReturnMoreDataWhenIteratorClosed(final StoreType storeType) {
          setup(storeType);
          listStore.put(0, "zero1");
          listStore.put(0, "zero2");
          listStore.put(1, "one");
  
          final KeyValueIterator<Integer, String> it = listStore.all();
  
          it.close();
  
          // A new all() iterator after a previous all() iterator was closed should not return deleted records.
          if (storeType == StoreType.InMemory) {
              assertThrows(IllegalStateException.class, it::next);
          } else {
              assertThrows(InvalidStateStoreException.class, it::next);
          }
      }
  }
  