Basel ने कोड कवरेज तैयार करने के लिए, coverage
सब-कमांड दिया है
डेटा स्टोर करने की जगहों के बारे में रिपोर्ट मौजूद हैं. इनका इस्तेमाल bazel coverage
की मदद से किया जा सकता है. पूरा होने की तारीख
की समस्याओं के बारे में जानने के लिए,
किसी दिए गए प्रोजेक्ट के लिए यह काम करना हमेशा आसान नहीं होता.
इस पेज में, कॉन्टेंट बनाने और उसे देखने की सामान्य प्रोसेस के बारे में बताया गया है कवरेज रिपोर्ट और भाषा के हिसाब से कुछ नोट भी उपलब्ध होते हैं जिनका कॉन्फ़िगरेशन जाना-पहचाना होता है. सबसे अच्छा है कि इसे पहले पढ़ा जाए सामान्य सेक्शन को पढ़ें और फिर पढ़ें. ध्यान दें कि रिमोट एक्ज़ीक्यूशन सेक्शन को सेट अप करना होता है, जिसके लिए कुछ ध्यान दें.
दस्तावेज़ को पसंद के मुताबिक बनाने के कई और विकल्प मौजूद हैं. हालांकि, इस दस्तावेज़ में आपकी
lcov
रिपोर्ट बनाने और इस्तेमाल करने की अनुमति है, जो फ़िलहाल
सबसे अच्छी तरह काम करने वाला रास्ता.
कवरेज रिपोर्ट बनाना
वीडियो की रणनीति
कवरेज रिपोर्ट बनाने के लिए बेसिक वर्कफ़्लो के लिए ज़रूरी है फ़ॉलो किया जा रहा है:
- टेस्ट टारगेट के साथ बुनियादी डेटा स्टोर करने की जगह
- भाषा के हिसाब से कोड कवरेज टूल इंस्टॉल करने वाला टूलचेन
- एक सही "इंस्ट्रुमेंट" कॉन्फ़िगरेशन
पहले वाली दो कार्रवाइयाँ किसी भाषा के हिसाब से हैं और ज़्यादातर आसान हैं, हालांकि, बाद वाले प्रोजेक्ट की स्थिति मुश्किल प्रोजेक्ट के लिए ज़्यादा मुश्किल हो सकती है.
"इंस्ट्रुमेंटेशन" का मतलब ऐसे कवरेज टूल से है जो
किसी टारगेट के लिए इस्तेमाल किया जाता है. Basel को इसे चालू करने की अनुमति मिलती है
का इस्तेमाल कर रहे हैं.
--instrumentation_filter
फ़्लैग, जो उन टारगेट के लिए फ़िल्टर तय करता है जिनका टेस्ट
इंस्ट्रुमेंटेशन चालू किया गया. टेस्ट के लिए इंस्ट्रुमेंटेशन चालू करने के लिए,
--instrument_test_targets
फ़्लैग आवश्यक है.
डिफ़ॉल्ट रूप से, बेज़ल टारगेट पैकेज से मिलान करने की कोशिश करता है और
INFO
मैसेज के तौर पर काम का फ़िल्टर.
कवरेज की संख्या
कवरेज रिपोर्ट बनाने के लिए, bazel coverage
--combined_report=lcov
[target]
का इस्तेमाल करें. यह
अपने टारगेट के लिए टेस्ट करना और lcov फ़ॉर्मैट में कवरेज रिपोर्ट जनरेट करना
.
यह काम पूरा होने के बाद, बेज़ल एक ऐसी कार्रवाई करता है जिससे प्रॉडक्ट की तैयार की गई पूरी
और उन्हें एक में मर्ज कर देता है, फिर अंत में
$(bazel info
output_path)/_coverage/_coverage_report.dat
के अंतर्गत बनाया गया.
टेस्ट में फ़ेल होने पर भी कवरेज रिपोर्ट तैयार की जाती हैं. हालांकि, ध्यान रखें कि यह फ़ेल हो चुके टेस्ट पर लागू नहीं होता - सिर्फ़ पास होने वाले टेस्ट रिपोर्ट की गई.
कवरेज देखना
कवरेज रिपोर्ट में सिर्फ़ ऐसी lcov
रिपोर्ट होती है जिसे इंसान पढ़ नहीं सकते
फ़ॉर्मैट. इससे, हम genhtml
यूटिलिटी (lcov का हिस्सा) का इस्तेमाल कर सकते हैं
प्रोजेक्ट) बनाने के लिए इस्तेमाल किया जाता है, जिसे वेब पर देखा जा सकता है
ब्राउज़र:
genhtml --branch-coverage --output genhtml "$(bazel info output_path)/_coverage/_coverage_report.dat"
ध्यान दें कि genhtml
, सोर्स कोड को भी पढ़ता है, ताकि उस कॉन्टेंट के बारे में पता चल सके जो मौजूद नहीं है
शामिल हैं. इसके काम करने के लिए, यह उम्मीद की जाती है कि
genhtml
को बेज़ल प्रोजेक्ट के रूट में एक्ज़ीक्यूट किया जाता है.
नतीजा देखने के लिए, यहां बनाई गई index.html
फ़ाइल को खोलें
किसी भी वेब ब्राउज़र में genhtml
डायरेक्ट्री.
genhtml
टूल के बारे में ज़्यादा मदद और जानकारी पाने के लिए, या
lcov
कवरेज फ़ॉर्मैट, lcov प्रोजेक्ट देखें.
रिमोट तरीके से एक्ज़ीक्यूट करें
रिमोट तरीके से टेस्ट करने की प्रोसेस चलाने के दौरान, फ़िलहाल कुछ चेतावनियां दी गई हैं:
- रिपोर्ट संयोजन कार्रवाई अभी दूर से नहीं चलाई जा सकती. यह है
क्योंकि Basel, कवरेज आउटपुट फ़ाइलों को
इसका ग्राफ़ (यह समस्या देखें) और इसलिए
उन्हें कॉम्बिनेशन ऐक्शन के लिए, इनपुट के तौर पर सही तरीके से नहीं इस्तेमाल किया जा सकता. यहां की यात्रा पर हूं
इसे ठीक करने के लिए
--strategy=CoverageReport=local
का इस्तेमाल करें.- ध्यान दें: इस तरह की जानकारी देना ज़रूरी हो सकता है
अगर Basel सेट है, तो इसके बजाय
--strategy=CoverageReport=local,remote
local,remote
तक आज़माने की सुविधा उपलब्ध है. इसकी वजह यह है कि Baज़र, रणनीतियों को कैसे हल करते हैं.
- ध्यान दें: इस तरह की जानकारी देना ज़रूरी हो सकता है
अगर Basel सेट है, तो इसके बजाय
--remote_download_minimal
और इससे मिलते-जुलते फ़्लैग भी इस्तेमाल नहीं किए जा सकते की वजह से, उन्हें पहले की ज़रूरत है.- अगर जांच की जाती है, तो Basel, फ़िलहाल कवरेज की जानकारी नहीं दे पाएगा
जिन्हें पहले कैश मेमोरी में सेव किया गया है. इससे बचने के लिए,
--nocache_test_results
को खास तौर पर, कवरेज के लिए सेट किया जा सकता है, हालांकि, टेस्ट में लगने वाला समय ज़्यादा है, लेकिन इसके लिए आपको ज़्यादा शुल्क देना पड़ सकता है. --experimental_split_coverage_postprocessing
और--experimental_fetch_all_coverage_outputs
- आम तौर पर, कवरेज को टेस्ट के तौर पर चलाया जाता है. डिफ़ॉल्ट रूप से, हमें रिमोट के आउटपुट के रूप में सभी कवरेज वापस नहीं मिलते डिफ़ॉल्ट रूप से लागू होता है. ये फ़्लैग डिफ़ॉल्ट को ओवरराइड करते हैं और और उनकी जानकारी देता है. ज़्यादा जानकारी के लिए यह समस्या देखें विवरण.
भाषा के हिसाब से कॉन्फ़िगरेशन
Java
Java को डिफ़ॉल्ट कॉन्फ़िगरेशन के साथ सबसे बेहतर काम करना चाहिए. कॉन्टेंट बनाने बेज़ल टूलचेन में वे सभी चीज़ें मौजूद होती हैं जो Google Tag Manager रिमोट एक्ज़ीक्यूशन के साथ-साथ JUnit को भी एक्ज़ीक्यूट किया जा सकता है.
Python
rules_python
कवरेज के दस्तावेज़ देखें
देखें.