base on Render your Android screens without a physical device or emulator Paparazzi ======== An Android library to render your application screens without a physical device or emulator. ```kotlin class LaunchViewTest { @get:Rule val paparazzi = Paparazzi( deviceConfig = PIXEL_5, theme = "android:Theme.Material.Light.NoActionBar" // ...see docs for more options ) @Test fun launchView() { val view = paparazzi.inflate<LaunchView>(R.layout.launch) // or... // val view = LaunchView(paparazzi.context) view.setModel(LaunchModel(title = "paparazzi")) paparazzi.snapshot(view) } @Test fun launchComposable() { paparazzi.snapshot { MyComposable() } } } ``` See the [project website][paparazzi] for documentation and APIs. Tasks ------- ```bash ./gradlew :sample:testDebug ``` Runs tests and generates an HTML report at `sample/build/reports/paparazzi/` showing all test runs and snapshots. ```bash ./gradlew :sample:recordPaparazziDebug ``` Saves snapshots as golden values to a predefined source-controlled location (defaults to `src/test/snapshots`). ```bash ./gradlew :sample:verifyPaparazziDebug ``` Runs tests and verifies against previously-recorded golden values. Failures generate diffs at `sample/build/paparazzi/failures`. For more examples, check out the [sample][sample] project. Git LFS -------- It is recommended you use [Git LFS][lfs] to store your snapshots. Here's a quick setup: ```bash brew install git-lfs git config core.hooksPath # optional, confirm where your git hooks will be installed git lfs install --local git lfs track "**/snapshots/**/*.png" git add .gitattributes # Optional to improve git checkout performance git config lfs.setlockablereadonly false ``` On CI, you might set up something like: `$HOOKS_DIR/pre-receive` ```bash # compares files that match .gitattributes filter to those actually tracked by git-lfs diff <(git ls-files ':(attr:filter=lfs)' | sort) <(git lfs ls-files -n | sort) >/dev/null ret=$? if [[ $ret -ne 0 ]]; then echo >&2 "This remote has detected files committed without using Git LFS. Run 'brew install git-lfs && git lfs install' to install it and re-commit your files."; exit 1; fi ``` `your_build_script.sh` ```bash if [[ is running snapshot tests ]]; then # fail fast if files not checked in using git lfs "$HOOKS_DIR"/pre-receive git lfs install --local git lfs pull fi ``` Jetifier -------- If using Jetifier to migrate off Support libraries, add the following to your `gradle.properties` to exclude bundled Android dependencies. ```properties android.jetifier.ignorelist=android-base-common,common ``` Lottie -------- When taking screenshots of Lottie animations, you need to force Lottie to not run on a background thread, otherwise Paparazzi can throw exceptions [#494](https://github.com/cashapp/paparazzi/issues/494), [#630](https://github.com/cashapp/paparazzi/issues/630). ```kotlin @Before fun setup() { LottieTask.EXECUTOR = Executor(Runnable::run) } ``` LocalInspectionMode -------- Some Composables -- such as `GoogleMap()` -- check for `LocalInspectionMode` to short-circuit to a `@Preview`-safe Composable. However, Paparazzi does not set `LocalInspectionMode` globally to ensure that the snapshot represents the true production output, similar to how it overrides `View.isInEditMode` for legacy views. As a workaround, we recommend wrapping such a Composable in a custom Composable with a `CompositionLocalProvider` and setting `LocalInspectionMode` there. ```kotlin @Test fun inspectionModeView() { paparazzi.snapshot( CompositionLocalProvider(LocalInspectionMode provides true) { YourComposable() } ) } ``` Releases -------- Our [change log][changelog] has release history. Using plugin application: ```groovy buildscript { repositories { mavenCentral() google() } dependencies { classpath 'app.cash.paparazzi:paparazzi-gradle-plugin:2.0.0-alpha01' } } apply plugin: 'app.cash.paparazzi' ``` Using the plugins DSL: ```groovy plugins { id 'app.cash.paparazzi' version '2.0.0-alpha01' } ``` Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap]. ```groovy repositories { // ... maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } } ``` License ------- ``` Copyright 2019 Square, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ``` [paparazzi]: https://cashapp.github.io/paparazzi/ [sample]: https://github.com/cashapp/paparazzi/tree/master/sample [lfs]: https://git-lfs.github.com/ [changelog]: https://cashapp.github.io/paparazzi/changelog/ [snap]: https://oss.sonatype.org/content/repositories/snapshots/app/cash/paparazzi/ ", Assign "at most 3 tags" to the expected json: {"id":"13596","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"