Merge pull request #20 from tuuhin/enhancements

Feat: Major Enhancements, Refactoring, and Test Coverage

Author: tuuhin

.github/workflows/android_build_ci.yaml

@@ -13,24 +13,24 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
+      # Optional, but good security practice
+      - name: 📝 Validate Gradle wrapper
+        uses: gradle/wrapper-validation-action@v3
+
       - name: Set up JDK
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
           java-version: '17'
-          cache: 'gradle'
-
-      - name: Set up Android SDK
-        uses: android-actions/setup-android@v3
 
-      - name: Grant execute permission for gradlew
+      - name: 🛡️ Grant execute permission for gradlew
         run: chmod +x gradlew
 
-      - name: Validate Gradle wrapper
-        uses: gradle/wrapper-validation-action@v1
+      - name: 🔧 Setup Gradle (Caching & Optimization)
+        uses: gradle/actions/setup-gradle@v4
 
-      - name: Create a debug build
-        run: ./gradlew assembleDebug
+      - name: 🏗️ Build debug APK
+        run: ./gradlew assembleDebug --stacktrace
 
       - name: Check if there is any build errors
         run: |

.github/workflows/instrumented_tests.yml

@@ -0,0 +1,96 @@
+name: Android Instrumented Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  checks: write
+  pull-requests: write
+
+jobs:
+  instrumented-tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+
+    strategy:
+      matrix:
+        api-level: [ 36 ]
+        target: [ google_apis ]
+        arch: [ x86_64 ]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: gradle
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Configure Gradle memory
+        run: |
+          mkdir -p ~/.gradle
+          echo "org.gradle.jvmargs=-Xmx4096m -XX:MaxMetaspaceSize=1024m" >> ~/.gradle/gradle.properties
+          echo "org.gradle.daemon=true" >> ~/.gradle/gradle.properties
+
+      - name: Enable KVM
+        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: Gradle cache
+        uses: gradle/actions/setup-gradle@v3
+
+      - name: AVD cache
+        uses: actions/cache@v4
+        id: avd-cache
+        with:
+          path: |
+            ~/.android/avd/*
+            ~/.android/adb*
+          key: avd-${{ matrix.api-level }}-${{ matrix.target }}-${{ matrix.arch }}
+
+      - name: Create AVD and generate snapshot for caching
+        if: steps.avd-cache.outputs.cache-hit != 'true'
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: ${{ matrix.api-level }}
+          target: ${{ matrix.target }}
+          arch: ${{ matrix.arch }}
+          force-avd-creation: false
+          emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          disable-animations: false
+          script: echo "Generated AVD snapshot for caching."
+
+      - name: Run instrumented tests
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: ${{ matrix.api-level }}
+          target: ${{ matrix.target }}
+          arch: ${{ matrix.arch }}
+          force-avd-creation: false
+          emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          disable-animations: true
+          script: |
+            adb devices
+            ./gradlew connectedAndroidTest --stacktrace
+
+      - name: Publish test results
+        if: always()
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        with:
+          files: |
+            **/build/test-results/**/*.xml
+            **/build/outputs/androidTest-results/**/*.xml
+          check_name: Instrumented Test Results (API ${{ matrix.api-level }})

.idea/gradle.xml

@@ -4,6 +4,7 @@ import java.util.Properties
 plugins {
 	alias(libs.plugins.android.application)
 	alias(libs.plugins.jetbrains.kotlin.android)
+	// custom plugins
 	alias(libs.plugins.recorderapp.hilt)
 	alias(libs.plugins.recorderapp.compose.compiler)
 }
@@ -16,8 +17,8 @@ android {
 		applicationId = "com.eva.recorderapp"
 		minSdk = libs.versions.minSdk.get().toInt()
 		targetSdk = libs.versions.compileSdk.get().toInt()
-		versionCode = 10
-		versionName = "1.4.0"
+		versionCode = 11
+		versionName = "1.4.1"
 
 		testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
 		vectorDrawables {
@@ -68,6 +69,10 @@ android {
 				"proguard-rules.pro"
 			)
 		}
+		debug {
+			applicationIdSuffix = ".debug"
+			resValue("string", "app_name", "RecorderApp (DEBUG)")
+		}
 	}
 	compileOptions {
 		sourceCompatibility = JavaVersion.VERSION_17
@@ -111,4 +116,6 @@ dependencies {
 	implementation(project(":feature:widget"))
 	implementation(project(":feature:onboarding"))
 
+	// android testing
+	androidTestImplementation(libs.androidx.runner)
 }

.idea/kotlinc.xml

@@ -3,6 +3,8 @@ package com.eva.recorderapp
 import android.app.Application
 import android.app.NotificationChannel
 import android.app.NotificationManager
+import androidx.compose.runtime.Composer
+import androidx.compose.runtime.ExperimentalComposeRuntimeApi
 import androidx.core.app.NotificationCompat
 import androidx.core.content.getSystemService
 import androidx.hilt.work.HiltWorkerFactory
@@ -14,7 +16,7 @@ import com.eva.worker.UpdateRecordingPathWorker
 import dagger.hilt.android.HiltAndroidApp
 import javax.inject.Inject
 
-
+@OptIn(ExperimentalComposeRuntimeApi::class)
 @HiltAndroidApp
 class RecorderApp : Application(), Configuration.Provider {
 
@@ -35,6 +37,22 @@ class RecorderApp : Application(), Configuration.Provider {
 	override fun onCreate() {
 		super.onCreate()
 
+		// enabled compose stack-trace
+		Composer.setDiagnosticStackTraceEnabled(enabled = BuildConfig.DEBUG)
+
+		createNotificationChannels()
+
+		//shortcuts
+		shortcutFacade.createRecordingsShortCut()
+
+		//start workers
+		RemoveTrashRecordingWorker.startRepeatWorker(applicationContext)
+		// update path worker
+		UpdateRecordingPathWorker.startWorker(applicationContext)
+	}
+
+
+	private fun createNotificationChannels() {
 		val channel1 = NotificationChannel(
 			NotificationConstants.RECORDER_CHANNEL_ID,
 			NotificationConstants.RECORDER_CHANNEL_NAME,
@@ -67,13 +85,5 @@ class RecorderApp : Application(), Configuration.Provider {
 		val channels = listOf(channel1, channel2, channel3)
 
 		notificationManager?.createNotificationChannels(channels)
-
-		//shortcuts
-		shortcutFacade.createRecordingsShortCut()
-
-		//start workers
-		RemoveTrashRecordingWorker.startRepeatWorker(applicationContext)
-		// update path worker
-		UpdateRecordingPathWorker.startWorker(applicationContext)
 	}
 }

.idea/markdown.xml

@@ -29,37 +29,57 @@ class ConfigureAndroidLibraryPlugin : Plugin<Project> {
 
 	private fun Project.addDependencies() = dependencies.apply {
 
-		val dependenciesMap = mapOf(
-			"implementation" to listOf(
-				"androidx.core.ktx",
-				"androidx.lifecycle.runtime.ktx",
-				"androidx.activity.compose"
-			),
-			"testImplementation" to listOf("junit"),
-			"androidTestImplementation" to listOf("androidx.junit", "androidx.espresso.core")
+		val implementations = listOf(
+			"androidx.core.ktx",
+			"androidx.lifecycle.runtime.ktx",
+			"androidx.activity.compose"
 		)
+		implementations.forEach {
+			catalog.findLibrary(it).ifPresent { dependency ->
+				add("implementation", dependency.get())
+			}
+		}
+
+		val testImplementations = listOf(
+			"junit",
+			"kotlin.test",
+			"kotlinx.coroutines.test",
+			"turbine"
+		)
+
+		testImplementations.forEach {
+			catalog.findLibrary(it).ifPresent { dependency ->
+				add("testImplementation", dependency.get())
+			}
+		}
 
-		dependenciesMap.forEach { (key, dependencies) ->
-			dependencies.forEach {
-				catalog.findLibrary(it).ifPresent { dependency ->
-					add(key, dependency.get())
-				}
+		val androidTestImplementations = listOf(
+			"androidx.junit",
+			"androidx.espresso.core",
+			"kotlin.test",
+			"kotlinx.coroutines.test",
+			"turbine"
+		)
+
+		androidTestImplementations.forEach {
+			catalog.findLibrary(it).ifPresent { dependency ->
+				add("androidTestImplementation", dependency.get())
 			}
 		}
+		// include the testing runtime module
+		if (findProject(":testing:runtime") != null) {
+			add("androidTestImplementation", project(":testing:runtime"))
+		}
 	}
 
 	private fun Project.configureLibrary() = extensions.configure<LibraryExtension> {
 
-		val compilerSdkVersion = catalog.findVersion("compileSdk")
-			.getOrNull()?.toString()?.toInt() ?: 36
-		val minSdkVersion = catalog.findVersion("minSdk")
-			.getOrNull()?.toString()?.toInt() ?: 29
+		compileSdk = catalog.findVersion("compileSdk").getOrNull()?.toString()?.toInt() ?: 36
 
-		compileSdk = compilerSdkVersion
 		defaultConfig {
-			minSdk = minSdkVersion
+			minSdk = catalog.findVersion("minSdk").getOrNull()?.toString()?.toInt() ?: 29
 
-			testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+			testInstrumentationRunner = Constants.TEST_RUNNER_CLASS_NAME
 			consumerProguardFiles("consumer-rules.pro")
 		}