Add gradle plugin for creating lambda release artifact

Author: trueangle

.github/workflows/buildLinux86_64.yml

@@ -20,10 +20,10 @@ jobs:
           sudo apt-get install libcurl3-dev
 
       - name: Run build
-        run: ./gradlew build
+        run: ./gradlew buildLambdaRelease
 
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
           name: kotlin-native-build
-          path: sample/build/bin
+          path: sample/build/bin/lambda/release

.gitignore

@@ -6,6 +6,7 @@ xcuserdata
 !src/**/build/
 local.properties
 .idea
+.vscode
 .DS_Store
 captures
 .externalNativeBuild

README.md

@@ -34,26 +34,19 @@ To create a simple lambda function, follow the following steps:
 2. Include library dependency into your module-level build.gradle file
 
 ```kotlin
-//..
 kotlin {
-    //..
     sourceSets {
         nativeMain.dependencies {
             implementation("io.github.trueangle:lambda-runtime:0.0.2")
             implementation("io.github.trueangle:lambda-events:0.0.2")
         }
     }
-    //..
 }
-//..
 ```
 
 3. Specify application entry point reference and supported targets
-
 ```kotlin
-//..
 kotlin {
-    //..
     listOf(
         macosArm64(),
         macosX64(),
@@ -66,14 +59,10 @@ kotlin {
             }
         }
     }
-    //..
 }
-//..
 ```
 
-4. Choose lambda function type.
-
-There are two types of lambda functions:
+4. Choose lambda function type. There are two types of lambda functions:
 
 ### Buffered 
 Buffered Lambda function collects all the data it needs to return as a response before sending
@@ -149,23 +138,19 @@ used. Here's how to run project's sample:
 
 ## Build and deploy to AWS
 
-1. Execute `./gradlew build`
-2. After successful build execute `cd YOUR_MODULE/build/bin/linuxX64/releaseExecutable/` this will
-   locate Lambda handler's executable file, e.g. `YOUR_MODULE.kexe`. The name of the file (including
-   the extension) will be used as `handler` name. Don't forget to specify it upon
-   lambda-function creation.
-3. Execute `(echo '#!/bin/sh' > bootstrap && echo './"$_HANDLER"' >> bootstrap && chmod +x bootstrap && zip -r bootstrap.zip ./*)`
-4. Deploy bootstrap.zip archive to AWS. If you have never used AWS Lambda
+1. Apply plugin `id("io.github.trueangle.plugin.lambda") version "0.0.1"`
+2. Execute `./gradlew buildLambdaRelease`. The command will output the path to the archive containing lambda executable (YOUR_MODULE_NAME.kexe) located in (YOUR_MODULE_NAME/build/bin/lambda/release/YOUR_MODULE_NAME.zip)
+3. Deploy .zip archive to AWS. If you have never used AWS Lambda
    before, [learn how to deploy Lambda function as zip archive manually](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-zip.html)
    or
    using [AWS CLI](https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-codedeploy.html):
 
 ```bash
-$ aws lambda create-function --function-name sample \
-  --handler sample.kexe \ # Important to specify the name of the Lambda executable
-  --zip-file bootstrap.zip \
+$ aws lambda create-function --function-name LAMBDA_FUNCTION_NAME \
+  --handler YOUR_MODULE_NAME.kexe \ # Important to specify the name of the Lambda executable. 
+  --zip-file YOUR_MODULE_NAME.zip \
   --runtime provided.al2023 \ # Change this to provided.al2 if you would like to use Amazon Linux 2
-  --role arn:aws:iam::XXXXXXXXXXXXX:role/your_lambda_execution_role \
+  --role arn:aws:iam::XXXXXXXXXXXXX:role/YOUR_LAMBDA_EXECUTION_ROLE \
   --environment Variables={RUST_BACKTRACE=1} \
   --tracing-config Mode=Active
 ```
@@ -233,7 +218,6 @@ Log.fatal(message: T?) // Messages about serious errors that cause the applicati
   build command:
 
 ```bash
-
 docker build -t sample .
 docker run --rm -v $(pwd):/sample -w /sample sample ./gradlew build
 ```

gradle-plugin/build.gradle.kts

@@ -0,0 +1,31 @@
+plugins {
+    `java-gradle-plugin`
+    `kotlin-dsl`
+    id("com.gradle.plugin-publish") version "1.2.1"
+}
+
+repositories {
+    gradlePluginPortal()
+}
+
+kotlin {
+    jvmToolchain(17)
+}
+
+group = "io.github.trueangle.plugin.lambda" 
+version = "0.0.1" 
+
+gradlePlugin {
+    website.set("https://github.com/trueangle/kotlin-native-aws-lambda-runtime")
+    vcsUrl.set("https://github.com/trueangle/kotlin-native-aws-lambda-runtime.git")
+
+    plugins {
+        create("buildLambdaRelease") {
+            id = "io.github.trueangle.plugin.lambda"
+            implementationClass = "LambdaPlugin"
+            displayName = "A plugin for Kotlin Native AWS Lambda"
+            description = "A plugin to streamline the development of Kotlin Native AWS Lambda functions"
+            tags.set(listOf("aws", "lambda", "kotlin-native"))
+        }
+    }
+}

gradle-plugin/src/main/kotlin/LambdaPlugin.kt

@@ -0,0 +1,53 @@
+import org.gradle.api.DefaultTask
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.tasks.TaskAction
+import java.io.File
+
+class LambdaPlugin : Plugin<Project> {
+    override fun apply(project: Project) {
+        project.tasks.create("buildLambdaRelease", LambdaPackagerTask::class.java)
+    }
+}
+
+abstract class LambdaPackagerTask : DefaultTask() {
+
+    @TaskAction
+    fun packageLambda() {
+        project.exec {
+            workingDir = project.rootDir
+            commandLine("./gradlew", "build")
+        }
+
+        val buildDir = project.layout.buildDirectory
+        val executableDir = project.file(buildDir.dir("bin/linuxX64/releaseExecutable"))
+        val executable = executableDir
+            .listFiles()
+            ?.first { it.name.endsWith(".kexe") }
+            ?: throw IllegalStateException("No .kexe file found in $executableDir")
+        val outputZip = project.file(buildDir.dir("lambda/release/${executable.nameWithoutExtension}.zip"))
+
+        outputZip.parentFile.mkdirs()
+        outputZip.setWritable(true)
+
+        val bootstrapFile = File(executableDir, "bootstrap")
+        bootstrapFile.writeText(
+            """
+            #!/bin/sh
+            ./"${'$'}_HANDLER"
+            """.trimIndent()
+        )
+        bootstrapFile.setExecutable(true)
+
+        project.exec {
+            workingDir = executableDir
+            commandLine("zip", "-r", outputZip.absolutePath, ".")
+        }
+
+        logger.lifecycle(
+            "\u001B[0;32mLambda package created at ${outputZip.absolutePath}. " +
+                    "Provide the \u001B[1m${executable.name}\u001B[0;32m as a value of " +
+                    "\u001B[1m--handler\u001B[0;32m argument while configuring the lambda function on AWS\u001B[0m\n"
+        )
+    }
+}

gradle/libs.versions.toml

@@ -11,6 +11,7 @@ ksp = "2.0.10-1.0.24"
 allopen = "2.0.20"
 mokkery = "2.3.0"
 kotlinx-resources = "0.9.0"
+gradle-publish = "1.2.0"
 
 [libraries]
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
@@ -37,4 +38,5 @@ kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", versi
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 allopen = { id = "org.jetbrains.kotlin.plugin.allopen", version.ref = "allopen" }
 mokkery = { id = "dev.mokkery", version.ref = "mokkery" }
-kotlinx-resources = { id = "com.goncalossilva.resources", version.ref = "kotlinx-resources" }
+kotlinx-resources = { id = "com.goncalossilva.resources", version.ref = "kotlinx-resources" }
+gradle-publish = { id = "com.gradle.plugin-publish", version.ref = "gradle-publish" }

lambda-runtime/src/commonMain/kotlin/io/github/trueangle/knative/lambda/runtime/LambdaRuntime.kt

@@ -14,7 +14,6 @@ import io.github.trueangle.knative.lambda.runtime.log.debug
 import io.github.trueangle.knative.lambda.runtime.log.error
 import io.github.trueangle.knative.lambda.runtime.log.fatal
 import io.github.trueangle.knative.lambda.runtime.log.info
-import io.github.trueangle.knative.lambda.runtime.log.trace
 import io.github.trueangle.knative.lambda.runtime.log.warn
 import io.ktor.client.HttpClient
 import io.ktor.client.engine.HttpClientEngine
@@ -35,9 +34,10 @@ import kotlinx.serialization.json.Json
 object LambdaRuntime {
     @OptIn(ExperimentalSerializationApi::class)
     internal val json = Json { explicitNulls = false }
+    @PublishedApi
+    internal val curlHttpClient = createHttpClient(Curl.create())
 
     inline fun <reified I, reified O> run(crossinline initHandler: () -> LambdaHandler<I, O>) = runBlocking {
-        val curlHttpClient = createHttpClient(Curl.create())
         val lambdaClient = LambdaClientImpl(curlHttpClient)
 
         Runner(client = lambdaClient, log = Log).run(false, initHandler)

sample/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     alias(libs.plugins.kotlin.multiplatform)
     alias(libs.plugins.kotlin.serialization)
+    id("io.github.trueangle.plugin.lambda")
 }
 
 kotlin {

settings.gradle.kts

@@ -28,6 +28,7 @@ dependencyResolutionManagement {
     }
 }
 includeBuild("convention-plugins")
+includeBuild("gradle-plugin")
 include(":lambda-runtime")
 include(":sample")
 include(":lambda-events")