Add Kotlin Native implementation

.circleci/config.yml

@@ -3,7 +3,6 @@
 #
 version: 2.1
 
-
 executors:
   jvm:
     docker:
@@ -17,6 +16,32 @@ executors:
     docker:
       - image: circleci/node:lts
 
+  native:
+    docker:
+      - image: cimg/base:2020.01
+
+commands:
+
+  conformance_test:
+    parameters:
+      target:
+        description: Target platform for which to run conformance tests
+        type: string
+
+    steps:
+      - attach_workspace:
+          at: ~/project
+
+      - restore_cache:
+          name: Restore protobuf cache
+          keys:
+            - v3-protobuf-3.10.1
+
+      - run:
+          name: Run << parameters.target >> conformance tests
+          command: |
+            export CONF_TEST_PATH=~/protobuf/conformance/conformance-test-runner
+            ./conformance/test-conformance.sh << parameters.target >>
 
 jobs:
 
@@ -27,6 +52,10 @@ jobs:
     steps:
       - checkout
 
+      - run:
+          name: Install Kotlin/Native compiler dependencies
+          command: sudo apt update && sudo apt install libncurses5
+
       - run:
           name: Collect files for dependencies cache key
           command: |
@@ -105,7 +134,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,11 +148,15 @@ jobs:
             - build/js
             - conformance/js/failing_tests.txt
             - conformance/js/run.sh
+            # native
+            - conformance/native/build/bin/linux/conformanceReleaseExecutable/conformance.kexe
+            - conformance/native/failing_tests.txt
 
       - save_cache:
           name: Save dependencies cache
           paths:
             - ~/.gradle
+            - ~/.konan
           key: v2-dependencies-{{ checksum "/tmp/circleci_cache_key" }}
           when: always
 
@@ -133,40 +166,24 @@ jobs:
       name: jvm
 
     steps:
-      - attach_workspace:
-          at: ~/project
-
-      - restore_cache:
-          name: Restore protobuf cache
-          keys:
-            - v3-protobuf-3.10.1
-
-      - run:
-          name: Run JVM conformance tests
-          command: |
-            export CONF_TEST_PATH=~/protobuf/conformance/conformance-test-runner
-            ./conformance/test-conformance.sh jvm
-
+      - conformance_test:
+          target: jvm
 
   conformance_js:
     executor:
       name: nodejs
 
     steps:
-      - attach_workspace:
-          at: ~/project
-
-      - restore_cache:
-          name: Restore protobuf cache
-          keys:
-            - v3-protobuf-3.10.1
+      - conformance_test:
+          target: js
 
-      - run:
-          name: Run JS conformance tests
-          command: |
-            export CONF_TEST_PATH=~/protobuf/conformance/conformance-test-runner
-            ./conformance/test-conformance.sh js
+  conformance_native:
+    executor:
+      name: native
 
+    steps:
+      - conformance_test:
+          target: linux
 
   build_examples:
     executor:
@@ -228,6 +245,9 @@ workflows:
       - conformance_js:
           requires:
             - build
+      - conformance_native:
+          requires:
+            - build
       - build_examples:
           requires:
             - build

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
@@ -234,7 +232,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 +259,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 +439,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).

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()

conformance/lib/build.gradle.kts

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+
 plugins {
     kotlin("multiplatform")
     kotlin("plugin.serialization")
@@ -18,11 +20,22 @@ 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")
+
+    targets.withType<KotlinNativeTarget> {
+        val main by compilations.getting {
+            defaultSourceSet {
+                kotlin.srcDir("src/nativeMain/kotlin")
+            }
+            dependencies {
+                implementation("org.jetbrains.kotlinx:kotlinx-serialization-runtime-native:${Versions.kotlinSerialization}")
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core-native:${Versions.kotlinCoroutines}")
+            }
+        }
+    }
 
     sourceSets {
         val commonMain by getting {
@@ -70,11 +83,6 @@ kotlin {
                 implementation(kotlin("test-js"))
             }
         }
-
-//      sourceSets["macosMain"].dependencies {
-//      }
-//      sourceSets["macosTest"].dependencies {
-//      }
     }
 }
 

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)

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)
 }

conformance/lib/src/jsMain/kotlin/pbandk/conformance/Platform.kt

@@ -6,6 +6,7 @@ import pbandk.asByteArray
 import pbandk.asUint8Array
 import kotlin.coroutines.resume
 import kotlin.coroutines.suspendCoroutine
+import kotlinx.coroutines.*
 
 internal external interface StdStream {
     val fd: Int
@@ -104,4 +105,8 @@ actual object Platform {
         } catch (e: dynamic) {
             errFn(e as Any)
         }
+
+    actual fun runBlockingMain(block: suspend CoroutineScope.() -> Unit) {
+        GlobalScope.launch(block = block)
+    }
 }

conformance/lib/src/jvmMain/kotlin/pbandk/conformance/Platform.kt

@@ -1,5 +1,6 @@
 package pbandk.conformance
 
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import java.nio.ByteBuffer
@@ -27,5 +28,13 @@ actual object Platform {
 
     actual fun stdoutWriteFull(arr: ByteArray) = System.out.write(arr)
 
-    actual inline fun <T> doTry(fn: () -> T, errFn: (Any) -> T) = try { fn() } catch (e: Exception) { errFn(e) }
+    actual inline fun <T> doTry(fn: () -> T, errFn: (Any) -> T) = try {
+        fn()
+    } catch (e: Exception) {
+        errFn(e)
+    }
+
+    actual fun runBlockingMain(block: suspend CoroutineScope.() -> Unit) {
+        kotlinx.coroutines.runBlocking(block = block)
+    }
 }