feat: k/n http bindings (#97)

Author: aajtodd

.github/scripts/run-container-test.py

@@ -101,13 +101,20 @@ def run_docker_test(opts):
         'run',
         '--rm',
         f'-v{test_bin_dir}:/test',
-        '-w/test',
-        '-e DEBIAN_FRONTEND=noninteractive',
-        '--platform',
-        platform,
-        image_name,
-        path_to_exe,
     ]
+    if not opts.no_system_certs:
+        cmd.append(f'-v/etc/ssl:/etc/ssl')
+
+    cmd.extend(
+        [
+            '-w/test',
+            '-e DEBIAN_FRONTEND=noninteractive',
+            '--platform',
+            platform,
+            image_name,
+            path_to_exe,
+        ]
+    )
 
     cmd = shlex.join(cmd)
     print(cmd)
@@ -126,6 +133,7 @@ def create_cli():
     parser.add_argument("--distro", required=True, choices=DISTRO_TO_IMAGE_NAME.keys(), help="the distribution name to run the task on")
     parser.add_argument("--arch", required=True, choices=DOCKER_PLATFORM_BY_ARCH.keys(), help="the architecture to use")
     parser.add_argument("--test-bin-dir", required=True, help="the path to the test binary directory root")
+    parser.add_argument("--no-system-certs", action='store_true', help="disable mounting system certificates into the container")
 
     return parser
 

.github/workflows/ci.yaml

@@ -1,10 +1,8 @@
 name: CI
 
 on:
-  push:
-    branches:
-      - '*'
-      - '!main'
+  pull_request:
+  workflow_dispatch:
 
 env:
   PACKAGE_NAME: aws-crt-kotlin

README.md

@@ -16,19 +16,27 @@ This project is licensed under the Apache-2.0 License.
 CRT interfaces are subject to change.
 
 ### Linux/Unix
-Install some version of libcrypto on which s2n depends. See the [s2n](https://github.com/awslabs/s2n) documentation.
+
+#### Testing Different Linux Distros and Architectures
+
+1. Build the test executable(s) for the architecture(s) you want to test. 
 
 ```sh
-apt-get install libssl-dev
+# build everything
+./gradlew linuxTestBinaries
+
+# build specific arch
+./gradlew linuxX64TestBinaries
 ```
 
-OR
+2. Use the `run-container-test.py` helper script to execute tests locally
 
 ```sh
-yum install openssl-devel
+OCI_EXE=docker python3 .github/scripts/run-container-test.py --distro al2 --arch x64 --test-bin-dir ./aws-crt-kotlin/build/bin
 ```
 
-Set the path to `libcrypto.a` either as a command line argument to gradle `-PlibcryptoPath=PATH` or in your `local.properties` file.
+
+See the usage/help for different distributions provided: `python3 .github/scripts/run-container.py -h`
 
 
 ### OSX

aws-crt-kotlin/api/android/aws-crt-kotlin.api

@@ -32,10 +32,13 @@ public final class aws/sdk/kotlin/crt/Config {
 }
 
 public class aws/sdk/kotlin/crt/CrtRuntimeException : java/lang/RuntimeException {
-	public fun <init> (Ljava/lang/String;)V
-	public fun getErrorCode ()I
+	public fun <init> ()V
+	public fun <init> (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/Integer;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/Integer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun getErrorCode ()I
 	public final fun getErrorDescription ()Ljava/lang/String;
 	public final fun getErrorName ()Ljava/lang/String;
+	public fun getMessage ()Ljava/lang/String;
 }
 
 public final class aws/sdk/kotlin/crt/LogDestination : java/lang/Enum {
@@ -502,7 +505,6 @@ public final class aws/sdk/kotlin/crt/http/HttpClientConnectionManagerOptionsBui
 
 public final class aws/sdk/kotlin/crt/http/HttpException : aws/sdk/kotlin/crt/CrtRuntimeException {
 	public fun <init> (I)V
-	public fun getErrorCode ()I
 }
 
 public final class aws/sdk/kotlin/crt/http/HttpHeader {
@@ -647,7 +649,7 @@ public abstract interface class aws/sdk/kotlin/crt/http/HttpStream : aws/sdk/kot
 	public abstract fun activate ()V
 	public abstract fun getResponseStatusCode ()I
 	public abstract fun incrementWindow (I)V
-	public abstract fun writeChunk ([BZ)V
+	public abstract fun writeChunk ([BZLkotlin/coroutines/Continuation;)Ljava/lang/Object;
 }
 
 public final class aws/sdk/kotlin/crt/http/HttpStreamMetrics {

aws-crt-kotlin/api/jvm/aws-crt-kotlin.api

@@ -32,10 +32,13 @@ public final class aws/sdk/kotlin/crt/Config {
 }
 
 public class aws/sdk/kotlin/crt/CrtRuntimeException : java/lang/RuntimeException {
-	public fun <init> (Ljava/lang/String;)V
-	public fun getErrorCode ()I
+	public fun <init> ()V
+	public fun <init> (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/Integer;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/Throwable;Ljava/lang/Integer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun getErrorCode ()I
 	public final fun getErrorDescription ()Ljava/lang/String;
 	public final fun getErrorName ()Ljava/lang/String;
+	public fun getMessage ()Ljava/lang/String;
 }
 
 public final class aws/sdk/kotlin/crt/LogDestination : java/lang/Enum {
@@ -502,7 +505,6 @@ public final class aws/sdk/kotlin/crt/http/HttpClientConnectionManagerOptionsBui
 
 public final class aws/sdk/kotlin/crt/http/HttpException : aws/sdk/kotlin/crt/CrtRuntimeException {
 	public fun <init> (I)V
-	public fun getErrorCode ()I
 }
 
 public final class aws/sdk/kotlin/crt/http/HttpHeader {
@@ -647,7 +649,7 @@ public abstract interface class aws/sdk/kotlin/crt/http/HttpStream : aws/sdk/kot
 	public abstract fun activate ()V
 	public abstract fun getResponseStatusCode ()I
 	public abstract fun incrementWindow (I)V
-	public abstract fun writeChunk ([BZ)V
+	public abstract fun writeChunk ([BZLkotlin/coroutines/Continuation;)Ljava/lang/Object;
 }
 
 public final class aws/sdk/kotlin/crt/http/HttpStreamMetrics {

aws-crt-kotlin/build.gradle.kts

@@ -11,7 +11,6 @@ import aws.sdk.kotlin.gradle.kmp.IDEA_ACTIVE
 import aws.sdk.kotlin.gradle.kmp.configureKmpTargets
 import aws.sdk.kotlin.gradle.util.typedProp
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
-import org.jetbrains.kotlin.konan.target.KonanTarget
 
 plugins {
     alias(libs.plugins.kotlin.multiplatform)
@@ -192,6 +191,7 @@ tasks.register("linuxTestBinaries") {
 
 val disableCrossCompile = typedProp<Boolean>("aws.sdk.kotlin.crt.disableCrossCompile") == true
 if (disableCrossCompile) {
+    logger.warn("aws.sdk.kotlin.crt.disableCrossCompile=true: Cross compilation is disabled.")
     disableCrossCompileTargets()
 }
 

aws-crt-kotlin/common/src/aws/sdk/kotlin/crt/CrtRuntimeException.kt

@@ -5,8 +5,28 @@
 
 package aws.sdk.kotlin.crt
 
-public open class CrtRuntimeException(message: String?) : RuntimeException(message) {
-    public open val errorCode: Int = CRT.lastError()
+public open class CrtRuntimeException(
+    message: String? = null,
+    cause: Throwable? = null,
+    ec: Int? = null,
+) : RuntimeException(message, cause) {
+
+    public val errorCode: Int = ec ?: CRT.lastError()
+
+    override val message: String?
+        get() = buildString {
+            if (super.message != null) {
+                append(super.message)
+                append(" ")
+            }
+            append("ErrorCode: $errorCode")
+            errorName?.let {
+                append("; ErrorName: $it")
+            }
+            errorDescription?.let {
+                append("; ErrorDescription: $it")
+            }
+        }
 
     public val errorName: String?
         get() = CRT.errorName(errorCode)

aws-crt-kotlin/common/src/aws/sdk/kotlin/crt/http/HttpException.kt

@@ -5,7 +5,6 @@
 
 package aws.sdk.kotlin.crt.http
 
-import aws.sdk.kotlin.crt.CRT
 import aws.sdk.kotlin.crt.CrtRuntimeException
 
-public class HttpException(override val errorCode: Int) : CrtRuntimeException(CRT.errorString(errorCode))
+public class HttpException(ec: Int) : CrtRuntimeException(ec = ec)

aws-crt-kotlin/common/src/aws/sdk/kotlin/crt/http/HttpStream.kt

@@ -46,5 +46,5 @@ public interface HttpStream : Closeable {
      * @param chunkData the chunk of data to send. this should be already formatted in the chunked transfer encoding.
      * @param isFinalChunk represents if the chunk of data is the final chunk. if set to true, this will terminate the request stream.
      */
-    public fun writeChunk(chunkData: ByteArray, isFinalChunk: Boolean)
+    public suspend fun writeChunk(chunkData: ByteArray, isFinalChunk: Boolean)
 }

aws-crt-kotlin/common/test/aws/sdk/kotlin/crt/http/HttpClientConnectionTest.kt

@@ -8,15 +8,14 @@ package aws.sdk.kotlin.crt.http
 import aws.sdk.kotlin.crt.CrtTest
 import aws.sdk.kotlin.crt.io.*
 import aws.sdk.kotlin.crt.use
-import kotlinx.coroutines.test.runTest
+import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withTimeout
 import kotlin.test.*
 import kotlin.time.measureTime
 
 class HttpClientConnectionTest : CrtTest() {
-    @Ignore // FIXME Enable when Kotlin/Native implementation is complete
     @Test
-    fun testDefaults() = runTest {
+    fun testDefaults(): Unit = runBlocking {
         val uri = Uri.parse("https://aws-crt-test-stuff.s3.amazonaws.com")
         val socketOpts = SocketOptions()
         val elg = EventLoopGroup()
@@ -54,9 +53,8 @@ class HttpClientConnectionTest : CrtTest() {
         println("exiting test")
     }
 
-    @Ignore // FIXME Enable when Kotlin/Native implementation is complete
     @Test
-    fun testHttpConnection() = runTest {
+    fun testHttpConnection(): Unit = runBlocking {
         // S3
         assertConnect("https://aws-crt-test-stuff.s3.amazonaws.com")
         assertConnect("http://aws-crt-test-stuff.s3.amazonaws.com")
@@ -132,6 +130,7 @@ class HttpClientConnectionTest : CrtTest() {
                 .forEach { pref ->
                     TlsContext.build {
                         tlsCipherPreference = pref
+                        println("connecting to $url with $pref")
                     }.use { tlsContext ->
                         val elapsed = measureTime {
                             connect(url, clientBootstrap, tlsContext)