Merge pull request #72 from sergio-sastre/release/2.0.0-beta03

Release/2.0.0 beta03

Author: sergio-sastre

README.md

@@ -1 +1,12 @@
-/build
+.gradle
+/local.properties
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties
+
+# idea
+*.iml
+.idea/

dropshots/.gitignore

@@ -11,8 +11,8 @@ android {
     defaultConfig {
         minSdk 23
         targetSdk 33
-        versionCode 17
-        versionName "2.0.0-beta02"
+        versionCode 18
+        versionName "2.0.0-beta03"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
@@ -43,6 +43,7 @@ android {
 
 dependencies {
     implementation project(':utils')
+    implementation 'androidx.test:rules:1.5.0'
     api 'com.dropbox.dropshots:dropshots:0.4.0'
     api 'androidx.activity:activity-compose:1.7.1'
 }
@@ -53,7 +54,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "dropshots"
-            version = '2.0.0-beta02'
+            version = '2.0.0-beta03'
 
             afterEvaluate {
                 from components.release

dropshots/build.gradle

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <!-- The content of this manifest is needed for Dropshots to run on API 29 -->
+    <uses-permission
+        android:name="android.permission.WRITE_EXTERNAL_STORAGE"
+        android:maxSdkVersion="29"
+        tools:node="replace" />
+
+    <application
+        android:requestLegacyExternalStorage="true"
+        tools:node="merge">
+    </application>
+
+</manifest>

dropshots/src/main/AndroidManifest.xml

@@ -0,0 +1,42 @@
+package sergio.sastre.uitesting.dropshots
+
+import android.Manifest
+import android.app.Activity
+import android.graphics.Bitmap
+import android.os.Build
+import android.view.View
+import androidx.test.rule.GrantPermissionRule
+import com.dropbox.dropshots.Dropshots
+import org.junit.rules.RuleChain
+import org.junit.rules.TestRule
+import org.junit.runner.Description
+import org.junit.runners.model.Statement
+
+/**
+ * Bugfix: Dropshots must grant WRITE_EXTERNAL_STORAGE to record screenshots on emulators running API 29
+ */
+class DropshotsAPI29Fix(
+    private val dropshots: Dropshots,
+) : TestRule {
+    override fun apply(base: Statement, description: Description): Statement =
+        if (Build.VERSION.SDK_INT == Build.VERSION_CODES.Q) {
+            RuleChain.outerRule(
+                // needed also in the manifest. Only required for API 29
+                GrantPermissionRule.grant(Manifest.permission.WRITE_EXTERNAL_STORAGE)
+            ).around(dropshots).apply(base, description)
+        } else {
+            dropshots.apply(base, description)
+        }
+
+    fun assertSnapshot(bitmap: Bitmap, name: String) {
+        dropshots.assertSnapshot(bitmap, name)
+    }
+
+    fun assertSnapshot(activity: Activity, name: String) {
+        dropshots.assertSnapshot(activity, name)
+    }
+
+    fun assertSnapshot(view: View, name: String) {
+        dropshots.assertSnapshot(view, name)
+    }
+}

dropshots/src/main/java/sergio/sastre/uitesting/dropshots/DropshotsAPI29Fix.kt

@@ -1,11 +1,17 @@
 package sergio.sastre.uitesting.dropshots
 
+import androidx.annotation.ColorInt
+import com.dropbox.differ.ImageComparator
+import com.dropbox.differ.SimpleImageComparator
+import com.dropbox.dropshots.CountValidator
 import com.dropbox.dropshots.ResultValidator
-import com.dropbox.dropshots.ThresholdValidator
 import sergio.sastre.uitesting.utils.crosslibrary.config.BitmapCaptureMethod
 import sergio.sastre.uitesting.utils.crosslibrary.config.LibraryConfig
 
 class DropshotsConfig(
+    val resultValidator: ResultValidator = CountValidator(0),
+    val imageComparator: ImageComparator = SimpleImageComparator(maxDistance = 0.004f),
     val bitmapCaptureMethod: BitmapCaptureMethod? = null,
-    val resultValidator: ResultValidator = ThresholdValidator(0.0f),
-): LibraryConfig
+    val recordScreenshots: Boolean = false,
+    @ColorInt val backgroundColor: Int? = null,
+) : LibraryConfig

dropshots/src/main/java/sergio/sastre/uitesting/dropshots/DropshotsConfig.kt

@@ -30,11 +30,18 @@ class DropshotsScreenshotTestRule(
             .setInitialOrientation(config.orientation)
             .setUiMode(config.uiMode)
             .setFontSize(config.fontScale)
-            .launchConfiguredActivity()
+            .setDisplaySize(config.displaySize)
+            .launchConfiguredActivity(dropshotsConfig.backgroundColor)
     }
 
-    private val dropshotsRule: Dropshots by lazy {
-        Dropshots(resultValidator = dropshotsConfig.resultValidator)
+    private val dropshotsRule: DropshotsAPI29Fix by lazy {
+        DropshotsAPI29Fix(
+            Dropshots(
+                resultValidator = dropshotsConfig.resultValidator,
+                imageComparator = dropshotsConfig.imageComparator,
+                recordScreenshots = dropshotsConfig.recordScreenshots,
+            )
+        )
     }
 
     private var dropshotsConfig: DropshotsConfig = DropshotsConfig()
@@ -64,7 +71,7 @@ class DropshotsScreenshotTestRule(
                 .findViewById<ViewGroup>(android.R.id.content)
                 .getChildAt(0) as ComposeView
 
-        when(val bitmapCaptureMethod = dropshotsConfig.bitmapCaptureMethod){
+        when (val bitmapCaptureMethod = dropshotsConfig.bitmapCaptureMethod) {
             is BitmapCaptureMethod.Canvas ->
                 takeSnapshotWithCanvas(bitmapCaptureMethod.config, existingComposeView, name)
             is BitmapCaptureMethod.PixelCopy ->