Merge branch '206-generate-diffs' into testify-ext

Author: Daniel Jette

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 #### Changes
 
+- FuzzyCompare (setExactness) is now multi-threaded and significantly faster.
 - TestifyFeatures now support multiple named strings.
 - PixelCopyCapture can be enabled using either "testify-experimental-capture" or "testify-pixelcopy-capture" in the AndroidManifest
 - Optional constructor argument enableReporter added to ScreenshotRule. Allows you to specify whether to run the reporter for this test rule.
@@ -23,6 +24,7 @@
 
 #### Added
 
+- Added `TestifyFeatures.GenerateDiffs`. When enabled, will output a `.diff.png` alongside existing baseline images. These images are high-contrast images where each difference, regardless of how minor, are indicated in red against a black background. See the `generateDiffs` test in `ScreenshotRuleExampleTests` for an example. Diff images will be pulled from the device when running `screenshotPull`.
 - Added method `ScreenshotRule.beforeAssertSame()`. This method is invoked immediately before assertSame and before the activity is launched.
 - Added method `ScreenshotRule.beforeInitializeView(activity: Activity)`. This method is invoked prior to any view modifications and prior to layout inflation.
 - Added method `ScreenshotRule.afterInitializeView(activity: Activity)`. This method is invoked after layout inflation and all view modifications have been applied.

Library/build.gradle

@@ -56,6 +56,12 @@ android {
         implementation "androidx.test:runner:${versions.androidx.test.runner}"
         implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:${versions.kotlin}"
         implementation "com.github.ajalt:colormath:${versions.colormath}"
+        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.3") {
+            exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-jdk8'
+            exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-jdk7'
+            exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib'
+            exclude group: 'org.jetbrains.kotlin', module: 'kotlin-stdlib-common'
+        }
 
         testImplementation "org.mockito:mockito-core:${versions.mockito2}"
         testImplementation "com.nhaarman.mockitokotlin2:mockito-kotlin:${versions.mockitokotlin}"
@@ -71,4 +77,4 @@ android {
 }
 
 apply from: "bintray.build.gradle"
-apply from: '../ktlint.gradle'
+apply from: '../ktlint.gradle'

Library/src/androidTest/assets/screenshots/29-1080x2220@440dp-en_US/benchmark_baseline.png

@@ -30,8 +30,8 @@ import android.graphics.Bitmap
 import android.view.View
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.rule.ActivityTestRule
-import com.shopify.testify.internal.compare.FuzzyCompare
-import com.shopify.testify.internal.compare.SameAsCompare
+import com.shopify.testify.internal.processor.compare.FuzzyCompare
+import com.shopify.testify.internal.processor.compare.SameAsCompare
 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertTrue
 import org.junit.Before

Library/src/androidTest/assets/screenshots/29-1080x2220@440dp-en_US/benchmark_current.png

@@ -28,7 +28,7 @@ package com.shopify.testify
 import android.graphics.Bitmap
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.rule.ActivityTestRule
-import com.shopify.testify.internal.compare.FuzzyCompare
+import com.shopify.testify.internal.processor.compare.FuzzyCompare
 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertTrue
 import org.junit.Rule
@@ -70,4 +70,15 @@ class FuzzyCompareBitmapTest {
          */
         assertTrue(FuzzyCompare(0.975f).compareBitmaps(baselineBitmap, currentBitmap))
     }
+
+    /**
+     * In this test, the baseline & current images are nearly identical where every pixel
+     * is different, but within the exactness threshold. So, it is required to compare every pixel
+     */
+    @Test
+    fun compareWorstCase() {
+        val baselineBitmap = loadBitmap("benchmark_baseline")
+        val currentBitmap = loadBitmap("benchmark_current")
+        assertTrue(FuzzyCompare(0.95f).compareBitmaps(baselineBitmap, currentBitmap))
+    }
 }

Library/src/androidTest/java/com/shopify/testify/BitmapCompareTest.kt

@@ -52,9 +52,9 @@ import com.shopify.testify.annotation.TestifyLayout
 import com.shopify.testify.internal.DeviceIdentifier
 import com.shopify.testify.internal.DeviceIdentifier.DEFAULT_NAME_FORMAT
 import com.shopify.testify.internal.TestName
-import com.shopify.testify.internal.compare.FuzzyCompare
-import com.shopify.testify.internal.compare.RegionCompare
-import com.shopify.testify.internal.compare.SameAsCompare
+import com.shopify.testify.internal.processor.compare.FuzzyCompare
+import com.shopify.testify.internal.processor.compare.RegionCompare
+import com.shopify.testify.internal.processor.compare.SameAsCompare
 import com.shopify.testify.internal.exception.ActivityNotRegisteredException
 import com.shopify.testify.internal.exception.AssertSameMustBeLastException
 import com.shopify.testify.internal.exception.MissingAssertSameException
@@ -75,6 +75,7 @@ import com.shopify.testify.internal.modification.HidePasswordViewModification
 import com.shopify.testify.internal.modification.HideScrollbarsViewModification
 import com.shopify.testify.internal.modification.HideTextSuggestionsViewModification
 import com.shopify.testify.internal.modification.SoftwareRenderViewModification
+import com.shopify.testify.internal.processor.diff.HighContrastDiff
 import com.shopify.testify.internal.output.OutputFileUtility
 import com.shopify.testify.report.ReportSession
 import com.shopify.testify.report.Reporter
@@ -543,6 +544,13 @@ open class ScreenshotRule<T : Activity> @JvmOverloads constructor(
                         screenshotUtility.deleteBitmap(activity, outputFileName)
                     )
                 } else {
+                    if (TestifyFeatures.GenerateDiffs.isEnabled(activity)) {
+                        HighContrastDiff()
+                            .name(outputFileName)
+                            .baseline(baselineBitmap)
+                            .current(currentBitmap)
+                            .generate(context = activity)
+                    }
                     if (isRecordMode()) {
                         instrumentationPrintln(
                             "\n\t✓ " + 27.toChar() + "[36mRecording baseline for " + testName +

Library/src/androidTest/java/com/shopify/testify/FuzzyCompareBitmapTest.kt

@@ -35,9 +35,9 @@ import androidx.test.platform.app.InstrumentationRegistry
 import com.shopify.testify.TestifyFeatures.CanvasCapture
 import com.shopify.testify.TestifyFeatures.PixelCopyCapture
 import com.shopify.testify.internal.DeviceIdentifier
-import com.shopify.testify.internal.capture.createBitmapFromCanvas
-import com.shopify.testify.internal.capture.createBitmapFromDrawingCache
-import com.shopify.testify.internal.capture.createBitmapUsingPixelCopy
+import com.shopify.testify.internal.processor.capture.createBitmapFromCanvas
+import com.shopify.testify.internal.processor.capture.createBitmapFromDrawingCache
+import com.shopify.testify.internal.processor.capture.createBitmapUsingPixelCopy
 import com.shopify.testify.internal.exception.ScreenshotDirectoryNotFoundException
 import com.shopify.testify.internal.output.OutputFileUtility
 import com.shopify.testify.internal.output.OutputFileUtility.Companion.PNG_EXTENSION
@@ -59,7 +59,7 @@ class ScreenshotUtility {
             return options
         }
 
-    private fun saveBitmapToFile(context: Context, bitmap: Bitmap?, outputFilePath: String): Boolean {
+    fun saveBitmapToFile(context: Context, bitmap: Bitmap?, outputFilePath: String): Boolean {
         if (bitmap == null) {
             return false
         }

Library/src/main/java/com/shopify/testify/ScreenshotRule.kt

@@ -31,6 +31,7 @@ enum class TestifyFeatures(internal val tags: List<String>, private val defaultV
     ExampleFeature(listOf("testify-example", "testify-alias"), defaultValue = true),
     ExampleDisabledFeature(listOf("testify-disabled")),
 
+    GenerateDiffs(listOf("testify-generate-diffs"), defaultValue = false),
     Locale(listOf("testify-experimental-locale"), defaultValue = true),
     CanvasCapture(listOf("testify-canvas-capture")),
     PixelCopyCapture(listOf("testify-experimental-capture", "testify-pixelcopy-capture"));

Library/src/main/java/com/shopify/testify/ScreenshotUtility.kt

@@ -0,0 +1,19 @@
+package com.shopify.testify.internal.processor
+
+import android.graphics.Bitmap
+import kotlinx.coroutines.asCoroutineDispatcher
+import java.util.concurrent.Executors
+
+fun ParallelPixelProcessor.TransformResult.createBitmap(): Bitmap {
+    return Bitmap.createBitmap(
+        this.pixels,
+        this.width,
+        this.height,
+        Bitmap.Config.ARGB_8888
+    )
+}
+
+val numberOfCores by lazy { Runtime.getRuntime().availableProcessors() }
+val executorDispatcher by lazy {
+    Executors.newFixedThreadPool(numberOfCores).asCoroutineDispatcher()
+}