refine API and fix Android connect check (#5)

* refine API and fix Android connect check

* fix ci

* use API 29 for Android connected check

* fix macApp compile

Author: Piasy

.github/workflows/ci.yaml

@@ -21,8 +21,9 @@ jobs:
         include:
           - os: macos-latest
             cmd: "./gradlew :kmp-xlog:testDebugUnitTest"
-          - os: macos-latest
-            cmd: "./gradlew :example:androidApp:assembleDebug"
+          - os: ubuntu-latest
+            androidEmulator: true
+            cmd: "./gradlew :example:androidApp:connectedCheck"
           - os: macos-latest
             dep: "brew update && brew install xcodegen"
             cmd: "./scripts/build_apple.sh && ./gradlew runKmp_xlogDebugExecutableMacosX64 && ./scripts/build_mac_demo.sh && ./scripts/build_ios_demo.sh"
@@ -55,5 +56,20 @@ jobs:
     - name: Install deps
       if: ${{ matrix.dep }}
       run: ${{ matrix.dep }}
-    - name: Run it
+    - name: Enable KVM for Android Emulator
+      if: ${{ matrix.androidEmulator }}
+      run: |
+        echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+        sudo udevadm control --reload-rules
+        sudo udevadm trigger --name-match=kvm
+    - name: Run normal
+      if: ${{ !matrix.androidEmulator }}
       run: ${{ matrix.cmd }}
+    - name: Run Android connected check
+      if: ${{ matrix.androidEmulator }}
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: 29
+        ndk: 21.3.6528147
+        cmake: 3.18.1
+        script: ${{ matrix.cmd }}

README.md

@@ -51,21 +51,25 @@ fun initializeMarsXLog(
   logDir: String,
   level: Int,
   namePrefix: String,
-  debugLog: Boolean
 )
 
 // iOS/macOS/Linux/Windows initialize
 fun initializeMarsXLog(
   level: Int,
   namePrefix: String,
-  debugLog: Boolean
 )
 
 // JS initialize
 fun initializeConsoleLog(debugLog: Boolean)
 
 // logging
 object Logging {
+  // if debug log is enabled (level is LEVEL_DEBUG)
+  fun debug(): Boolean
+
+  // compute log content lazily, only when debug log is enabled
+  fun debug(tag: String, block: () -> String)
+  
   fun debug(tag: String, content: String)
 
   fun info(tag: String, content: String)
@@ -76,12 +80,14 @@ object Logging {
 
 ## Env Setup
 
-You need to install [RVM](https://rvm.io/) to manage your ruby version, and install gems. You need to use homebrew to install the following tools:
+You will need cocoapods. You can use [RVM](https://rvm.io/) to manage your ruby version, and install gems.
+
+You need to use homebrew to install the following tools:
 
 ```bash
-brew install cocoapods xcodegen
+brew install xcodegen
 # if you have installed them earlier, you need to remove them at first,
-# or run brew link --overwrite xcodegen cocoapods
+# or run brew link --overwrite xcodegen
 ```
 
 You may need to restart your system so that Android Studio could use the correct ruby.

buildSrc/src/main/kotlin/Constants.kt

@@ -1,7 +1,7 @@
 object Consts {
   const val releaseGroup = "com.piasy"
   const val releaseName = "kmp-xlog"
-  const val releaseVersion = "1.4.1"
+  const val releaseVersion = "1.4.2"
 
   val androidNS = "$releaseGroup.${releaseName.replace('-', '.')}"
 }

example/androidApp/build.gradle.kts

@@ -13,6 +13,8 @@ android {
         targetSdk = libs.versions.targetSdk.get().toInt()
         versionCode = 1
         versionName = Consts.releaseVersion
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
     }
     buildFeatures {
         compose = true
@@ -46,4 +48,6 @@ dependencies {
     implementation(libs.androidx.compose.foundation)
     implementation(libs.androidx.compose.material)
     implementation(libs.androidx.activity.compose)
+    androidTestImplementation(libs.androidx.junit)
+    androidTestImplementation(libs.androidx.runner)
 }

example/androidApp/src/androidTest/java/com/piasy/kmp/xlog/android/LoggingTest.kt

@@ -4,7 +4,6 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.platform.app.InstrumentationRegistry
 import com.piasy.kmp.xlog.Logging
 import com.piasy.kmp.xlog.initializeMarsXLog
-import org.junit.Assert.*
 import org.junit.Test
 import org.junit.runner.RunWith
 
@@ -25,7 +24,6 @@ class LoggingTest {
       "${appContext.getExternalFilesDir(null)?.absolutePath}/log",
       Logging.LEVEL_DEBUG,
       "test",
-      true
     )
 
     Logging.debug("xxx", "test debug log")

example/macApp/macApp/ViewController.m

@@ -30,7 +30,7 @@ - (void)viewDidLoad {
 
     [self.view addSubview:self.label];
 
-    [Kmp_xlogLoggingKt initializeMarsXLogLevel:1 namePrefix:@"test" debugLog:YES];
+    [Kmp_xlogLoggingKt initializeMarsXLogLevel:1 namePrefix:@"test"];
     [[Kmp_xlogLogging logging] infoTag:@"XXPXX" content:[NSString stringWithFormat:@"greeting from %@", [self getSystemVersion]]];
     [[Kmp_xlogLogging logging] errorTag:@"XXPXX" content:@"flush"];
 }

example/shared/build.gradle.kts

@@ -54,8 +54,8 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
-                //implementation("${Consts.releaseGroup}:${Consts.releaseName}:${Consts.releaseVersion}")
-                implementation(project(":kmp-xlog"))
+                //api("${Consts.releaseGroup}:${Consts.releaseName}:${Consts.releaseVersion}")
+                api(project(":kmp-xlog"))
             }
         }
 

example/shared/src/androidMain/kotlin/com/piasy/kmp/xlog/example/Platform.kt

@@ -11,5 +11,5 @@ class AndroidPlatform : Platform {
 actual fun getPlatform(): Platform = AndroidPlatform()
 
 fun initialize(context: Context) {
-  initializeMarsXLog(context, "logs", Logging.LEVEL_DEBUG, "test", true)
+  initializeMarsXLog(context, "logs", Logging.LEVEL_DEBUG, "test")
 }

example/shared/src/cppCommon/kotlin/com/piasy/kmp/xlog/example/Platform.kt

@@ -10,6 +10,6 @@ class CppPlatform : Platform {
 actual fun getPlatform(): Platform = CppPlatform()
 
 fun main() {
-  initializeMarsXLog(Logging.LEVEL_DEBUG, "test", true)
+  initializeMarsXLog(Logging.LEVEL_DEBUG, "test")
   println(Greeting().greeting())
 }

example/shared/src/iosMain/kotlin/com/piasy/kmp/xlog/example/Platform.kt

@@ -12,5 +12,5 @@ class IOSPlatform : Platform {
 actual fun getPlatform(): Platform = IOSPlatform()
 
 fun initialize() {
-  initializeMarsXLog(Logging.LEVEL_DEBUG, "test", true)
+  initializeMarsXLog(Logging.LEVEL_DEBUG, "test")
 }