Merge pull request #111 from sergio-sastre/release/2.2.1

sergio-sastre · web-flow · commit 447ad5bc016b · 2024-02-21T17:25:02.000+01:00
Release/2.2.1
diff --git a/android-testify/build.gradle b/android-testify/build.gradle
@@ -62,7 +62,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "android-testify"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/android-testify/src/main/java/sergio/sastre/uitesting/android_testify/AndroidTestifyScreenshotTestRuleForView.kt b/android-testify/src/main/java/sergio/sastre/uitesting/android_testify/AndroidTestifyScreenshotTestRuleForView.kt
@@ -97,6 +97,7 @@ class AndroidTestifyScreenshotTestRuleForView(
             .setViewUnderTest(viewToScreenshot!!)
             .setBitmapCaptureMethod(androidTestifyConfig.bitmapCaptureMethod)
             .generateDiffs(androidTestifyConfig.generateDiffs)
+            .waitForIdleSync()
             .assertSame(name = name)
     }
 
diff --git a/android-testify/src/main/java/sergio/sastre/uitesting/android_testify/ScreenshotRuleExt.kt b/android-testify/src/main/java/sergio/sastre/uitesting/android_testify/ScreenshotRuleExt.kt
@@ -45,6 +45,10 @@ fun <T : Activity> ScreenshotRule<T>.assertSame(name: String?) {
     assertSame()
 }
 
+fun <T : Activity> ScreenshotRule<T>.waitForIdleSync(): ScreenshotRule<T> = apply {
+    getInstrumentation().waitForIdleSync()
+}
+
 // We need to ensure the view is attached to the screenshotRule activity window for testify to
 // take the screenshot. This is especially important for dialogs
 internal fun <T : Activity> ScreenshotRule<T>.setViewUnderTest(
diff --git a/dropshots/build.gradle b/dropshots/build.gradle
@@ -61,7 +61,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "dropshots"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/mapper-paparazzi/build.gradle b/mapper-paparazzi/build.gradle
@@ -49,7 +49,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "mapper-paparazzi"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/mapper-roborazzi/build.gradle b/mapper-roborazzi/build.gradle
@@ -50,7 +50,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "mapper-roborazzi"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/paparazzi/build.gradle b/paparazzi/build.gradle
@@ -57,7 +57,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "paparazzi"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/robolectric/build.gradle b/robolectric/build.gradle
@@ -50,7 +50,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "robolectric"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/roborazzi/build.gradle b/roborazzi/build.gradle
@@ -64,7 +64,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "roborazzi"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/shot/build.gradle b/shot/build.gradle
@@ -61,7 +61,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "shot"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/utils/build.gradle b/utils/build.gradle
@@ -73,7 +73,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.sergio-sastre'
             artifactId = "utils"
-            version = '2.2.0'
+            version = '2.2.1'
 
             afterEvaluate {
                 from components.release
diff --git a/utils/src/main/java/sergio/sastre/uitesting/utils/testrules/displaysize/DisplaySizeTestRule.kt b/utils/src/main/java/sergio/sastre/uitesting/utils/testrules/displaysize/DisplaySizeTestRule.kt
@@ -2,15 +2,9 @@ package sergio.sastre.uitesting.utils.testrules.displaysize
 
 import android.os.SystemClock
 import android.util.Log
-import androidx.annotation.Discouraged
-import androidx.annotation.IntRange
-
-import org.junit.rules.TestRule
-import org.junit.rules.TestWatcher
 import org.junit.runner.Description
 import org.junit.runners.model.Statement
-
-import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
+import org.junit.rules.TestRule
 import sergio.sastre.uitesting.utils.common.DisplaySize
 import sergio.sastre.uitesting.utils.testrules.Condition
 import sergio.sastre.uitesting.utils.testrules.displaysize.DisplaySizeTestRule.DisplaySizeStatement.Companion.MAX_RETRIES_TO_WAIT_FOR_SETTING
@@ -23,9 +17,11 @@ import sergio.sastre.uitesting.utils.testrules.displaysize.DisplaySizeTestRule.D
  */
 class DisplaySizeTestRule(
     private val displaySize: DisplaySize,
-) : TestWatcher(), TestRule {
+) : TestRule {
 
     companion object {
+        private val TAG = DisplaySizeTestRule::class.java.simpleName
+
         fun smallDisplaySizeTestRule(): DisplaySizeTestRule = DisplaySizeTestRule(
             DisplaySize.SMALL
         )
@@ -48,36 +44,13 @@ class DisplaySizeTestRule(
 
     private val displayScaleSetting: DisplayScaleSetting = DisplayScaleSetting()
 
-    private var previousDensityDpi: Int = 0
-
-    /**
-     * Since the Display Size setting is changed via adb, it might take longer than expected to
-     * take effect, and could be device dependent. One can use this method to adjust the default
-     * time out which is [MAX_RETRIES_TO_WAIT_FOR_SETTING] * [SLEEP_TO_WAIT_FOR_SETTING_MILLIS]
-     */
-    @Discouraged(
-        message = "Consider removing this method, since it will be removed in a future version. " +
-                "This was initially built as a workaround for an issue that should not happen anymore. " +
-                "If after all, you still need this, consider opening an issue."
-    )
-    fun withTimeOut(@IntRange(from = 0) inMillis: Int): DisplaySizeTestRule = apply {
-        this.timeOutInMillis = inMillis
-    }
-
-    override fun starting(description: Description?) {
-        previousDensityDpi = getInstrumentation().targetContext.resources.configuration.densityDpi
-    }
-
-    override fun finished(description: Description?) {
-        displayScaleSetting.resetDisplaySizeScale(previousDensityDpi)
-    }
-
     override fun apply(base: Statement, description: Description): Statement {
-        return DisplaySizeStatement(base, displayScaleSetting, displaySize, timeOutInMillis)
+        return DisplaySizeStatement(base, description, displayScaleSetting, displaySize, timeOutInMillis)
     }
 
     private class DisplaySizeStatement(
         private val baseStatement: Statement,
+        private val description: Description,
         private val scaleSetting: DisplayScaleSetting,
         private val scale: DisplaySize,
         private val timeOutInMillis: Int,
@@ -86,14 +59,25 @@ class DisplaySizeTestRule(
         @Throws(Throwable::class)
         override fun evaluate() {
             val initialDisplay = scaleSetting.densityDpi
-            val expectedDisplay = (initialDisplay * scale.value.toFloat()).toInt()
-            scaleSetting.setDisplaySizeScale(scale)
-            sleepUntil(scaleMatches(expectedDisplay), expectedDisplay)
-
-            baseStatement.evaluate()
-
-            scaleSetting.resetDisplaySizeScale(initialDisplay)
-            sleepUntil(scaleMatches(initialDisplay), initialDisplay)
+            try {
+                val expectedDisplay = (initialDisplay * scale.value.toFloat()).toInt()
+                scaleSetting.setDisplaySizeScale(scale)
+                sleepUntil(scaleMatches(expectedDisplay), expectedDisplay)
+
+                baseStatement.evaluate()
+
+                scaleSetting.resetDisplaySizeScale(initialDisplay)
+                sleepUntil(scaleMatches(initialDisplay), initialDisplay)
+            } catch (throwable: Throwable){
+                val testName = "${description.testClass.simpleName}\$${description.methodName}"
+                val errorMessage =
+                    "Test $testName failed on setting DisplaySize to ${scale.name}"
+                Log.e(TAG, errorMessage)
+                throw throwable
+            } finally {
+                scaleSetting.resetDisplaySizeScale(initialDisplay)
+                sleepUntil(scaleMatches(initialDisplay), initialDisplay)
+            }
         }
 
         private fun scaleMatches(densityDpi: Int): Condition {
@@ -116,7 +100,7 @@ class DisplaySizeTestRule(
                 if (mustRetry) {
                     retries++
                     scaleSetting.setDisplaySizeScale(expectedDisplay)
-                    Log.d("DisplaySizeTestRule", "trying to set DisplaySize to $expectedDisplay, $retries retry")
+                    Log.d(TAG, "trying to set DisplaySize to $expectedDisplay, $retries retry")
                 }
                 if (iterations == iterationsCount) {
                     throw timeoutError()
diff --git a/utils/src/main/java/sergio/sastre/uitesting/utils/testrules/fontsize/FontSizeTestRule.kt b/utils/src/main/java/sergio/sastre/uitesting/utils/testrules/fontsize/FontSizeTestRule.kt
@@ -2,15 +2,9 @@ package sergio.sastre.uitesting.utils.testrules.fontsize
 
 import android.os.SystemClock
 import android.util.Log
-import androidx.annotation.Discouraged
-import androidx.annotation.IntRange
-
-import org.junit.rules.TestRule
-import org.junit.rules.TestWatcher
 import org.junit.runner.Description
 import org.junit.runners.model.Statement
-
-import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
+import org.junit.rules.TestRule
 import sergio.sastre.uitesting.utils.common.FontSize
 import sergio.sastre.uitesting.utils.testrules.Condition
 import sergio.sastre.uitesting.utils.testrules.fontsize.FontSizeTestRule.FontScaleStatement.Companion.MAX_RETRIES_TO_WAIT_FOR_SETTING
@@ -26,10 +20,11 @@ import sergio.sastre.uitesting.utils.testrules.fontsize.FontSizeTestRule.FontSca
  */
 class FontSizeTestRule(
     private val fontSize: FontSize
-) : TestWatcher(), TestRule {
+) : TestRule {
 
     companion object {
-        val TAG = FontSizeTestRule::class.java.simpleName
+        private val TAG = FontSizeTestRule::class.java.simpleName
+
         fun smallFontScaleTestRule(): FontSizeTestRule = FontSizeTestRule(FontSize.SMALL)
 
         fun normalFontScaleTestRule(): FontSizeTestRule = FontSizeTestRule(FontSize.NORMAL)
@@ -43,36 +38,13 @@ class FontSizeTestRule(
 
     private val fontScaleSetting: FontScaleSetting = FontScaleSetting()
 
-    private var previousScale: Float = 0.toFloat()
-
-    /**
-     * Since the Font Size setting might be changed via adb, it might take longer than expected to
-     * take effect, and could be device dependent. One can use this method to adjust the default
-     * time out which is [MAX_RETRIES_TO_WAIT_FOR_SETTING] * [SLEEP_TO_WAIT_FOR_SETTING_MILLIS]
-     */
-    @Discouraged(
-        message = "Consider removing this method, since it will be removed in a future version. " +
-                "This was initially built as a workaround for an issue that should not happen anymore. " +
-                "If after all, you still need this, consider opening an issue."
-    )
-    fun withTimeOut(@IntRange(from = 0) inMillis: Int): FontSizeTestRule = apply {
-        this.timeOutInMillis = inMillis
-    }
-
-    override fun starting(description: Description?) {
-        previousScale = getInstrumentation().targetContext.resources.configuration.fontScale
-    }
-
-    override fun finished(description: Description?) {
-        fontScaleSetting.set(FontSize.from(previousScale))
-    }
-
     override fun apply(base: Statement, description: Description): Statement {
-        return FontScaleStatement(base, fontScaleSetting, fontSize, timeOutInMillis)
+        return FontScaleStatement(base, description, fontScaleSetting, fontSize, timeOutInMillis)
     }
 
     private class FontScaleStatement(
         private val baseStatement: Statement,
+        private val description: Description,
         private val scaleSetting: FontScaleSetting,
         private val scale: FontSize,
         private val timeOutInMillis: Int,
@@ -81,13 +53,21 @@ class FontSizeTestRule(
         @Throws(Throwable::class)
         override fun evaluate() {
             val initialScale = scaleSetting.get()
-            scaleSetting.set(scale)
-            sleepUntil(scaleMatches(scale), scale)
-
-            baseStatement.evaluate()
-
-            scaleSetting.set(initialScale)
-            sleepUntil(scaleMatches(initialScale), initialScale)
+            try {
+                scaleSetting.set(scale)
+                sleepUntil(scaleMatches(scale), scale)
+
+                baseStatement.evaluate()
+            } catch (throwable: Throwable) {
+                val testName = "${description.testClass.simpleName}\$${description.methodName}"
+                val errorMessage =
+                    "Test $testName failed on setting FontSize to ${scale.name}"
+                Log.e(TAG, errorMessage)
+                throw throwable
+            } finally {
+                scaleSetting.set(initialScale)
+                sleepUntil(scaleMatches(initialScale), initialScale)
+            }
         }
 
         private fun scaleMatches(scale: FontSize): Condition {

Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ class AndroidTestifyScreenshotTestRuleForView(`
`97`	`97`	`.setViewUnderTest(viewToScreenshot!!)`
`98`	`98`	`.setBitmapCaptureMethod(androidTestifyConfig.bitmapCaptureMethod)`
`99`	`99`	`.generateDiffs(androidTestifyConfig.generateDiffs)`
	`100`	`+ .waitForIdleSync()`
`100`	`101`	`.assertSame(name = name)`
`101`	`102`	`}`
`102`	`103`