anishshri-db commented on code in PR #45467: URL: https://github.com/apache/spark/pull/45467#discussion_r1530875269
########## sql/core/src/test/scala/org/apache/spark/sql/streaming/TransformWithStateInitialStateSuite.scala: ########## @@ -0,0 +1,286 @@ +/* + * 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.spark.sql.streaming + +import org.apache.spark.sql.{Encoders, KeyValueGroupedDataset} +import org.apache.spark.sql.execution.streaming.MemoryStream +import org.apache.spark.sql.execution.streaming.state.{AlsoTestWithChangelogCheckpointingEnabled, RocksDBStateStoreProvider, StateStoreMultipleColumnFamiliesNotSupportedException} +import org.apache.spark.sql.internal.SQLConf + +case class InitInputRow(key: String, action: String, value: Double) +case class InputRowForInitialState( + value: Double, entries: List[Double], mapping: Map[Double, Int]) + +abstract class StatefulProcessorWithInitialStateTestClass[V] + extends StatefulProcessorWithInitialState[ + String, InitInputRow, (String, String, Double), (String, V)] { + @transient var _valState: ValueState[Double] = _ + @transient var _listState: ListState[Double] = _ + @transient var _mapState: MapState[Double, Int] = _ + + override def init(outputMode: OutputMode, timeoutMode: TimeoutMode): Unit = { + _valState = getHandle.getValueState[Double]("testValueInit", Encoders.scalaDouble) + _listState = getHandle.getListState[Double]("testListInit", Encoders.scalaDouble) + _mapState = getHandle.getMapState[Double, Int]( + "testMapInit", Encoders.scalaDouble, Encoders.scalaInt) + } + + override def close(): Unit = {} + + override def handleInputRows( + key: String, + inputRows: Iterator[InitInputRow], + timerValues: TimerValues, + expiredTimerInfo: ExpiredTimerInfo): Iterator[(String, String, Double)] = { + var output = List[(String, String, Double)]() + for (row <- inputRows) { + if (row.action == "getOption") { + output = (key, row.action, _valState.getOption().getOrElse(-1.0)) :: output + } else if (row.action == "update") { + _valState.update(row.value) + } else if (row.action == "remove") { + _valState.clear() + } else if (row.action == "getList") { + _listState.get().foreach { element => + output = (key, row.action, element) :: output + } + } else if (row.action == "appendList") { + _listState.appendValue(row.value) + } else if (row.action == "clearList") { + _listState.clear() + } else if (row.action == "getCount") { + val count = + if (!_mapState.containsKey(row.value)) 0 + else _mapState.getValue(row.value) + output = (key, row.action, count.toDouble) :: output + } else if (row.action == "incCount") { + val count = + if (!_mapState.containsKey(row.value)) 0 + else _mapState.getValue(row.value) + _mapState.updateValue(row.value, count + 1) + } else if (row.action == "clearCount") { + _mapState.removeKey(row.value) + } + } + output.iterator + } +} + +class AccumulateStatefulProcessorWithInitState + extends StatefulProcessorWithInitialStateTestClass[Double] { + override def handleInitialState( + key: String, + initialState: (String, Double)): Unit = { + _valState.update(initialState._2) + } + + override def handleInputRows( + key: String, + inputRows: Iterator[InitInputRow], + timerValues: TimerValues, + expiredTimerInfo: ExpiredTimerInfo): Iterator[(String, String, Double)] = { + var output = List[(String, String, Double)]() + for (row <- inputRows) { + if (row.action == "getOption") { + output = (key, row.action, _valState.getOption().getOrElse(0.0)) :: output + } else if (row.action == "add") { + // Update state variable as accumulative sum + val accumulateSum = _valState.getOption().getOrElse(0.0) + row.value + _valState.update(accumulateSum) + } else if (row.action == "remove") { + _valState.clear() + } + } + output.iterator + } +} + +class InitialStateInMemoryTestClass + extends StatefulProcessorWithInitialStateTestClass[InputRowForInitialState] { + override def handleInitialState( + key: String, + initialState: (String, InputRowForInitialState)): Unit = { + _valState.update(initialState._2.value) + _listState.appendList(initialState._2.entries.toArray) + val inMemoryMap = initialState._2.mapping + inMemoryMap.foreach { kvPair => + _mapState.updateValue(kvPair._1, kvPair._2) + } + } +} + +/** + * Class that adds tests for transformWithState stateful + * streaming operator with user-defined initial state + */ +class TransformWithStateInitialStateSuite extends StateStoreMetricsTest + with AlsoTestWithChangelogCheckpointingEnabled { + + import testImplicits._ + + private def createInitialDfForTest: KeyValueGroupedDataset[String, (String, Double)] = { + Seq(("init_1", 40.0), ("init_2", 100.0)).toDS() + .groupByKey(x => x._1) + .mapValues(x => x) + } + + + test("transformWithStateWithInitialState - correctness test, " + + "run with multiple state variables - in-memory type") { + withSQLConf(SQLConf.STATE_STORE_PROVIDER_CLASS.key -> + classOf[RocksDBStateStoreProvider].getName) { + + val inputData = MemoryStream[InitInputRow] + val kvDataSet = inputData.toDS() + .groupByKey(x => x.key) + val initStateDf = + Seq(("init_1", InputRowForInitialState(40.0, List(40.0), Map(40.0 -> 1))), + ("init_2", InputRowForInitialState(100.0, List(100.0), Map(100.0 -> 1)))) + .toDS().groupByKey(x => x._1).mapValues(x => x) + val query = kvDataSet.transformWithState(new InitialStateInMemoryTestClass(), + TimeoutMode.NoTimeouts (), OutputMode.Append (), initStateDf) + + testStream(query, OutputMode.Update())( + // non-exist key test + AddData(inputData, InitInputRow("k1", "update", 37.0)), + AddData(inputData, InitInputRow("k2", "update", 40.0)), + AddData(inputData, InitInputRow("non-exist", "getOption", -1.0)), + CheckNewAnswer(("non-exist", "getOption", -1.0)), + AddData(inputData, InitInputRow("k1", "appendList", 37.0)), + AddData(inputData, InitInputRow("k2", "appendList", 40.0)), + AddData(inputData, InitInputRow("non-exist", "getList", -1.0)), + CheckNewAnswer(), + + AddData(inputData, InitInputRow("k1", "incCount", 37.0)), + AddData(inputData, InitInputRow("k2", "incCount", 40.0)), + AddData(inputData, InitInputRow("non-exist", "getCount", -1.0)), + CheckNewAnswer(("non-exist", "getCount", 0.0)), + AddData(inputData, InitInputRow("k2", "incCount", 40.0)), + AddData(inputData, InitInputRow("k2", "getCount", 40.0)), + CheckNewAnswer(("k2", "getCount", 2.0)), + + // test every row in initial State is processed + AddData(inputData, InitInputRow("init_1", "getOption", -1.0)), + CheckNewAnswer(("init_1", "getOption", 40.0)), + AddData(inputData, InitInputRow("init_2", "getOption", -1.0)), + CheckNewAnswer(("init_2", "getOption", 100.0)), + + AddData(inputData, InitInputRow("init_1", "getList", -1.0)), + CheckNewAnswer(("init_1", "getList", 40.0)), + AddData(inputData, InitInputRow("init_2", "getList", -1.0)), + CheckNewAnswer(("init_2", "getList", 100.0)), + + AddData(inputData, InitInputRow("init_1", "getCount", 40.0)), + CheckNewAnswer(("init_1", "getCount", 1.0)), + AddData(inputData, InitInputRow("init_2", "getCount", 100.0)), + CheckNewAnswer(("init_2", "getCount", 1.0)), + + // Update row with key in initial row will work + AddData(inputData, InitInputRow("init_1", "update", 50.0)), + AddData(inputData, InitInputRow("init_1", "getOption", -1.0)), + CheckNewAnswer(("init_1", "getOption", 50.0)), + AddData(inputData, InitInputRow("init_1", "remove", -1.0)), + AddData(inputData, InitInputRow("init_1", "getOption", -1.0)), + CheckNewAnswer(("init_1", "getOption", -1.0)), + + AddData(inputData, InitInputRow("init_1", "appendList", 50.0)), + AddData(inputData, InitInputRow("init_1", "getList", -1.0)), + CheckNewAnswer(("init_1", "getList", 50.0), ("init_1", "getList", 40.0)), + + AddData(inputData, InitInputRow("init_1", "incCount", 40.0)), + AddData(inputData, InitInputRow("init_1", "getCount", 40.0)), + CheckNewAnswer(("init_1", "getCount", 2.0)), + + // test remove + AddData(inputData, InitInputRow("k1", "remove", -1.0)), + AddData(inputData, InitInputRow("k1", "getOption", -1.0)), + CheckNewAnswer(("k1", "getOption", -1.0)), + + AddData(inputData, InitInputRow("init_1", "clearCount", -1.0)), + AddData(inputData, InitInputRow("init_1", "getCount", -1.0)), + CheckNewAnswer(("init_1", "getCount", 0.0)), + + AddData(inputData, InitInputRow("init_1", "clearList", -1.0)), + AddData(inputData, InitInputRow("init_1", "getList", -1.0)), + CheckNewAnswer() + ) + } + } + + + test("transformWithStateWithInitialState -" + + " correctness test, processInitialState should only run once") { + withSQLConf(SQLConf.STATE_STORE_PROVIDER_CLASS.key -> + classOf[RocksDBStateStoreProvider].getName) { + val initStateDf = createInitialDfForTest + val inputData = MemoryStream[InitInputRow] + val query = inputData.toDS() + .groupByKey(x => x.key) + .transformWithState(new AccumulateStatefulProcessorWithInitState(), + TimeoutMode.NoTimeouts(), OutputMode.Append(), initStateDf + ) + testStream(query, OutputMode.Update())( + AddData(inputData, InitInputRow("init_1", "add", 50.0)), + AddData(inputData, InitInputRow("init_2", "add", 60.0)), + AddData(inputData, InitInputRow("init_1", "add", 50.0)), + // If processInitialState was processed multiple times, + // following checks will fail + AddData(inputData, + InitInputRow("init_1", "getOption", -1.0), InitInputRow("init_2", "getOption", -1.0)), + CheckNewAnswer(("init_2", "getOption", 160.0), ("init_1", "getOption", 140.0)) + ) + } + } + + test("transformWithStateWithInitialState - batch should succeed") { + val inputData = Seq(InitInputRow("k1", "add", 37.0), InitInputRow("k1", "getOption", -1.0)) + val result = inputData.toDS() + .groupByKey(x => x.key) + .transformWithState(new AccumulateStatefulProcessorWithInitState(), + TimeoutMode.NoTimeouts(), + OutputMode.Append(), + createInitialDfForTest) + + val df = result.toDF() + checkAnswer(df, Seq(("k1", "getOption", 37.0)).toDF()) + } +} + +class TransformWithStateInitialStateValidationSuite extends StateStoreMetricsTest { Review Comment: we can just move this test to the validation suite we have in `TransformWithStateSuite` ? or we can move the validation tests out as a separate file and move this test there ? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
