הפצת אפליקציות ל-Android לבודקים באמצעות fastlane

במאמר הזה נסביר איך להפיץ גרסאות build של APK לבודקים באמצעות fastlane, פלטפורמה בקוד פתוח שמאפשרת ליצור ולהפיץ באופן אוטומטי אפליקציות ל-iOS ולאפליקציות Android. המסמך הזה מבוסס על ההוראות שמופיעות בFastfile. אחרי שמגדירים את fastlane ואת Fastfile, אפשר לשלב את App Distribution בהגדרות של fastlane.

לפני שמתחילים

1. אם עדיין לא הוספתם את Firebase לפרויקט Android, אתם צריכים להוסיף אותו.

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

2. פותחים את הדף App Distribution במסוף Firebase. כשמוצגת בקשה, בוחרים את פרויקט Firebase, בוחרים את האפליקציה באמצעות הממשק למעבר בין חשבונות ולוחצים על תחילת העבודה.

שלב 1. הגדרת fastlane

1. מתקינים ומגדירים את fastlane.

2. כדי להוסיף את App Distribution להגדרות של fastlane, מריצים את הפקודה הבאה מה-root של פרויקט Android:

   fastlane add_plugin firebase_app_distribution

   אם הפקודה מציגה אפשרות, בוחרים באפשרות Option 3: RubyGems.org.

שלב 2. אימות באמצעות Firebase

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

שלב 3. הגדרת Fastfile והפצת האפליקציה

1. במסלול ./fastlane/Fastfile, מוסיפים בלוק firebase_app_distribution. משתמשים בפרמטרים הבאים כדי להגדיר את ההפצה:

   פרמטרים של firebase_app_distribution
   app	חובה: מזהה האפליקציה ב-Firebase. מזהה האפליקציה מופיע במסוף Firebase, בדף ההגדרות הכלליות. app: "1:1234567890:android:0a1b2c3d4e5f67890"
   firebase_cli_token	טוקן רענון שמוצג כשמאמתים את סביבת ה-CI באמצעות ה-CLI של Firebase (מידע נוסף זמין במאמר שימוש ב-CLI עם מערכות CI).
   service_credentials_file	הנתיב לקובץ ה-JSON של חשבון השירות ב-Google. למעלה מוסבר איך לבצע אימות באמצעות פרטי כניסה לחשבון שירות.
   android_artifact_type	מציין את סוג הקובץ של Android‏ (APK או AAB).
   android_artifact_path	מחליף את apk_path (הוצא משימוש). הנתיב המוחלט לקובץ ה-APK או ה-AAB שרוצים להעלות. אם לא מציינים את המיקום, fastlane קובע את מיקום הקובץ לפי ה-lane שבו הקובץ נוצר.
   release_notes release_notes_file	נתוני הגרסה של ה-build הזה. אפשר לציין את הערות הגרסה ישירות: release_notes: "Text of release notes" אפשר גם לציין את הנתיב לקובץ טקסט פשוט: release_notes_file: "/path/to/release-notes.txt"
   testers testers_file	כתובות האימייל של הבודקים שרוצים להזמין. אתם יכולים לציין את הבודקים כרשימה של כתובות אימייל שמופרדות בפסיקים: testers: "ali@example.com, bri@example.com, cal@example.com" אפשר גם לציין את הנתיב לקובץ טקסט פשוט שמכיל רשימה של כתובות אימייל שמופרדות בפסיקים: testers_file: "/path/to/testers.txt"
   groups groups_file	קבוצות הבודקים שרוצים להזמין (מידע נוסף זמין במאמר ניהול בודקים). הקבוצות מצוינות באמצעות כתובות אימייל חלופיות של קבוצות, שאפשר לחפש במסוף Firebase. אפשר לציין את הקבוצות כרשימה מופרדת בפסיקים: groups: "qa-team, trusted-testers" אפשר גם לציין את הנתיב לקובץ טקסט פשוט שמכיל רשימה מופרדת בפסיקים של שמות קבוצות: groups_file: "/path/to/groups.txt"
   test_devices test_devices_file	מכשירי הבדיקה שבהם רוצים להריץ בדיקות של סוכן App Testing. אפשר לציין את מכשירי הבדיקה ברשימה של מפרטי מכשירים שמופרדים בנקודה ופסיק: test_devices: "model=shiba,version=34,locale=en,orientation=portrait" לחלופין, אפשר לציין את הנתיב לקובץ טקסט פשוט שמכיל רשימה של מכשירי בדיקה שמופרדים באמצעות נקודה-פסיק: test_devices_file: "/path/to/test-devices.txt"
   test_username	שם המשתמש להתחברות אוטומטית במהלך בדיקות של סוכן App Testing.
   test_password test_password_file	הסיסמה להתחברות אוטומטית שמשמשת במהלך בדיקות של סוכן App Testing. אפשר גם לציין את הנתיב לקובץ טקסט פשוט שמכיל סיסמה: test_password_file: "/path/to/test-password.txt"
   test_username_resource	שם המשאב של שדה שם המשתמש להתחברות אוטומטית, שישמש במהלך בדיקות של סוכן App Testing.
   test_password_resource	שם המשאב של שדה הסיסמה להתחברות אוטומטית, שישמש במהלך בדיקות של סוכן App Testing.
   test_non_blocking	אם מגדירים את האפשרות הזו כשמריצים בדיקות של סוכן App Testing, הפקודה תתחיל את הבדיקות ואז תחזור מיד במקום לחכות שהן יסתיימו. כדי לראות את תוצאות הבדיקה, צריך להיכנס למסוף Firebase. אם הדגל הזה לא מוגדר, הפקודה תחסום עד שהבדיקות יסתיימו, ותצא עם קוד שגיאה אם אחת מהבדיקות תיכשל.
   debug	דגל בוליאני. אפשר להגדיר את הערך true כדי להדפיס פלט מפורט של ניפוי באגים.

platform :android do
    desc "My awesome app"
    lane :distribute do
        build_android_app(...)
        # build_android_app is a built-in fastlane action.
        release = firebase_app_distribution(
            app: "1:123456789:android:abcd1234",
            testers: "tester1@company.com, tester2@company.com",
            release_notes: "Lots of amazing new features to test out!"
        )
    end
end

כדי להפוך את ה-build לזמין לבודקים, מריצים את ה-lane:

fastlane <lane>

הערך שמוחזר מהפעולה הוא גיבוב (hash) שמייצג את הגרסה שהועלתה. אפשר לקבל את הגיבוב הזה גם באמצעות lane_context[SharedValues::FIREBASE_APP_DISTRO_RELEASE]. מידע נוסף על השדות הזמינים בגיבוב הזה מופיע במאמרי העזרה של ה-API בארכיטקטורת REST.

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

• קישור למסוף Firebase שבו מוצגת גרסה אחת. אתם יכולים לשתף את הקישור הזה עם מפתחים אחרים בארגון.
• קישור לגרסה בממשק של הבודקים (אפליקציית Android מובנית) שמאפשר לבודקים לראות את הערות הגרסה ולהתקין את האפליקציה במכשיר שלהם. כדי להשתמש בקישור, הבודק צריך גישה לגרסה.
• קישור חתום שמוריד ומתקין ישירות את הקובץ הבינארי של האפליקציה (קובץ APK או AAB). התוקף של הקישור יפוג אחרי שעה.

אחרי שמפיצים את ה-build, הוא זמין במרכז הבקרה של App Distribution במסוף Firebase למשך 150 ימים. כאשר נותרו 30 ימים עד לתפוגת התוקף של ה-build, הודעת תפוגה מופיעה במסוף וברשימת ה-builds של הבודק במכשיר הבדיקה שלו.

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

(אופציונלי) כדי להגדיל באופן אוטומטי את מספר ה-build בכל פעם שיוצרים גרסה חדשה ב"הפצת אפליקציות", אפשר להשתמש בפעולה firebase_app_distribution_get_latest_release ובפלאגין increment_version_code fastlane, לדוגמה. הקוד הבא הוא דוגמה להגדלה אוטומטית של מספר ה-build:

lane :increment_version do
  latest_release = firebase_app_distribution_get_latest_release(
    app: "<your Firebase app ID>"
  )
  increment_version_code({ version_code: latest_release[:buildVersion].to_i + 1 })
end

מידע נוסף על הפעולה firebase_app_distribution_get_latest_release זמין במאמר קבלת מידע על הגרסה האחרונה של האפליקציה.

שלב 4 (אופציונלי). ניהול הבודקים של ההפצה

אתם יכולים להוסיף בודקים לפרויקט או לקבוצה ולהסיר אותם מהם באמצעות קובץ Fastfile או על ידי הפעלה ישירה של פעולות fastlane. הפעלה של פעולות באופן ישיר מבטלת את הערכים שהוגדרו ב-Fastfile.

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

אם יש לכם מספר גדול של בודקים, כדאי להשתמש בקבוצות.

שימוש ב-Fastfile

# Use lanes to add or remove testers from a project.
lane(:add_testers) do
  firebase_app_distribution_add_testers(
    emails: "foo@google.com,bar@google.com"
    # or file: "/path/to/testers.txt"
    group_alias: "qa-team" # (Optional) add testers to this group
  )
end

lane(:remove_testers) do
  firebase_app_distribution_remove_testers(
    emails: "foo@google.com,bar@google.com"
    # or file: "/path/to/testers.txt"
    group_alias: "qa-team" # (Optional) remove testers from this group only
  )
end

# Add or remove testers with the terminal
$ fastlane add_testers
$ fastlane remove_testers

הפעלת פעולות fastlane

fastlane run firebase_app_distribution_create_group display_name:"QA Team" alias:"qa-team"
fastlane run firebase_app_distribution_add_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"
fastlane run firebase_app_distribution_remove_testers group_alias:"qa-team" emails:"foo@google.com,bar@google.com"
fastlane run firebase_app_distribution_delete_group alias:"qa-team"

אפשר גם לציין בודקים באמצעות --file="/path/to/testers.txt במקום --emails.

המשימות firebase_app_distribution_add_testers ו-firebase_app_distribution_remove_testers מקבלות גם את הארגומנטים הבאים:

• ‫project_number: מספר הפרויקט ב-Firebase.
• ‫group_alias (אופציונלי): אם מציינים את הפרמטר הזה, הבודקים מתווספים לקבוצה שצוינה (או מוסרים ממנה).
• ‫service_credentials_file: הנתיב לקובץ פרטי הכניסה של שירות Google.
• firebase_cli_token: אסימון אימות ל-CLI של Firebase.

הארגומנטים service_credentials_file ו-firebase_cli_token זהים לאלה שמשמשים לפעולת ההעלאה.

שלב 5 (אופציונלי). איך לקבל מידע על הגרסה האחרונה של האפליקציה

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

הערך המוחזר של הפעולה הוא גיבוב (hash) שמייצג את הגרסה האחרונה. אפשר לקבל את הגיבוב הזה גם באמצעות lane_context[SharedValues::FIREBASE_APP_DISTRO_LATEST_RELEASE]. מידע נוסף על השדות הזמינים בגיבוב הזה מופיע במאמרי העזרה של API בארכיטקטורת REST.

פרמטרים

app: "1:1234567890:android:0a1b2c3d4e5f67890"

השלבים הבאים

• מטמיעים משוב בתוך האפליקציה כדי לאסוף משוב מהבודקים על האפליקציה (כולל צילומי מסך).

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

• שיטות מומלצות להפצת אפליקציות ל-Android לבודקי QA באמצעות CI/CD