جمع‌کننده IMetric

public interface IMetricCollector
implements IDisableable , ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector


این رابط به عنوان یک دکوراتور هنگام گزارش نتایج آزمایش‌ها اضافه می‌شود تا معیارهای منطبق را جمع‌آوری کند.

این رابط را نمی‌توان به عنوان ... استفاده کرد. حتی اگر از ITestInvocationListener ارث‌بری کند. بررسی پیکربندی آن را رد می‌کند. باید به عنوان یک "metrics_collector" استفاده شود.

انتظار نمی‌رود که کالکتورها وضعیت داخلی را حفظ کنند، زیرا ممکن است در چندین جا دوباره استفاده شوند. اگر واقعاً لازم است از یک وضعیت داخلی استفاده شود، باید در init(IInvocationContext,ITestInvocationListener) پاک‌سازی شود.

خلاصه

روش‌های عمومی

default boolean captureModuleLevel ()

اینکه آیا کلکتور برای ضبط در سطح ماژول قابل استفاده است یا خیر و باید init باشد.

default boolean doesModuleContainFailure ()

اگر ماژول فعلی حاوی هرگونه خطای مورد آزمایشی یا اجرای آزمایشی باشد، مقدار true را برمی‌گرداند.

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)

فراخوانی مجدد (callback) پس از پایان یک مورد آزمایشی (test case).

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

فراخوانی مجدد (callback) پس از پایان یک مورد آزمایشی (test case).

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)

سطحی را تعیین می‌کند که در آن جمع‌کننده باید در هنگام خرابی‌ها، لاگ‌ها را جمع‌آوری کند.

روش‌های عمومی

سطح ماژول را ضبط کنید

public boolean captureModuleLevel ()

اینکه آیا کلکتور برای ضبط در سطح ماژول قابل استفاده است یا خیر و باید init باشد.

بازگشت‌ها
boolean

doesModuleContainFailure

public boolean doesModuleContainFailure ()

اگر ماژول فعلی حاوی هرگونه خطای مورد آزمایشی یا اجرای آزمایشی باشد، مقدار true را برمی‌گرداند.

بازگشت‌ها
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

به گردآورندگان اجازه می‌دهد تا جمع‌آوری معیارهای پیش‌فرض را فعال کنند. وقتی جمع‌آوری معیارهای پیش‌فرض فعال است، گردآورنده فقط باید در سطح جمع‌آوری مشخص‌شده جمع‌آوری کند.

سطح مجموعه همیشه فعال

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

بازگشت‌ها
IMetricCollector.MetricCollectionLevel

اطلاعات ساخت را دریافت کنید

public abstract List<IBuildInfo> getBuildInfos ()

لیست اطلاعات ساخت موجود در فراخوانی را برمی‌گرداند.

بازگشت‌ها
List< IBuildInfo >

دریافت دستگاه‌ها

public abstract List<ITestDevice> getDevices ()

لیست دستگاه‌های موجود در فراخوانی را برمی‌گرداند.

بازگشت‌ها
List< ITestDevice >

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

ITestInvocationListener اصلی را که نتایج را به آن ارسال می‌کنیم، برمی‌گرداند.

بازگشت‌ها
ITestInvocationListener

سطح مجموعه در صورت بروز خطا

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

بازگشت‌ها
IMetricCollector.MetricCollectionLevel

اولیه

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

مقداردهی اولیه‌ی جمع‌کننده با زمینه‌ی فعلی و محل ارسال نتایج. فقط یک بار برای هر نمونه فراخوانی می‌شود و انتظار می‌رود جمع‌کننده زمینه‌ی داخلی و شنونده‌ی خود را به‌روزرسانی کند. Init هرگز در طول اجرای آزمایشی فراخوانی نخواهد شد، همیشه قبل از آن.

مگر اینکه بدانید چه می‌کنید، آن را لغو نکنید.

پارامترها
context IInvocationContext : IInvocationContext برای فراخوانی که در حال انجام است.

listener ITestInvocationListener : این ITestInvocationListener محل قرار دادن نتایج است.

بازگشت‌ها
ITestInvocationListener شنونده‌ی جدید، شنونده‌ی اصلی را در بر می‌گیرد.

پرتاب‌ها
DeviceNotAvailableException

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

اینکه آیا گردآورنده، معیارها را به عنوان بخشی از مجموعه معیار پیش‌فرض جمع‌آوری می‌کند یا خیر.

بازگشت‌ها
boolean

خطای onTestAssumption

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

فراخوانی مجدد زمانی که یک مورد آزمایشی با فرض شکست مواجه می‌شود.

پارامترها
testData DeviceMetricData : DeviceMetricData که داده‌های مربوط به مورد آزمایشی را در خود نگه می‌دارد.

test TestDescription : TestDescription موردِ آزمایشیِ در حال انجام.

پرتاب‌ها
DeviceNotAvailableException

پایان آزمون

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

پایان آزمون

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

onTestModuleEnd شده

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

شروع آزمون

public abstract void onTestStart (DeviceMetricData testData)

فراخوانی مجدد هنگام شروع یک مورد آزمایشی.

پارامترها
testData DeviceMetricData : DeviceMetricData که داده‌های مربوط به مورد آزمایشی را در خود نگه می‌دارد.

پرتاب‌ها
DeviceNotAvailableException

سطح مجموعه همیشه فعال

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

سطحی را تعیین می‌کند که در آن جمع‌کننده باید صرف نظر از خرابی‌ها، لاگ‌ها را جمع‌آوری کند.

سطح NULL منجر به عدم جمع‌آوری خواهد شد.

پارامترها
level IMetricCollector.MetricCollectionLevel : MetricCollectionLevel که در آن گزارش‌ها جمع‌آوری خواهند شد.

خطای setModuleContains

public void setModuleContainsFailure ()

مشخص می‌کند که آیا ماژول دچار خرابی (مورد آزمایشی، اجرای آزمایشی) شده است یا خیر.

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

سطحی را تعیین می‌کند که در آن جمع‌کننده باید در هنگام خرابی‌ها، لاگ‌ها را جمع‌آوری کند.

سطح NULL منجر به عدم جمع‌آوری خواهد شد.

پارامترها
level IMetricCollector.MetricCollectionLevel : MetricCollectionLevel که در آن گزارش‌ها جمع‌آوری خواهند شد.