Publishing

.github/workflows/deploy.yml

@@ -0,0 +1,45 @@
+name: Publishing of libs and plugin on release
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  publish:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'gradle'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: Publish api
+        env:
+          MAVEN_REPOSITORY_LOGIN: ${{ secrets.MAVEN_REPOSITORY_LOGIN }}
+          MAVEN_REPOSITORY_PASSWORD: ${{ secrets.MAVEN_REPOSITORY_PASSWORD }}
+        run:  ./gradlew :kotlinx.fuzz.api:publish
+
+      - name: Publish engine
+        env:
+          MAVEN_REPOSITORY_LOGIN: ${{ secrets.MAVEN_REPOSITORY_LOGIN }}
+          MAVEN_REPOSITORY_PASSWORD: ${{ secrets.MAVEN_REPOSITORY_PASSWORD }}
+        run:  ./gradlew :kotlinx.fuzz.engine:publish
+
+      - name: Publish jazzer
+        env:
+          MAVEN_REPOSITORY_LOGIN: ${{ secrets.MAVEN_REPOSITORY_LOGIN }}
+          MAVEN_REPOSITORY_PASSWORD: ${{ secrets.MAVEN_REPOSITORY_PASSWORD }}
+        run:  ./gradlew :kotlinx.fuzz.jazzer:publish
+
+      - name: Publish gradle plugin
+        env:
+          GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
+          GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
+        run:  ./gradlew :kotlinx.fuzz.gradle:publishPlugins

README.md

@@ -1,3 +1,70 @@
 # kotlinx.fuzz
 
-`kotlinx.fuzz` is a general purpose fuzzing library for Kotlin
+`kotlinx.fuzz` is a general purpose fuzzing library for Kotlin
+
+## Usage
+
+1. Add PLAN lab maven repository to your gradle config:
+```kotlin
+repositories {
+    maven(url = "https://plan-maven.apal-research.com")
+}
+```
+
+2. Add `kotlinx.fuzz` as a dependency:
+```kotlin
+dependencies {
+    testRuntimeOnly("org.jetbrains:kotlinx.fuzz.jazzer:0.1.0")
+}
+```
+
+3. Apply `kotlinx.fuzz` plugin to your project:
+```kotlin
+plugins {
+    id("kotlinx.fuzz") version "0.1.0"
+}
+```
+
+4. Configure plugin:
+```kotlin
+fuzzConfig {
+    instrument = listOf("org.example.**")
+    maxSingleTargetFuzzTime = 10.seconds
+}
+```
+
+5. Write your fuzz tests:
+```kotlin
+package org.example
+
+import kotlinx.fuzz.KFuzzTest
+import kotlinx.fuzz.KFuzzer
+
+object ExampleTest {
+    @KFuzzTest
+    fun foo(data: KFuzzer) {
+        if (data.int() % 2 == 0) {
+            if (data.int() % 3 == 2) {
+                if (data.int() % 31 == 11) {
+                    throw IllegalArgumentException()
+                }
+            }
+        }
+    }
+}
+```
+
+6. Run fuzzer:
+```bash
+~/example » ./gradlew fuzz                                                                                                                                                  1 ↵
+
+> Task fuzz
+
+SampleTarget > public final void org.example.ExampleTest.foo(kotlinx.fuzz.KFuzzer) FAILED
+    java.lang.IllegalArgumentException
+        at org.example.ExampleTest.foo(ExampleTest.kt:12)
+```
+
+7. Check the fuzzing report in `build/fuzz`
+
+You can see more examples of `kotlinz.fuzz` usage in [`kotlinx.fuzz.test`](kotlinx.fuzz.test)

buildSrc/build.gradle.kts

@@ -8,6 +8,7 @@ repositories {
 }
 
 dependencies {
+    implementation(gradleApi())
     implementation(libs.kotlin.gradle.plugin)
     implementation(libs.diktat.gradle.plugin)
     implementation(kotlin("reflect"))

buildSrc/src/main/kotlin/constants.kt

@@ -1,2 +1,2 @@
-const val GROUP_ID = "kotlinx.fuzz"
+const val GROUP_ID = "org.jetbrains"
 const val VERSION = "0.0.1"

buildSrc/src/main/kotlin/kotlinx/fuzz/publishing.kt

@@ -0,0 +1,36 @@
+package kotlinx.fuzz
+
+import org.gradle.api.Project
+import org.gradle.api.publish.PublishingExtension
+import org.gradle.api.publish.maven.MavenPublication
+import org.gradle.kotlin.dsl.get
+
+fun Project.configurePublishing() {
+    pluginManager.apply("maven-publish")
+    project.pluginManager.withPlugin("maven-publish") {
+        project.afterEvaluate {
+            project.extensions.configure<PublishingExtension>("publishing") {
+                publications {
+                    this@publications.create("runner", MavenPublication::class.java) {
+                        groupId = project.group.toString()
+                        artifactId = project.name
+                        version = project.version.toString()
+
+                        from(components["java"])
+                    }
+                }
+                repositories {
+                    maven {
+                        url = uri("https://maven.pkg.github.com/plan-research/kotlin-maven")
+                        credentials {
+                            username = project.findProperty("gpr.user")?.toString()
+                                ?: System.getenv("MAVEN_REPOSITORY_LOGIN")
+                            password = project.findProperty("gpr.token")?.toString()
+                                ?: System.getenv("MAVEN_REPOSITORY_PASSWORD")
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

kotlinx.fuzz.api/build.gradle.kts

@@ -1,3 +1,5 @@
+import kotlinx.fuzz.configurePublishing
+
 plugins {
     id("kotlinx.fuzz.src-module")
 }
@@ -12,3 +14,5 @@ dependencies {
 tasks.test {
     useJUnitPlatform()
 }
+
+configurePublishing()

kotlinx.fuzz.engine/build.gradle.kts

@@ -1,3 +1,5 @@
+import kotlinx.fuzz.configurePublishing
+
 plugins {
     id("kotlinx.fuzz.src-module")
 }
@@ -13,3 +15,5 @@ dependencies {
 tasks.test {
     useJUnitPlatform()
 }
+
+configurePublishing()

kotlinx.fuzz.gradle/src/main/kotlin/kotlinx/fuzz/gradle/KFuzzPlugin.kt

@@ -17,8 +17,8 @@ abstract class KFuzzPlugin : Plugin<Project> {
 
     override fun apply(project: Project) {
         project.dependencies {
-            add("testImplementation", "kotlinx.fuzz:kotlinx.fuzz.api")
-            add("testRuntimeOnly", "kotlinx.fuzz:kotlinx.fuzz.gradle")
+            add("testImplementation", "org.jetbrains:kotlinx.fuzz.api")
+            add("testRuntimeOnly", "org.jetbrains:kotlinx.fuzz.gradle")
         }
 
         project.tasks.withType<Test>().configureEach {

kotlinx.fuzz.jazzer/build.gradle.kts

@@ -1,3 +1,5 @@
+import kotlinx.fuzz.configurePublishing
+
 plugins {
     id("kotlinx.fuzz.src-module")
 }
@@ -8,3 +10,5 @@ dependencies {
     implementation(kotlin("reflect"))
     implementation(libs.jazzer)
 }
+
+configurePublishing()

kotlinx.fuzz.jazzer/src/main/kotlin/kotlinx/fuzz/jazzer/ParseLog.kt

@@ -62,7 +62,7 @@ internal fun jazzerLogToCsv(file: Path, duration: Duration): String {
         }
     }
 
-    val maxExecNr = statsNoTimeStamps.maxOf { it.execNr }
+    val maxExecNr = statsNoTimeStamps.maxOfOrNull { it.execNr } ?: 0
     val stats = listOf(
         LibfuzzerLogEntry(0, 0, 0, 0, 0),
     ) + statsNoTimeStamps.map { it.addTimestamp(it.execNr * duration.inWholeSeconds / maxExecNr) }

kotlinx.fuzz.test/build.gradle.kts

@@ -12,7 +12,7 @@ repositories {
 
 dependencies {
     testImplementation(kotlin("test")) // adds green arrow in IDEA (no idea why)
-    testRuntimeOnly("kotlinx.fuzz:kotlinx.fuzz.jazzer")
+    testRuntimeOnly("org.jetbrains:kotlinx.fuzz.jazzer")
 }
 
 fuzzConfig {