Feature/ASAA-23 Compose UI x Karumi Shot Testing

README.md

@@ -80,4 +80,9 @@ This project uses the `generateNavDrawerItems` method in the `ComposeActivity` t
     * cancelOnTouchOutside (Boolean)
 
 ## LaunchPad Development
-Uncomment mavenLocal in main build.gradle.kts to test local library changes.
+Uncomment mavenLocal in main build.gradle.kts to test local library changes.
+
+## Compose UI Testing x Karumi Shots
+* Requires API 30+
+* Must re-install app prior to running any tests to get updated Manifest
+* Complete setup can be found here <https://confluence.bottlerocketapps.com/display/BKB/Screenshot+Testing%3A+Compose+UI+x+Karumi>

app/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
     kotlin(Config.ApplyPlugins.Kotlin.ANDROID)
     id(Config.ApplyPlugins.KSP)
     id(Config.ApplyPlugins.PARCELIZE)
+    id(Config.ApplyPlugins.KARUMI_SHOT_TESTING)
 }
 
 extra.set("jacocoCoverageThreshold", 0.30.toBigDecimal()) // module specific code coverage verification threshold
@@ -34,7 +35,10 @@ android {
         targetSdk = Config.AndroidSdkVersions.TARGET_SDK
         versionCode = BuildInfoManager.APP_VERSION.versionCode
         versionName = BuildInfoManager.APP_VERSION.versionName
-        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+
+        // testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+
+        testInstrumentationRunner = "com.karumi.shot.ShotTestRunner"
     }
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_11
@@ -127,6 +131,10 @@ android {
     testOptions {
         unitTests.isIncludeAndroidResources = true
     }
+    shot {
+        applicationId = "com.bottlerocketstudios.brarchitecture.test"
+        // tolerance = 1.1
+    }
 }
 
 // Declare configurations per variant to use in the dependencies block below. See :data module for examples if needed here in the :app module.
@@ -178,4 +186,5 @@ dependencies {
     espressoDependencies()
     extJunitRunnerDependencies()
     androidxCoreDependencies()
+    composeTestDependencies()
 }

app/src/androidTest/AndroidManifest.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.bottlerocketstudios.brarchitecture.test"
+    android:sharedUserId="com.bottlerocketstudios.brarchitecture.uid">
+
+</manifest>

app/src/androidTest/java/com/bottlerocketstudios/brarchitecture/BaseUIScreenshotTest.kt

@@ -0,0 +1,12 @@
+package com.bottlerocketstudios.brarchitecture
+
+import com.karumi.shot.ScreenshotTest
+
+/**
+ * For later use to create extension functions to speed up development of UI tests
+ *
+ * Please see the Confluence page for setup, troubleshooting and more information on Compose UI x Karumi screenshot testing.
+ *
+ * https://confluence.bottlerocketapps.com/display/BKB/Screenshot+Testing%3A+Compose+UI+x+Karumi
+ */
+open class BaseUIScreenshotTest : ScreenshotTest