streem · sebleclerc · Mar 5, 2020 · Mar 5, 2020 · Mar 5, 2020 · Apr 1, 2020
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,7 +3,6 @@
 #
 version: 2.1
 
-
 executors:
   jvm:
     docker:
@@ -17,6 +16,9 @@ executors:
     docker:
       - image: circleci/node:lts
 
+  native:
+    docker:
+      - image: cimg/base:2020.01
 
 jobs:
 
@@ -105,7 +107,7 @@ jobs:
 
       - run:
           name: Build conformance test suite
-          command: ./gradlew :conformance:lib:assemble :conformance:jvm:installDist
+          command: ./gradlew :conformance:lib:assemble :conformance:jvm:installDist :conformance:native:build
 
       # persist files necessary to run conformance tests
       - persist_to_workspace:
@@ -119,6 +121,9 @@ jobs:
             - build/js
             - conformance/js/failing_tests.txt
             - conformance/js/run.sh
+            # native
+            - conformance/native/build/bin/linux/debugExecutable/conformance.kexe
+            - conformance/native/failing_tests.txt
 
       - save_cache:
           name: Save dependencies cache
@@ -167,6 +172,24 @@ jobs:
             export CONF_TEST_PATH=~/protobuf/conformance/conformance-test-runner
             ./conformance/test-conformance.sh js
 
+  conformance_native:
+    executor:
+      name: native
+
+    steps:
+      - attach_workspace:
+          at: ~/project
+
+      - restore_cache:
+          name: Restore protobuf cache
+          keys:
+            - v3-protobuf-3.10.1
+
+      - run:
+          name: Run Native conformance tests
+          command: |
+            export CONF_TEST_PATH=~/protobuf/conformance/conformance-test-runner
+            ./conformance/test-conformance.sh linux
 
   build_examples:
     executor:
@@ -228,6 +251,9 @@ workflows:
       - conformance_js:
           requires:
             - build
+      - conformance_native:
+          requires:
+            - build
       - build_examples:
           requires:
             - build
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ It is built to work across multiple Kotlin platforms.
 **Features**
 
 * Clean data class generation
-* Works for JVM and JS
+* Works for JVM, JS and Native
 * Support for proto2 and proto3 syntaxes
 * Oneof's are properly handled as sealed classes
 * Specialized support to handle wrappers from the well-known types (e.g. `StringValue`, `BoolValue`) as nullable primitives (`String?`, `Boolean?`, etc.)
@@ -21,8 +21,6 @@ It is built to work across multiple Kotlin platforms.
 
 **Not Yet Implemented**
 
-* Kotlin Native runtime support
-* Protobuf code generator in Kotlin Native for easier importing
 * Specialized support for more of the well known types (e.g. `Any`)
 * Support for protobuf annotations
 * Access to the protobuf descriptor from generated code
@@ -186,6 +184,13 @@ rename it to `protoc-gen-kotlin`, make the file executable (`chmod +x protoc-gen
 protoc --kotlin_out=src/main/kotlin sample.proto
 ```
 
+For Windows however, `protoc` doesn't support finding `protoc-gen-kotlin.bat` on the `PATH`. So it has to be specified
+explicitly as a plugin:
+
+```
+protoc --kotlin_out=src/main/kotlin --plugin=protoc-gen-kotlin=path/to/protoc-gen-kotlin.bat sample.proto
+```
+
 The file is generated as `sample.kt` in the subdirectories specified by the package. Like other `X_out` arguments,
 comma-separated options can be added to `--kotlin_out` before the colon and out dir path. To explicitly set the Kotlin
 package to `my.pkg`, use the `kotlin_package` option like so:
@@ -234,7 +239,15 @@ Then the dependency can be added for JVM libraries:
 
 ```
 dependencies {
-    implementation 'com.github.streem.pbandk:pbandk-runtime-jvm:0.8.1'
+    implementation 'com.github.streem.pbandk:pbandk-runtime-jvm:0.9.0-SNAPSHOT'
+}
+```
+
+or for the Native libraries:
+
+```
+dependencies {
+    implementation "com.github.streem.pbandk:pbandk-runtime-native:0.9.0-SNAPSHOT
 }
 ```
 
@@ -253,7 +266,7 @@ runtime:
 
 ```
 dependencies {
-    compileOnly 'com.github.streem.pbandk:protoc-gen-kotlin-lib-jvm:0.8.1'
+    compileOnly 'com.github.streem.pbandk:protoc-gen-kotlin-jvm:0.9.0-SNAPSHOT'
 }
 ```
 
@@ -433,12 +446,10 @@ Set the `CONF_TEST_PATH` environment variable (used to run the tests below) with
 export CONF_TEST_PATH="$(pwd)/conformance-test-runner"
 ```
 
-Now, back in `pbandk`, build both the JS and JVM projects via:
+Now, back in `pbandk`, build all JS. JVM and native projects via:
 
 ```
-./gradlew \
-    :conformance:lib:assemble
-    :conformance:jvm:installDist
+./gradlew :conformance:lib:assemble :conformance:jvm:installDist :conformance:native:build
 ```
 
 You are now ready to run the conformance tests.  Make sure `CONF_TEST_PATH` environment variable is set to `path/to/protobuf/conformance/conformance-test-runner` (see above).

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -11,7 +11,7 @@ plugins {
 
 allprojects {
     group = "com.github.streem.pbandk"
-    version = "0.8.2-SNAPSHOT"
+    version = "0.9.0-SNAPSHOT"
 
     repositories {
         jcenter()

diff --git a/conformance/lib/build.gradle.kts b/conformance/lib/build.gradle.kts
@@ -18,11 +18,10 @@ kotlin {
         nodejs {}
     }
 
-    // For ARM, should be changed to iosArm32 or iosArm64
-    // For Linux, should be changed to e.g. linuxX64
-    // For MacOS, should be changed to e.g. macosX64
-    // For Windows, should be changed to e.g. mingwX64
-    // macosX64("macos")
+    macosX64("macos")
+    linuxX64("linux")
+    // Uncomment to enable Windows
+    // mingwX64("windows")
 
     sourceSets {
         val commonMain by getting {
@@ -71,10 +70,25 @@ kotlin {
             }
         }
 
-//      sourceSets["macosMain"].dependencies {
-//      }
-//      sourceSets["macosTest"].dependencies {
-//      }
+        val nativeMain by creating {
+            dependencies {
+                implementation("org.jetbrains.kotlinx:kotlinx-serialization-runtime-native:${Versions.kotlinSerialization}")
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core-native:${Versions.kotlinCoroutines}")
+            }
+        }
+
+        val linuxMain by getting {
+            dependsOn(nativeMain)
+        }
+
+        val macosMain by getting {
+            dependsOn(nativeMain)
+        }
+
+        // Uncomment to enable Windows
+        //val windowsMain by getting {
+        //    dependsOn(nativeMain)
+        //}
     }
 }
 

diff --git a/conformance/lib/src/commonMain/kotlin/pbandk/conformance/Main.kt b/conformance/lib/src/commonMain/kotlin/pbandk/conformance/Main.kt
@@ -1,15 +1,20 @@
 package pbandk.conformance
 
 import pbandk.ByteArr
+import pbandk.conformance.Platform.runBlockingMain
 import pbandk.conformance.pb.*
 
 var logDebug = false
-inline fun debug(fn: () -> String) { if (logDebug) Platform.stderrPrintln(fn()) }
 
-suspend fun main(args: Array<String>) {
+inline fun debug(fn: () -> String) {
+    if (logDebug) Platform.stderrPrintln(fn())
+}
+
+fun main(args: Array<String>) = runBlockingMain {
     debug { "Starting conformance test" }
     while (true) {
-        val res = doTestIo().also { debug { "Result: $it" } } ?: return
+        val res = doTestIo().also { debug { "Result: $it" } } ?: return@runBlockingMain
+
         ConformanceResponse(res).protoMarshal().also { bytes ->
             Platform.stdoutWriteIntLE(bytes.size)
             Platform.stdoutWriteFull(bytes)

diff --git a/conformance/lib/src/commonMain/kotlin/pbandk/conformance/Platform.kt b/conformance/lib/src/commonMain/kotlin/pbandk/conformance/Platform.kt
@@ -1,5 +1,7 @@
 package pbandk.conformance
 
+import kotlinx.coroutines.CoroutineScope
+
 expect object Platform {
     fun stderrPrintln(str: String)
 
@@ -10,4 +12,6 @@ expect object Platform {
     fun stdoutWriteFull(arr: ByteArray)
 
     inline fun <T> doTry(fn: () -> T, errFn: (Any) -> T): T
+
+    fun runBlockingMain(block: suspend CoroutineScope.() -> Unit)
 }
diff --git a/conformance/lib/src/commonMain/kotlin/pbandk/conformance/pb/conformance.kt b/conformance/lib/src/commonMain/kotlin/pbandk/conformance/pb/conformance.kt
@@ -228,7 +228,7 @@ private fun FailureSet.protoMergeImpl(plus: FailureSet?): FailureSet = plus?.cop
 
 private fun FailureSet.protoSizeImpl(): Int {
     var protoSize = 0
-    if (failure.isNotEmpty()) protoSize += (pbandk.Sizer.tagSize(1) * failure.size) + failure.sumBy(pbandk.Sizer::stringSize)
+    if (failure.isNotEmpty()) protoSize += (pbandk.SizerImpl.tagSize(1) * failure.size) + failure.sumBy(pbandk.SizerImpl::stringSize)
     protoSize += unknownFields.entries.sumBy { it.value.size() }
     return protoSize
 }
@@ -275,16 +275,16 @@ private fun ConformanceRequest.protoMergeImpl(plus: ConformanceRequest?): Confor
 
 private fun ConformanceRequest.protoSizeImpl(): Int {
     var protoSize = 0
-    if (requestedOutputFormat.value != 0) protoSize += pbandk.Sizer.tagSize(3) + pbandk.Sizer.enumSize(requestedOutputFormat)
-    if (messageType.isNotEmpty()) protoSize += pbandk.Sizer.tagSize(4) + pbandk.Sizer.stringSize(messageType)
-    if (testCategory.value != 0) protoSize += pbandk.Sizer.tagSize(5) + pbandk.Sizer.enumSize(testCategory)
-    if (jspbEncodingOptions != null) protoSize += pbandk.Sizer.tagSize(6) + pbandk.Sizer.messageSize(jspbEncodingOptions)
-    if (printUnknownFields) protoSize += pbandk.Sizer.tagSize(9) + pbandk.Sizer.boolSize(printUnknownFields)
+    if (requestedOutputFormat.value != 0) protoSize += pbandk.SizerImpl.tagSize(3) + pbandk.SizerImpl.enumSize(requestedOutputFormat)
+    if (messageType.isNotEmpty()) protoSize += pbandk.SizerImpl.tagSize(4) + pbandk.SizerImpl.stringSize(messageType)
+    if (testCategory.value != 0) protoSize += pbandk.SizerImpl.tagSize(5) + pbandk.SizerImpl.enumSize(testCategory)
+    if (jspbEncodingOptions != null) protoSize += pbandk.SizerImpl.tagSize(6) + pbandk.SizerImpl.messageSize(jspbEncodingOptions)
+    if (printUnknownFields) protoSize += pbandk.SizerImpl.tagSize(9) + pbandk.SizerImpl.boolSize(printUnknownFields)
     when (payload) {
-        is ConformanceRequest.Payload.ProtobufPayload -> protoSize += pbandk.Sizer.tagSize(1) + pbandk.Sizer.bytesSize(payload.value)
-        is ConformanceRequest.Payload.JsonPayload -> protoSize += pbandk.Sizer.tagSize(2) + pbandk.Sizer.stringSize(payload.value)
-        is ConformanceRequest.Payload.JspbPayload -> protoSize += pbandk.Sizer.tagSize(7) + pbandk.Sizer.stringSize(payload.value)
-        is ConformanceRequest.Payload.TextPayload -> protoSize += pbandk.Sizer.tagSize(8) + pbandk.Sizer.stringSize(payload.value)
+        is ConformanceRequest.Payload.ProtobufPayload -> protoSize += pbandk.SizerImpl.tagSize(1) + pbandk.SizerImpl.bytesSize(payload.value)
+        is ConformanceRequest.Payload.JsonPayload -> protoSize += pbandk.SizerImpl.tagSize(2) + pbandk.SizerImpl.stringSize(payload.value)
+        is ConformanceRequest.Payload.JspbPayload -> protoSize += pbandk.SizerImpl.tagSize(7) + pbandk.SizerImpl.stringSize(payload.value)
+        is ConformanceRequest.Payload.TextPayload -> protoSize += pbandk.SizerImpl.tagSize(8) + pbandk.SizerImpl.stringSize(payload.value)
     }
     protoSize += unknownFields.entries.sumBy { it.value.size() }
     return protoSize
@@ -371,14 +371,14 @@ private fun ConformanceResponse.protoMergeImpl(plus: ConformanceResponse?): Conf
 private fun ConformanceResponse.protoSizeImpl(): Int {
     var protoSize = 0
     when (result) {
-        is ConformanceResponse.Result.ParseError -> protoSize += pbandk.Sizer.tagSize(1) + pbandk.Sizer.stringSize(result.value)
-        is ConformanceResponse.Result.SerializeError -> protoSize += pbandk.Sizer.tagSize(6) + pbandk.Sizer.stringSize(result.value)
-        is ConformanceResponse.Result.RuntimeError -> protoSize += pbandk.Sizer.tagSize(2) + pbandk.Sizer.stringSize(result.value)
-        is ConformanceResponse.Result.ProtobufPayload -> protoSize += pbandk.Sizer.tagSize(3) + pbandk.Sizer.bytesSize(result.value)
-        is ConformanceResponse.Result.JsonPayload -> protoSize += pbandk.Sizer.tagSize(4) + pbandk.Sizer.stringSize(result.value)
-        is ConformanceResponse.Result.Skipped -> protoSize += pbandk.Sizer.tagSize(5) + pbandk.Sizer.stringSize(result.value)
-        is ConformanceResponse.Result.JspbPayload -> protoSize += pbandk.Sizer.tagSize(7) + pbandk.Sizer.stringSize(result.value)
-        is ConformanceResponse.Result.TextPayload -> protoSize += pbandk.Sizer.tagSize(8) + pbandk.Sizer.stringSize(result.value)
+        is ConformanceResponse.Result.ParseError -> protoSize += pbandk.SizerImpl.tagSize(1) + pbandk.SizerImpl.stringSize(result.value)
+        is ConformanceResponse.Result.SerializeError -> protoSize += pbandk.SizerImpl.tagSize(6) + pbandk.SizerImpl.stringSize(result.value)
+        is ConformanceResponse.Result.RuntimeError -> protoSize += pbandk.SizerImpl.tagSize(2) + pbandk.SizerImpl.stringSize(result.value)
+        is ConformanceResponse.Result.ProtobufPayload -> protoSize += pbandk.SizerImpl.tagSize(3) + pbandk.SizerImpl.bytesSize(result.value)
+        is ConformanceResponse.Result.JsonPayload -> protoSize += pbandk.SizerImpl.tagSize(4) + pbandk.SizerImpl.stringSize(result.value)
+        is ConformanceResponse.Result.Skipped -> protoSize += pbandk.SizerImpl.tagSize(5) + pbandk.SizerImpl.stringSize(result.value)
+        is ConformanceResponse.Result.JspbPayload -> protoSize += pbandk.SizerImpl.tagSize(7) + pbandk.SizerImpl.stringSize(result.value)
+        is ConformanceResponse.Result.TextPayload -> protoSize += pbandk.SizerImpl.tagSize(8) + pbandk.SizerImpl.stringSize(result.value)
     }
     protoSize += unknownFields.entries.sumBy { it.value.size() }
     return protoSize
@@ -453,7 +453,7 @@ private fun JspbEncodingConfig.protoMergeImpl(plus: JspbEncodingConfig?): JspbEn
 
 private fun JspbEncodingConfig.protoSizeImpl(): Int {
     var protoSize = 0
-    if (useJspbArrayAnyFormat) protoSize += pbandk.Sizer.tagSize(1) + pbandk.Sizer.boolSize(useJspbArrayAnyFormat)
+    if (useJspbArrayAnyFormat) protoSize += pbandk.SizerImpl.tagSize(1) + pbandk.SizerImpl.boolSize(useJspbArrayAnyFormat)
     protoSize += unknownFields.entries.sumBy { it.value.size() }
     return protoSize
 }