Merge pull request #4 from ooni/tooling

Tooling: CI + Lints

.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/actions/setup/action.yml

@@ -0,0 +1,13 @@
+name: 'Setup'
+description: 'Setup Java, checkout and setup gradle'
+runs:
+  using: "composite"
+  steps:
+    - name: Set up JDK 17
+      uses: actions/setup-java@v4
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+
+    - name: Gradle cache
+      uses: gradle/actions/setup-gradle@v3

.github/workflows/validate.yml

@@ -0,0 +1,69 @@
+name: Validate
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    name: Build
+    runs-on: macos-latest
+
+    strategy:
+      matrix:
+        type: [Debug, Release]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Build Android
+        run: ./gradlew assemble${{ matrix.type }}
+
+      - name: Build iOS
+        run: ./gradlew link${{ matrix.type }}FrameworkIosSimulatorArm64
+
+  android-lint:
+    name: Android Lint
+    runs-on: macos-latest
+    needs: [ build ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Run lint
+        run: ./gradlew lint
+
+      - name: Uploads test reports
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: android-lint-report
+          path: composeApp/build/reports/
+
+  kotlin-lint:
+    name: Kotlin Lint
+    runs-on: macos-latest
+    needs: [ build ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Run lint
+        run: ./gradlew ktlintCheck
+
+      - name: Uploads test reports
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: android-lint-report
+          path: composeApp/build/reports/ktlint/

build.gradle.kts

@@ -7,4 +7,5 @@ plugins {
     alias(libs.plugins.jetbrainsComposeCompiler) apply false
     alias(libs.plugins.kotlinMultiplatform) apply false
     alias(libs.plugins.cocoapods) apply false
+    alias(libs.plugins.ktlint) apply false
 }

composeApp/build.gradle.kts

@@ -8,6 +8,7 @@ plugins {
     alias(libs.plugins.jetbrainsComposeCompiler)
     alias(libs.plugins.cocoapods)
     alias(libs.plugins.kotlinSerialization)
+    alias(libs.plugins.ktlint)
 }
 
 kotlin {
@@ -32,11 +33,12 @@ kotlin {
         framework {
             baseName = "composeApp"
             isStatic = true
+            binaryOption("bundleId", "composeApp")
         }
 
         podfile = project.file("../iosApp/Podfile")
     }
-    
+
     sourceSets {
         androidMain.dependencies {
             implementation(libs.compose.ui.tooling.preview)
@@ -53,6 +55,10 @@ kotlin {
             implementation(compose.components.uiToolingPreview)
             implementation(libs.kotlin.serialization)
         }
+
+        all {
+            languageSettings.optIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
+        }
     }
 
     @OptIn(ExperimentalKotlinGradlePluginApi::class)
@@ -96,4 +102,18 @@ android {
     dependencies {
         debugImplementation(libs.compose.ui.tooling)
     }
+    android {
+        lint {
+            warningsAsErrors = true
+            disable += "AndroidGradlePluginVersion"
+        }
+    }
+}
+
+ktlint {
+    filter {
+        exclude("**/generated/**")
+        include("**/kotlin/**")
+    }
+    additionalEditorconfig.put("ktlint_function_naming_ignore_when_annotated_with", "Composable")
 }

composeApp/src/androidMain/kotlin/org/ooni/engine/AndroidOonimkallBridge.kt

@@ -13,4 +13,4 @@ class AndroidOonimkallBridge : OonimkallBridge {
             override fun waitForNextEvent() = task.waitForNextEvent()
         }
     }
-}
+}

composeApp/src/androidMain/kotlin/org/ooni/probe/AndroidApplication.kt

@@ -2,4 +2,4 @@ package org.ooni.probe
 
 import android.app.Application
 
-class AndroidApplication : Application()
+class AndroidApplication : Application()

composeApp/src/androidMain/res/mipmap-anydpi-v26/ic_launcher.xml

@@ -2,4 +2,5 @@
 <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
     <background android:drawable="@drawable/ic_launcher_background" />
     <foreground android:drawable="@drawable/ic_launcher_foreground" />
+    <monochrome android:drawable="@drawable/ic_launcher_foreground" />
 </adaptive-icon>

composeApp/src/androidMain/res/mipmap-anydpi-v26/ic_launcher_round.xml

@@ -2,4 +2,5 @@
 <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
     <background android:drawable="@drawable/ic_launcher_background" />
     <foreground android:drawable="@drawable/ic_launcher_foreground" />
+    <monochrome android:drawable="@drawable/ic_launcher_foreground" />
 </adaptive-icon>

composeApp/src/commonMain/kotlin/org/ooni/engine/Engine.kt

@@ -10,31 +10,32 @@ import kotlin.math.roundToInt
 class Engine(
     private val bridge: OonimkallBridge,
     private val json: Json,
-    private val baseFilePath: String
+    private val baseFilePath: String,
 ) {
+    fun startTask(taskSettings: TaskSettings): Flow<TaskEvent> =
+        channelFlow {
+            val finalSettings =
+                taskSettings.copy(
+                    stateDir = baseFilePath,
+                    tunnelDir = baseFilePath,
+                    tempDir = baseFilePath,
+                    assetsDir = baseFilePath,
+                )
 
-    fun startTask(taskSettings: TaskSettings): Flow<TaskEvent> = channelFlow {
-        val finalSettings = taskSettings.copy(
-            stateDir = baseFilePath,
-            tunnelDir = baseFilePath,
-            tempDir = baseFilePath,
-            assetsDir = baseFilePath,
-        )
-
-        val task = bridge.startTask(json.encodeToString(finalSettings))
+            val task = bridge.startTask(json.encodeToString(finalSettings))
 
-        while (!task.isDone()) {
-            val eventJson = task.waitForNextEvent()
-            val eventResult = json.decodeFromString<EventResult>(eventJson)
-            eventResult.toTaskEvent()?.let { send(it) }
-        }
+            while (!task.isDone()) {
+                val eventJson = task.waitForNextEvent()
+                val eventResult = json.decodeFromString<EventResult>(eventJson)
+                eventResult.toTaskEvent()?.let { send(it) }
+            }
 
-        invokeOnClose {
-            if (it is CancellationException) {
-                task.interrupt()
+            invokeOnClose {
+                if (it is CancellationException) {
+                    task.interrupt()
+                }
             }
         }
-    }
 
     private fun EventResult.toTaskEvent(): TaskEvent? =
         when (key) {
@@ -46,25 +47,27 @@ class Engine(
                 value?.percentage?.let { percentageValue ->
                     TaskEvent.Progress(
                         percentage = (percentageValue * 100.0).roundToInt(),
-                        message = value?.message
+                        message = value?.message,
                     )
                 }
 
-            "log" -> value?.message?.let { message ->
-                TaskEvent.Log(
-                    level = value?.log_level,
-                    message = message
-                )
-            }
+            "log" ->
+                value?.message?.let { message ->
+                    TaskEvent.Log(
+                        level = value?.logLevel,
+                        message = message,
+                    )
+                }
 
-            "status.report_create" -> value?.report_id?.let {
-                TaskEvent.ReportCreate(reportId = it)
-            }
+            "status.report_create" ->
+                value?.reportId?.let {
+                    TaskEvent.ReportCreate(reportId = it)
+                }
 
             "task_terminated" -> TaskEvent.TaskTerminated
 
             "failure.startup" -> TaskEvent.FailureStartup(message = value?.failure)
 
             else -> null
         }
-}
+}

composeApp/src/commonMain/kotlin/org/ooni/engine/EventResult.kt

@@ -1,29 +1,64 @@
 package org.ooni.engine
 
+import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
 @Serializable
 class EventResult {
+    @SerialName("key")
     var key: String? = null
+
+    @SerialName("value")
     var value: Value? = null
 
     @Serializable
     class Value {
+        @SerialName("key")
         var key: Double = 0.0
-        var log_level: String? = null
+
+        @SerialName("log_level")
+        var logLevel: String? = null
+
+        @SerialName("message")
         var message: String? = null
+
+        @SerialName("percentage")
         var percentage: Double = 0.0
-        var json_str: String? = null
+
+        @SerialName("json_str")
+        var jsonStr: String? = null
+
+        @SerialName("idx")
         var idx: Int = 0
-        var report_id: String? = null
-        var probe_ip: String? = null
-        var probe_asn: String? = null
-        var probe_cc: String? = null
-        var probe_network_name: String? = null
-        var downloaded_kb: Double = 0.0
-        var uploaded_kb: Double = 0.0
+
+        @SerialName("report_id")
+        var reportId: String? = null
+
+        @SerialName("probe_ip")
+        var probeIp: String? = null
+
+        @SerialName("probe_asn")
+        var probeAsn: String? = null
+
+        @SerialName("probe_cc")
+        var probeCc: String? = null
+
+        @SerialName("probe_network_name")
+        var probeNetworkName: String? = null
+
+        @SerialName("downloaded_kb")
+        var downloadedKb: Double = 0.0
+
+        @SerialName("uploaded_kb")
+        var uploadedKb: Double = 0.0
+
+        @SerialName("input")
         var input: String? = null
+
+        @SerialName("failure")
         var failure: String? = null
-        var orig_key: String? = null
+
+        @SerialName("orig_key")
+        var origKey: String? = null
     }
 }

composeApp/src/commonMain/kotlin/org/ooni/engine/OonimkallBridge.kt

@@ -5,7 +5,9 @@ interface OonimkallBridge {
 
     interface Task {
         fun interrupt()
+
         fun isDone(): Boolean
+
         fun waitForNextEvent(): String
     }
-}
+}