cashapp · swankjesse · Jun 26, 2023 · Jun 26, 2023
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,14 +1,15 @@
 rootProject.name = "zipline-root"
 
 include(":zipline")
-include(":zipline-testing")
+include(":zipline-api-validator")
+include(":zipline-bytecode")
 include(":zipline-cli")
 include(":zipline-gradle-plugin")
 include(":zipline-kotlin-plugin")
 include(":zipline-kotlin-plugin-tests")
-include(":zipline-bytecode")
 include(":zipline-loader")
 include(":zipline-loader-testing")
 include(":zipline-profiler")
+include(":zipline-testing")
 
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
diff --git a/zipline-api-validator/build.gradle.kts b/zipline-api-validator/build.gradle.kts
@@ -0,0 +1,45 @@
+import com.vanniktech.maven.publish.JavadocJar
+import com.vanniktech.maven.publish.KotlinJvm
+import com.vanniktech.maven.publish.MavenPublishBaseExtension
+import org.gradle.api.plugins.JavaPlugin.TEST_TASK_NAME
+import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation.Companion.TEST_COMPILATION_NAME
+
+plugins {
+  kotlin("jvm")
+  kotlin("kapt")
+  id("com.vanniktech.maven.publish.base")
+}
+
+dependencies {
+  api(kotlin("compiler-embeddable"))
+  api(libs.okio.core)
+
+  kapt(libs.auto.service.compiler)
+  compileOnly(libs.auto.service.annotations)
+
+  testImplementation(projects.zipline)
+  testImplementation(libs.assertk)
+  testImplementation(libs.junit)
+  testImplementation(libs.kotlin.test)
+}
+
+// In order to simplify writing test schemas, inject the test sources and
+// test classpath as properties into the test runtime. This allows testing
+// the FIR-based parser on sources written inside the test case. Cool!
+tasks.named<Test>(TEST_TASK_NAME).configure {
+  val compilation = kotlin.target.compilations.getByName(TEST_COMPILATION_NAME)
+
+  val sources = compilation.defaultSourceSet.kotlin.sourceDirectories.files
+  systemProperty("zipline.internal.sources", sources.joinToString(separator = File.pathSeparator))
+
+  val classpath = project.configurations.getByName(compilation.compileDependencyConfigurationName).files
+  systemProperty("zipline.internal.classpath", classpath.joinToString(separator = File.pathSeparator))
+}
+
+configure<MavenPublishBaseExtension> {
+  configure(
+    KotlinJvm(
+      javadocJar = JavadocJar.Empty()
+    )
+  )
+}
diff --git a/...compatibility/ApiCompatibilityDecision.kt → ...api/validator/ApiCompatibilityDecision.kt b/...compatibility/ApiCompatibilityDecision.kt → ...api/validator/ApiCompatibilityDecision.kt
@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.compatibility
+package app.cash.zipline.api.validator
 
-import app.cash.zipline.api.fir.FirZiplineApi
-import app.cash.zipline.api.toml.TomlZiplineApi
-import app.cash.zipline.api.toml.TomlZiplineFunction
-import app.cash.zipline.api.toml.TomlZiplineService
+import app.cash.zipline.api.validator.fir.FirZiplineApi
+import app.cash.zipline.api.validator.toml.TomlZiplineApi
+import app.cash.zipline.api.validator.toml.TomlZiplineFunction
+import app.cash.zipline.api.validator.toml.TomlZiplineService
 
 sealed interface ApiCompatibilityDecision
 

diff --git a/...in/kotlin/app/cash/zipline/api/fir/Fir.kt → ...app/cash/zipline/api/validator/fir/Fir.kt b/...in/kotlin/app/cash/zipline/api/fir/Fir.kt → ...app/cash/zipline/api/validator/fir/Fir.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.fir
+package app.cash.zipline.api.validator.fir
 
 import org.jetbrains.kotlin.fir.FirSession
 import org.jetbrains.kotlin.fir.declarations.FirClass

diff --git a/...ash/zipline/api/fir/FirZiplineFunction.kt → ...ipline/api/validator/fir/FirZiplineApi.kt b/...ash/zipline/api/fir/FirZiplineFunction.kt → ...ipline/api/validator/fir/FirZiplineApi.kt
@@ -13,9 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.fir
+package app.cash.zipline.api.validator.fir
 
-import app.cash.zipline.kotlin.signatureHash
+data class FirZiplineApi(
+  val services: List<FirZiplineService>,
+)
+
+/** An interface that extends from ZiplineService. */
+data class FirZiplineService(
+  val name: String,
+  val functions: List<FirZiplineFunction>,
+)
 
 data class FirZiplineFunction(
   val id: String,

diff --git a/...sh/zipline/api/fir/FirZiplineApiReader.kt → .../api/validator/fir/FirZiplineApiReader.kt b/...sh/zipline/api/fir/FirZiplineApiReader.kt → .../api/validator/fir/FirZiplineApiReader.kt
@@ -13,11 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.fir
+package app.cash.zipline.api.validator.fir
 
-import app.cash.zipline.kotlin.BridgedInterface.Companion.NON_INTERFACE_FUNCTION_NAMES
-import app.cash.zipline.kotlin.FqPackageName
-import app.cash.zipline.kotlin.classId
 import java.io.File
 import org.jetbrains.kotlin.fir.FirSession
 import org.jetbrains.kotlin.fir.analysis.checkers.isSupertypeOf
@@ -38,6 +35,9 @@ import org.jetbrains.kotlin.fir.types.FirTypeProjection
 import org.jetbrains.kotlin.fir.types.FirTypeProjectionWithVariance
 import org.jetbrains.kotlin.fir.types.FirTypeRef
 import org.jetbrains.kotlin.fir.types.FirUserTypeRef
+import org.jetbrains.kotlin.name.ClassId
+import org.jetbrains.kotlin.name.FqName
+import org.jetbrains.kotlin.name.Name
 import org.jetbrains.kotlin.types.Variance
 
 fun readFirZiplineApi(
@@ -50,8 +50,8 @@ fun readFirZiplineApi(
   }
 }
 
-private val ziplineFqPackage = FqPackageName("app.cash.zipline")
-private val ziplineServiceClassId = ziplineFqPackage.classId("ZiplineService")
+private val ziplineServiceClassId =
+  ClassId(FqName("app.cash.zipline"), Name.identifier("ZiplineService"))
 
 /**
  * Read the frontend intermediate representation of a program and emit its ZiplineService

diff --git a/...p/cash/zipline/api/fir/KotlinFirLoader.kt → ...line/api/validator/fir/KotlinFirLoader.kt b/...p/cash/zipline/api/fir/KotlinFirLoader.kt → ...line/api/validator/fir/KotlinFirLoader.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.fir
+package app.cash.zipline.api.validator.fir
 
 import java.io.File
 import org.jetbrains.kotlin.KtVirtualFileSourceFile

diff --git a/...app/cash/zipline/api/fir/FirZiplineApi.kt → .../zipline/api/validator/fir/ZiplineApis.kt b/...app/cash/zipline/api/fir/FirZiplineApi.kt → .../zipline/api/validator/fir/ZiplineApis.kt
@@ -13,8 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.fir
+package app.cash.zipline.api.validator.fir
 
-data class FirZiplineApi(
-  val services: List<FirZiplineService>,
+import okio.ByteString.Companion.encodeUtf8
+
+internal fun String.signatureHash(): String =
+  encodeUtf8().sha256().substring(0, 6).base64() // In base64, 6 bytes takes 8 chars.
+
+/** Don't bridge these. */
+internal val NON_INTERFACE_FUNCTION_NAMES = setOf(
+  "equals",
+  "hashCode",
+  "toString",
 )
diff --git a/...p/cash/zipline/api/toml/TomlZiplineApi.kt → ...line/api/validator/toml/TomlZiplineApi.kt b/...p/cash/zipline/api/toml/TomlZiplineApi.kt → ...line/api/validator/toml/TomlZiplineApi.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.toml
+package app.cash.zipline.api.validator.toml
 
 data class TomlZiplineApi(
   val services: List<TomlZiplineService>,

diff --git a/.../zipline/api/toml/ZiplineApiTomlReader.kt → ...pi/validator/toml/ZiplineApiTomlReader.kt b/.../zipline/api/toml/ZiplineApiTomlReader.kt → ...pi/validator/toml/ZiplineApiTomlReader.kt
@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.toml
+package app.cash.zipline.api.validator.toml
 
 import okio.BufferedSource
 import okio.ByteString.Companion.encodeUtf8
 import okio.IOException
 import okio.Options
 
-fun BufferedSource.readZiplineApi(): TomlZiplineApi {
+fun BufferedSource.readTomlZiplineApi(): TomlZiplineApi {
   return TomlZiplineApiReader(this).readServices()
 }
 

diff --git a/.../zipline/api/toml/ZiplineApiTomlWriter.kt → ...pi/validator/toml/ZiplineApiTomlWriter.kt b/.../zipline/api/toml/ZiplineApiTomlWriter.kt → ...pi/validator/toml/ZiplineApiTomlWriter.kt
@@ -13,11 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.toml
+package app.cash.zipline.api.validator.toml
 
 import okio.BufferedSink
 
-fun BufferedSink.writeZiplineApi(api: TomlZiplineApi) {
+fun BufferedSink.writeTomlZiplineApi(api: TomlZiplineApi) {
   TomlZiplineApiWriter(this).writeApi(api)
 }
 

diff --git a/...atibility/ApiCompatibilityDecisionTest.kt → ...validator/ApiCompatibilityDecisionTest.kt b/...atibility/ApiCompatibilityDecisionTest.kt → ...validator/ApiCompatibilityDecisionTest.kt
@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.compatibility
+package app.cash.zipline.api.validator
 
-import app.cash.zipline.api.fir.FirZiplineApi
-import app.cash.zipline.api.fir.FirZiplineFunction
-import app.cash.zipline.api.fir.FirZiplineService
-import app.cash.zipline.api.toml.TomlZiplineApi
-import app.cash.zipline.api.toml.TomlZiplineFunction
-import app.cash.zipline.api.toml.TomlZiplineService
-import app.cash.zipline.kotlin.signatureHash
+import app.cash.zipline.api.validator.fir.FirZiplineApi
+import app.cash.zipline.api.validator.fir.FirZiplineFunction
+import app.cash.zipline.api.validator.fir.FirZiplineService
+import app.cash.zipline.api.validator.fir.signatureHash
+import app.cash.zipline.api.validator.toml.TomlZiplineApi
+import app.cash.zipline.api.validator.toml.TomlZiplineFunction
+import app.cash.zipline.api.validator.toml.TomlZiplineService
 import assertk.assertThat
 import assertk.assertions.containsExactly
 import assertk.assertions.isEqualTo

diff --git a/...ipline/api/fir/FirZiplineApiReaderTest.kt → .../validator/fir/FirZiplineApiReaderTest.kt b/...ipline/api/fir/FirZiplineApiReaderTest.kt → .../validator/fir/FirZiplineApiReaderTest.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.fir
+package app.cash.zipline.api.validator.fir
 
 import app.cash.zipline.ZiplineService
 import assertk.assertThat

diff --git a/...line/api/toml/ZiplineApiTomlReaderTest.kt → ...alidator/toml/TomlZiplineApiReaderTest.kt b/...line/api/toml/ZiplineApiTomlReaderTest.kt → ...alidator/toml/TomlZiplineApiReaderTest.kt
@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.toml
+package app.cash.zipline.api.validator.toml
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
 import okio.Buffer
 import org.junit.Test
 
-internal class ZiplineApiTomlReaderTest {
+internal class TomlZiplineApiReaderTest {
   @Test
   fun happyPath() {
     val toml = Buffer().writeUtf8(
@@ -37,7 +37,7 @@ internal class ZiplineApiTomlReaderTest {
       """.trimMargin(),
     )
 
-    val ziplineApi = toml.readZiplineApi()
+    val ziplineApi = toml.readTomlZiplineApi()
     assertThat(ziplineApi).isEqualTo(
       TomlZiplineApi(
         services = listOf(
@@ -70,7 +70,7 @@ internal class ZiplineApiTomlReaderTest {
       """.trimMargin(),
     )
 
-    val ziplineApi = toml.readZiplineApi()
+    val ziplineApi = toml.readTomlZiplineApi()
     assertThat(ziplineApi).isEqualTo(
       TomlZiplineApi(
         services = listOf(
@@ -108,7 +108,7 @@ internal class ZiplineApiTomlReaderTest {
       """.trimMargin(),
     )
 
-    val ziplineApi = toml.readZiplineApi()
+    val ziplineApi = toml.readTomlZiplineApi()
     assertThat(ziplineApi).isEqualTo(
       TomlZiplineApi(
         services = listOf(

diff --git a/...line/api/toml/ZiplineApiTomlWriterTest.kt → ...alidator/toml/TomlZiplineApiWriterTest.kt b/...line/api/toml/ZiplineApiTomlWriterTest.kt → ...alidator/toml/TomlZiplineApiWriterTest.kt
@@ -13,18 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package app.cash.zipline.api.toml
+package app.cash.zipline.api.validator.toml
 
 import assertk.assertThat
 import assertk.assertions.isEqualTo
 import okio.Buffer
 import org.junit.Test
 
-internal class ZiplineApiTomlWriterTest {
+internal class TomlZiplineApiWriterTest {
   @Test
   fun happyPath() {
     val buffer = Buffer().apply {
-      writeZiplineApi(
+      writeTomlZiplineApi(
         TomlZiplineApi(
           services = listOf(
             TomlZiplineService(
@@ -64,7 +64,7 @@ internal class ZiplineApiTomlWriterTest {
   @Test
   fun multipleServices() {
     val buffer = Buffer().apply {
-      writeZiplineApi(
+      writeTomlZiplineApi(
         TomlZiplineApi(
           services = listOf(
             TomlZiplineService(

diff --git a/zipline-cli/build.gradle.kts b/zipline-cli/build.gradle.kts
@@ -45,6 +45,7 @@ kotlin {
 }
 
 dependencies {
+  api(projects.ziplineApiValidator)
   api(projects.ziplineLoader)
   implementation(libs.okHttp.core)
   implementation(libs.picocli)

diff --git a/zipline-gradle-plugin/build.gradle.kts b/zipline-gradle-plugin/build.gradle.kts
@@ -21,6 +21,7 @@ kotlin {
 dependencies {
   implementation(kotlin("gradle-plugin-api"))
   implementation(projects.zipline)
+  implementation(projects.ziplineApiValidator)
   implementation(projects.ziplineBytecode)
   implementation(projects.ziplineKotlinPlugin)
   implementation(projects.ziplineLoader)
@@ -71,6 +72,7 @@ tasks {
       }
     )
     systemProperty("ziplineVersion", project.version)
+    dependsOn(":zipline-api-validator:publishAllPublicationsToTestMavenRepository")
     dependsOn(":zipline-bytecode:publishAllPublicationsToTestMavenRepository")
     dependsOn(":zipline-gradle-plugin:publishAllPublicationsToTestMavenRepository")
     dependsOn(":zipline-kotlin-plugin:publishAllPublicationsToTestMavenRepository")

diff --git a/...ipline/gradle/ZiplineApiValidationTask.kt → ...zipline/gradle/ZiplineApiValidatorTask.kt b/...ipline/gradle/ZiplineApiValidationTask.kt → ...zipline/gradle/ZiplineApiValidatorTask.kt
@@ -16,14 +16,14 @@
 
 package app.cash.zipline.gradle
 
-import app.cash.zipline.api.compatibility.ActualApiHasProblems
-import app.cash.zipline.api.compatibility.ExpectedApiIsUpToDate
-import app.cash.zipline.api.compatibility.ExpectedApiRequiresUpdates
-import app.cash.zipline.api.compatibility.makeApiCompatibilityDecision
-import app.cash.zipline.api.fir.readFirZiplineApi
-import app.cash.zipline.api.toml.TomlZiplineApi
-import app.cash.zipline.api.toml.readZiplineApi
-import app.cash.zipline.api.toml.writeZiplineApi
+import app.cash.zipline.api.validator.ActualApiHasProblems
+import app.cash.zipline.api.validator.ExpectedApiIsUpToDate
+import app.cash.zipline.api.validator.ExpectedApiRequiresUpdates
+import app.cash.zipline.api.validator.fir.readFirZiplineApi
+import app.cash.zipline.api.validator.makeApiCompatibilityDecision
+import app.cash.zipline.api.validator.toml.TomlZiplineApi
+import app.cash.zipline.api.validator.toml.readTomlZiplineApi
+import app.cash.zipline.api.validator.toml.writeTomlZiplineApi
 import javax.inject.Inject
 import okio.buffer
 import okio.sink
@@ -38,7 +38,7 @@ import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.TaskAction
 
 @Suppress("unused") // Public API for Gradle plugin users.
-abstract class ZiplineApiValidationTask @Inject constructor(
+abstract class ZiplineApiValidatorTask @Inject constructor(
   fileCollectionFactory: FileCollectionFactory,
   @Input val mode: Mode,
 ) : DefaultTask() {
@@ -69,7 +69,7 @@ abstract class ZiplineApiValidationTask @Inject constructor(
     val tomlFile = ziplineApiFile.get().asFile
 
     val expectedZiplineApi = when {
-      tomlFile.exists() -> tomlFile.source().buffer().use { it.readZiplineApi() }
+      tomlFile.exists() -> tomlFile.source().buffer().use { it.readTomlZiplineApi() }
       else -> TomlZiplineApi(listOf())
     }
 
@@ -99,7 +99,7 @@ abstract class ZiplineApiValidationTask @Inject constructor(
 
           Mode.Dump -> {
             logger.info("Updated $tomlFileRelative because Zipline API has changed")
-            tomlFile.sink().buffer().use { it.writeZiplineApi(decision.updatedApi) }
+            tomlFile.sink().buffer().use { it.writeTomlZiplineApi(decision.updatedApi) }
           }
         }
       }