IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector


इस इंटरफ़ेस को डेकोरेटर के तौर पर तब जोड़ा जाएगा, जब टेस्ट के नतीजे रिपोर्ट किए जा रहे हों. ऐसा इसलिए किया जाएगा, ताकि मिलती-जुलती मेट्रिक इकट्ठा की जा सकें.

इस इंटरफ़ेस का इस्तेमाल के तौर पर नहीं किया जा सकता, भले ही यह ITestInvocationListener को बढ़ाता हो. कॉन्फ़िगरेशन की जांच करने वाली सुविधा, इसे अस्वीकार कर देगी. इसका इस्तेमाल "metrics_collector" के तौर पर किया जाना चाहिए.

कलेक्टर से यह उम्मीद नहीं की जाती कि वे इंटरनल स्टेट को बनाए रखें, क्योंकि उन्हें कई जगहों पर फिर से इस्तेमाल किया जा सकता है. अगर किसी इंटरनल स्टेट का इस्तेमाल करना ज़रूरी है, तो उसे init(IInvocationContext,ITestInvocationListener) पर साफ़ कर देना चाहिए.

खास जानकारी

पब्लिक मेथड

default boolean captureModuleLevel()

यह तय करता है कि कलेक्टर, मॉड्यूल लेवल पर कैप्चर करने के लिए लागू होता है या नहीं. साथ ही, यह भी तय करता है कि इसे शुरू किया जाना चाहिए या नहीं.

default boolean doesModuleContainFailure()

अगर मौजूदा मॉड्यूल में कोई टेस्ट केस या टेस्ट रन फ़ेल हुआ है, तो यह फ़ंक्शन 'सही' दिखाता है.

default void enableDefaultMetricCollection()

इस कुकी की मदद से, डेटा इकट्ठा करने वाले लोग डिफ़ॉल्ट मेट्रिक कलेक्शन की सुविधा चालू कर सकते हैं.

default IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel()
abstract List<IBuildInfo> getBuildInfos()

यह फ़ंक्शन, इनवोकेशन में उपलब्ध बिल्ड की जानकारी की सूची दिखाता है.

abstract List<ITestDevice> getDevices()

इस तरीके से, कॉल करने के लिए उपलब्ध डिवाइसों की सूची मिलती है.

abstract ITestInvocationListener getInvocationListener()

यह कुकी, उस ओरिजनल ITestInvocationListener को वापस लाती है जहां हम नतीजे फ़ॉरवर्ड कर रहे हैं.

default IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel()
abstract ITestInvocationListener init(IInvocationContext context, ITestInvocationListener listener)

मौजूदा कॉन्टेक्स्ट के साथ कलेक्टर को शुरू करना और नतीजों को कहां फ़ॉरवर्ड करना है.

default boolean isDefaultMetricCollectionEnabled()

क्या कलेक्टर, डिफ़ॉल्ट मेट्रिक कलेक्शन के हिस्से के तौर पर मेट्रिक इकट्ठा कर रहा है.

abstract void onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)

जब कोई टेस्ट केस, अनुमान के सही न होने की वजह से पूरा नहीं होता है, तब कॉलबैक होता है.

abstract void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)

टेस्ट केस खत्म होने पर कॉलबैक.

abstract void onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

टेस्ट केस खत्म होने पर कॉलबैक.

abstract void onTestFail(DeviceMetricData testData, TestDescription test)

टेस्ट केस फ़ेल होने पर कॉलबैक.

default void onTestModuleEnded()

इस कुकी का इस्तेमाल, मॉड्यूल के खत्म होने से जुड़े इवेंट को कैप्चर करने के लिए किया जाता है.

default void onTestModuleStarted()

इस कुकी की मदद से, मॉड्यूल शुरू होने वाले इवेंट को कैप्चर किया जा सकता है.

abstract void onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)

टेस्ट रन खत्म होने पर कॉलबैक.

abstract void onTestRunStart(DeviceMetricData runData)

टेस्ट रन शुरू होने पर कॉलबैक.

default void onTestRunStart(DeviceMetricData runData, int testCount)

टेस्ट रन शुरू होने पर कॉलबैक.

default void onTestRunStartBlocking()

अगर कलेक्टर इस सुविधा के साथ काम करता है, तो उसे मैन्युअल तरीके से शुरू करने के लिए, साफ़ तौर पर कॉलबैक करें.

abstract void onTestStart(DeviceMetricData testData)

टेस्ट केस शुरू होने पर कॉलबैक.

default void setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)

यह उस लेवल को सेट करता है जिस पर कलेक्टर को लॉग इकट्ठा करने चाहिए. भले ही, लॉग इकट्ठा करने में कोई समस्या आ रही हो.

default void setModuleContainsFailure()

यह कुकी सेट करती है कि मॉड्यूल में कोई गड़बड़ी (टेस्ट केस, टेस्ट रन) हुई है या नहीं.

default void setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)

यह उस लेवल को सेट करता है जिस पर कलेक्टर को गड़बड़ियों के दौरान लॉग इकट्ठा करने चाहिए.

पब्लिक मेथड

captureModuleLevel

public boolean captureModuleLevel ()

यह तय करता है कि कलेक्टर, मॉड्यूल लेवल पर कैप्चर करने के लिए लागू होता है या नहीं. साथ ही, यह भी तय करता है कि इसे शुरू किया जाना चाहिए या नहीं.

रिटर्न
boolean

doesModuleContainFailure

public boolean doesModuleContainFailure ()

अगर मौजूदा मॉड्यूल में कोई टेस्ट केस या टेस्ट रन फ़ेल हुआ है, तो यह फ़ंक्शन 'सही' दिखाता है.

रिटर्न
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

इस कुकी की मदद से, डेटा इकट्ठा करने वाले लोग डिफ़ॉल्ट मेट्रिक कलेक्शन की सुविधा चालू कर सकते हैं. डिफ़ॉल्ट मेट्रिक कलेक्शन चालू होने पर, कलेक्टर को सिर्फ़ तय किए गए कलेक्शन लेवल पर डेटा इकट्ठा करना चाहिए.

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

रिटर्न
IMetricCollector.MetricCollectionLevel

getBuildInfos

public abstract List<IBuildInfo> getBuildInfos ()

यह फ़ंक्शन, इनवोकेशन में उपलब्ध बिल्ड की जानकारी की सूची दिखाता है.

रिटर्न
List<IBuildInfo>

getDevices

public abstract List<ITestDevice> getDevices ()

इस तरीके से, कॉल करने के लिए उपलब्ध डिवाइसों की सूची मिलती है.

रिटर्न
List<ITestDevice>

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

यह कुकी, उस ओरिजनल ITestInvocationListener को वापस लाती है जहां हम नतीजे फ़ॉरवर्ड कर रहे हैं.

रिटर्न
ITestInvocationListener

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

रिटर्न
IMetricCollector.MetricCollectionLevel

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

मौजूदा कॉन्टेक्स्ट के साथ कलेक्टर को शुरू करना और नतीजों को कहां फ़ॉरवर्ड करना है. इसे हर इंस्टेंस के लिए सिर्फ़ एक बार कॉल किया जाएगा. साथ ही, कलेक्टर को अपने इंटरनल कॉन्टेक्स्ट और लिसनर को अपडेट करना होगा. टेस्ट रन के दौरान, Init को कभी भी कॉल नहीं किया जाएगा.

जब तक आपको यह न पता हो कि क्या करना है, तब तक इस विकल्प को न चुनें.

पैरामीटर
context IInvocationContext: चालू इनवोकेशन के लिए IInvocationContext.

listener ITestInvocationListener: वह ITestInvocationListener जहां नतीजे रखने हैं.

रिटर्न
ITestInvocationListener नए लिसनर की रैपिंग, ओरिजनल लिसनर की रैपिंग को बदल देती है.

थ्रो
DeviceNotAvailableException

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

क्या कलेक्टर, डिफ़ॉल्ट मेट्रिक कलेक्शन के हिस्से के तौर पर मेट्रिक इकट्ठा कर रहा है.

रिटर्न
boolean

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

जब कोई टेस्ट केस, अनुमान के सही न होने की वजह से पूरा नहीं होता है, तब कॉलबैक होता है.

पैरामीटर
testData DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है.

test TestDescription: यह टेस्ट केस की TestDescription है.

थ्रो
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, 
                TestDescription test)

टेस्ट केस खत्म होने पर कॉलबैक. यह समय, डेटा को साफ़ करने का होना चाहिए.

पैरामीटर
testData DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है. यह onTestStart(DeviceMetricData) के दौरान इस्तेमाल किए गए ऑब्जेक्ट जैसा ही होगा.

currentTestCaseMetrics Map: testEnded(TestDescription,Map) को पास की गई मेट्रिक का मौजूदा मैप.

test TestDescription: यह टेस्ट केस की TestDescription है.

थ्रो
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

टेस्ट केस खत्म होने पर कॉलबैक. यह समय, डेटा को साफ़ करने का होना चाहिए.

पैरामीटर
testData DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है. यह onTestStart(DeviceMetricData) के दौरान इस्तेमाल किए गए ऑब्जेक्ट जैसा ही होगा.

currentTestCaseMetrics Map: testEnded(TestDescription,Map) को पास की गई मेट्रिक का मौजूदा मैप.

थ्रो
DeviceNotAvailableException

onTestFail

public abstract void onTestFail (DeviceMetricData testData, 
                TestDescription test)

टेस्ट केस फ़ेल होने पर कॉलबैक.

पैरामीटर
testData DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है.

test TestDescription: यह टेस्ट केस की TestDescription है.

थ्रो
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

इस कुकी का इस्तेमाल, मॉड्यूल के खत्म होने से जुड़े इवेंट को कैप्चर करने के लिए किया जाता है.

थ्रो
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

इस कुकी की मदद से, मॉड्यूल शुरू होने वाले इवेंट को कैप्चर किया जा सकता है.

थ्रो
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunEnd

public abstract void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

टेस्ट रन खत्म होने पर कॉलबैक. यह समय, डेटा को साफ़ करने का होना चाहिए.

पैरामीटर
runData DeviceMetricData: यह DeviceMetricData है, जिसमें रन के लिए डेटा होता है. यह onTestRunStart(DeviceMetricData) के दौरान इस्तेमाल किए गए ऑब्जेक्ट जैसा ही होगा.

currentRunMetrics Map: testRunEnded(long,Map) को पास की गई मेट्रिक का मौजूदा मैप.

थ्रो
DeviceNotAvailableException

onTestRunStart

public abstract void onTestRunStart (DeviceMetricData runData)

टेस्ट रन शुरू होने पर कॉलबैक.

पैरामीटर
runData DeviceMetricData: यह DeviceMetricData है, जिसमें रन के लिए डेटा होता है.

थ्रो
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData, 
                int testCount)

टेस्ट रन शुरू होने पर कॉलबैक.

पैरामीटर
runData DeviceMetricData: यह DeviceMetricData है, जिसमें रन के लिए डेटा होता है.

testCount int: इस टेस्ट रन में टेस्ट केस की संख्या.

थ्रो
DeviceNotAvailableException

onTestRunStartBlocking

public void onTestRunStartBlocking ()

अगर कलेक्टर इस सुविधा के साथ काम करता है, तो उसे मैन्युअल तरीके से शुरू करने के लिए साफ़ तौर पर कॉलबैक करें. इससे यह पक्का किया जा सकता है कि हम कुछ ऐसे टेस्ट लाइफ़साइकल से बाहर हैं जो एसिंक्रोनस हैं.

थ्रो
com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

टेस्ट केस शुरू होने पर कॉलबैक.

पैरामीटर
testData DeviceMetricData: DeviceMetricData, जिसमें टेस्ट केस का डेटा मौजूद है.

थ्रो
DeviceNotAvailableException

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

यह उस लेवल को सेट करता है जिस पर कलेक्टर को लॉग इकट्ठा करने चाहिए. भले ही, लॉग इकट्ठा करने में कोई समस्या आ रही हो.

NULL लेवल पर कोई कलेक्शन नहीं होगा.

पैरामीटर
level IMetricCollector.MetricCollectionLevel: वह MetricCollectionLevel जिस पर लॉग इकट्ठा किए जाएंगे.

setModuleContainsFailure

public void setModuleContainsFailure ()

यह कुकी सेट करती है कि मॉड्यूल में कोई गड़बड़ी (टेस्ट केस, टेस्ट रन) हुई है या नहीं.

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

यह उस लेवल को सेट करता है जिस पर कलेक्टर को गड़बड़ियों के दौरान लॉग इकट्ठा करने चाहिए.

NULL लेवल पर कोई कलेक्शन नहीं होगा.

पैरामीटर
level IMetricCollector.MetricCollectionLevel: वह MetricCollectionLevel जिस पर लॉग इकट्ठा किए जाएंगे.