gcloud सीएलआई की मदद से जांच करना शुरू करें

इस गाइड में, gcloud सीएलआई का इस्तेमाल करके, इंस्ट्रूमेंटेशन, रोबो या गेम लूप टेस्ट चलाने का तरीका बताया गया है.

gcloud में अपने Android ऐप्लिकेशन के साथ इस्तेमाल किए जा सकने वाले Test Lab निर्देशों की पूरी सूची के लिए, gcloud firebase test android के लिए रेफ़रंस दस्तावेज़ पर जाएं.

शुरू करने से पहले

अगर आपने पहले से ही ऐसा नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें.

पहला चरण. gcloud सीएलआई सेट अप करें

1. Google Cloud SDK डाउनलोड करें

इसमें gcloud CLI टूल भी शामिल है.

2. पक्का करें कि आपका इंस्टॉलेशन अप-टू-डेट हो:

   gcloud components update
   

3. अपने Google खाते का इस्तेमाल करके gcloud सीएलआई में साइन इन करें:

   gcloud auth login
   

4. gcloud में अपना Firebase प्रोजेक्ट सेट करें. यहां PROJECT_ID, आपके Firebase प्रोजेक्ट का आईडी है:

   gcloud config set project PROJECT_ID
   

दूसरा चरण. टेस्ट के लिए उपलब्ध डिवाइसों की जानकारी देखना

टेस्ट के लिए उपलब्ध डिवाइसों और भाषाओं को देखने के लिए, यहां दिए गए gcloud निर्देशों का इस्तेमाल करें.

इसके अलावा, निर्देशों को तुरंत चलाने के लिए, Notepad ऐप्लिकेशन का सैंपल भी डाउनलोड किया जा सकता है. app-debug-unaligned.apk और इंस्ट्रूमेंटेशन टेस्ट फ़ाइल app-debug-test-unaligned.apk का इस्तेमाल करें. ये फ़ाइलें NotePad/app/build/outputs/apk/ में मौजूद होती हैं.

• models list: आपके लिए उपलब्ध Android डिवाइसों की मौजूदा सूची पाएं, ताकि आप उसकी फिर से जांच कर सकें.

  gcloud firebase test android models list
  

  कमांड के आउटपुट में:

  • कॉलम MODEL_ID में वह आइडेंटिफ़ायर होता है जिसका इस्तेमाल, बाद में डिवाइस मॉडल पर टेस्ट चलाने के लिए किया जा सकता है.
  • कॉलम OS_VERSION_ID में, डिवाइस पर काम करने वाले ऑपरेटिंग सिस्टम के वर्शन शामिल होते हैं.

  आउटपुट का उदाहरण

  

• models describe: किसी खास Android MODEL_ID के बारे में ज़्यादा जानकारी पाएं.

  gcloud firebase test android models describe MODEL_ID
  

  आउटपुट में, डिवाइस मॉडल का ब्रैंड, मैन्युफ़ैक्चरर, ऑपरेटिंग सिस्टम के वर्शन, काम करने वाले एपीआई लेवल, काम करने वाले ऐप्लिकेशन बाइनरी इंटरफ़ेस (एबीआई), रिलीज़ की तारीखें, और यह जानकारी शामिल होती है कि डिवाइस फ़िज़िकल है या वर्चुअल.

• versions list: टेस्ट करने के लिए, फ़िलहाल उपलब्ध ओएस वर्शन की सूची पाएं.

  gcloud firebase test android versions list
  

  कमांड के आउटपुट (OS_VERSION_ID और VERSION) के पहले दो कॉलम में से किसी एक आइडेंटिफ़ायर का इस्तेमाल करके, बाद में Android OS के किसी वर्शन के लिए टेस्ट चलाए जा सकते हैं. अगर आपने टेस्ट करने के लिए Android OS के वर्शन की जानकारी नहीं दी है, तो TAGS कॉलम में दिए गए डिफ़ॉल्ट वर्शन का इस्तेमाल किया जाता है.

  आउटपुट का उदाहरण

  

• locales list: टेस्ट करने के लिए उपलब्ध सभी भाषाओं की मौजूदा सूची पाएं.

  gcloud firebase test android versions list
  

  निर्देश के आउटपुट के पहले कॉलम, LOCALE में आइडेंटिफ़ायर होता है. इसका इस्तेमाल, बाद में किसी स्थानीय भाषा के लिए टेस्ट चलाने के लिए किया जा सकता है. अगर आपने जांच के लिए भाषाओं की जानकारी नहीं दी है, तो डिफ़ॉल्ट भाषा के तौर पर अंग्रेज़ी का इस्तेमाल किया जाता है.

चरण 3. टेस्ट चलाना

अब आपके पास अपने ऐप्लिकेशन की जांच करने के लिए, डिवाइस मॉडल, स्थानीय भाषाओं, और ओएस वर्शन की रेंज के बारे में जानकारी है. इसलिए, रोबो या इंस्ट्रूमेंटेशन टेस्ट चलाने के लिए, gcloud firebase test android run कमांड और --device फ़्लैग का इस्तेमाल करके डिवाइसों की जानकारी दी जा सकती है.

ध्यान दें: टेस्ट डिवाइसों की जानकारी देने के लिए, अब --device फ़्लैग का इस्तेमाल करना सबसे सही तरीका है. साथ ही, इसका इस्तेमाल --devices-ids, --os-version-ids, --locales या --orientations के साथ नहीं किया जा सकता. इन लेगसी फ़्लैग के बारे में जानने के लिए, gcloud firebase test android run पर, डिवाइस डाइमेंशन के उन फ़्लैग की सूची देखें जिन्हें इस्तेमाल नहीं किया जा सकता.

रोबो टेस्ट चलाना

भले ही, आपने कोई इंस्ट्रूमेंटेशन टेस्ट न किया हो, फिर भी अपने ऐप्लिकेशन में गड़बड़ियों का पता लगाया जा सकता है. अपने ऐप्लिकेशन के यूज़र इंटरफ़ेस की अपने-आप होने वाली समीक्षा करने के लिए, रोबो टेस्ट का इस्तेमाल करें. रोबो टेस्ट, ऐप्लिकेशन के यूज़र इंटरफ़ेस के ज़रिए अलग-अलग पाथ का स्टैटिक विश्लेषण करके, ऐप्लिकेशन की जांच करता है. इसके बाद, ऐप्लिकेशन को क्रॉल करके क्रैश और अन्य संभावित समस्याओं का पता लगाता है.

रोबो टेस्ट चलाने के लिए, यहां दिया गया कमांड चलाएं:

gcloud firebase test android run \
  --type robo \
  --app app-debug-unaligned.apk \
  --device model=Nexus6,version=21,locale=en,orientation=portrait  \
  --device model=Nexus7,version=19,locale=fr,orientation=landscape \
  --timeout 90s \
  --client-details matrixLabel="Example matrix label"

• अगर --type वैल्यू नहीं दी गई है, तो --type robo पैरामीटर अपने-आप लागू हो जाता है.
• Firebase कंसोल में अपने टेस्ट मैट्रिक की पहचान करने और उन्हें ढूंढने में मदद पाने के लिए, अपने टेस्ट मैट्रिक को लेबल करने के लिए, --client-details matrixLabel="Example matrix label" फ़्लैग का इस्तेमाल किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.
• gcloud help firebase test android run टाइप करके, जांच करने के लिए कमांड लाइन के विकल्पों का पूरा सेट देखा जा सकता है.

कमांड लाइन पर इन आर्ग्युमेंट को बताने के बजाय, आपके पास वैकल्पिक तौर पर, YAML फ़ॉर्मैट वाली आर्ग्युमेंट फ़ाइल में अपने आर्ग्युमेंट बताने का विकल्प होता है. इस सुविधा को इस्तेमाल करने का तरीका जानने के लिए, gcloud topic arg-files चलाएं.

रोबो टेस्ट के नतीजों की जांच करने का तरीका जानने के लिए, अपने टेस्ट के नतीजों का विश्लेषण करना लेख पढ़ें.

इंस्ट्रुमेंटेशन टेस्ट चलाना

अब gcloud कमांड लाइन टूल का इस्तेमाल करके, अपने चुने गए Android डिवाइस कॉन्फ़िगरेशन पर, Notepad ऐप्लिकेशन के Espresso टेस्ट चलाएं. app-debug-test-unaligned.apk में टेस्ट चलाने के लिए, instrumentation टेस्ट टाइप का इस्तेमाल इस तरह करें:

gcloud firebase test android run \
  --type instrumentation \
  --app app-debug-unaligned.apk \
  --test app-debug-test-unaligned.apk \
  --device model=Nexus6,version=21,locale=en,orientation=portrait  \
  --device model=Nexus7,version=19,locale=fr,orientation=landscape
  --client-details matrixLabel="Example matrix label"

• अगर टेस्ट APK के साथ --test की जानकारी दी गई है, तो --type इंस्ट्रुमेंटेशन पैरामीटर लागू नहीं होता.
• Firebase कंसोल में अपने टेस्ट मैट्रिक की पहचान करने और उन्हें ढूंढने में मदद पाने के लिए, अपने टेस्ट मैट्रिक को लेबल करने के लिए, --client-details matrixLabel="Example matrix label" फ़्लैग का इस्तेमाल किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.
• gcloud help firebase test android run टाइप करके, जांच करने के लिए कमांड-लाइन के विकल्पों का पूरा सेट देखा जा सकता है.

कमांड लाइन पर इन आर्ग्युमेंट के बारे में बताने के अलावा, YAML फ़ॉर्मैट वाली आर्ग्युमेंट फ़ाइल में भी आर्ग्युमेंट के बारे में जानकारी दी जा सकती है. इस सुविधा को इस्तेमाल करने का तरीका जानने के लिए, gcloud topic arg-files चलाएं.

gcloud सीएलआई, Android Test Orchestrator के साथ काम करता है. ऑर्चेस्ट्रेटर के लिए AndroidJUnitRunner v1.1 या इसके बाद के वर्शन की ज़रूरत होती है. इसे चालू करने के लिए,
--use-orchestrator फ़्लैग के साथ gcloud firebase test android run का इस्तेमाल करें. इसे बंद करने के लिए, --no-use-orchestrator फ़्लैग का इस्तेमाल करें.

चेतावनी: खराब जांच वाले टेस्ट पर कोटा खर्च करने या उनके बिल से बचने के लिए, Test Lab में Orchestrator को स्थानीय तौर पर आज़माने से पहले उसे चलाएं. APK अपलोड करने से पहले, अपनी मशीन पर जांच करके पुष्टि करें कि ऑर्केस्ट्रेटर आपके ऐप्लिकेशन में काम कर रहा है या नहीं. ध्यान रखें कि ऑर्केस्ट्रेटर के साथ टेस्ट करने में, बिना ऑर्केस्ट्रेटर के टेस्ट करने के मुकाबले थोड़ा ज़्यादा समय लगता है. इससे आपकी बिलिंग पर असर पड़ सकता है या आपके टेस्ट, टाइम आउट की सीमा से ज़्यादा समय तक चल सकते हैं.

ऊपर नहीं दिए गए दूसरे फ़्लैग इस्तेमाल करके भी यह कंट्रोल किया जा सकता है कि Test Lab आपके इंस्ट्रुमेंटेशन टेस्ट कैसे चलाएगा. उदाहरण के लिए, --test-targets फ़्लैग का इस्तेमाल करके, किसी एक क्लास या टेस्ट APK में इस्तेमाल की गई क्लास के तरीके की जांच की जा सकती है. --num-flaky-test-attempts फ़्लैग का इस्तेमाल करके यह भी पता लगाया जा सकता है कि आपका टेस्ट असल में सही तरीके से काम कर रहा था या नहीं. इससे यह भी पता चलता है कि अगर टेस्ट के एक या उससे ज़्यादा केस किसी वजह से पास नहीं होते हैं, तो टेस्ट को फिर से कितनी बार चलाया जाना चाहिए. ज़्यादा जानने के लिए, gcloud firebase test android run देखें.

इंस्ट्रुमेंटेशन टेस्ट के लिए कोड कवरेज रिपोर्ट

Test Lab, कोड कवरेज रिपोर्टिंग टूल के साथ काम करता है. जैसे, EMMA और JaCoCo. अगर आपने अपने ऐप्लिकेशन के लिए, इनमें से किसी टूल को इंटिग्रेट किया है, तो कुछ अतिरिक्त आर्ग्युमेंट के साथ gcloud firebase test android run को चलाकर, Test Lab टेस्ट के लिए कोड कवरेज रिपोर्ट देखी जा सकती है. अगर Android Test Orchestrator चालू नहीं है, तो इनका इस्तेमाल करें:

gcloud firebase test android run \
  --type instrumentation \
  --app your-app.apk \
  --test your-app-test.apk \
  --device model=TestDevice,version=AndroidVersion  \
  --environment-variables coverage=true,coverageFile="/sdcard/Download/coverage.ec" \
  --directories-to-pull /sdcard/Download

अगर Android TestOrchestrator का इस्तेमाल करते समय कोड कवरेज रिपोर्ट जनरेट की जा रही हैं, तो अपने एनवायरमेंट वैरिएबल में इस तरह बदलाव करें:

gcloud firebase test android run \
  --type instrumentation \
  --app your-app.apk \
  --test your-app-test.apk \
  --device model=TestDevice,version=AndroidVersion  \
  --environment-variables clearPackageData=true,coverage=true,coverageFilePath="/sdcard/Download/" \
  --directories-to-pull /sdcard/Download

जब Test Lab आपके टेस्ट चलाना बंद कर दे, तो Google Cloud Storage में अपनी कोड कवरेज रिपोर्ट देखें:

1. Firebase कंसोल लिंक खोलें, जिसे gcloud टूल ने आपके टर्मिनल में जांच के नतीजे वाली टेबल के ऊपर प्रिंट किया है.
2. उस लिंक पर मौजूद सूची में से किसी टेस्ट परफ़ॉर्मेंस पर क्लिक करके, उसकी जानकारी वाला पेज खोलें.
3. टेस्ट के नतीजे पर क्लिक करके, उस Cloud Storage बकेट पर जाएं जिसमें उस एक्सीक्यूशन के टेस्ट के नतीजे हैं.
4. अपने कोड कवरेज की रिपोर्ट देखने के लिए, artifacts/coverage.ec खोलें.

ध्यान दें: हर टेस्ट के लिए sdcard/Download डायरेक्ट्री को खींचने पर, उस डायरेक्ट्री की सभी फ़ाइलें, टेस्ट की Cloud Storage बकेट में चली जाती हैं. अगर आपने Blaze के पेमेंट प्लान का इस्तेमाल किया है और आपका ऐप्लिकेशन उस डायरेक्ट्री में कई फ़ाइलें बनाता है, तो डायरेक्ट्री को खींचने पर, स्टोरेज के लिए अतिरिक्त शुल्क लिया जा सकता है.

टेस्ट के नतीजों का विश्लेषण करना

कुछ मिनटों के बाद, gcloud टूल आपके टेस्ट के नतीजों की खास जानकारी प्रिंट करता है:

आपके कमांड लाइन टेस्ट रन के आउटपुट में, जांच के नतीजे देखने का लिंक भी शामिल होता है. इन नतीजों को समझने के तरीके के बारे में ज़्यादा जानने के लिए, Android पर मिले नतीजों के लिए Firebase Test Lab का विश्लेषण करना लेख पढ़ें.

रोबो टेस्ट के साथ कस्टम लॉगिन और टेक्स्ट इनपुट

जब तक --no-auto-google-login पैरामीटर का इस्तेमाल नहीं किया जाता, तब तक रोबो टेस्ट, पुष्टि करने के लिए Google खाते का इस्तेमाल करने वाली साइन इन स्क्रीन को अपने-आप पूरा कर देता है. यह आपके दिए गए टेस्ट खाते के क्रेडेंशियल का इस्तेमाल करके, पसंद के मुताबिक लॉगिन स्क्रीन भी बना सकता है. इस पैरामीटर का इस्तेमाल, अपने ऐप्लिकेशन में इस्तेमाल किए जाने वाले अन्य टेक्स्ट फ़ील्ड के लिए, कस्टम इनपुट टेक्स्ट देने के लिए भी किया जा सकता है.

अपने ऐप्लिकेशन में टेक्स्ट फ़ील्ड भरने के लिए, --robo-directives पैरामीटर का इस्तेमाल करें और key-value पेयर की ऐसी सूची दें जिसमें कॉमा लगाकर अलग किया गया हो. इसमें key, टारगेट यूज़र इंटरफ़ेस (यूआई) एलिमेंट के Android संसाधन का नाम और value टेक्स्ट स्ट्रिंग है. इस फ़्लैग का इस्तेमाल करके, Robo को कुछ खास यूज़र इंटरफ़ेस (यूआई) एलिमेंट (उदाहरण के लिए, "लॉग आउट करें" बटन). WebView यूज़र इंटरफ़ेस (यूआई) एलिमेंट में EditText फ़ील्ड इस्तेमाल किए जा सकते हैं, लेकिन टेक्स्ट फ़ील्ड नहीं.

उदाहरण के लिए, कस्टम लॉगिन के लिए, इस पैरामीटर का इस्तेमाल किया जा सकता है:

--robo-directives username_resource=username,password_resource=password

चेतावनी: जांच के लिए सिर्फ़ ऐसे क्रेडेंशियल इस्तेमाल करें जो असली उपयोगकर्ताओं से जुड़े न हों.

उपलब्ध निर्देश और फ़्लैग

Test Lab gcloud CLI में कई निर्देश और फ़्लैग उपलब्ध हैं. इनकी मदद से, अलग-अलग खास बातों के साथ जांच की जा सकती है:

• Android Test Orchestrator फ़्लैग: Orchestrator को चालू करने के लिए फ़्लैग. यह एक ऐसा टूल है जिसकी मदद से, Instrumentation के अपने इनवोकेशन में अपने ऐप्लिकेशन के हर टेस्ट को चलाया जा सकता है. Test Lab हमेशा Orchestrator का नया वर्शन इस्तेमाल करता है.

• गेम लूप टेस्ट फ़्लैग: कॉन्फ़िगरेशन फ़्लैग का एक सेट, जो गेम ऐप्लिकेशन में खिलाड़ी की कार्रवाइयों को सिम्युलेट करने के लिए, "डेमो मोड" को चालू और कंट्रोल करता है. Test Lab की मदद से गेम लूप टेस्ट चलाने के बारे में ज़्यादा जानें.

• यूनिफ़ॉर्म शार्डिंग फ़्लैग (बीटा में): यह ऐसा फ़्लैग है जो उन शार्ड की संख्या के बारे में बताता है जिनमें आपको टेस्ट केस को समान रूप से डिस्ट्रिब्यूट करना है. शर्ड, अलग-अलग डिवाइसों पर एक साथ चलाए जाते हैं.

  ध्यान दें: फ़िज़िकल डिवाइसों की संख्या 50, Arm वर्चुअल के लिए 200, और x86 वर्चुअल के लिए 500 हो सकती है. यह बात, मैन्युअल तौर पर डेटा का बंटवारा करने के फ़्लैग पर भी लागू होती है.

• मैन्युअल शार्डिंग फ़्लैग (बीटा वर्शन में): ऐसा फ़्लैग जो शार्ड (टेस्ट केस का ग्रुप) में चलाए जाने के लिए पैकेज, क्लास, और/या टेस्ट केस के एक ग्रुप के बारे में बताता है. शर्ड, अलग-अलग डिवाइसों पर एक साथ चलाए जाते हैं.

• नेटवर्क ट्रैफ़िक प्रोफ़ाइल फ़्लैग (बीटा वर्शन में): यह फ़्लैग बताता है कि आपके टेस्ट, फ़िज़िकल डिवाइसों के साथ किस नेटवर्क प्रोफ़ाइल का इस्तेमाल करते हैं. नेटवर्क प्रोफ़ाइलें, नेटवर्क की अलग-अलग स्थितियों को एमुलेट करती हैं. इससे आपको अविश्वसनीय या रुक-रुककर चलने वाले नेटवर्क पर, अपने ऐप्लिकेशन की परफ़ॉर्मेंस की जांच करने में मदद मिलती है.

Test Lab की मदद से gcloud कमांड की स्क्रिप्ट बनाना

मोबाइल ऐप्लिकेशन टेस्टिंग वाले कमांड को ऑटोमेट करने के लिए, शेल स्क्रिप्ट या बैच फ़ाइलों का इस्तेमाल किया जा सकता है. इन्हें gcloud कमांड लाइन का इस्तेमाल करके चलाया जाता. यहां दी गई उदाहरण के तौर पर दी गई bash स्क्रिप्ट, दो मिनट के टाइम आउट के साथ इंस्ट्रूमेंटेशन टेस्ट चलाती है. साथ ही, यह रिपोर्ट करती है कि टेस्ट पूरा हो गया है या नहीं:

if gcloud firebase test android run --app my-app.apk --test my-test.apk --timeout 2m
then
    echo "Test matrix successfully finished"
else
    echo "Test matrix exited abnormally with non-zero exit code: " $?
fi

स्क्रिप्ट से बाहर निकलने के कोड

Test Lab में कई एग्ज़िट कोड इस्तेमाल किए जा सकते हैं. इनकी मदद से, स्क्रिप्ट या बैच फ़ाइलों का इस्तेमाल करके चलाए जाने वाले टेस्ट के नतीजों को बेहतर तरीके से समझा जा सकता है.

Test Lab के लिए स्क्रिप्टिंग के लिए, बाहर निकलने के कोड

बाहर निकलने का कोड	नोट
0	सभी टेस्ट पास हो गए.
1	कोई सामान्य गड़बड़ी हुई. इसकी ये वजहें हो सकती हैं: फ़ाइल का ऐसा नाम जो मौजूद न हो या एचटीटीपी/नेटवर्क में गड़बड़ी हो.
2	अज्ञात निर्देश या आर्ग्युमेंट दिए जाने की वजह से, जांच बंद हो गई.
10	जांच के दौरान एक या उससे ज़्यादा टेस्ट केस (टेस्ट की गई क्लास या क्लास के तरीके) पास नहीं हुए.
15	अचानक हुई गड़बड़ी की वजह से, Firebase Test Lab यह पता नहीं लगा सका कि टेस्ट मैट्रिक पास हुई या नहीं.
18	इस टेस्ट को चलाने के लिए, टेस्ट एनवायरमेंट का इस्तेमाल नहीं किया जा सकता. ऐसा, काम न करने वाले टेस्ट डाइमेंशन की वजह से होता है. यह गड़बड़ी तब हो सकती है, जब चुने गए डिवाइस टाइप पर, चुना गया Android API लेवल काम न करता हो.
19	टेस्ट मैट्रिक्स को उपयोगकर्ता ने रद्द कर दिया था.
20	टेस्ट इन्फ़्रास्ट्रक्चर से जुड़ी कोई गड़बड़ी हुई.