אנו מבצעים בדיקות אינסטרומנטליות ב-Firebase Test Lab. חלק 1: פרויקט iOS

שמי דמיטרי, אני עובד כטסטר בחברה מדע MEL. די לאחרונה סיימתי לעסוק בפיצ'ר עדכני יחסית מ Firebase Test Lab - כלומר, עם בדיקה אינסטרומנטלית של יישומי iOS באמצעות מסגרת הבדיקה המקורית XCUITest.

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

לכן, אם יש לך מבחני ממשק משתמש בפרויקט iOS, אתה כבר יכול לנסות להפעיל אותם במכשירים אמיתיים היום, בחביבות על ידי Good Corporation. למעוניינים, ברוכים הבאים לחתול.

בסיפור, החלטתי לבנות על כמה נתונים ראשוניים - מאגר פרטי ב-GitHub ומערכת הבנייה CircleCI. שם האפליקציה הוא AmazingApp, bundleID הוא com.company.amazingapp. אני מציג את הנתונים האלה באופן מיידי כדי להפחית את הבלבול הבא.

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

1. המבחנים עצמם

צור ענף פרויקט חדש עבור מבחני ממשק משתמש:

$ git checkout develop
$ git pull
$ git checkout -b “feature/add-ui-tests”

בואו נפתח את הפרויקט ב-XCode וניצור יעד חדש עם מבחני ממשק משתמש [XCode -> קובץ -> חדש -> יעד -> חבילת בדיקות iOS], ונעניק לו את השם המובן מאליו AmazingAppUITests.

עבור לקטע Build Phases של היעד שנוצר ובדוק את נוכחותם של Target Dependencies - AmazingApp, ב-Compile Sources - AmazingAppUITests.swift.

תרגול טוב הוא להפריד אפשרויות בנייה שונות ל- Schemes נפרדות. אנו יוצרים סכימה עבור מבחני ממשק המשתמש שלנו [XCode -> מוצר -> סכמה -> סכמה חדשה] ונותנים לה את אותו השם: AmazingAppUITests.

המבנה של הסכימה שנוצרה חייב לכלול את היעד של האפליקציה הראשית - בדיקות AmazingApp ו-Target UI - AmazingAppUITests - ראה צילום מסך

לאחר מכן, אנו יוצרים תצורת בנייה חדשה עבור מבחני ממשק משתמש. ב-XCode, לחץ על קובץ הפרויקט ועבור לקטע מידע. לחץ על "+" וצור תצורה חדשה, למשל XCtest. נצטרך את זה בעתיד כדי להימנע מריקוד עם טמבורין בכל הנוגע לחתימה בקוד.

יש לפחות שלושה יעדים בפרויקט שלך: האפליקציה הראשית, בדיקות יחידה (בכל זאת, הן קיימות, נכון?) ומבחני ה-Target UI שיצרנו.

עבור אל Target AmazingApp, הכרטיסייה Build Settings, סעיף זהות חתימת קוד. עבור תצורת XCtest, בחר iOS Developer. בקטע סגנון חתימת קוד, בחר ידני. עדיין לא יצרנו פרופיל אספקה, אבל בהחלט נחזור אליו מעט מאוחר יותר.

עבור Target AmazingAppUITests אנחנו עושים את אותו הדבר, אבל בעמודה Product Bundle Identifier אנחנו מכניסים com.company.amazingappuitests.

2. הקמת פרויקט בתוכנית המפתחים של אפל

עבור אל הדף של Apple Developer Program, עבור אל הקטע אישורים, מזהים ופרופילים ולאחר מכן אל העמודה מזהי אפליקציה של הפריט מזהים. צור מזהה אפליקציה חדש בשם AmazingAppUITests ו-bundleID com.company.amazingappuitests.

כעת יש לנו הזדמנות לחתום על הבדיקות שלנו עם תעודה נפרדת, אבל... הליך הרכבת build לבדיקה כולל הרכבת האפליקציה עצמה והרכבת ה-test runner. בהתאם, אנו עומדים בפני בעיה של חתימה על שני מזהי חבילה עם פרופיל הקצאה אחד. למרבה המזל, יש פתרון פשוט ואלגנטי - Wildcard App ID. אנו חוזרים על ההליך ליצירת מזהה אפליקציה חדש, אך במקום מזהה אפליקציה מפורש, בחר מזהה אפליקציה Wildcard כמו בצילום המסך.

בשלב זה סיימנו לעבוד עם developer.apple.com, אך לא נצמצם את חלון הדפדפן. בוא נלך ל אתר תיעוד Fastlane וקרא על כלי השירות Match מכסה לכריכה.

קורא קשוב שם לב שכדי להשתמש בכלי השירות הזה נזדקק למאגר פרטי ולחשבון עם גישה גם לתוכנית המפתחים של אפל וגם ל-Github. אנחנו יוצרים (אם פתאום אין דבר כזה) חשבון של הטופס [מוגן בדוא"ל], העלה סיסמה חזקה, רשום אותה ב-developer.apple.com, ומינו אותה כמנהל פרויקט. לאחר מכן, אנו נותנים לחשבון גישה למאגר github של החברה שלך ויוצרים מאגר פרטי חדש עם שם כמו AmazingAppMatch.

3. הגדרת Fastlane ושירות ההתאמה

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

$ fastlane init

תתבקש לבחור תצורות שימוש זמינות. בחר באפשרות הרביעית - הגדרת פרויקט ידנית.

לפרויקט יש ספרייה חדשה של fastlane, המכילה שני קבצים - Appfile ו-Fastfile. בקצרה, אנו מאחסנים נתוני שירות ב-Appfile, וכותבים עבודות ב-Fastfile, הנקראים מסלולים בטרמינולוגיה של Fastlane. אני ממליץ לקרוא את התיעוד הרשמי: זמן, два.

פתח את ה-Appfile בעורך הטקסט המועדף עליך והבא אותו לטופס הבא:

app_identifier "com.company.amazingapp"       # Bundle ID
apple_dev_portal_id "[email protected]"  # Созданный инфраструктурный аккаунт, имеющий право на редактирование iOS проекта в Apple Developer Program.
team_id "LSDY3IFJAY9" # Your Developer Portal Team ID

אנו חוזרים לטרמינל ולפי המדריך הרשמי מתחילים להגדיר התאמה.

$ fastlane match init
$ fastlane match development

לאחר מכן, הזינו את הנתונים המבוקשים - מאגר, חשבון, סיסמה וכו'.

חשוב: כאשר אתה מפעיל לראשונה את כלי ההתאמה, תתבקש להזין סיסמה כדי לפענח את המאגר. חשוב מאוד לשמור את הסיסמה הזו; נצטרך אותה בעת הגדרת שרת ה-CI!

קובץ חדש הופיע בתיקיית fastlane - Matchfile. פתח אותו בעורך הטקסט המועדף עליך והצג אותו כך:

git_url("https://github.com/YourCompany/AmazingAppMatch") #Созданный приватный репозиторий для хранения сертификатов и профайлов.
type("development") # The default type, can be: appstore, adhoc, enterprise or development
app_identifier("com.company.amazingapp")
username("[email protected]") # Your Infrastructure account Apple Developer Portal username

אנו ממלאים אותו בדיוק כך אם נרצה להשתמש ב-match בעתיד כדי לחתום על builds לתצוגה ב-Crashlytics ו/או ב-AppStore, כלומר לחתום על מזהה החבילה של האפליקציה שלך.

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

lane :testing_build_for_firebase do

    match(
      type: "development",
      readonly: true,
      app_identifier: "com.company.*",
      git_branch: "uitests"  # создаем отдельный бранч для development сертификата для подписи тестовой сборки.
    )

end

שמור והיכנס למסוף

fastlane testing_build_for_firebase

ואנחנו רואים איך fastlane יצרה תעודה חדשה והכניסה אותה למאגר. גדול!

פתח את XCode. כעת יש לנו את פרופיל ההקצאה הדרוש של הטופס Match Development com.company.*, אותו יש לציין בסעיף פרופיל ההקצאה עבור היעדים AmazingApp ו-AmazingAppUITests.

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

בואו נעשה העתק-הדבק מהדוגמה המקורית כך שה-Lane testing_build_for_firebase שלנו בסופו של דבר ייראה כך:

 lane :testing_build_for_firebase do

    match(
      type: "development",
      readonly: true,
      app_identifier: "com.company.*",
      git_branch: "uitests"
    )

    scan(
      scheme: 'AmazingAppUITests',      # UI Test scheme
      clean: true,                        # Recommended: This would ensure the build would not include unnecessary files
      skip_detect_devices: true,          # Required
      build_for_testing: true,            # Required
      sdk: 'iphoneos',                    # Required
      should_zip_build_products: true,     # Must be true to set the correct format for Firebase Test Lab
    )

    firebase_test_lab_ios_xctest(
      gcp_project: 'AmazingAppUITests', # Your Google Cloud project name (к этой строчке вернемся позже)
      devices: [                          # Device(s) to run tests on
        {
          ios_model_id: 'iphonex',        # Device model ID, see gcloud command above
          ios_version_id: '12.0',         # iOS version ID, see gcloud command above
          locale: 'en_US',                # Optional: default to en_US if not set
          orientation: 'portrait'         # Optional: default to portrait if not set
        }
      ]
    )

  end

למידע מלא על הגדרת fastlane ב-CircleCI, אני ממליץ לקרוא את התיעוד הרשמי זְמַן, два.

אל תשכח להוסיף משימה חדשה ל-config.yml שלנו:

build-for-firebase-test-lab:
   macos:
     xcode: "10.1.0"   
   working_directory: ~/project
   shell: /bin/bash --login -o pipefail
   steps:
     - checkout
     - attach_workspace:
         at: ~/project
     - run: sudo bundle install     # обновляем зависимости
     - run:
         name: install gcloud-sdk   # на mac машину необходимо установить gcloud
         command: |
           ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null ; brew install caskroom/cask/brew-cask 2> /dev/null
           brew cask install google-cloud-sdk
     - run:
         name: build app for testing
         command: fastlane testing_build_for_firebase  # запускаем lane сборки и отправки в firebase

4. מה לגבי ספסל המבחן שלנו? הגדרת Firebase.

בואו נרד למה נכתב המאמר.

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

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

חשוב: בשלב הקודם ב-Fastfile ב-lane firebase_test_lab_ios_xctest הפרמטר gcp_project צריך להתאים לשם הפרויקט.

הגדרות ברירת המחדל מתאימות לנו די טוב.

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

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

נחזור ללשונית עם פרויקט Firebase ונעביר אותו לתוכנית התעריפים של Blaze - עכשיו יש לנו מה לשלם אם יחרוג מהמגבלה.

בממשק gcloud, בחר בפרויקט Firebase שלנו, בחר בפריט התפריט הראשי "Directory" והוסף את Cloud Testing API ואת Cloud Tools Result API.

לאחר מכן עבור לפריט התפריט "IAM וניהול" -> חשבונות שירות -> צור חשבון שירות. אנו מעניקים זכויות לעריכת הפרויקט.

צור מפתח API בפורמט JSON

נזדקק ל-JSON שהורד מעט מאוחר יותר, אך לעת עתה נשקול את ההגדרה של מעבדת הבדיקות כשלמה.

5. הגדרת CircleCI

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

והגדר את המשתנים הבאים:

• מפתח: GOOGLE_APPLICATION_CREDENTIALS
  ערך: התוכן של קובץ ה-json של מפתח החשבון של שירות gcloud
• מפתח: MATCH_PASSWORD
  value: סיסמה לפענוח מאגר github עם אישורים
• מפתח: FASTLANE_PASSWORD
  ערך: סיסמת חשבון תשתית של פורטל המפתחים של Apple

אנו שומרים את השינויים, יוצרים יח"צ ושולחים אותו להובלת הצוות שלנו לבדיקה.

תוצאות של

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

החלק השני יוקדש להגדרה שלב אחר שלב של Firebase Test Lab עבור פרויקט אנדרואיד.

מקור: www.habr.com