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.kstream.internals;
  
  import org.apache.kafka.common.serialization.Serdes;
  import org.apache.kafka.common.serialization.StringDeserializer;
  import org.apache.kafka.common.serialization.StringSerializer;
  import org.apache.kafka.common.utils.Bytes;
  import org.apache.kafka.streams.StreamsBuilder;
  import org.apache.kafka.streams.TestInputTopic;
  import org.apache.kafka.streams.TestOutputTopic;
  import org.apache.kafka.streams.TopologyTestDriver;
  import org.apache.kafka.streams.kstream.CogroupedKStream;
  import org.apache.kafka.streams.kstream.Consumed;
  import org.apache.kafka.streams.kstream.Grouped;
  import org.apache.kafka.streams.kstream.KGroupedStream;
  import org.apache.kafka.streams.kstream.KStream;
  import org.apache.kafka.streams.kstream.KTable;
  import org.apache.kafka.streams.kstream.Materialized;
  import org.apache.kafka.streams.kstream.Named;
  import org.apache.kafka.streams.kstream.SlidingWindows;
  import org.apache.kafka.streams.kstream.TimeWindowedCogroupedKStream;
  import org.apache.kafka.streams.kstream.TimeWindowedDeserializer;
  import org.apache.kafka.streams.kstream.Windowed;
  import org.apache.kafka.streams.state.WindowStore;
  import org.apache.kafka.streams.test.TestRecord;
  import org.apache.kafka.test.MockAggregator;
  import org.apache.kafka.test.MockInitializer;
  import org.apache.kafka.test.StreamsTestUtils;
  
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Properties;
  
  import static java.time.Duration.ofMillis;
  import static org.hamcrest.CoreMatchers.equalTo;
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  
  public class SlidingWindowedCogroupedKStreamImplTest {
  
      private static final String TOPIC = "topic";
      private static final String TOPIC2 = "topic2";
      private static final String OUTPUT = "output";
      private static final long WINDOW_SIZE_MS = 500L;
      private final StreamsBuilder builder = new StreamsBuilder();
  
      private KGroupedStream<String, String> groupedStream;
  
      private TimeWindowedCogroupedKStream<String, String> windowedCogroupedStream;
  
      private final Properties props = StreamsTestUtils.getStreamsConfig(Serdes.String(), Serdes.String());
  
      @BeforeEach
      public void setup() {
          final KStream<String, String> stream = builder.stream(TOPIC, Consumed
                  .with(Serdes.String(), Serdes.String()));
          final KStream<String, String> stream2 = builder.stream(TOPIC2, Consumed
                  .with(Serdes.String(), Serdes.String()));
  
          groupedStream = stream.groupByKey(Grouped.with(Serdes.String(), Serdes.String()));
          final KGroupedStream<String, String> groupedStream2 = stream2.groupByKey(Grouped.with(Serdes.String(), Serdes.String()));
          final CogroupedKStream<String, String> cogroupedStream = groupedStream.cogroup(MockAggregator.TOSTRING_ADDER)
                  .cogroup(groupedStream2, MockAggregator.TOSTRING_REMOVER);
          windowedCogroupedStream = cogroupedStream.windowedBy(SlidingWindows.ofTimeDifferenceAndGrace(ofMillis(
              WINDOW_SIZE_MS), ofMillis(2000L)));
      }
  
      @Test
      public void shouldNotHaveNullInitializerOnAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(null));
      }
  
      @Test
      public void shouldNotHaveNullMaterializedOnTwoOptionAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(MockInitializer.STRING_INIT, (Materialized<String, String, WindowStore<Bytes, byte[]>>) null));
      }
  
      @Test
      public void shouldNotHaveNullNamedTwoOptionOnAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(MockInitializer.STRING_INIT, (Named) null));
      }
  
      @Test
      public void shouldNotHaveNullInitializerTwoOptionNamedOnAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(null, Named.as("test")));
      }
  
      @Test
      public void shouldNotHaveNullInitializerTwoOptionMaterializedOnAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(null, Materialized.as("test")));
      }
  
      @Test
      public void shouldNotHaveNullInitializerThreeOptionOnAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(null, Named.as("test"), Materialized.as("test")));
      }
  
      @Test
      public void shouldNotHaveNullMaterializedOnAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(MockInitializer.STRING_INIT, Named.as("Test"), null));
      }
  
      @Test
      public void shouldNotHaveNullNamedOnAggregate() {
          assertThrows(NullPointerException.class, () ->  windowedCogroupedStream.aggregate(MockInitializer.STRING_INIT, null, Materialized.as("test")));
      }
  
      @Test
      public void namedParamShouldSetName() {
          final StreamsBuilder builder = new StreamsBuilder();
          final KStream<String, String> stream = builder.stream(TOPIC, Consumed
                  .with(Serdes.String(), Serdes.String()));
          groupedStream = stream.groupByKey(Grouped.with(Serdes.String(), Serdes.String()));
          groupedStream.cogroup(MockAggregator.TOSTRING_ADDER)
                  .windowedBy(SlidingWindows.ofTimeDifferenceAndGrace(ofMillis(WINDOW_SIZE_MS), ofMillis(2000L)))
                  .aggregate(MockInitializer.STRING_INIT, Named.as("foo"));
  
          assertThat(builder.build().describe().toString(), equalTo(
                  "Topologies:\n" +
                          "   Sub-topology: 0\n" +
                          "    Source: KSTREAM-SOURCE-0000000000 (topics: [topic])\n" +
                          "      --> foo-cogroup-agg-0\n" +
                          "    Processor: foo-cogroup-agg-0 (stores: [COGROUPKSTREAM-AGGREGATE-STATE-STORE-0000000001])\n" +
                          "      --> foo-cogroup-merge\n" +
                          "      <-- KSTREAM-SOURCE-0000000000\n" +
                          "    Processor: foo-cogroup-merge (stores: [])\n" +
                          "      --> none\n" +
                          "      <-- foo-cogroup-agg-0\n\n"));
      }
  
      @Test
      public void slidingWindowAggregateStreamsTest() {
          final KTable<Windowed<String>, String> customers = windowedCogroupedStream.aggregate(
                  MockInitializer.STRING_INIT, Materialized.with(Serdes.String(), Serdes.String()));
          customers.toStream().to(OUTPUT);
  
          try (final TopologyTestDriver driver = new TopologyTestDriver(builder.build(), props)) {
              final TestInputTopic<String, String> testInputTopic = driver.createInputTopic(
                      TOPIC, new StringSerializer(), new StringSerializer());
              final TestOutputTopic<Windowed<String>, String> testOutputTopic = driver.createOutputTopic(
                      OUTPUT, new TimeWindowedDeserializer<>(new StringDeserializer(), WINDOW_SIZE_MS), new StringDeserializer());
  
              testInputTopic.pipeInput("k1", "A", 500);
              testInputTopic.pipeInput("k2", "A", 500);
              testInputTopic.pipeInput("k2", "A", 501);
              testInputTopic.pipeInput("k1", "A", 502);
              testInputTopic.pipeInput("k1", "B", 503);
              testInputTopic.pipeInput("k2", "B", 503);
              testInputTopic.pipeInput("k2", "B", 504);
              testInputTopic.pipeInput("k1", "B", 504);
  
              final List<TestRecord<Windowed<String>, String>> results = testOutputTopic.readRecordsToList();
  
              final List<TestRecord<Windowed<String>, String>> expected = new LinkedList<>();
              // k1-A-500
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(0L, 500L)), "0+A", null, 500L));
              // k2-A-500
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(0L, 500L)), "0+A", null, 500L));
              // k2-A-501
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(501L, 1001L)), "0+A", null, 501L));
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(1L, 501L)), "0+A+A", null, 501L));
              // k1-A-502
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(501L, 1001L)), "0+A", null, 502L));
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(2L, 502L)), "0+A+A", null, 502L));
              // k1-B-503
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(501L, 1001L)), "0+A+B", null, 503L));
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(503L, 1003L)), "0+B", null, 503L));
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(3L, 503L)), "0+A+A+B", null, 503L));
              // k2-B-503
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(501L, 1001L)), "0+A+B", null, 503L));
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(502L, 1002)), "0+B", null, 503L));
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(3L, 503L)), "0+A+A+B", null, 503L));
              // k2-B-504
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(502L, 1002L)), "0+B+B", null, 504L));
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(501L, 1001L)), "0+A+B+B", null, 504L));
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(504L, 1004L)), "0+B", null, 504L));
              expected.add(new TestRecord<>(new Windowed<>("k2", new TimeWindow(4L, 504L)), "0+A+A+B+B", null, 504L));
              // k1-B-504
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(503L, 1003L)), "0+B+B", null, 504L));
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(501L, 1001L)), "0+A+B+B", null, 504L));
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(504L, 1004L)), "0+B", null, 504L));
              expected.add(new TestRecord<>(new Windowed<>("k1", new TimeWindow(4L, 504L)), "0+A+A+B+B", null, 504L));
  
              assertEquals(expected, results);
          }
      }
  
      @Test
      public void slidingWindowAggregateOverlappingWindowsTest() {
  
          final KTable<Windowed<String>, String> customers = groupedStream.cogroup(MockAggregator.TOSTRING_ADDER)
                  .windowedBy(SlidingWindows.ofTimeDifferenceAndGrace(ofMillis(WINDOW_SIZE_MS), ofMillis(2000L))).aggregate(
                          MockInitializer.STRING_INIT, Materialized.with(Serdes.String(), Serdes.String()));
          customers.toStream().to(OUTPUT);
  
          try (final TopologyTestDriver driver = new TopologyTestDriver(builder.build(), props)) {
              final TestInputTopic<String, String> testInputTopic = driver.createInputTopic(
                      TOPIC, new StringSerializer(), new StringSerializer());
              final TestOutputTopic<Windowed<String>, String> testOutputTopic = driver.createOutputTopic(
                      OUTPUT, new TimeWindowedDeserializer<>(new StringDeserializer(), WINDOW_SIZE_MS), new StringDeserializer());
  
              testInputTopic.pipeInput("k1", "A", 500);
              testInputTopic.pipeInput("k2", "A", 500);
              testInputTopic.pipeInput("k1", "B", 750);
              testInputTopic.pipeInput("k2", "B", 750);
              testInputTopic.pipeInput("k2", "A", 1000L);
              testInputTopic.pipeInput("k1", "A", 1000L);
  
              // left window k1@500
              assertOutputKeyValueTimestamp(testOutputTopic, "k1", "0+A", 500);
              // left window k2@500
              assertOutputKeyValueTimestamp(testOutputTopic, "k2", "0+A", 500);
              // right window k1@500
              assertOutputKeyValueTimestamp(testOutputTopic, "k1", "0+B", 750);
              // left window k1@750
              assertOutputKeyValueTimestamp(testOutputTopic, "k1", "0+A+B", 750);
              // right window k2@500
              assertOutputKeyValueTimestamp(testOutputTopic, "k2", "0+B", 750);
              // left window k2@750
              assertOutputKeyValueTimestamp(testOutputTopic, "k2", "0+A+B", 750);
              // right window k2@500 update
              assertOutputKeyValueTimestamp(testOutputTopic, "k2", "0+B+A", 1000);
              // right window k2@750
              assertOutputKeyValueTimestamp(testOutputTopic, "k2", "0+A", 1000);
              // left window k2@1000
              assertOutputKeyValueTimestamp(testOutputTopic, "k2", "0+A+B+A", 1000);
              // right window k1@500 update
              assertOutputKeyValueTimestamp(testOutputTopic, "k1", "0+B+A", 1000);
              // right window k1@750
              assertOutputKeyValueTimestamp(testOutputTopic, "k1", "0+A", 1000);
              // left window k1@1000
              assertOutputKeyValueTimestamp(testOutputTopic, "k1", "0+A+B+A", 1000);
          }
      }
  
      private void assertOutputKeyValueTimestamp(final TestOutputTopic<Windowed<String>, String> outputTopic,
                                                 final String expectedKey,
                                                 final String expectedValue,
                                                 final long expectedTimestamp) {
          final TestRecord<Windowed<String>, String> realRecord = outputTopic.readRecord();
          final TestRecord<String, String> nonWindowedRecord = new TestRecord<>(
                  realRecord.getKey().key(), realRecord.getValue(), null, realRecord.timestamp());
          final TestRecord<String, String> testRecord = new TestRecord<>(expectedKey, expectedValue, null, expectedTimestamp);
          assertThat(nonWindowedRecord, equalTo(testRecord));
      }
  }
  