paparazzi

Paparazzi

Eine Android -Bibliothek, um Ihre Anwendungsbildschirme ohne physisches Gerät oder Emulator zu rendern.

 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 ()
    }
  }
}

Auf der Projektwebsite finden Sie Unterlagen und APIs.

Aufgaben

./gradlew sample:testDebug

FIRT -Tests und generiert einen HTML -Bericht unter sample/build/reports/paparazzi/ Zeigt alle Testläufe und Schnappschüsse an.

./gradlew sample:recordPaparazziDebug

Speichert Schnappschüsse als goldene Werte in einem vordefinierten Quellen-kontrollierten Speicherort (Standardeinstellungen zu src/test/snapshots ).

./gradlew sample:verifyPaparazziDebug

Führen Sie Tests aus und überprüft sie gegen zuvor aufgezeichnete goldene Werte. Fehler erzeugen Diffs bei sample/build/paparazzi/failures .

Weitere Beispiele finden Sie im Beispielprojekt.

Git LFS

Es wird empfohlen, dass Sie GIT -LFS verwenden, um Ihre Schnappschüsse zu speichern. Hier ist ein kurzes Setup:

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

Auf CI könnten Sie so etwas wie folgt einrichten:

$HOOKS_DIR/pre-receive

 # 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

 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

Wenn Sie Jetifier zum Migrieren von Support -Bibliotheken verwenden, fügen Sie Folgendes zu Ihrem gradle.properties hinzu, um gebündelte Android -Abhängigkeiten auszuschließen.

 android.jetifier.ignorelist =android-base-common,common

Lottie

Wenn Sie Screenshots von Lottie -Animationen machen, müssen Sie Lottie zwingen, nicht auf einem Hintergrund -Thread zu laufen, ansonsten können Paparazzi Ausnahmen #494, #630 werfen.

@Before
fun setup () {
    LottieTask . EXECUTOR = Executor ( Runnable ::run)
}

LocalinSpectionMode

Einige Komponisten -z. B. GoogleMap() -prüfen Sie, ob LocalInspectionMode zu einem Kurzschluss zu einem @Preview -Safe -Komponierbarkeitsabschnitt.

Paparazzi setzt jedoch weltweit keine LocalInspectionMode , um sicherzustellen, dass der Snapshot die tatsächliche Produktionsausgabe darstellt, ähnlich wie er View.isInEditMode überschreibt.

Als Problemumgehung empfehlen wir, einen so komponierbaren in einem benutzerdefinierten komponierbaren mit einem CompositionLocalProvider einzuwickeln und dort LocalInspectionMode einzustellen.

 @Test
  fun inspectionModeView () {
    paparazzi.snapshot(
      CompositionLocalProvider ( LocalInspectionMode provides true ) {
        YourComposable ()
      }
    )
  }

Veröffentlichungen

Unser Änderungsprotokoll hat Veröffentlichungsverlauf.

Verwenden der Plugin -Anwendung:

buildscript {
  repositories {
    mavenCentral()
    google()
  }
  dependencies {
    classpath ' app.cash.paparazzi:paparazzi-gradle-plugin:1.3.5 '
  }
}

apply plugin : ' app.cash.paparazzi '

Verwenden der Plugins DSL:

plugins {
  id ' app.cash.paparazzi ' version ' 1.3.5 '
}

Snapshots der Entwicklungsversion sind im snapshots -Repository von Sonatype verfügbar.

repositories {
  // ...
  maven {
    url ' https://oss.sonatype.org/content/repositories/snapshots/ '
  }
}

Lizenz

 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.