בדיקת צילום מסך של תצוגה מקדימה

בדיקות באמצעות צילומי מסך הן דרך יעילה לוודא איך ממשק המשתמש נראה למשתמשים. הכלי לבדיקת צילומי מסך של תצוגה מקדימה של יצירה משלב את הפשטות והתכונות של תצוגות מקדימות שניתנות להרכבה עם היתרונות של בדיקות צילומי מסך בצד המארח. הבדיקה של צילומי מסך של תצוגה מקדימה של יצירה נועדה להיות פשוטה לשימוש כמו תצוגות מקדימות של יצירה.

בדיקת צילום מסך היא בדיקה אוטומטית שמצלמת מסך של חלק מממשק המשתמש ואז משווה אותו לתמונה לדוגמה שאושרה בעבר. אם התמונות לא זהות, הבדיקה נכשלת ונוצר דוח HTML שיעזור לכם להשוות ולמצוא את ההבדלים.

בעזרת הכלי לבדיקת צילומי מסך של טיוטות, אתם יכולים:

  • אפשר להשתמש ב-@PreviewTest כדי ליצור בדיקות של צילומי מסך לתצוגות מקדימות קיימות או חדשות של רכיבים.
  • ליצור תמונות לדוגמה מהתצוגות המקדימות האלה שאפשר להרכיב.
  • אפשר ליצור דוח HTML שמזהה שינויים בתצוגות המקדימות האלה אחרי שמבצעים שינויים בקוד.
  • כדי להרחיב את הבדיקות, אפשר להשתמש בפרמטרים של @Preview, כמו uiMode או fontScale, ובתצוגות מקדימות מרובות.
  • אפשר להפוך את הבדיקות למודולריות באמצעות screenshotTest קבוצת המקור החדשה.
איור 1. דוח HTML לדוגמה.

שילוב עם IDE

אפשר להשתמש בכלי Compose Preview Screenshot Testing על ידי הפעלת משימות Gradle הבסיסיות (updateScreenshotTest ו-validateScreenshotTest) באופן ידני, אבל בגרסה Canary 4 של Android Studio Otter 3 Feature Drop יש שילוב מלא של IDE. כך תוכלו ליצור תמונות עזר, להריץ בדיקות ולנתח כשלים באימות, הכול בסביבת הפיתוח המשולבת. אלה כמה מהתכונות העיקריות:

  • סמלים בשוליים בעורך. עכשיו אפשר להריץ בדיקות או לעדכן תמונות לדוגמה ישירות מקוד המקור. סמלי הפעלה ירוקים מופיעים בשוליים לצד קומפוזיציות ומחלקות עם ההערה @PreviewTest.
    • מריצים בדיקות של צילומי מסך. להריץ בדיקות ספציפיות לפונקציה אחת או לכל המחלקה.
    • הוספה או עדכון של תמונות לדוגמה מפעילים את תהליך העדכון באופן ספציפי להיקף שנבחר.

  • ניהול אינטראקטיבי של קובצי עזר. עדכון תמונות לדוגמה בטוח יותר ומפורט יותר.
    • תיבת דו-שיח חדשה ליצירת תמונה לדוגמה. במקום להריץ משימת Gradle בכמות גדולה, תיבת דו-שיח חדשה מאפשרת לכם לראות בתצוגה מקדימה ולבחור בדיוק אילו תצוגות מקדימות ליצור או לעדכן.
    • תצוגה מקדימה של הגרסאות. בתיבת הדו-שיח מוצגות כל הווריאציות של התצוגה המקדימה (למשל, עיצוב בהיר או עיצוב כהה, או מכשירים שונים) בנפרד, כך שאפשר לבחור או לבטל את הבחירה של פריטים ספציפיים לפני יצירת התמונות.

  • תוצאות הבדיקה משולבות ומוצגות בכלי להשוואת קבצים. הצגת התוצאות בלי לצאת מה-IDE.
    • חלונית הפעלה מאוחדת. תוצאות הבדיקה של צילום המסך מופיעות בחלון של הכלי הרגיל Run. הבדיקות מקובצות לפי כיתה ופונקציה, והסטטוס שלהן (עבר או נכשל) מסומן בבירור.
    • כלי להשוואה ויזואלית. אם הבדיקה נכשלת, בכרטיסייה צילום מסך אפשר להשוות בין התמונות Reference,‏ Actual ו-Diff זו לצד זו.
    • מאפיינים מפורטים. בכרטיסייה מאפיינים מופיעים מטא-נתונים על בדיקות שנכשלו, כולל אחוז ההתאמה, מידות התמונה והגדרת התצוגה המקדימה הספציפית שבה נעשה שימוש (לדוגמה, uiMode או fontScale).

  • הגדרת היקף הבדיקה בצורה גמישה. עכשיו אפשר להריץ בדיקות של צילומי מסך עם היקפים שונים ישירות מתצוגת הפרויקט. לוחצים לחיצה ימנית על מודול, ספרייה, קובץ או מחלקה כדי להריץ בדיקות של צילומי מסך רק עבור הבחירה הזו.

דרישות

כדי להשתמש בבדיקות צילומי מסך של תצוגה מקדימה של קומפוזיציה באמצעות השילוב המלא של IDE, הפרויקט צריך לעמוד בדרישות הבאות:

  • ‫Android Studio Panda 1 Canary 4 ואילך.
  • פלאגין של Android Gradle‏ (AGP) בגרסה 9.0 ואילך.
  • גרסת הפלאגין Compose Preview Screenshot Testing 0.0.1-alpha14 ואילך.
  • גרסה 2.2.10 ואילך של Kotlin.
  • ‫JDK מגרסה 17 ואילך.
  • האפשרות Compose מופעלת בפרויקט. מומלץ להפעיל את Compose באמצעות התוסף Compose Compiler Gradle.

אם רוצים להשתמש רק במשימות הבסיסיות של Gradle בלי שילוב IDE, הדרישות הן:

  • ‫Android Gradle Plugin ‏ (AGP) מגרסה 8.5.0 ואילך.
  • גרסת הפלאגין Compose Preview Screenshot Testing 0.0.1-alpha14 ומעלה.
  • ‫Kotlin מגרסה 1.9.20 ואילך. מומלץ להשתמש ב-Kotlin 2.0 ומעלה כדי שתוכלו להשתמש בתוסף Compose Compiler Gradle.
  • ‫JDK מגרסה 17 ואילך.
  • האפשרות Compose מופעלת בפרויקט. מומלץ להפעיל את Compose באמצעות התוסף Compose Compiler Gradle.

הגדרה

הכלי המשולב ומשימות Gradle הבסיסיות מסתמכים על התוסף Compose Preview Screenshot Testing. כדי להגדיר את הפלאגין:

  1. מפעילים את המאפיין הניסיוני בקובץ gradle.properties של הפרויקט.

    android.experimental.enableScreenshotTest=true

  2. בבלוק android {} בקובץ build.gradle.kts ברמת המודול, מפעילים את דגל הניסוי כדי להשתמש בערכת המקור screenshotTest.

    android {
    experimentalProperties["android.experimental.enableScreenshotTest"] = true
}

  3. מוסיפים את הפלאגין com.android.compose.screenshot בגרסה 0.0.1-alpha14 לפרויקט.

    1. מוסיפים את הפלאגין לקובץ קטלוגי הגרסאות:

      [versions]
agp = "9.0.0-rc03"
kotlin = "2.1.20"
screenshot = "0.0.1-alpha14"

[plugins]
screenshot = { id = "com.android.compose.screenshot", version.ref = "screenshot"}

    2. בקובץ build.gradle.kts ברמת המודול, מוסיפים את הפלאגין בבלוק plugins {}:

      plugins {
    alias(libs.plugins.screenshot)
}

  4. מוסיפים את יחסי התלות screenshot-validation-api ו-ui-tooling.

    1. מוסיפים אותם לקטלוגים של הגרסאות:

      [libraries]
screenshot-validation-api = { group = "com.android.tools.screenshot", name = "screenshot-validation-api", version.ref = "screenshot"}
androidx-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling"}

    2. מוסיפים אותם לקובץ build.gradle.kts ברמת המודול:

      dependencies {
  screenshotTestImplementation(libs.screenshot.validation.api)
  screenshotTestImplementation(libs.androidx.ui.tooling)
}

הגדרת תצוגות מקדימות של רכיבים לשימוש בבדיקות צילומי מסך

כדי לציין את התצוגות המקדימות שניתן להרכיב שבהן רוצים להשתמש לבדיקות צילומי מסך, צריך לסמן את התצוגות המקדימות באמצעות ההערה @PreviewTest. התצוגות המקדימות צריכות להיות במיקום הבא בערכת המקור החדשה screenshotTest, לדוגמה:

app/src/screenshotTest/kotlin/com/example/yourapp/ ExamplePreviewScreenshotTest.kt

אתם יכולים להוסיף עוד רכיבים שניתנים להרכבה או תצוגות מקדימות, כולל תצוגות מקדימות מרובות, בקובץ הזה או בקבצים אחרים שנוצרו באותו מקור.

package com.example.yourapp

import androidx.compose.runtime.Composable
import androidx.compose.ui.tooling.preview.Preview
import com.android.tools.screenshot.PreviewTest
import com.example.yourapp.ui.theme.MyApplicationTheme

@PreviewTest
@Preview(showBackground = true)
@Composable
fun GreetingPreview() {
    MyApplicationTheme {
        Greeting("Android!")
    }
}

יצירת תמונות לדוגמה

אחרי שמגדירים כיתת בדיקה, צריך ליצור תמונות לדוגמה לכל תצוגה מקדימה. התמונות לדוגמה האלה משמשות לזיהוי שינויים בשלב מאוחר יותר, אחרי שמבצעים שינויים בקוד. כדי ליצור תמונות לדוגמה לבדיקות צילומי מסך של תצוגה מקדימה של קומפוזיציה, פועלים לפי ההוראות בקטע הזה לגבי שילוב IDE או משימות Gradle.

ב-IDE

לוחצים על סמל השוליים לצד פונקציה @PreviewTest ובוחרים באפשרות הוספה/עדכון של תמונות להשוואה. בוחרים את התצוגות המקדימות בתיבת הדו-שיח ולוחצים על הוספה.

עם משימות Gradle

מריצים את משימת Gradle הבאה:

  • ‫Linux ו-macOS: ‏ ./gradlew updateDebugScreenshotTest (./gradlew :{module}:update{Variant}ScreenshotTest)
  • ‫Windows: ‏ gradlew updateDebugScreenshotTest ‏(gradlew :{module}:update{Variant}ScreenshotTest)

אחרי שהמשימה מסתיימת, התמונות לדוגמה מופיעות בתיקייה app/src/screenshotTestDebug/reference ({module}/src/screenshotTest{Variant}/reference).

יצירת דוח בדיקה

אחרי שיוצרים את תמונות ההשוואה, אפשר ליצור דוח בדיקה לפי ההוראות שבקטע הזה לשילוב עם IDE או למשימות Gradle.

ב-IDE

לוחצים על סמל השוליים לצד פונקציה @PreviewTest ובוחרים באפשרות הפעלה של ScreenshotTests.

אם בדיקה נכשלת, לוחצים על שם הבדיקה בחלונית Run (הפעלה). בוחרים בכרטיסייה צילום מסך כדי לבדוק את ההבדלים בין התמונות באמצעות אמצעי הבקרה המשולבים של הזום וההזזה.

עם משימות Gradle

מריצים את משימת האימות כדי ליצור צילום מסך חדש ולהשוות אותו לתמונה לדוגמה:

  • ‫Linux ו-macOS: ‏ ./gradlew validateDebugScreenshotTest (./gradlew :{module}:validate{Variant}ScreenshotTest)
  • ‫Windows: ‏ gradlew validateDebugScreenshotTest ‏(gradlew :{module}:validate{Variant}ScreenshotTest)

משימת האימות יוצרת דוח HTML בכתובת {module}/build/reports/screenshotTest/preview/{variant}/index.html.

בעיות מוכרות

  • ‫Kotlin Multiplatform‏ (KMP): גם סביבת הפיתוח המשולבת וגם הפלאגין הבסיסי מיועדים באופן בלעדי לפרויקטים של Android. הם לא תומכים ביעדים שאינם Android בפרויקטים של KMP.

הרשימה המלאה של הבעיות המוכרות הנוכחיות מופיעה ברכיב המעקב אחר בעיות בכלי. אפשר לדווח על משוב ובעיות אחרים באמצעות מעקב אחר בעיות.

עדכוני גרסה

הרשימה המלאה של עדכוני הגרסה מופיעה בנתוני הגרסה.