Add binary API compatibility checks to v1 branch (#1427)

buildSrc/build.gradle.kts

@@ -23,6 +23,7 @@ repositories {
 }
 
 object Versions {
+    const val binaryCompatibilityValidator = "0.14.0"
     const val detekt = "1.20.0-RC1"
     const val dokka = "1.6.10"
     const val kotlin = "1.6.20"
@@ -31,6 +32,7 @@ object Versions {
 }
 
 object Plugins {
+    const val binaryCompatibilityValidator = "org.jetbrains.kotlinx:binary-compatibility-validator:${Versions.binaryCompatibilityValidator}"
     const val detekt = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:${Versions.detekt}"
     const val dokka = "org.jetbrains.dokka:dokka-gradle-plugin:${Versions.dokka}"
     const val kotlinGradle = "org.jetbrains.kotlin:kotlin-gradle-plugin:${Versions.kotlin}"
@@ -44,6 +46,7 @@ dependencies {
     implementation(Plugins.kotlinGradle)
     implementation(Plugins.ktlint)
     implementation(Plugins.pig)
+    implementation(Plugins.binaryCompatibilityValidator)
 }
 
 allprojects {

buildSrc/src/main/kotlin/org/partiql/gradle/plugin/publish/PublishPlugin.kt

@@ -34,6 +34,7 @@ import org.jetbrains.dokka.gradle.DokkaPlugin
 import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.dsl.ExplicitApiMode
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
+import kotlinx.validation.BinaryCompatibilityValidatorPlugin
 import java.io.File
 
 /**
@@ -51,6 +52,12 @@ abstract class PublishPlugin : Plugin<Project> {
         pluginManager.apply(MavenPublishPlugin::class.java)
         pluginManager.apply(SigningPlugin::class.java)
         pluginManager.apply(DokkaPlugin::class.java)
+        // Use https://github.com/Kotlin/binary-compatibility-validator to maintain list of public binary APIs (defaults
+        // to <project dir>/api/<project dir>.api). When changes are made to public APIs (e.g. modifying a public class,
+        // adding a public function, etc.), the gradle `apiCheck` task will fail. To fix this error, run the `apiDump` task
+        // to update these .api files and commit the changes.
+        // See https://github.com/Kotlin/binary-compatibility-validator#optional-parameters for additional configuration.
+        pluginManager.apply(BinaryCompatibilityValidatorPlugin::class.java)
         extensions.getByType(KotlinJvmProjectExtension::class.java).explicitApi = ExplicitApiMode.Strict
         val ext = extensions.create("publish", PublishExtension::class.java)
         target.afterEvaluate { publish(ext) }

partiql-coverage/api/partiql-coverage.api

@@ -0,0 +1,14 @@
+public abstract interface annotation class org/partiql/coverage/api/PartiQLTest : java/lang/annotation/Annotation {
+	public abstract fun provider ()Ljava/lang/Class;
+}
+
+public abstract interface class org/partiql/coverage/api/PartiQLTestCase {
+	public abstract fun getSession ()Lorg/partiql/lang/eval/EvaluationSession;
+}
+
+public abstract interface class org/partiql/coverage/api/PartiQLTestProvider {
+	public abstract fun getPipelineBuilder ()Lorg/partiql/lang/CompilerPipeline$Builder;
+	public abstract fun getStatement ()Ljava/lang/String;
+	public abstract fun getTestCases ()Ljava/lang/Iterable;
+}
+

partiql-eval/api/partiql-eval.api

@@ -0,0 +1,65 @@
+public abstract interface class org/partiql/eval/PartiQLEngine {
+	public static final field Companion Lorg/partiql/eval/PartiQLEngine$Companion;
+	public static fun builder ()Lorg/partiql/eval/PartiQLEngineBuilder;
+	public static fun default ()Lorg/partiql/eval/PartiQLEngine;
+	public abstract fun execute (Lorg/partiql/eval/PartiQLStatement;)Lorg/partiql/eval/PartiQLResult;
+	public abstract fun prepare (Lorg/partiql/plan/PartiQLPlan;Lorg/partiql/eval/PartiQLEngine$Session;)Lorg/partiql/eval/PartiQLStatement;
+}
+
+public final class org/partiql/eval/PartiQLEngine$Companion {
+	public final fun builder ()Lorg/partiql/eval/PartiQLEngineBuilder;
+	public final fun default ()Lorg/partiql/eval/PartiQLEngine;
+}
+
+public final class org/partiql/eval/PartiQLEngine$Mode : java/lang/Enum {
+	public static final field PERMISSIVE Lorg/partiql/eval/PartiQLEngine$Mode;
+	public static final field STRICT Lorg/partiql/eval/PartiQLEngine$Mode;
+	public static fun valueOf (Ljava/lang/String;)Lorg/partiql/eval/PartiQLEngine$Mode;
+	public static fun values ()[Lorg/partiql/eval/PartiQLEngine$Mode;
+}
+
+public final class org/partiql/eval/PartiQLEngine$Session {
+	public fun <init> ()V
+	public fun <init> (Ljava/util/Map;Lorg/partiql/eval/PartiQLEngine$Mode;)V
+	public synthetic fun <init> (Ljava/util/Map;Lorg/partiql/eval/PartiQLEngine$Mode;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun getCatalogs ()Ljava/util/Map;
+	public final fun getMode ()Lorg/partiql/eval/PartiQLEngine$Mode;
+}
+
+public final class org/partiql/eval/PartiQLEngineBuilder {
+	public fun <init> ()V
+	public final fun build ()Lorg/partiql/eval/PartiQLEngine;
+}
+
+public abstract interface class org/partiql/eval/PartiQLResult {
+}
+
+public final class org/partiql/eval/PartiQLResult$Error : org/partiql/eval/PartiQLResult {
+	public fun <init> (Ljava/lang/Throwable;)V
+	public final fun component1 ()Ljava/lang/Throwable;
+	public final fun copy (Ljava/lang/Throwable;)Lorg/partiql/eval/PartiQLResult$Error;
+	public static synthetic fun copy$default (Lorg/partiql/eval/PartiQLResult$Error;Ljava/lang/Throwable;ILjava/lang/Object;)Lorg/partiql/eval/PartiQLResult$Error;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getCause ()Ljava/lang/Throwable;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class org/partiql/eval/PartiQLResult$Value : org/partiql/eval/PartiQLResult {
+	public fun <init> (Lorg/partiql/value/PartiQLValue;)V
+	public final fun component1 ()Lorg/partiql/value/PartiQLValue;
+	public final fun copy (Lorg/partiql/value/PartiQLValue;)Lorg/partiql/eval/PartiQLResult$Value;
+	public static synthetic fun copy$default (Lorg/partiql/eval/PartiQLResult$Value;Lorg/partiql/value/PartiQLValue;ILjava/lang/Object;)Lorg/partiql/eval/PartiQLResult$Value;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getValue ()Lorg/partiql/value/PartiQLValue;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public abstract interface class org/partiql/eval/PartiQLStatement {
+	public abstract fun execute ()Ljava/lang/Object;
+}
+
+public abstract interface class org/partiql/eval/PartiQLStatement$Query : org/partiql/eval/PartiQLStatement {
+}
+