cloud-fan commented on code in PR #56190: URL: https://github.com/apache/spark/pull/56190#discussion_r3493073344
########## sql/core/src/test/scala/org/apache/spark/sql/SessionQueryTestBase.scala: ########## @@ -0,0 +1,80 @@ +/* + * 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 + +// scalastyle:off funsuite +import org.scalatest.funsuite.AnyFunSuite + +import org.apache.spark.CheckErrorHelper +// scalastyle:on + +/** + * TODO should be moved to sql/api + * + * base for fully sql/core independent tests, i.e. this trait could be moved to sql/api and then + * used in sql/connect/client. + */ +trait SessionQueryTestBase + extends AnyFunSuite + with SparkSessionProvider + with CheckAnswerHelper + with CheckErrorHelper + with QueryCleanupHelper { + + /** + * Sets all configurations specified in `pairs`, calls `f`, and then restores all configurations. + * + * Use this instead of `withSQLConf` as [[internal.SQLConf SQLConf]] is not part of Spark's public + * API. + */ + protected def withConf[T](pairs: (String, String)*)(f: => T): T = { + val (keys, values) = pairs.unzip + val currentValues = keys.map { key => + if (spark.conf.contains(key)) { + Some(spark.conf.get(key)) + } else { + None + } + } + keys.lazyZip(values).foreach { (k, v) => + spark.conf.set(k, v) + } + try f finally { + keys.zip(currentValues).foreach { + case (key, Some(value)) => spark.conf.set(key, value) + case (key, None) => spark.conf.unset(key) + } + } + } + + /** + * Documents used session so that tests can handle and document session-specific behaviour + * + * {{{ + * test(...) { + * val df = // query with connect-specific behaviour + * if (sessionType == "connect") { + * checkError(...) + * } else { + * checkAnswer(df, ...) + * } + * } + * }}} + */ + def sessionType: String Review Comment: `sessionType: String` is typo-prone in exactly the way that bites silently: the idiom this trait blesses is `if (sessionType == "connect")`, and a misspelling (`"conenct"`, or even `"Connect"`) compiles and reads `false`, so a Connect run quietly takes the *classic* branch with no error. Since this is the standard hundreds of suites will copy, I'd make it a boolean: ```scala def isConnect: Boolean ``` with `override def isConnect = true` only in `connect.SessionQueryTest` (the base/`classic` default `false`). `isConnect` polarity lets the divergent branch read positively — `if (isConnect) checkError(...) else checkAnswer(...)` — which is the case tests actually special-case. Call sites here move too: the `"classic"`/`"connect"` overrides, the `sessionType == "connect"` checks in `ExampleSessionAgnosticSuite`, and the scaladoc example above. This is the simpler form of the sealed-`SessionType` idea from the 2026-06-23 thread — a boolean is enough for a strictly binary classic/connect split (an orthogonal axis like codegen-on/off would be its own flag anyway). Non-blocking. -- 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]
