-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Customize test reporting for all runs (#1675)
Co-authored-by: Geoff Powell <[email protected]>
- Loading branch information
1 parent
d6a8f1e
commit 084dd1b
Showing
38 changed files
with
941 additions
and
1,880 deletions.
There are no files selected for viewing
This file contains 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 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 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
208 changes: 208 additions & 0 deletions
208
...azzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/reporting/ClassPageRenderer.kt
This file contains 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,208 @@ | ||
| package app.cash.paparazzi.gradle.reporting | ||
|
|
||
| import org.gradle.api.internal.tasks.testing.junit.result.TestResultsProvider | ||
| import org.gradle.api.tasks.testing.TestOutputEvent | ||
| import org.gradle.internal.html.SimpleHtmlWriter | ||
| import org.gradle.internal.xml.SimpleMarkupWriter | ||
| import org.gradle.reporting.CodePanelRenderer | ||
| import java.io.File | ||
| import java.io.IOException | ||
| import kotlin.io.encoding.Base64 | ||
| import kotlin.io.encoding.ExperimentalEncodingApi | ||
|
|
||
| internal class ClassPageRenderer( | ||
| private val resultsProvider: TestResultsProvider, | ||
| isVerifyRun: Boolean, | ||
| failureDir: File | ||
| ) : PageRenderer<ClassTestResults>() { | ||
| private val codePanelRenderer = CodePanelRenderer() | ||
| private val imagePanelRenderer = ImagePanelRenderer() | ||
|
|
||
| @OptIn(ExperimentalEncodingApi::class) | ||
| private val diffImages: List<DiffImage> = | ||
| if (isVerifyRun && failureDir.exists()) { | ||
| failureDir.listFiles() | ||
| ?.filter { it.name.startsWith("delta-") } | ||
| ?.map { diff -> | ||
| // TODO: read from failure diff metadata file instead of brittle parsing | ||
| val nameSegments = diff.name.split("_", limit = 3) | ||
| val testClassPackage = nameSegments[0].replace("delta-", "") | ||
| val testClass = "$testClassPackage.${nameSegments[1]}" | ||
| val testMethodWithLabel = nameSegments[2].removeSuffix(".png") | ||
|
|
||
| return@map DiffImage( | ||
| testClass = testClass, | ||
| testMethod = testMethodWithLabel, | ||
| path = diff.path, | ||
| base64EncodedImage = Base64.encode(diff.readBytes()) | ||
| ) | ||
| } | ||
| ?.toList() ?: emptyList() | ||
| } else { | ||
| emptyList() | ||
| } | ||
|
|
||
| @Throws(IOException::class) | ||
| override fun renderBreadcrumbs(htmlWriter: SimpleHtmlWriter) { | ||
| htmlWriter | ||
| .startElement("div") | ||
| .attribute("class", "breadcrumbs") | ||
| .startElement("a") | ||
| .attribute("href", results.getUrlTo(results.parent!!.parent!!)) | ||
| .characters("all").endElement() | ||
| .characters(" > ") | ||
| .startElement("a") | ||
| .attribute("href", results.getUrlTo(results.packageResults)) | ||
| .characters(results.packageResults.name) | ||
| .endElement() | ||
| .characters(" > " + results.simpleName) | ||
| .endElement() | ||
| } | ||
|
|
||
| @Throws(IOException::class) | ||
| private fun renderTests(htmlWriter: SimpleHtmlWriter) { | ||
| val writer = htmlWriter.startElement("table") | ||
| renderTableHead(writer, determineTableHeaders()) | ||
|
|
||
| val methodNameColumnExists = methodNameColumnExists() | ||
|
|
||
| for (test in results.testResults) { | ||
| renderTableRow(writer, test, determineTableRow(test, methodNameColumnExists)) | ||
| } | ||
| htmlWriter.endElement() | ||
| } | ||
|
|
||
| private fun determineTableRow( | ||
| test: TestResult, | ||
| methodNameColumnExists: Boolean | ||
| ): List<String> = | ||
| if (methodNameColumnExists) { | ||
| listOf( | ||
| test.displayName, | ||
| test.name, | ||
| test.formattedDuration, | ||
| test.formattedResultType | ||
| ) | ||
| } else { | ||
| listOf( | ||
| test.displayName, | ||
| test.formattedDuration, | ||
| test.formattedResultType | ||
| ) | ||
| } | ||
|
|
||
| private fun determineTableHeaders(): List<String> = | ||
| if (methodNameColumnExists()) { | ||
| listOf("Test", "Method name", "Duration", "Result") | ||
| } else { | ||
| listOf("Test", "Duration", "Result") | ||
| } | ||
|
|
||
| @Throws(IOException::class) | ||
| private fun renderTableHead(writer: SimpleMarkupWriter, headers: List<String>) { | ||
| writer.startElement("thead").startElement("tr") | ||
| for (header in headers) { | ||
| writer.startElement("th").characters(header).endElement() | ||
| } | ||
| writer.endElement().endElement() | ||
| } | ||
|
|
||
| @Throws(IOException::class) | ||
| private fun renderTableRow( | ||
| writer: SimpleMarkupWriter, | ||
| test: TestResult, | ||
| rowCells: List<String> | ||
| ) { | ||
| writer.startElement("tr") | ||
| for (cell in rowCells) { | ||
| writer | ||
| .startElement("td") | ||
| .attribute("class", test.statusClass) | ||
| .characters(cell) | ||
| .endElement() | ||
| } | ||
| writer.endElement() | ||
| } | ||
|
|
||
| private fun methodNameColumnExists(): Boolean = | ||
| results.testResults.any { it.name != it.displayName } | ||
|
|
||
| @Throws(IOException::class) | ||
| override fun renderFailures(htmlWriter: SimpleHtmlWriter) { | ||
| for (test in results.failures) { | ||
| htmlWriter | ||
| .startElement("div") | ||
| .attribute("class", "test") | ||
| .startElement("a") | ||
| .attribute("name", test.id.toString()).characters("") | ||
| .endElement() // browsers dont understand <a name="..."/> | ||
| .startElement("h3") | ||
| .attribute("class", test.statusClass) | ||
| .characters(test.displayName) | ||
| .endElement() | ||
| for (failure in test.failures) { | ||
| val diffImage = diffImages.find { it.testClass == results.name && it.testMethod == test.name } | ||
| if (diffImage != null) { | ||
| imagePanelRenderer.render(diffImage, htmlWriter) | ||
| } | ||
|
|
||
| val message = | ||
| if (failure.message.isNullOrBlank() && !failure.stackTrace.contains(failure.message)) { | ||
| failure.message + System.lineSeparator() + System.lineSeparator() + failure.stackTrace | ||
| } else { | ||
| failure.stackTrace | ||
| } | ||
| codePanelRenderer.render(message, htmlWriter) | ||
| } | ||
| htmlWriter.endElement() | ||
| } | ||
| } | ||
|
|
||
| override fun registerTabs() { | ||
| addFailuresTab() | ||
| addTab( | ||
| "Tests", | ||
| object : ErroringAction<SimpleHtmlWriter>() { | ||
| @Throws(IOException::class) | ||
| public override fun doExecute(htmlWriter: SimpleHtmlWriter) { | ||
| renderTests(htmlWriter) | ||
| } | ||
| } | ||
| ) | ||
| val classId = model.id | ||
| if (resultsProvider.hasOutput(classId, TestOutputEvent.Destination.StdOut)) { | ||
| addTab( | ||
| "Standard output", | ||
| object : ErroringAction<SimpleHtmlWriter>() { | ||
| @Throws(IOException::class) | ||
| override fun doExecute(htmlWriter: SimpleHtmlWriter) { | ||
| htmlWriter | ||
| .startElement("span") | ||
| .attribute("class", "code") | ||
| .startElement("pre") | ||
| .characters("") | ||
| resultsProvider.writeAllOutput(classId, TestOutputEvent.Destination.StdOut, htmlWriter) | ||
| htmlWriter.endElement().endElement() | ||
| } | ||
| } | ||
| ) | ||
| } | ||
| if (resultsProvider.hasOutput(classId, TestOutputEvent.Destination.StdErr)) { | ||
| addTab( | ||
| "Standard error", | ||
| object : ErroringAction<SimpleHtmlWriter>() { | ||
| @Throws(Exception::class) | ||
| override fun doExecute(htmlWriter: SimpleHtmlWriter) { | ||
| htmlWriter | ||
| .startElement("span") | ||
| .attribute("class", "code") | ||
| .startElement("pre") | ||
| .characters("") | ||
| resultsProvider.writeAllOutput(classId, TestOutputEvent.Destination.StdErr, htmlWriter) | ||
| htmlWriter.endElement().endElement() | ||
| } | ||
| } | ||
| ) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.