|
| 1 | +/* |
| 2 | + * Copyright (c) 2026 Composable Horizons |
| 3 | + * |
| 4 | + * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 5 | + * of this software and associated documentation files (the "Software"), to deal |
| 6 | + * in the Software without restriction, including without limitation the rights |
| 7 | + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 8 | + * copies of the Software, and to permit persons to whom the Software is |
| 9 | + * furnished to do so, subject to the following conditions: |
| 10 | + * |
| 11 | + * The above copyright notice and this permission notice shall be included in all |
| 12 | + * copies or substantial portions of the Software. |
| 13 | + * |
| 14 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 15 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 16 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 17 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 18 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 19 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 20 | + * SOFTWARE. |
| 21 | + */ |
| 22 | +package com.composeunstyled.demo |
| 23 | + |
| 24 | +import androidx.compose.foundation.layout.Box |
| 25 | +import androidx.compose.foundation.layout.requiredSize |
| 26 | +import androidx.compose.ui.Modifier |
| 27 | +import androidx.compose.ui.graphics.toAwtImage |
| 28 | +import androidx.compose.ui.platform.testTag |
| 29 | +import androidx.compose.ui.test.ComposeUiTest |
| 30 | +import androidx.compose.ui.test.ExperimentalTestApi |
| 31 | +import androidx.compose.ui.test.captureToImage |
| 32 | +import androidx.compose.ui.test.onNodeWithTag |
| 33 | +import androidx.compose.ui.test.runComposeUiTest |
| 34 | +import androidx.compose.ui.unit.dp |
| 35 | +import java.awt.image.BufferedImage |
| 36 | +import java.io.File |
| 37 | +import javax.imageio.ImageIO |
| 38 | +import kotlin.test.Test |
| 39 | +import kotlin.test.assertEquals |
| 40 | +import kotlin.test.assertTrue |
| 41 | +import kotlin.test.fail |
| 42 | + |
| 43 | +@OptIn(ExperimentalTestApi::class) |
| 44 | +class BottomSheetDemoScreenshotTest { |
| 45 | + @Test |
| 46 | + fun bottomSheetDemoMatchesScreenshot() = runComposeUiTest { |
| 47 | + val actual = captureBottomSheetDemoScreenshot() |
| 48 | + |
| 49 | + val reportDir = File("build/reports/screenshot-tests") |
| 50 | + reportDir.mkdirs() |
| 51 | + ImageIO.write(actual, "png", File(reportDir, "$ScreenshotName.actual.png")) |
| 52 | + |
| 53 | + val expected = javaClass.classLoader |
| 54 | + .getResourceAsStream("screenshots/$ScreenshotName.png") |
| 55 | + ?.use(ImageIO::read) |
| 56 | + ?: fail( |
| 57 | + "Missing expected screenshot. Run `./gradlew :demo:updateDesktopScreenshots`.", |
| 58 | + ) |
| 59 | + |
| 60 | + assertEquals(expected.width, actual.width, "Screenshot width changed.") |
| 61 | + assertEquals(expected.height, actual.height, "Screenshot height changed.") |
| 62 | + |
| 63 | + val diff = diff(expected, actual) |
| 64 | + if (diff.changedPixels > 0) { |
| 65 | + ImageIO.write(diff.image, "png", File(reportDir, "$ScreenshotName.diff.png")) |
| 66 | + } |
| 67 | + assertTrue( |
| 68 | + actual = diff.changedPixels == 0, |
| 69 | + message = "Screenshot changed by ${diff.changedPixels} pixels. " + |
| 70 | + "See ${reportDir.path}/$ScreenshotName.actual.png and " + |
| 71 | + "${reportDir.path}/$ScreenshotName.diff.png.", |
| 72 | + ) |
| 73 | + } |
| 74 | + |
| 75 | + private fun diff(expected: BufferedImage, actual: BufferedImage): ScreenshotDiff { |
| 76 | + val diff = BufferedImage(expected.width, expected.height, BufferedImage.TYPE_INT_ARGB) |
| 77 | + var changedPixels = 0 |
| 78 | + |
| 79 | + for (y in 0 until expected.height) { |
| 80 | + for (x in 0 until expected.width) { |
| 81 | + val expectedRgb = expected.getRGB(x, y) |
| 82 | + val actualRgb = actual.getRGB(x, y) |
| 83 | + if (expectedRgb == actualRgb) { |
| 84 | + diff.setRGB(x, y, expectedRgb) |
| 85 | + } else { |
| 86 | + changedPixels++ |
| 87 | + diff.setRGB(x, y, DiffColor) |
| 88 | + } |
| 89 | + } |
| 90 | + } |
| 91 | + |
| 92 | + return ScreenshotDiff(diff, changedPixels) |
| 93 | + } |
| 94 | + |
| 95 | + private data class ScreenshotDiff( |
| 96 | + val image: BufferedImage, |
| 97 | + val changedPixels: Int, |
| 98 | + ) |
| 99 | +} |
| 100 | + |
| 101 | +@OptIn(ExperimentalTestApi::class) |
| 102 | +private fun ComposeUiTest.captureBottomSheetDemoScreenshot(): BufferedImage { |
| 103 | + setContent { |
| 104 | + Box( |
| 105 | + modifier = Modifier |
| 106 | + .requiredSize(width = ScreenshotWidth.dp, height = ScreenshotHeight.dp) |
| 107 | + .testTag(ScreenshotTargetTag), |
| 108 | + ) { |
| 109 | + Demo(startDestination = "bottom-sheet") |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + waitForIdle() |
| 114 | + |
| 115 | + return onNodeWithTag(ScreenshotTargetTag).captureToImage().toAwtImage() |
| 116 | +} |
| 117 | + |
| 118 | +@OptIn(ExperimentalTestApi::class) |
| 119 | +fun main() = runComposeUiTest { |
| 120 | + val actual = captureBottomSheetDemoScreenshot() |
| 121 | + val expectedFile = File("src/jvmTest/resources/screenshots/$ScreenshotName.png") |
| 122 | + expectedFile.parentFile.mkdirs() |
| 123 | + ImageIO.write(actual, "png", expectedFile) |
| 124 | +} |
| 125 | + |
| 126 | +private const val ScreenshotName = "bottom-sheet-demo" |
| 127 | +private const val ScreenshotTargetTag = "screenshot-target" |
| 128 | +private const val ScreenshotWidth = 1024 |
| 129 | +private const val ScreenshotHeight = 600 |
| 130 | +private const val DiffColor = 0xFFFF00FF.toInt() |
0 commit comments