paparazzi
kotlinpoet
Our great sponsors
paparazzi | kotlinpoet | |
---|---|---|
12 | 2 | |
2,159 | 3,799 | |
2.4% | 1.0% | |
9.5 | 9.4 | |
5 days ago | 5 days ago | |
Kotlin | Kotlin | |
Apache License 2.0 | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
paparazzi
- paparazzi 1.3.0 released
-
Building Reddit’s design system for Android with Jetpack Compose
Component API tests are written for all components in the library. These are Paparazzi snapshot tests that are parameterized to cover all the combinations of values for the properties in the API of a given component. Additionally, they include as parameters: color theme, layout direction, and optionally other properties that may be relevant to the component under test (e.g., font scale).
-
Compose & Paparazzi: Automatically find @Preview composables at runtime
Looks really nice. Sadly, I wasn't able to test it because it doesn't support application module
- Paparazzi 1.2 is out
-
How do you guys test the UI of your app?
Curious what you mean by hilt refuses to work and what you have tried? Usually though if I'm testing the UI of the app, I might use paparazzi for screenshot tests because it doesn't have to run the test on device. Then for a UI integration test for navigation and user flows, use espresso and replace the network data sources with mocks which in your case would be with hilt android test rule and test install in annotation .
-
Improving snapshot tests with Paparazzi
/** * Finds all files in the components module which have Compose previews * and generates Paparazzi screenshot tests for them. * * The generated tests can then be used to record screenshots with * ./gradlew components:recordPaparazziInternalDebug * * To verify that the current implementation matches the recorded screenshots * ./gradlew components:verifyPaparazziInternalDebug */ fun main() { val path = System.getProperty("user.dir") ?: error("Can't get user dir") // Paparazzi does not currently work in the app module: https://github.com/cashapp/paparazzi/issues/107 // For now this is hardcoded to only check files in the components module. // If we pull our compose files out of the app module to a separate module this code has to be updated. File(path).walk().filter { it.path.contains("/components/src/main/java") && it.extension == "kt" }.forEach { if (it.readText().contains("@Preview")) { processFileWithPreviews(it) } } } /** * Reads the given file, finds the names of all the functions annotated with @Preview * and uses them to generate a Paparazzi test file with one test for each preview. */ private fun processFileWithPreviews(file: File) { val lines = file.readLines() val previewNames = mutableListOf() var saveNextFunctionName = false var packageName = "" lines.forEachIndexed { i, line -> if (i == 0) { packageName = line.split(" ").last() } if (line.contains("@Preview")) { saveNextFunctionName = true } if (saveNextFunctionName && line.startsWith("fun ")) { previewNames += line.split(" ")[1].removeSuffix("()") saveNextFunctionName = false } } val pathString = file.path.replace("src/main", "src/test").split("java").first() + "java" val testFilePath = pathString.toPath() generatePaparazziTest(packageName, file.nameWithoutExtension + "PaparazziTest", testFilePath, previewNames) } fun generatePaparazziTest(packageName: String, fileName: String, path: Path, previewNames: List) { val classBuilder = TypeSpec.classBuilder(fileName) .superclass(PaparazziTest::class) .addAnnotation( AnnotationSpec.builder(Suppress::class) // KotlinPoet does not let us remove redundant public modifiers or Unit return types for the functions, // but we don't mind for generated code as long as the tests work .addMember("\"RedundantVisibilityModifier\", \"RedundantUnitReturnType\"") .build() ) previewNames.forEach { classBuilder.addFunction( FunSpec.builder(it.removeSuffix("Preview").usLocaleDecapitalize()) .addStatement("paparazziRule.snapshot { $it() }") .addAnnotation(Test::class) .build() ) } val testFile = FileSpec.builder(packageName, fileName) .addType(classBuilder.build()) .addFileComment("AUTO-GENERATED FILE by generate_paparazzi_tests.kt\nDO NOT MODIFY") .build() val nioPath = path.toNioPath() testFile.writeTo(nioPath) }
- Do you do test-based capture & publish for QA? (Espresso, JUnit,..)
- Paparazzi 1.0 is out
-
Mockito and non-debuggable testBuildTypes
The good thing is, Square got us covered once more, in regards to the flaky emulators, by providing a screenshot-testing library that does not require an emulator: https://cashapp.github.io/paparazzi/
- Most Efficient Way of Testing Layouts on Various Aspect Ratios/Pixel Densities/Viewport/Resolutions
kotlinpoet
-
Improving snapshot tests with Paparazzi
To do this we created a Kotlin program with a main function and used another library, also from Square, KotlinPoet (https://github.com/square/kotlinpoet) to generate the code.
-
GitHub Actions: a New Hope in YAML Wasteland
This generation is done with the KotlinPoet library. That's also what powers the script-generator from the previous paragraph.
What are some alternatives?
ardupilot - ArduPlane, ArduCopter, ArduRover, ArduSub source
Shot - Screenshot testing library for Android
PX4-Autopilot - PX4 Autopilot Software
github-workflows-kt - Authoring GitHub Actions workflows in Kotlin. You won't go back to YAML!
setup-wsl - A GitHub action to install and setup a Linux distribution for the Windows Subsystem for Linux (WSL)
Mockito - Most popular Mocking framework for unit tests written in Java
awesome-kotlin - A curated list of awesome Kotlin related stuff Inspired by awesome-java.
dropshots - Easy on-device screenshot testing for Android.
github-actions-typing - Bring type-safety to your GitHub actions' API!
ESP32 - DroneBridge for ESP32. A transparent short range wifi based telemetry (serial to WiFi) link. Support for MAVLink, MSP, LTM (iNAV) or any other protocol
setup-wsl - A GitHub action to install and setup a Linux distribution for the Windows Subsystem for Linux (WSL)