zhenlineo commented on code in PR #39712: URL: https://github.com/apache/spark/pull/39712#discussion_r1086095693
########## connector/connect/client/jvm/src/test/scala/org/apache/spark/sql/connect/client/CompatibilitySuite.scala: ########## @@ -0,0 +1,139 @@ +/* + * 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.connect.client + +import java.io.File +import java.net.URLClassLoader +import java.util.regex.Pattern + +import com.typesafe.tools.mima.core._ +import com.typesafe.tools.mima.lib.MiMaLib +import org.scalatest.funsuite.AnyFunSuite // scalastyle:ignore funsuite +import org.apache.spark.sql.connect.client.util.IntegrationTestUtils._ + +/** + * This test requires the following artifacts built before running the tests: + * {{{ + * spark-sql + * spark-connect-client-jvm + * }}} + * To build the above artifact, use e.g. `sbt package` or `mvn clean install -DskipTests`. + * + * When debugging this test, if any changes to the client API, the client jar need to be built + * before re-running the test. An example workflow with SBT for this test: + * 1. Compatibility test reported an unexpected client API change. + * 1. Fix the wrong client API. + * 1. Build the client jar: `sbt package` + * 1. Run the test again: `sbt "testOnly + * org.apache.spark.sql.connect.client.CompatibilitySuite"` + */ +class CompatibilitySuite extends AnyFunSuite { // scalastyle:ignore funsuite + + private lazy val clientJar: File = + findJar( + "connector/connect/client/jvm", + "spark-connect-client-jvm-assembly", + "spark-connect-client-jvm") + + private lazy val sqlJar: File = findJar("sql/core", "spark-sql", "spark-sql") + + test("compatibility mima tests") { + val mima = new MiMaLib(Seq(clientJar, sqlJar)) + val allProblems = mima.collectProblems(sqlJar, clientJar, List.empty) + val includedRules = Seq( + IncludeByName("org.apache.spark.sql.Column"), + IncludeByName("org.apache.spark.sql.Column$"), + IncludeByName("org.apache.spark.sql.Dataset"), + // TODO Add the Dataset object definition Review Comment: https://issues.apache.org/jira/browse/SPARK-42175 This was skipped as I do not want to include too much API impl with the compatibility test PR. -- 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: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
