-
-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathGenerateSnapshotTestsTaskTest.kt
More file actions
255 lines (204 loc) · 9.09 KB
/
GenerateSnapshotTestsTaskTest.kt
File metadata and controls
255 lines (204 loc) · 9.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
package io.sentry.android.gradle.snapshot
import io.sentry.android.gradle.parseMajorVersion
import java.io.File
import kotlin.test.assertEquals
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(), \"_\")")
)
}
@Test
fun `generated sidecar reads SentrySnapshot annotation via reflection`() {
val content = generateAndRead(packageTrees = listOf("com.example"))
assertTrue(content.contains("Class.forName(preview.declaringClass)"))
assertTrue(content.contains("\"io.sentry.snapshots.runtime.SentrySnapshot\""))
assertTrue(content.contains("getDeclaredMethod(\"diffThreshold\")"))
}
@Test
fun `generated sidecar emits diff_threshold only when non-default`() {
val content = generateAndRead(packageTrees = listOf("com.example"))
assertTrue(
content.contains(
"if (diffThreshold != null && diffThreshold != 0f) metadata[\"diff_threshold\"] = diffThreshold"
)
)
}
@Test
fun `generated sidecar places preview location fields in context block`() {
val content = generateAndRead(packageTrees = listOf("com.example"))
assertTrue(content.contains("val context = linkedMapOf<String, Any>("))
assertTrue(content.contains("\"image_file_name\" to screenshotId"))
assertTrue(content.contains("\"class_name\" to preview.declaringClass"))
assertTrue(content.contains("\"method_name\" to preview.methodName"))
assertTrue(content.contains("metadata[\"context\"] = context"))
}
@Test
fun `generated sidecar places appearance inputs in tags block`() {
val content = generateAndRead(packageTrees = listOf("com.example"))
assertTrue(content.contains("val tags = linkedMapOf<String, Any>()"))
assertTrue(content.contains("if (info.name.isNotBlank()) tags[\"preview_name\"] = info.name"))
assertTrue(content.contains("if (info.locale.isNotBlank()) tags[\"locale\"] = info.locale"))
assertTrue(content.contains("if (info.device.isNotBlank()) tags[\"device\"] = info.device"))
assertTrue(content.contains("if (info.fontScale != 1f) tags[\"font_scale\"] = info.fontScale"))
assertTrue(content.contains("if (info.apiLevel != -1) tags[\"api_level\"] = info.apiLevel"))
assertTrue(content.contains("if (info.widthDp > 0) tags[\"width_dp\"] = info.widthDp"))
assertTrue(content.contains("if (info.heightDp > 0) tags[\"height_dp\"] = info.heightDp"))
assertTrue(content.contains("if (info.showSystemUi) tags[\"show_system_ui\"] = true"))
assertTrue(content.contains("if (info.showBackground) tags[\"show_background\"] = true"))
assertTrue(content.contains("if (tags.isNotEmpty()) metadata[\"tags\"] = tags"))
}
@Test
fun `generated sidecar places ui_mode in tags block`() {
val content = generateAndRead(packageTrees = listOf("com.example"))
assertTrue(content.contains("when (info.uiMode and UI_MODE_NIGHT_MASK) {"))
assertTrue(content.contains("UI_MODE_NIGHT_YES -> tags[\"ui_mode\"] = \"dark\""))
assertTrue(content.contains("UI_MODE_NIGHT_NO -> tags[\"ui_mode\"] = \"light\""))
}
@Test
fun `generated sidecar does not emit legacy night_mode field`() {
val content = generateAndRead(packageTrees = listOf("com.example"))
assertFalse(content.contains("metadata[\"night_mode\"]"))
}
@Test
fun `parseMajorVersion extracts major from standard semver`() {
assertEquals(1, parseMajorVersion("1.3.5"))
assertEquals(2, parseMajorVersion("2.0.0-alpha01"))
}
@Test
fun `parseMajorVersion extracts major from dynamic versions`() {
assertEquals(1, parseMajorVersion("1.+"))
assertEquals(2, parseMajorVersion("2.+"))
}
@Test
fun `parseMajorVersion returns default for unparseable versions`() {
assertEquals(2, parseMajorVersion("latest.release"))
assertEquals(2, parseMajorVersion(null))
assertEquals(2, parseMajorVersion("+"))
}
@Test
fun `generated file uses HtmlReportWriter without maxPercentDifference for paparazzi 1`() {
val content = generateAndRead(packageTrees = listOf("com.example"), paparazziMajorVersion = 1)
assertTrue(content.contains("HtmlReportWriter()"))
assertFalse(content.contains("HtmlReportWriter(maxPercentDifference"))
}
@Test
fun `generated file uses HtmlReportWriter with maxPercentDifference for paparazzi 2`() {
val content = generateAndRead(packageTrees = listOf("com.example"), paparazziMajorVersion = 2)
assertTrue(content.contains("HtmlReportWriter(maxPercentDifference = tolerance)"))
assertFalse(content.contains("HtmlReportWriter()"))
}
private fun generateAndRead(
packageTrees: List<String>,
includePrivatePreviews: Boolean = false,
paparazziMajorVersion: Int = 2,
): String {
val task = createTask(packageTrees, includePrivatePreviews, paparazziMajorVersion)
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,
paparazziMajorVersion: Int = 2,
): GenerateSnapshotTestsTask {
val project = ProjectBuilder.builder().build()
return project.tasks
.register("testGenerateSnapshotTests", GenerateSnapshotTestsTask::class.java) { task ->
task.includePrivatePreviews.set(includePrivatePreviews)
task.packageTrees.set(packageTrees)
task.paparazziMajorVersion.set(paparazziMajorVersion)
task.outputDir.set(tmpDir.newFolder("output"))
}
.get()
}
}