Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added maxPixels to ScreenshotTest #349

Merged
merged 1 commit into from
Feb 5, 2024
Merged

added maxPixels to ScreenshotTest #349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 30 additions & 14 deletions shot-android/src/main/java/com/karumi/shot/ScreenshotTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import androidx.test.espresso.Espresso
import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
import com.facebook.testing.screenshot.Screenshot
import com.facebook.testing.screenshot.ViewHelpers
import com.facebook.testing.screenshot.internal.RecordBuilderImpl
import com.facebook.testing.screenshot.internal.TestNameDetector
import com.karumi.shot.compose.ComposeScreenshotRunner
import com.karumi.shot.compose.ScreenshotMetadata
Expand All @@ -50,48 +51,58 @@ interface ScreenshotTest {
heightInPx: Int? = null,
widthInPx: Int? = null,
name: String? = null,
backgroundColor: Int = android.R.color.white
backgroundColor: Int = android.R.color.white,
maxPixels: Long = RecordBuilderImpl.DEFAULT_MAX_PIXELS,
) {
val view = activity.findViewById<View>(android.R.id.content)

if (heightInPx == null && widthInPx == null) {
disableFlakyComponentsAndWaitForIdle(view)
takeActivitySnapshot(activity, name)
takeActivitySnapshot(activity, name, maxPixels)
} else {
runOnUi {
view.setBackgroundResource(backgroundColor)
}
compareScreenshot(view = view!!, heightInPx = heightInPx, widthInPx = widthInPx, name = name)
compareScreenshot(view = view!!, heightInPx = heightInPx, widthInPx = widthInPx, name = name, maxPixels = maxPixels)
}
}

fun compareScreenshot(
fragment: Fragment,
heightInPx: Int? = null,
widthInPx: Int? = null,
name: String? = null
) = compareScreenshot(view = fragment.requireView(), heightInPx = heightInPx, widthInPx = widthInPx, name = name)
name: String? = null,
maxPixels: Long = RecordBuilderImpl.DEFAULT_MAX_PIXELS,
) = compareScreenshot(view = fragment.requireView(), heightInPx = heightInPx, widthInPx = widthInPx, name = name, maxPixels = maxPixels)

fun compareScreenshot(
dialog: Dialog,
heightInPx: Int? = null,
widthInPx: Int? = null,
name: String? = null
name: String? = null,
maxPixels: Long = RecordBuilderImpl.DEFAULT_MAX_PIXELS,
) {
val window = dialog.window
if (window != null) {
compareScreenshot(view = window.decorView, heightInPx = heightInPx, widthInPx = widthInPx, name = name)
compareScreenshot(view = window.decorView, heightInPx = heightInPx, widthInPx = widthInPx, name = name, maxPixels = maxPixels)
}
}

fun compareScreenshot(
holder: RecyclerView.ViewHolder,
heightInPx: Int,
widthInPx: Int? = null,
name: String? = null
) = compareScreenshot(view = holder.itemView, heightInPx = heightInPx, widthInPx = widthInPx, name = name)
name: String? = null,
maxPixels: Long = RecordBuilderImpl.DEFAULT_MAX_PIXELS,
) = compareScreenshot(view = holder.itemView, heightInPx = heightInPx, widthInPx = widthInPx, name = name, maxPixels = maxPixels)

fun compareScreenshot(view: View, heightInPx: Int? = null, widthInPx: Int? = null, name: String? = null) {
fun compareScreenshot(
view: View,
heightInPx: Int? = null,
widthInPx: Int? = null,
name: String? = null,
maxPixels: Long = RecordBuilderImpl.DEFAULT_MAX_PIXELS,
) {
disableFlakyComponentsAndWaitForIdle(view)

val context = getInstrumentation().targetContext
Expand All @@ -107,11 +118,14 @@ interface ScreenshotTest {
.setExactWidthPx(width)
.layout()
}
takeViewSnapshot(name, view)
takeViewSnapshot(name, view, maxPixels)
}

@RequiresApi(Build.VERSION_CODES.O)
fun compareScreenshot(rule: ComposeTestRule, name: String? = null) {
fun compareScreenshot(
rule: ComposeTestRule,
name: String? = null,
) {
rule.waitForIdle()
compareScreenshot(rule.onRoot(), name)
}
Expand Down Expand Up @@ -179,28 +193,30 @@ interface ScreenshotTest {

private fun notInAppMainThread() = Looper.myLooper() != Looper.getMainLooper()

private fun takeViewSnapshot(name: String?, view: View) {
private fun takeViewSnapshot(name: String?, view: View, maxPixels: Long) {
val testName = name ?: TestNameDetector.getTestName()
val snapshotName = "${TestNameDetector.getTestClass()}_$testName"
try {
Screenshot
.snap(view)
.setIncludeAccessibilityInfo(false)
.setName(snapshotName)
.setMaxPixels(maxPixels)
.record()
} catch (t: Throwable) {
Log.e("Shot", "Exception captured while taking screenshot for snapshot with name $snapshotName", t)
}
}

private fun takeActivitySnapshot(activity: Activity, name: String?) {
private fun takeActivitySnapshot(activity: Activity, name: String?, maxPixels: Long) {
val testName = name ?: TestNameDetector.getTestName()
val snapshotName = "${TestNameDetector.getTestClass()}_$testName"
try {
Screenshot
.snapActivity(activity)
.setIncludeAccessibilityInfo(false)
.setName(snapshotName)
.setMaxPixels(maxPixels)
.record()
} catch (t: Throwable) {
Log.e("Shot", "Exception captured while taking screenshot for snapshot with name $snapshotName", t)
Expand Down