ProtoResultReporter

public abstract class ProtoResultReporter
extends Object implements ILogSaverListener, ISupportGranularResults, ITestInvocationListener

java.lang.Object
   ↳ com.android.tradefed.result.proto.ProtoResultReporter

नतीजे की जानकारी देने वाला सिस्टम, TestRecord प्रोटोबफ़ बनाता है. इसमें सभी नतीजे शामिल होते हैं. processFinalProto(TestRecord) में फ़ाइनल प्रोटो के साथ क्या करना है, यह तय करने के लिए इसे बढ़ाया जाना चाहिए.

खास जानकारी

सार्वजनिक कंस्ट्रक्टर

ProtoResultReporter()

पब्लिक मेथड

final void invocationEnded(long elapsedTime)

यह रिपोर्ट करती है कि इनवॉकेशन खत्म हो गया है. भले ही, यह काम सही तरीके से हुआ हो या किसी गड़बड़ी की वजह से.

void invocationFailed(FailureDescription failure)

किसी गड़बड़ी की वजह से, यह कुकी इनवोकेशन पूरा न होने की सूचना देती है.

void invocationFailed(Throwable cause)

किसी गड़बड़ी की वजह से, यह कुकी इनवोकेशन पूरा न होने की सूचना देती है.

void invocationSkipped(SkipReason reason)

इस फ़ंक्शन का इस्तेमाल, किसी इनवोकेशन को 'अभी नहीं' के तौर पर रिपोर्ट करने के लिए किया जाता है

void invocationStarted(IInvocationContext context)

यह कुकी, टेस्ट शुरू होने की जानकारी देती है.

final void logAssociation(String dataName, LogFile logFile)

कुछ मामलों में, लॉग को टेस्ट केस से जोड़ा जाना ज़रूरी होता है. हालांकि, सीधे testLogSaved(String,LogDataType,InputStreamSource,LogFile) कॉलबैक पर ऐसा नहीं किया जा सकता.

void processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)

इनवॉकेशन के सभी फ़ाइनल लॉग एक-एक करके भेजने के लिए, इनवॉकेशन रिकॉर्ड का इस्तेमाल करें.

void processFinalProto(TestRecordProto.TestRecord finalRecord)

सभी नतीजों के साथ फ़ाइनल प्रोटो को हैंडल करना.

void processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)

invocationStarted(IInvocationContext) के बाद, आंशिक इनवोकेशन जांच का रिकॉर्ड प्रोटो को मैनेज करना.

void processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)

testEnded(TestDescription,long,HashMap) होने के बाद, फ़ाइनल किए गए टेस्ट केस के रिकॉर्ड प्रोटो को मैनेज करना.

void processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)

testStarted(TestDescription,long) के बाद, टेस्ट केस के रिकॉर्ड प्रोटो के कुछ हिस्से को मैनेज करना.

void processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)

testModuleEnded() के बाद, फ़ाइनल किए गए मॉड्यूल रिकॉर्ड प्रोटो को मैनेज करना.

void processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)

testModuleStarted(IInvocationContext) होने के बाद, मॉड्यूल के रिकॉर्ड प्रोटो के कुछ हिस्से को हैंडल करना.

void processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)

testRunEnded(long,HashMap) के बाद, फ़ाइनल किए गए रन रिकॉर्ड प्रोटो को हैंडल किया गया.

void processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)

testRunStarted(String,int) के बाद, टेस्ट रन के आंशिक रिकॉर्ड प्रोटोकॉल को हैंडल करना.

void setGranularResults(boolean granularResults)
void setInlineRecordOfChildren(boolean inline)
boolean supportGranularResults()

अगर रिपोर्टर, ज़्यादा जानकारी वाले नतीजे दिखाता है, तो True वैल्यू मिलती है. ऐसा न होने पर, False वैल्यू मिलती है.

final void testAssumptionFailure(TestDescription test, String trace)

इस फ़ंक्शन को तब कॉल किया जाता है, जब कोई ऐटॉमिक टेस्ट यह फ़्लैग करता है कि वह ऐसी शर्त मान रहा है जो गलत है

final void testAssumptionFailure(TestDescription test, FailureDescription failure)

इस फ़ंक्शन को तब कॉल किया जाता है, जब कोई ऐटॉमिक टेस्ट यह फ़्लैग करता है कि वह ऐसी शर्त मान रहा है जो गलत है

final void testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics)

testEnded(TestDescription,Map) के बजाय, सीधे तौर पर इवेंट खत्म होने का समय बताने का विकल्प.

void testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics)

यह कुकी, किसी टेस्ट केस के खत्म होने की जानकारी देती है.

final void testFailed(TestDescription test, FailureDescription failure)

यह किसी टेस्ट केस के फ़ेल होने की जानकारी देता है.

final void testFailed(TestDescription test, String trace)

यह किसी टेस्ट केस के फ़ेल होने की जानकारी देता है.

final void testIgnored(TestDescription test)

इस फ़ंक्शन को तब कॉल किया जाता है, जब कोई टेस्ट नहीं चलाया जाता. आम तौर पर, ऐसा इसलिए होता है, क्योंकि टेस्ट के तरीके को org.junit.Ignore के साथ एनोटेट किया जाता है.

final void testModuleEnded()

यह कुकी, मॉड्यूल के रन के खत्म होने की जानकारी देती है.

final void testModuleStarted(IInvocationContext moduleContext)

यह कुकी, मॉड्यूल के चलने की शुरुआत की जानकारी देती है.

final void testRunEnded(long elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics)

यह कुकी, टेस्ट रन के खत्म होने की जानकारी देती है.

final void testRunFailed(FailureDescription failure)

FailureDescription की वजह से, रिपोर्ट टेस्ट रन पूरा नहीं हो सका.

final void testRunFailed(String errorMessage)

गंभीर गड़बड़ी की वजह से, रिपोर्ट के टेस्ट रन को पूरा नहीं किया जा सका.

void testRunStarted(String runName, int testCount, int attemptNumber)

यह कुकी, टेस्ट रन शुरू होने की जानकारी देती है.

final void testRunStarted(String runName, int testCount)

यह कुकी, टेस्ट रन शुरू होने की जानकारी देती है.

void testRunStarted(String runName, int testCount, int attemptNumber, long startTime)

यह कुकी, टेस्ट रन शुरू होने की जानकारी देती है.

final void testSkipped(TestDescription test, SkipReason reason)

इस फ़ंक्शन को तब कॉल किया जाता है, जब किसी टेस्ट को स्किप किया जाता है और उसे किसी ऐसी वजह से लागू नहीं किया जाता जिसकी आम तौर पर उम्मीद नहीं होती.

final void testStarted(TestDescription test, long startTime)

testStarted(TestDescription) के बजाय, यहां हम यह भी बताते हैं कि टेस्ट कब शुरू हुआ था. साथ ही, सटीक मेज़रमेंट के लिए testEnded(TestDescription,long,Map) का इस्तेमाल किया जाता है.

final void testStarted(TestDescription test)

यह फ़ंक्शन, किसी टेस्ट केस के शुरू होने की जानकारी देता है.

प्रोटेक्टेड मेथड

void afterModuleEnd()
void beforeModuleStart()
TestRecordProto.ChildReference createModuleChildReference(TestRecordProto.TestRecord record)

यह फ़ंक्शन, किसी मॉड्यूल के लिए चाइल्ड रेफ़रंस बनाता है.

सार्वजनिक कंस्ट्रक्टर

ProtoResultReporter

public ProtoResultReporter ()

पब्लिक मेथड

invocationEnded

public final void invocationEnded (long elapsedTime)

यह रिपोर्ट करती है कि इनवॉकेशन खत्म हो गया है. भले ही, यह काम सही तरीके से हुआ हो या किसी गड़बड़ी की वजह से.

इसे TradeFederation फ़्रेमवर्क अपने-आप कॉल करेगा.

पैरामीटर
elapsedTime long: फ़ंक्शन को कॉल करने में लगा समय, मिलीसेकंड में

invocationFailed

public void invocationFailed (FailureDescription failure)

किसी गड़बड़ी की वजह से, यह कुकी इनवोकेशन पूरा न होने की सूचना देती है.

इसे TradeFederation फ़्रेमवर्क अपने-आप कॉल करेगा.

पैरामीटर
failure FailureDescription: FailureDescription, जिसमें अनुरोध पूरा न होने की वजह बताई गई है

invocationFailed

public void invocationFailed (Throwable cause)

किसी गड़बड़ी की वजह से, यह कुकी इनवोकेशन पूरा न होने की सूचना देती है.

इसे TradeFederation फ़्रेमवर्क अपने-आप कॉल करेगा.

पैरामीटर
cause Throwable: Throwable की वजह से टेस्ट पूरा नहीं हो सका

invocationSkipped

public void invocationSkipped (SkipReason reason)

इस फ़ंक्शन का इस्तेमाल, किसी इनवोकेशन को 'अभी नहीं' के तौर पर रिपोर्ट करने के लिए किया जाता है

पैरामीटर
reason SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

यह कुकी, टेस्ट शुरू होने की जानकारी देती है.

इसे TradeFederation फ़्रेमवर्क अपने-आप कॉल करेगा. रिपोर्टर को इस तरीके को बदलना होगा, ताकि एक से ज़्यादा डिवाइसों से रिपोर्टिंग की जा सके.

पैरामीटर
context IInvocationContext: शुरू करने के बारे में जानकारी

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

कुछ मामलों में, लॉग को टेस्ट केस से जोड़ा जाना ज़रूरी होता है. हालांकि, सीधे testLogSaved(String,LogDataType,InputStreamSource,LogFile) कॉलबैक पर ऐसा नहीं किया जा सकता. इसलिए, यह कॉलबैक साफ़ तौर पर एक मज़बूत असोसिएशन उपलब्ध कराने की अनुमति देता है.

पैरामीटर
dataName String: डेटा का नाम
logFile LogFile: वह LogFile जिसे पहले लॉग किया गया था और जिसे टेस्ट केस से जोड़ा जाना चाहिए.

processFinalInvocationLogs

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

इनवॉकेशन के सभी फ़ाइनल लॉग एक-एक करके भेजने के लिए, इनवॉकेशन रिकॉर्ड का इस्तेमाल करें.

पैरामीटर
invocationLogs TestRecordProto.TestRecord: इनवोकेशन को दिखाने वाला फ़ाइनल प्रोटो.

processFinalProto

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

सभी नतीजों के साथ फ़ाइनल प्रोटो को हैंडल करना.

पैरामीटर
finalRecord TestRecordProto.TestRecord: यह सभी इनवोकेशन के नतीजों वाला फ़ाइनल प्रोटो है.

processStartInvocation

public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord, 
                IInvocationContext invocationContext)

invocationStarted(IInvocationContext) के बाद, आंशिक इनवोकेशन जांच का रिकॉर्ड प्रोटो को मैनेज करना.

पैरामीटर
invocationStartRecord TestRecordProto.TestRecord: यह invocationStart के बाद पॉप्युलेट किया गया आंशिक प्रोटो है.
invocationContext IInvocationContext: शुरू करने का तरीका IInvocationContext.

processTestCaseEnded

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

testEnded(TestDescription,long,HashMap) होने के बाद, फ़ाइनल किए गए टेस्ट केस के रिकॉर्ड प्रोटो को मैनेज करना.

पैरामीटर
testCaseRecord TestRecordProto.TestRecord: टेस्ट केस को दिखाने वाला फ़ाइनल प्रोटोटाइप.

processTestCaseStarted

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

testStarted(TestDescription,long) के बाद, टेस्ट केस के रिकॉर्ड प्रोटो के कुछ हिस्से को मैनेज करना.

पैरामीटर
testCaseStartedRecord TestRecordProto.TestRecord: टेस्ट केस को दिखाने वाला आंशिक प्रोटो.

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

testModuleEnded() के बाद, फ़ाइनल किए गए मॉड्यूल रिकॉर्ड प्रोटो को मैनेज करना.

पैरामीटर
moduleRecord TestRecordProto.TestRecord: मॉड्यूल को दिखाने वाला फ़ाइनल प्रोटो.

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

testModuleStarted(IInvocationContext) होने के बाद, मॉड्यूल के रिकॉर्ड प्रोटो के कुछ हिस्से को हैंडल करना.

पैरामीटर
moduleStartRecord TestRecordProto.TestRecord: मॉड्यूल को दिखाने वाला आंशिक प्रोटो.

processTestRunEnded

public void processTestRunEnded (TestRecordProto.TestRecord runRecord, 
                boolean moduleInProgress)

testRunEnded(long,HashMap) के बाद, फ़ाइनल किए गए रन रिकॉर्ड प्रोटो को हैंडल किया गया.

पैरामीटर
runRecord TestRecordProto.TestRecord: यह रन को दिखाने वाला फ़ाइनल प्रोटो है.
moduleInProgress boolean: मॉड्यूल पर काम चल रहा है या नहीं.

processTestRunStarted

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

testRunStarted(String,int) के बाद, टेस्ट रन के आंशिक रिकॉर्ड प्रोटोकॉल को हैंडल करना.

पैरामीटर
runStartedRecord TestRecordProto.TestRecord: रन को दिखाने वाला आंशिक प्रोटो.

setGranularResults

public void setGranularResults (boolean granularResults)

पैरामीटर
granularResults boolean

setInlineRecordOfChildren

public void setInlineRecordOfChildren (boolean inline)

पैरामीटर
inline boolean

supportGranularResults

public boolean supportGranularResults ()

अगर रिपोर्टर, ज़्यादा जानकारी वाले नतीजे दिखाता है, तो True वैल्यू मिलती है. ऐसा न होने पर, False वैल्यू मिलती है.

रिटर्न
boolean

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

इस फ़ंक्शन को तब कॉल किया जाता है, जब कोई ऐटॉमिक टेस्ट यह फ़्लैग करता है कि वह ऐसी शर्त मान रहा है जो गलत है

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
trace String: गड़बड़ी का स्टैक ट्रेस

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

इस फ़ंक्शन को तब कॉल किया जाता है, जब कोई ऐटॉमिक टेस्ट यह फ़्लैग करता है कि वह ऐसी शर्त मान रहा है जो गलत है

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
failure FailureDescription: FailureDescription में गड़बड़ी और उसके संदर्भ के बारे में बताया गया हो.

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

testEnded(TestDescription,Map) के बजाय, सीधे तौर पर इवेंट खत्म होने का समय बताने का विकल्प. सटीक मेज़रमेंट के लिए, इसे testStarted(TestDescription,long) के साथ जोड़ें.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
endTime long: टेस्ट के खत्म होने का समय, जिसे System.currentTimeMillis() के ज़रिए मेज़र किया जाता है
testMetrics HashMap: भेजी गई मेट्रिक का Map

testEnded

public void testEnded (TestDescription test, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

यह कुकी, किसी टेस्ट केस के खत्म होने की जानकारी देती है.

अगर testFailed(TestDescription, FailureDescription) को लागू नहीं किया गया है, तो यह टेस्ट पास हो गया है. यह टेस्ट केस के एक्ज़ीक्यूशन के दौरान, जनरेट हुई किसी भी कुंजी/वैल्यू मेट्रिक को भी दिखाता है.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
testMetrics HashMap: भेजी गई मेट्रिक का Map

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

यह किसी टेस्ट केस के फ़ेल होने की जानकारी देता है.

इसे testStarted और testEnded के बीच कॉल किया जाएगा.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
failure FailureDescription: FailureDescription में गड़बड़ी और उसके संदर्भ के बारे में बताया गया हो.

testFailed

public final void testFailed (TestDescription test, 
                String trace)

यह किसी टेस्ट केस के फ़ेल होने की जानकारी देता है.

इसे testStarted और testEnded के बीच कॉल किया जाएगा.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
trace String: गड़बड़ी का स्टैक ट्रेस

testIgnored

public final void testIgnored (TestDescription test)

इस फ़ंक्शन को तब कॉल किया जाता है, जब कोई टेस्ट नहीं चलाया जाता. आम तौर पर, ऐसा इसलिए होता है, क्योंकि टेस्ट के तरीके को org.junit.Ignore के साथ एनोटेट किया जाता है.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है

testModuleEnded

public final void testModuleEnded ()

यह कुकी, मॉड्यूल के रन के खत्म होने की जानकारी देती है.

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

यह कुकी, मॉड्यूल के चलने की शुरुआत की जानकारी देती है. यह कॉलबैक, testModuleEnded() से जुड़ा है. साथ ही, यह क्रम में ज़रूरी नहीं है. इसका इस्तेमाल सिर्फ़ ऐसे रन के दौरान किया जाता है जो मॉड्यूल का इस्तेमाल करते हैं: सुइट आधारित रनर.

पैरामीटर
moduleContext IInvocationContext: मॉड्यूल का IInvocationContext.

testRunEnded

public final void testRunEnded (long elapsedTimeMillis, 
                HashMap<String, MetricMeasurement.Metric> runMetrics)

यह कुकी, टेस्ट रन के खत्म होने की जानकारी देती है. FIXME: We cannot have two Map<> interfaces with different type, so we have to use HashMap here.

पैरामीटर
elapsedTimeMillis long: डिवाइस ने मिलीसेकंड में बीता हुआ समय रिपोर्ट किया
runMetrics HashMap: Metric के साथ टेस्ट रन के आखिर में रिपोर्ट किए गए की-वैल्यू पेयर.

testRunFailed

public final void testRunFailed (FailureDescription failure)

FailureDescription की वजह से, रिपोर्ट टेस्ट रन पूरा नहीं हो सका.

पैरामीटर
failure FailureDescription: FailureDescription में गड़बड़ी और उसके संदर्भ के बारे में बताया गया हो.

testRunFailed

public final void testRunFailed (String errorMessage)

गंभीर गड़बड़ी की वजह से, रिपोर्ट के टेस्ट रन को पूरा नहीं किया जा सका.

पैरामीटर
errorMessage String: String, रन फ़ेल होने की वजह के बारे में बताता है.

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

यह कुकी, टेस्ट रन शुरू होने की जानकारी देती है.

पैरामीटर
runName String: टेस्ट रन का नाम
testCount int: टेस्ट रन में कुल टेस्ट की संख्या
attemptNumber int: ऑर्डर नंबर, जो एक ही runName के अलग-अलग प्रयासों की पहचान करता है. यह कई बार चलता है. attemptNumber, 0 से शुरू होता है और हर बार नया रन होने पर इसे बढ़ाना चाहिए. उदाहरण के लिए, अगर किसी टेस्ट को तीन बार फिर से आज़माया जाता है, तो उसे एक ही runName के तहत कुल चार रन करने चाहिए. साथ ही, attemptNumber 0 से 3 तक होना चाहिए.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

यह कुकी, टेस्ट रन शुरू होने की जानकारी देती है.

पैरामीटर
runName String: टेस्ट रन का नाम
testCount int: टेस्ट रन में कुल टेस्ट की संख्या

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

यह कुकी, टेस्ट रन शुरू होने की जानकारी देती है.

पैरामीटर
runName String: टेस्ट रन का नाम
testCount int: टेस्ट रन में कुल टेस्ट की संख्या
attemptNumber int: ऑर्डर नंबर, जो एक ही runName के अलग-अलग प्रयासों की पहचान करता है. यह कई बार चलता है. attemptNumber, 0 से शुरू होता है और हर बार नया रन होने पर इसे बढ़ाना चाहिए. उदाहरण के लिए, अगर किसी टेस्ट को तीन बार फिर से चलाया जाता है, तो उसे एक ही runName के तहत कुल चार बार चलाया जाना चाहिए. साथ ही, attemptNumber 0 से 3 तक होना चाहिए.
startTime long: दौड़ शुरू होने का समय, जिसे System.currentTimeMillis() के ज़रिए मेज़र किया जाता है

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

इस फ़ंक्शन को तब कॉल किया जाता है, जब किसी टेस्ट को स्किप किया जाता है और उसे किसी ऐसी वजह से लागू नहीं किया जाता जिसकी आम तौर पर उम्मीद नहीं होती. इन टेस्ट को फिर से चलाने की कोशिश की जाएगी, ताकि इन्हें सही तरीके से लागू किया जा सके.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
reason SkipReason: SkipReason

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

testStarted(TestDescription) के बजाय, यहां हम यह भी बताते हैं कि टेस्ट कब शुरू हुआ था. साथ ही, सटीक मेज़रमेंट के लिए testEnded(TestDescription,long,Map) का इस्तेमाल किया जाता है.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है
startTime long: यह टेस्ट शुरू होने का समय है. इसे System.currentTimeMillis() के ज़रिए मेज़र किया जाता है

testStarted

public final void testStarted (TestDescription test)

यह फ़ंक्शन, किसी टेस्ट केस के शुरू होने की जानकारी देता है. पुराना इंटरफ़ेस. जब भी हो सके, testStarted(TestDescription) का इस्तेमाल करना चाहिए.

पैरामीटर
test TestDescription: इससे टेस्ट की पहचान होती है

प्रोटेक्टेड मेथड

afterModuleEnd

protected void afterModuleEnd ()

beforeModuleStart

protected void beforeModuleStart ()

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

यह फ़ंक्शन, किसी मॉड्यूल के लिए चाइल्ड रेफ़रंस बनाता है.

पैरामीटर
record TestRecordProto.TestRecord

रिटर्न
TestRecordProto.ChildReference