chore: added screenshot testing

Author: kikoso

app/build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
     id("kotlin-android")
     id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
     alias(libs.plugins.compose.compiler)
+    alias(libs.plugins.screenshot)
 }
 
 android {
@@ -46,6 +47,8 @@ android {
         jvmTarget = "1.8"
         freeCompilerArgs += "-Xopt-in=kotlin.RequiresOptIn"
     }
+
+    experimentalProperties["android.experimental.enableScreenshotTest"] = true
 }
 
 dependencies {
@@ -68,6 +71,8 @@ dependencies {
     androidTestImplementation(libs.androidx.test.compose.ui)
     androidTestImplementation(libs.kotlinx.coroutines.test)
 
+    screenshotTestImplementation(libs.androidx.compose.ui.tooling)
+
     // Instead of the lines below, regular apps would load these libraries from Maven according to
     // the README installation instructions
     implementation(project(":maps-compose"))

app/src/debug/screenshotTest/reference/com/google/maps/android/compose/ScaleBarTest/PreviewScaleBar_da39a3ee_da39a3ee_0.png

@@ -31,13 +31,18 @@ import androidx.compose.foundation.layout.systemBarsPadding
 import androidx.compose.foundation.layout.wrapContentSize
 import androidx.compose.material.CircularProgressIndicator
 import androidx.compose.material.MaterialTheme
+import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
+import com.google.android.gms.maps.model.CameraPosition
+import com.google.android.gms.maps.model.LatLng
+import com.google.maps.android.compose.theme.MapsComposeSampleTheme
 import com.google.maps.android.compose.widgets.DarkGray
 import com.google.maps.android.compose.widgets.DisappearingScaleBar
 import com.google.maps.android.compose.widgets.ScaleBar
@@ -126,4 +131,26 @@ class ScaleBarActivity : ComponentActivity() {
             }
         }
     }
+}
+
+@Preview
+@Composable
+fun PreviewScaleBar() {
+    val cameraPositionState = remember {
+        CameraPositionState(
+            position = CameraPosition(
+                LatLng(48.137154, 11.576124), // Example coordinates: Munich, Germany
+                12f,
+                0f,
+                0f
+            )
+        )
+    }
+
+    MapsComposeSampleTheme {
+        ScaleBar(
+            modifier = Modifier.padding(end = 4.dp),
+            cameraPositionState = cameraPositionState
+        )
+    }
 }

app/src/main/java/com/google/maps/android/compose/ScaleBarActivity.kt

@@ -42,6 +42,7 @@ import com.google.android.gms.maps.model.CameraPosition
 import com.google.android.gms.maps.model.LatLng
 import com.google.maps.android.clustering.ClusterItem
 import com.google.maps.android.clustering.algo.NonHierarchicalViewBasedAlgorithm
+import com.google.maps.android.clustering.view.DefaultClusterRenderer
 import com.google.maps.android.compose.GoogleMap
 import com.google.maps.android.compose.MapsComposeExperimentalApi
 import com.google.maps.android.compose.MarkerInfoWindow
@@ -79,7 +80,8 @@ fun GoogleMapClustering() {
         }
     }
     Box(
-        modifier = Modifier.fillMaxSize()
+        modifier = Modifier
+            .fillMaxSize()
             .systemBarsPadding()
     ) {
         GoogleMapClustering(items = items)
@@ -158,6 +160,7 @@ private fun DefaultClustering(items: List<MyItem>) {
 @OptIn(MapsComposeExperimentalApi::class)
 @Composable
 private fun CustomUiClustering(items: List<MyItem>) {
+    Log.i("","Clusteringggg")
     Clustering(
         items = items,
         // Optional: Handle clicks on clusters, cluster items, and cluster item info windows
@@ -181,7 +184,9 @@ private fun CustomUiClustering(items: List<MyItem>) {
             )
         },
         // Optional: Custom rendering for non-clustered items
-        clusterItemContent = null
+        clusterItemContent = null,
+        // Optional: Customization hook for clusterManager and renderer when they're ready
+
     )
 }
 
@@ -218,6 +223,7 @@ fun CustomRendererClustering(items: List<MyItem>) {
         },
         clusterManager = clusterManager,
     )
+
     SideEffect {
         clusterManager ?: return@SideEffect
         clusterManager.setOnClusterClickListener {

app/src/main/java/com/google/maps/android/compose/markerexamples/MarkerClusteringActivity.kt

@@ -0,0 +1,37 @@
+package com.google.maps.android.compose
+
+import androidx.compose.foundation.layout.padding
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
+import com.google.android.gms.maps.model.CameraPosition
+import com.google.android.gms.maps.model.LatLng
+import com.google.maps.android.compose.theme.MapsComposeSampleTheme
+import com.google.maps.android.compose.widgets.ScaleBar
+
+
+class ScaleBarTest() {
+    @Preview
+    @Composable
+    fun PreviewScaleBar() {
+        val cameraPositionState = remember {
+            CameraPositionState(
+                position = CameraPosition(
+                    LatLng(48.137154, 11.576124), // Example coordinates: Munich, Germany
+                    12f,
+                    0f,
+                    0f
+                )
+            )
+        }
+
+        MapsComposeSampleTheme {
+            ScaleBar(
+                modifier = Modifier.padding(end = 4.dp),
+                cameraPositionState = cameraPositionState
+            )
+        }
+    }
+}

app/src/screenshotTest/java/com/google/maps/android/compose/ScaleBarTest.kt

@@ -31,4 +31,6 @@ sonatypeToken=
 sonatypeTokenPassword=
 
 android.nonTransitiveRClass=false
-android.nonFinalResIds=false
+android.nonFinalResIds=false
+
+android.experimental.enableScreenshotTest=true

gradle.properties

@@ -1,8 +1,9 @@
 [versions]
 activitycompose = "1.9.3"
 agp = "8.7.2"
-androidxtest = "1.6.1"
-compose-bom = "2024.10.01"
+androidxtest = "1.6.2"
+androidCore = "1.6.1"
+compose-bom = "2024.11.00"
 dokka = "1.9.20"
 espresso = "3.6.1"
 jacoco-plugin = "0.2.1"
@@ -14,6 +15,7 @@ mapsktx = "5.1.1"
 mapsecrets = "2.0.1"
 org-jacoco-core = "0.8.11"
 androidx-core = "1.15.0"
+screenshot = "0.0.1-alpha07"
 
 [libraries]
 android-gradle-plugin = { module = "com.android.tools.build:gradle", version.ref = "agp" }
@@ -26,10 +28,10 @@ androidx-compose-ui-preview-tooling = { module = "androidx.compose.ui:ui-tooling
 androidx-compose-ui-tooling = { module = "androidx.compose.ui:ui-tooling" }
 androidx-core = { module = "androidx.core:core-ktx", version.ref = "androidx-core" }
 androidx-test-compose-ui = { module = "androidx.compose.ui:ui-test-junit4" }
-androidx-test-core = { module = "androidx.test:core", version.ref = "androidxtest" }
+androidx-test-core = { module = "androidx.test:core", version.ref = "androidCore" }
 androidx-test-espresso = { module = "androidx.test.espresso:espresso-core", version.ref = "espresso" }
 androidx-test-junit-ktx = { module = "androidx.test.ext:junit-ktx", version.ref = "junitktx" }
-androidx-test-rules = { module = "androidx.test:rules", version.ref = "androidxtest" }
+androidx-test-rules = { module = "androidx.test:rules", version.ref = "androidCore" }
 androidx-test-runner = { module = "androidx.test:runner", version.ref = "androidxtest" }
 dokka-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
 jacoco-android-plugin = { module = "com.mxalbert.gradle:jacoco-android", version.ref = "jacoco-plugin", version.require = "0.2.1" }
@@ -45,4 +47,5 @@ test-junit = { module = "junit:junit", version.ref = "junit" }
 
 [plugins]
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
-compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+screenshot = { id = "com.android.compose.screenshot", version.ref = "screenshot"}

gradle/libs.versions.toml

@@ -126,6 +126,46 @@ public fun <T : ClusterItem> Clustering(
     onClusterItemInfoWindowLongClick: (T) -> Unit = { },
     clusterContent: @[UiComposable Composable] ((Cluster<T>) -> Unit)? = null,
     clusterItemContent: @[UiComposable Composable] ((T) -> Unit)? = null,
+) {
+    Clustering(
+        items = items,
+        onClusterClick = onClusterClick,
+        onClusterItemClick = onClusterItemClick,
+        onClusterItemInfoWindowClick = onClusterItemInfoWindowClick,
+        onClusterItemInfoWindowLongClick = onClusterItemInfoWindowLongClick,
+        clusterContent = clusterContent,
+        clusterItemContent = clusterItemContent,
+        onClusterManager = null,
+    )
+}
+
+/**
+ * Groups many items on a map based on zoom level.
+ *
+ * @param items all items to show
+ * @param onClusterClick a lambda invoked when the user clicks a cluster of items
+ * @param onClusterItemClick a lambda invoked when the user clicks a non-clustered item
+ * @param onClusterItemInfoWindowClick a lambda invoked when the user clicks the info window of a
+ * non-clustered item
+ * @param onClusterItemInfoWindowLongClick a lambda invoked when the user long-clicks the info
+ * window of a non-clustered item
+ * @param clusterContent an optional Composable that is rendered for each [Cluster].
+ * @param clusterItemContent an optional Composable that is rendered for each non-clustered item.
+ * @param onClusterManager an optional lambda invoked with the clusterManager as a param when both
+ * the clusterManager and renderer are set up, allowing callers a customization hook.
+ */
+@Composable
+@GoogleMapComposable
+@MapsComposeExperimentalApi
+public fun <T : ClusterItem> Clustering(
+    items: Collection<T>,
+    onClusterClick: (Cluster<T>) -> Boolean = { false },
+    onClusterItemClick: (T) -> Boolean = { false },
+    onClusterItemInfoWindowClick: (T) -> Unit = { },
+    onClusterItemInfoWindowLongClick: (T) -> Unit = { },
+    clusterContent: @[UiComposable Composable] ((Cluster<T>) -> Unit)? = null,
+    clusterItemContent: @[UiComposable Composable] ((T) -> Unit)? = null,
+    onClusterManager: ((ClusterManager<T>) -> Unit)? = null,
 ) {
     val clusterManager = rememberClusterManager<T>()
     val renderer = rememberClusterRenderer(clusterContent, clusterItemContent, clusterManager)
@@ -142,6 +182,7 @@ public fun <T : ClusterItem> Clustering(
         clusterManager.setOnClusterItemClickListener(onClusterItemClick)
         clusterManager.setOnClusterItemInfoWindowClickListener(onClusterItemInfoWindowClick)
         clusterManager.setOnClusterItemInfoWindowLongClickListener(onClusterItemInfoWindowLongClick)
+        onClusterManager?.invoke(clusterManager)
     }
 
     if (clusterManager != null && renderer != null) {