feat(snapshot): Write per-image sidecar metadata during test execution #1127
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| package io.sentry.android.gradle.snapshot | ||
|
|
||
| import java.io.File | ||
| import kotlin.test.assertFalse | ||
| import kotlin.test.assertTrue | ||
| import org.gradle.testfixtures.ProjectBuilder | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.junit.rules.TemporaryFolder | ||
|
|
||
| class GenerateSnapshotTestsTaskTest { | ||
|
|
||
| @get:Rule val tmpDir = TemporaryFolder() | ||
|
|
||
| @Test | ||
| fun `generates test file in correct package directory`() { | ||
| val task = createTask(packageTrees = listOf("com.example")) | ||
|
|
||
| task.generate() | ||
|
|
||
| val outputDir = task.outputDir.get().asFile | ||
| val expectedFile = File(outputDir, "io/sentry/snapshot/ComposablePreviewSnapshotTest.kt") | ||
| assertTrue(expectedFile.exists()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `cleans output directory on re-run`() { | ||
| val task = createTask(packageTrees = listOf("com.example")) | ||
| val outputDir = task.outputDir.get().asFile | ||
|
|
||
| // Create a stale file in the output directory | ||
| val staleDir = File(outputDir, "io/sentry/snapshot") | ||
| staleDir.mkdirs() | ||
| val staleFile = File(staleDir, "OldFile.kt") | ||
| staleFile.writeText("old content") | ||
| assertTrue(staleFile.exists()) | ||
|
|
||
| task.generate() | ||
|
|
||
| assertFalse(staleFile.exists()) | ||
| val expectedFile = File(outputDir, "io/sentry/snapshot/ComposablePreviewSnapshotTest.kt") | ||
| assertTrue(expectedFile.exists()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated file contains correct package declaration`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example")) | ||
|
|
||
| assertTrue(content.contains("package io.sentry.snapshot")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated file scans configured package tree`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example.app")) | ||
|
|
||
| assertTrue(content.contains(".scanPackageTrees(\"com.example.app\")")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated file scans multiple package trees`() { | ||
| val content = | ||
| generateAndRead(packageTrees = listOf("com.example.feature1", "com.example.feature2")) | ||
|
|
||
| assertTrue( | ||
| content.contains(".scanPackageTrees(\"com.example.feature1\", \"com.example.feature2\")") | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated file includes private previews when enabled`() { | ||
| val content = | ||
| generateAndRead(packageTrees = listOf("com.example"), includePrivatePreviews = true) | ||
|
|
||
| assertTrue(content.contains(".includePrivatePreviews()")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated file excludes private previews by default`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example")) | ||
|
|
||
| assertFalse(content.contains(".includePrivatePreviews()")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated file contains parameterized test runner`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example")) | ||
|
|
||
| assertTrue(content.contains("@RunWith(Parameterized::class)")) | ||
| assertTrue(content.contains("class ComposablePreviewSnapshotTest")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated sidecar metadata uses short display name`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example")) | ||
|
|
||
| assertTrue( | ||
| content.contains( | ||
| "\"display_name\" to screenshotId.removePrefix(preview.declaringClass + \".\")" | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated sidecar metadata uses full screenshotId for image file name`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example")) | ||
|
|
||
| assertTrue(content.contains("\"image_file_name\" to screenshotId")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated file writes sidecar json to images directory`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example")) | ||
|
|
||
| assertTrue(content.contains("val imagesDir = File(snapshotDir, \"images\")")) | ||
| assertTrue(content.contains("File(imagesDir, \"\${sidecarName}.json\").writeText(json)")) | ||
| } | ||
|
|
||
| @Test | ||
| fun `generated sidecar filename is lowercased to match Paparazzi image filenames`() { | ||
| val content = generateAndRead(packageTrees = listOf("com.example")) | ||
|
|
||
| assertTrue( | ||
| content.contains("screenshotId.lowercase(Locale.US).replace(\"\\\\s\".toRegex(), \"_\")") | ||
| ) | ||
| } | ||
|
|
||
| private fun generateAndRead( | ||
| packageTrees: List<String>, | ||
| includePrivatePreviews: Boolean = false, | ||
| ): String { | ||
| val task = createTask(packageTrees, includePrivatePreviews) | ||
| task.generate() | ||
| val file = | ||
| File(task.outputDir.get().asFile, "io/sentry/snapshot/ComposablePreviewSnapshotTest.kt") | ||
| return file.readText() | ||
| } | ||
|
|
||
| private fun createTask( | ||
| packageTrees: List<String>, | ||
| includePrivatePreviews: Boolean = false, | ||
| ): GenerateSnapshotTestsTask { | ||
| val project = ProjectBuilder.builder().build() | ||
| return project.tasks | ||
| .register("testGenerateSnapshotTests", GenerateSnapshotTestsTask::class.java) { task -> | ||
| task.includePrivatePreviews.set(includePrivatePreviews) | ||
| task.packageTrees.set(packageTrees) | ||
| task.outputDir.set(tmpDir.newFolder("output")) | ||
| } | ||
| .get() | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.