Feat: Static Analysis & Lint Setup (#2208)

Author: niyajali

.github/workflows/android.yml

@@ -28,103 +28,4 @@ jobs:
           # Artifact name
           name: android-client-app
           # File path describing what artifact to upload
-          path: mifosng-android/build/outputs/apk/debug/mifosng-android-debug.apk
-
-  test:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-        # Set up JDK 17
-      - name: Set up JDK 17
-        uses: actions/setup-java@v1
-        with:
-          java-version: 17
-
-        # Test with Gradle
-      - name: Test App
-        run: ./gradlew test
-
-        # Upload test reports
-      - name: Upload Test Reports
-        uses: actions/[email protected]
-        with:
-          # Artifact name
-          name: test-reports
-          # File path describing what artifact to upload
-          path: mifosng-android/build/reports/tests/**
-
-  lintCheck:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-        # Set up JDK 17
-      - name: Set up JDK 17
-        uses: actions/setup-java@v1
-        with:
-          java-version: 17
-
-        # Perform Lint Check
-      - name: Lint Check
-        run: ./gradlew lint
-
-        # Upload reports
-      - name: Upload Lint Reports
-        uses: actions/[email protected]
-        with:
-          # Artifact name
-          name: lint-reports
-          # File path describing what artifact to upload
-          path: mifosng-android/build/reports/lint-results**
-
-  pmd:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-        # Set up JDK 17
-      - name: Set up JDK 17
-        uses: actions/setup-java@v1
-        with:
-          java-version: 17
-
-        # Perform PMD Check
-      - name: PMD Check
-        run: ./gradlew pmd
-
-        # Upload reports
-      - name: Upload PMD Reports
-        uses: actions/[email protected]
-        with:
-          # Artifact name
-          name: pmd-reports
-          # File path describing what artifact to upload
-          path: mifosng-android/build/reports/pmd/**
-
-  checkstyle:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-        # Set up JDK 17
-      - name: Set up JDK 17
-        uses: actions/setup-java@v1
-        with:
-          java-version: 17
-        # Perform Checkstyle Check
-      - name: Checkstyle
-        run: ./gradlew checkstyle
-
-        # Upload reports
-      - name: Upload Checkstyle Reports
-        uses: actions/[email protected]
-        with:
-          # Artifact name
-          name: checkstyle-reports
-          # File path describing what artifact to upload
-          path: mifosng-android/build/reports/checkstyle/**
+          path: mifosng-android/build/outputs/apk/debug/mifosng-android-debug.apk

build-logic/convention/build.gradle.kts

@@ -24,8 +24,12 @@ dependencies {
     compileOnly(libs.firebase.crashlytics.gradlePlugin)
     compileOnly(libs.firebase.performance.gradlePlugin)
     compileOnly(libs.kotlin.gradlePlugin)
+//    compileOnly(libs.compose.gradlePlugin)
     compileOnly(libs.ksp.gradlePlugin)
     compileOnly(libs.room.gradlePlugin)
+    compileOnly(libs.detekt.gradlePlugin)
+    compileOnly(libs.ktlint.gradlePlugin)
+    compileOnly(libs.spotless.gradlePlugin)
     implementation(libs.truth)
 }
 
@@ -94,5 +98,25 @@ gradlePlugin {
             id = "mifos.jvm.library"
             implementationClass = "JvmLibraryConventionPlugin"
         }
+        register("detekt") {
+            id = "mifos.detekt.plugin"
+            implementationClass = "MifosDetektConventionPlugin"
+            description = "Configures detekt for the project"
+        }
+        register("spotless") {
+            id = "mifos.spotless.plugin"
+            implementationClass = "MifosSpotlessConventionPlugin"
+            description = "Configures spotless for the project"
+        }
+        register("ktlint") {
+            id = "mifos.ktlint.plugin"
+            implementationClass = "MifosKtlintConventionPlugin"
+            description = "Configures kotlinter for the project"
+        }
+        register("gitHooks") {
+            id = "mifos.git.hooks"
+            implementationClass = "MifosGitHooksConventionPlugin"
+            description = "Installs git hooks for the project"
+        }
     }
 }

build-logic/convention/src/main/kotlin/AndroidApplicationComposeConventionPlugin.kt

@@ -1,13 +1,15 @@
 import com.android.build.api.dsl.ApplicationExtension
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.getByType
 import org.mifos.configureAndroidCompose
 
 class AndroidApplicationComposeConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
-            pluginManager.apply("com.android.application")
+            apply(plugin = "com.android.application")
+//            apply(plugin = "org.jetbrains.kotlin.plugin.compose")
 
             val extension = extensions.getByType<ApplicationExtension>()
             configureAndroidCompose(extension)

build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt

@@ -17,6 +17,12 @@ class AndroidApplicationConventionPlugin : Plugin<Project> {
                 apply("com.android.application")
                 apply("org.jetbrains.kotlin.android")
                 apply("mifos.android.lint")
+                apply("mifos.android.application.jacoco")
+                apply("com.dropbox.dependency-guard")
+                apply("mifos.detekt.plugin")
+                apply("mifos.spotless.plugin")
+                apply("mifos.ktlint.plugin")
+//                apply("mifos.git.hooks")
             }
 
             extensions.configure<ApplicationExtension> {

build-logic/convention/src/main/kotlin/AndroidFeatureConventionPlugin.kt

@@ -3,6 +3,7 @@ import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.configure
 import org.gradle.kotlin.dsl.dependencies
+import org.gradle.kotlin.dsl.kotlin
 import org.mifos.configureGradleManagedDevices
 import org.mifos.libs
 
@@ -26,14 +27,33 @@ class AndroidFeatureConventionPlugin : Plugin<Project> {
                 add("implementation", project(":core:ui"))
                 add("implementation", project(":core:designsystem"))
                 add("implementation", project(":core:common"))
+                add("implementation", project(":core:model"))
                 add("implementation", project(":core:data"))
+                add("implementation", project(":core:domain"))
+
+                // This could be removed after migrating to Room
+                add("implementation", libs.findLibrary("dbflow").get())
+
+                add("implementation", libs.findLibrary("kotlinx.collections.immutable").get())
 
                 add("implementation", libs.findLibrary("androidx.hilt.navigation.compose").get())
                 add("implementation", libs.findLibrary("androidx.lifecycle.runtimeCompose").get())
                 add("implementation", libs.findLibrary("androidx.lifecycle.viewModelCompose").get())
-                add("implementation", libs.findLibrary("androidx.tracing.ktx").get())
 
                 add("androidTestImplementation", libs.findLibrary("androidx.lifecycle.runtimeTesting").get())
+
+                add("testImplementation", kotlin("test"))
+                add("testImplementation", project(":core:testing"))
+                add("testImplementation", libs.findLibrary("hilt.android.testing").get())
+                add("testImplementation", libs.findLibrary("squareup.okhttp").get())
+
+                add("debugImplementation", libs.findLibrary("androidx.compose.ui.test.manifest").get())
+
+                add("androidTestImplementation", project(":core:testing"))
+                add("androidTestImplementation", libs.findLibrary("androidx.navigation.testing").get())
+                add("androidTestImplementation", libs.findLibrary("androidx.compose.ui.test").get())
+                add("androidTestImplementation", libs.findLibrary("hilt.android.testing").get())
+                add("androidTestImplementation", libs.findLibrary("androidx.lifecycle.runtimeTesting").get())
             }
         }
     }

build-logic/convention/src/main/kotlin/AndroidLibraryComposeConventionPlugin.kt

@@ -1,13 +1,15 @@
 import com.android.build.gradle.LibraryExtension
 import org.gradle.api.Plugin
 import org.gradle.api.Project
+import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.getByType
 import org.mifos.configureAndroidCompose
 
 class AndroidLibraryComposeConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
-            pluginManager.apply("com.android.library")
+            apply(plugin = "com.android.library")
+//            apply(plugin = "org.jetbrains.kotlin.plugin.compose")
 
             val extension = extensions.getByType<LibraryExtension>()
             configureAndroidCompose(extension)

build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt

@@ -18,7 +18,11 @@ class AndroidLibraryConventionPlugin : Plugin<Project> {
             with(pluginManager) {
                 apply("com.android.library")
                 apply("org.jetbrains.kotlin.android")
+                apply("mifos.android.library.jacoco")
                 apply("mifos.android.lint")
+                apply("mifos.detekt.plugin")
+                apply("mifos.spotless.plugin")
+                apply("mifos.ktlint.plugin")
             }
 
             extensions.configure<LibraryExtension> {

build-logic/convention/src/main/kotlin/AndroidLintConventionPlugin.kt

@@ -4,6 +4,7 @@ import com.android.build.api.dsl.Lint
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.configure
+import java.io.File
 
 class AndroidLintConventionPlugin : Plugin<Project> {
     override fun apply(target: Project) {
@@ -27,4 +28,10 @@ class AndroidLintConventionPlugin : Plugin<Project> {
 private fun Lint.configure() {
     xmlReport = true
     checkDependencies = true
+    abortOnError = false
+    // Disable this rule until we ship the libraries to some maven.
+    disable += "ResourceName"
+    baseline = File("lint-baseline.xml")
+    explainIssues = true
+    htmlReport = true
 }

build-logic/convention/src/main/kotlin/MifosDetektConventionPlugin.kt

@@ -0,0 +1,22 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.mifos.configureDetekt
+import org.mifos.detektGradle
+
+class MifosDetektConventionPlugin : Plugin<Project> {
+    override fun apply(target: Project) {
+        with(target) {
+            applyPlugins()
+
+            detektGradle {
+                configureDetekt(this)
+            }
+        }
+    }
+
+    private fun Project.applyPlugins() {
+        pluginManager.apply {
+            apply("io.gitlab.arturbosch.detekt")
+        }
+    }
+}

build-logic/convention/src/main/kotlin/MifosGitHooksConventionPlugin.kt

@@ -0,0 +1,54 @@
+
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.api.tasks.Copy
+import org.gradle.api.tasks.Exec
+import org.gradle.kotlin.dsl.register
+import java.util.Locale
+
+class MifosGitHooksConventionPlugin : Plugin<Project> {
+    override fun apply(project: Project) {
+        // Define a function to check if the OS is Linux or MacOS
+        fun isLinuxOrMacOs(): Boolean {
+            val osName = System.getProperty("os.name").lowercase(Locale.getDefault())
+            return osName.contains("linux") || osName.contains("mac os") || osName.contains("macos")
+        }
+
+        // Define the copyGitHooks task
+        project.tasks.register<Copy>("copyGitHooks") {
+            description = "Copies the git hooks from /scripts to the .git/hooks folder."
+            from("${project.rootDir}/scripts/") {
+                include("**/*.sh")
+                rename { it.removeSuffix(".sh") }
+            }
+            into("${project.rootDir}/.git/hooks")
+        }
+
+        // Define the installGitHooks task
+        project.tasks.register<Exec>("installGitHooks") {
+            description = "Installs the pre-commit git hooks from the scripts directory."
+            group = "git hooks"
+            workingDir = project.rootDir
+
+            if (isLinuxOrMacOs()) {
+                commandLine("chmod", "-R", "+x", ".git/hooks/")
+            }else {
+                commandLine("cmd", "/c", "attrib", "-R", "+X", ".git/hooks/*.*")
+            }
+            dependsOn(project.tasks.named("copyGitHooks"))
+
+            doLast {
+                println("Git hooks installed successfully.")
+            }
+        }
+
+        // Configure task dependencies after evaluation
+        project.afterEvaluate {
+            project.tasks.matching {
+                it.name in listOf("preBuild", "build", "assembleDebug", "assembleRelease", "installDebug", "installRelease", "clean")
+            }.configureEach {
+                dependsOn(project.tasks.named("installGitHooks"))
+            }
+        }
+    }
+}

build-logic/convention/src/main/kotlin/MifosKtlintConventionPlugin.kt

@@ -0,0 +1,16 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+
+class MifosKtlintConventionPlugin : Plugin<Project> {
+    override fun apply(target: Project) {
+        with(target) {
+            applyPlugins()
+        }
+    }
+
+    private fun Project.applyPlugins() {
+        pluginManager.apply {
+            apply("org.jlleitschuh.gradle.ktlint")
+        }
+    }
+}

build-logic/convention/src/main/kotlin/MifosSpotlessConventionPlugin.kt

@@ -0,0 +1,22 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.mifos.configureSpotless
+import org.mifos.spotlessGradle
+
+class MifosSpotlessConventionPlugin : Plugin<Project> {
+    override fun apply(target: Project) {
+        with(target) {
+            applyPlugins()
+
+            spotlessGradle {
+                configureSpotless(this)
+            }
+        }
+    }
+
+    private fun Project.applyPlugins() {
+        pluginManager.apply {
+            apply("com.diffplug.spotless")
+        }
+    }
+}

build-logic/convention/src/main/kotlin/org/mifos/AndroidCompose.kt

@@ -10,7 +10,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
  * Configure Compose-specific options
  */
 internal fun Project.configureAndroidCompose(
-    commonExtension: CommonExtension<*, *, *, *, *>,
+    commonExtension: CommonExtension<*, *, *, *, *, *>,
 ) {
     commonExtension.apply {
         buildFeatures {