BasePostProcessor
public abstract class BasePostProcessor
extends Object
implements IPostProcessor
java.lang.object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
IPostProcessor
پایه که هر پیاده سازی باید گسترش یابد. اطمینان حاصل کنید که روشهای پردازش پست قبل از گزارشگران نتیجه نهایی فراخوانی شدهاند.
خلاصه
سازندگان عمومی | |
---|---|
BasePostProcessor () |
روش های عمومی | |
---|---|
final ITestInvocationListener | init ( ITestInvocationListener listener) مرحله اولیه سازی پردازشگر پست. |
final void | invocationEnded (long elapsedTime) گزارش می دهد که فراخوانی خاتمه یافته است، چه با موفقیت یا به دلیل برخی شرایط خطا. |
final void | invocationFailed ( FailureDescription failure) یک فراخوان ناقص را به دلیل برخی شرایط خطا گزارش می دهد. |
final void | invocationFailed (Throwable cause) یک فراخوان ناقص را به دلیل برخی شرایط خطا گزارش می دهد. |
void | invocationSkipped ( SkipReason reason) یک فراخوان را به عنوان نادیده گرفته شده گزارش می کند |
final void | invocationStarted ( IInvocationContext context) Invocation Listeners برای ارسال |
final boolean | isDisabled () اگر کل شی غیرفعال باشد، True را برمیگرداند (از راهاندازی و حذف کردن صرفنظر کنید). |
final void | logAssociation (String dataName, LogFile logFile) در برخی موارد، log باید به شدت با موارد آزمایشی مرتبط باشد، اما این فرصت در انجمن ورود به آزمون را به روز می کند. |
processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) این روش را برای تجمیع معیارها و گزارشها در تمام آزمایشها اجرا کنید. | |
abstract | processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) این روش را به منظور تولید مجموعه ای از معیارهای جدید از متریک ها و گزارش های موجود پیاده سازی کنید. |
processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) این روش را برای ارسال معیارهای پردازش و گزارشهای مربوط به هر آزمون پیادهسازی کنید. | |
final void | setLogSaver ( ILogSaver logSaver) |
void | setUp () این روش را در پردازشگرهای پست فرزند لغو کنید تا قبل از اجرای آزمایشی مقداردهی اولیه شود. |
final void | testAssumptionFailure ( TestDescription test, String trace) زمانی که یک آزمایش اتمی نشان می دهد که شرطی نادرست را فرض می کند، نامیده می شود |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) زمانی که یک آزمایش اتمی نشان می دهد که شرطی نادرست را فرض می کند، نامیده می شود |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) جایگزینی برای |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, 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 | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) از این روش برای ثبت یک فایل از پیاده سازی PostProcessor استفاده کنید. |
final void | testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile) هنگامی که گزارش تست ذخیره می شود، فراخوانی می شود. |
final void | testModuleEnded () پایان اجرای یک ماژول را گزارش می دهد. |
final void | testModuleStarted ( IInvocationContext moduleContext) شروع یک ماژول در حال اجرا را گزارش می دهد. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) گزارش پایان اجرای آزمایشی |
final void | testRunFailed ( FailureDescription failure) اجرای آزمایشی گزارشها به دلیل نقصی که توسط |
final void | testRunFailed (String errorMessage) اجرای آزمایشی گزارش ها به دلیل یک خطای مهلک انجام نشد. |
final void | testRunStarted (String runName, int testCount, int attemptNumber) شروع اجرای آزمایشی را گزارش می دهد. |
final void | testRunStarted (String runName, int testCount) تست پاسخ به تماس |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) شروع اجرای آزمایشی را گزارش می دهد. |
final void | testRunStopped (long elapsedTime) اجرای آزمایشی گزارشها قبل از تکمیل به دلیل درخواست کاربر متوقف شد. |
final void | testSkipped ( TestDescription test, SkipReason reason) زمانی فراخوانی میشود که آزمایشی نادیده گرفته میشود و به دلیلی که معمولاً انتظار نمیرود اجرا نمیشود. |
final void | testStarted ( TestDescription test, long startTime) جایگزینی برای |
final void | testStarted ( TestDescription test) موارد تست پاسخ به تماس |
روش های محافظت شده | |
---|---|
void | cleanUp () |
MetricMeasurement.DataType | getMetricType () این روش را نادیده بگیرید تا در صورت نیاز نوع متریک را تغییر دهید. |
String | getRunName () |
سازندگان عمومی
BasePostProcessor
public BasePostProcessor ()
روش های عمومی
init
public final ITestInvocationListener init (ITestInvocationListener listener)
مرحله اولیه سازی پردازشگر پست. اطمینان حاصل شود که قبل از هر یک از تست ها تماس گرفته می شود.
پارامترها | |
---|---|
listener | ITestInvocationListener |
برمی گرداند | |
---|---|
ITestInvocationListener |
فراخوان پایان یافت
public final void invocationEnded (long elapsedTime)
گزارش می دهد که فراخوانی خاتمه یافته است، چه با موفقیت یا به دلیل برخی شرایط خطا.
به طور خودکار توسط چارچوب TradeFederation فراخوانی می شود.
پارامترها | |
---|---|
elapsedTime | long : زمان سپری شده فراخوانی در ms |
فراخوان ناموفق بود
public final void invocationFailed (FailureDescription failure)
یک فراخوان ناقص را به دلیل برخی شرایط خطا گزارش می دهد.
به طور خودکار توسط چارچوب TradeFederation فراخوانی می شود.
پارامترها | |
---|---|
failure | FailureDescription : FailureDescription که علت خرابی را توصیف می کند |
فراخوان ناموفق بود
public final void invocationFailed (Throwable cause)
یک فراخوان ناقص را به دلیل برخی شرایط خطا گزارش می دهد.
به طور خودکار توسط چارچوب TradeFederation فراخوانی می شود.
پارامترها | |
---|---|
cause | Throwable : علت Throwable شکست |
فراخوان نادیده گرفته شد
public void invocationSkipped (SkipReason reason)
یک فراخوان را به عنوان نادیده گرفته شده گزارش می کند
پارامترها | |
---|---|
reason | SkipReason |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Invocation Listeners برای ارسال
پارامترها | |
---|---|
context | IInvocationContext : اطلاعاتی در مورد فراخوانی |
غیرفعال است
public final boolean isDisabled ()
اگر کل شی غیرفعال باشد، True را برمیگرداند (از راهاندازی و حذف کردن صرفنظر کنید). در غیر این صورت نادرست است.
برمی گرداند | |
---|---|
boolean |
logAssociation
public final void logAssociation (String dataName, LogFile logFile)
در برخی موارد، log باید به شدت با موارد آزمایشی مرتبط باشد، اما این فرصت در testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
امکان پذیر نیست. بنابراین، این تماس برگشتی اجازه می دهد تا یک ارتباط قوی را به صراحت ارائه دهد.
انجمن ورود به آزمون را به روز می کند. اگر این متد در حین تست فراخوانی شود، لاگ متعلق به تست است. در غیر این صورت یک گزارش اجرا خواهد بود.
پارامترها | |
---|---|
dataName | String : نام داده ها |
logFile | LogFile : فایل LogFile که قبلاً ثبت شده است و باید با پرونده آزمایشی مرتبط شود. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
این روش را برای تجمیع معیارها و گزارشها در تمام آزمایشها اجرا کنید. معیارهایی که از این روش به دست میآیند گزارشگر بهعنوان معیارهای اجرا شده خواهند بود. فقط معیارهای جدید ایجاد شده باید برگردانده شوند، و با نام کلید منحصر به فرد (هیچ برخورد با کلیدهای موجود مجاز نیست).
پارامترها | |
---|---|
allTestMetrics | ListMultimap : HashMultimap که معیارهای مربوط به هر آزمون را با نام متریک گروه بندی می کند. |
allTestLogs | TestDescription هر آزمون به عنوان کلید استفاده میکند. |
برمی گرداند | |
---|---|
مجموعه معیارهای جدید ایجاد شده از تمام معیارهای آزمایشی. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
این روش را به منظور تولید مجموعه ای از معیارهای جدید از متریک ها و گزارش های موجود پیاده سازی کنید. فقط معیارهای جدید ایجاد شده باید برگردانده شوند، و با نام کلید منحصر به فرد (هیچ برخورد با کلیدهای موجود مجاز نیست).
پارامترها | |
---|---|
rawMetrics | |
runLogs |
برمی گرداند | |
---|---|
مجموعه معیارهای جدید تولید شده از معیارهای اجرا. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
این روش را برای ارسال معیارهای پردازش و گزارشهای مربوط به هر آزمون پیادهسازی کنید. فقط معیارهای جدید ایجاد شده باید برگردانده شوند، و با نام کلید منحصر به فرد (هیچ برخورد با کلیدهای موجود مجاز نیست).
پارامترها | |
---|---|
testDescription | TestDescription : شی TestDescription که تست را توصیف می کند. |
testMetrics | |
testLogs |
برمی گرداند | |
---|---|
مجموعه معیارهای جدید تولید شده از معیارهای آزمون. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
ILogSaver
طوری تنظیم کنید که به پیادهکننده اجازه دهد فایلها را ذخیره کند.
پارامترها | |
---|---|
logSaver | ILogSaver : ILogSaver |
راه اندازی
public void setUp ()
این روش را در پردازشگرهای پست فرزند لغو کنید تا قبل از اجرای آزمایشی مقداردهی اولیه شود.
آزمون فرض شکست
public final void testAssumptionFailure (TestDescription test, String trace)
زمانی که یک آزمایش اتمی نشان می دهد که شرطی نادرست را فرض می کند، نامیده می شود
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
trace | String : ردپای شکست |
آزمون فرض شکست
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
زمانی که یک آزمایش اتمی نشان می دهد که شرطی نادرست را فرض می کند، نامیده می شود
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
failure | FailureDescription : FailureDescription که شکست و زمینه آن را توصیف می کند. |
تست پایان یافت
public final void testEnded (TestDescription test, long endTime,testMetrics)
جایگزینی برای ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
که میتوانیم زمان پایان را مستقیماً مشخص کنیم. برای اندازه گیری دقیق، با testStarted(com.android.tradefed.result.TestDescription, long)
ترکیب کنید.
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
endTime | long : زمان پایان آزمایش، اندازهگیری شده از طریق System.currentTimeMillis() |
testMetrics | ERROR(/Map) از معیارهای منتشر شده |
تست پایان یافت
public final void testEnded (TestDescription test,testMetrics)
پایان اجرای یک مورد آزمایشی فردی را گزارش می کند.
اگر testFailed(TestDescription, FailureDescription)
فراخوانی نمی شد، این آزمایش با موفقیت انجام شد. همچنین هر معیار کلید/مقداری را که ممکن است در طول اجرای مورد آزمایشی منتشر شده باشد، برمی گرداند.
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
testMetrics | ERROR(/Map) از معیارهای منتشر شده |
تست شکست خورد
public final void testFailed (TestDescription test, FailureDescription failure)
گزارش شکست یک مورد آزمایشی فردی.
بین testStarted و testEnded فراخوانی خواهد شد.
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
failure | FailureDescription : FailureDescription که شکست و زمینه آن را توصیف می کند. |
تست شکست خورد
public final void testFailed (TestDescription test, String trace)
گزارش شکست یک مورد آزمایشی فردی.
بین testStarted و testEnded فراخوانی خواهد شد.
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
trace | String : ردپای شکست |
تست نادیده گرفته شد
public final void testIgnored (TestDescription test)
زمانی که آزمایشی اجرا نمیشود نامیده میشود، معمولاً به این دلیل که یک روش تست با org.junit.Ignore حاشیهنویسی میشود.
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
testLog
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
از این روش برای ثبت یک فایل از پیاده سازی PostProcessor استفاده کنید.
پارامترها | |
---|---|
dataName | String : نام توصیفی String از داده ها. به عنوان مثال "device_logcat". توجه داشته باشید dataName ممکن است در هر فراخوان منحصر به فرد نباشد. به عنوان مثال، پیادهکنندهها باید بتوانند چندین تماس را با یک dataName مدیریت کنند |
dataType | LogDataType : LogDataType داده ها |
dataStream | InputStreamSource : InputStreamSource داده ها. پیادهکنندهها باید createInputStream را برای شروع خواندن دادهها فراخوانی کنند و از بسته شدن InputStream حاصل پس از تکمیل اطمینان حاصل کنند. تماسگیرندگان باید اطمینان حاصل کنند که منبع دادهها تا زمانی که روش testLog کامل نشود، موجود و قابل دسترسی است. |
testLogSaved
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
هنگامی که گزارش تست ذخیره می شود، فراخوانی می شود.
باید به جای ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)
استفاده شود.
پارامترها | |
---|---|
dataName | String : نام توصیفی String از داده ها. به عنوان مثال "device_logcat". توجه داشته باشید dataName ممکن است در هر فراخوان منحصر به فرد نباشد. به عنوان مثال، پیادهکنندهها باید بتوانند چندین تماس را با یک dataName مدیریت کنند |
dataType | LogDataType : LogDataType داده ها |
dataStream | InputStreamSource : InputStreamSource داده ها. پیادهکنندهها باید createInputStream را برای شروع خواندن دادهها فراخوانی کنند و از بسته شدن InputStream حاصل پس از تکمیل اطمینان حاصل کنند. |
logFile | LogFile : LogFile حاوی متا داده های فایل ذخیره شده است. |
testModuleEnded
public final void testModuleEnded ()
پایان اجرای یک ماژول را گزارش می دهد.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
شروع یک ماژول در حال اجرا را گزارش می دهد. این فراخوانی با testModuleEnded()
مرتبط است و در دنباله اختیاری است. این فقط در طول اجرا استفاده می شود که از ماژول ها استفاده می کند: دونده های مبتنی بر مجموعه.
پارامترها | |
---|---|
moduleContext | IInvocationContext : IInvocationContext ماژول. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
گزارش پایان اجرای آزمایشی FIXME: ما نمی توانیم دو رابط Map<> با نوع متفاوت داشته باشیم، بنابراین باید از HashMap در اینجا استفاده کنیم.
پارامترها | |
---|---|
elapsedTime | long : دستگاه زمان سپری شده را بر حسب میلی ثانیه گزارش کرد |
runMetrics | Metric گزارش شده است. |
testRunFailed
public final void testRunFailed (FailureDescription failure)
اجرای آزمایشی گزارشها به دلیل نقصی که توسط FailureDescription
توصیف شده است، انجام نشد.
پارامترها | |
---|---|
failure | FailureDescription : FailureDescription که شکست و زمینه آن را توصیف می کند. |
testRunFailed
public final void testRunFailed (String errorMessage)
اجرای آزمایشی گزارش ها به دلیل یک خطای مهلک انجام نشد.
پارامترها | |
---|---|
errorMessage | String : String که دلیل شکست اجرا را توضیح می دهد. |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber)
شروع اجرای آزمایشی را گزارش می دهد.
پارامترها | |
---|---|
runName | String : نام اجرای آزمایشی |
testCount | int : تعداد کل تست ها در اجرای آزمایشی |
attemptNumber | int : شماره سفارش، شناسایی تلاشهای مختلف یک runName که چندین بار اجرا میشوند. تلاش Number با 0 ایندکس شده است و باید هر بار که اجرای جدیدی اتفاق می افتد افزایش یابد. به عنوان مثال، یک تست 3 بار به صورت دانه ای تکرار می شود، باید 4 اجرا در مجموع تحت همان runName داشته باشد و numberNumber از 0 تا 3 باشد. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
تست پاسخ به تماس
پارامترها | |
---|---|
runName | String : نام اجرای آزمایشی |
testCount | int : تعداد کل تست ها در اجرای آزمایشی |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
شروع اجرای آزمایشی را گزارش می دهد.
پارامترها | |
---|---|
runName | String : نام اجرای آزمایشی |
testCount | int : تعداد کل تست ها در اجرای آزمایشی |
attemptNumber | int : شماره سفارش، شناسایی تلاشهای مختلف یک runName که چندین بار اجرا میشوند. تلاش Number با 0 ایندکس شده است و باید هر بار که اجرای جدیدی اتفاق می افتد افزایش یابد. به عنوان مثال، یک تست 3 بار به صورت دانه ای تکرار می شود، باید 4 اجرا در مجموع تحت همان runName داشته باشد و numberNumber از 0 تا 3 باشد. |
startTime | long : زمان شروع اجرا، اندازهگیری شده از طریق System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
اجرای آزمایشی گزارشها قبل از تکمیل به دلیل درخواست کاربر متوقف شد.
TODO: در حال حاضر استفاده نشده است، حذف را در نظر بگیرید
پارامترها | |
---|---|
elapsedTime | long : دستگاه زمان سپری شده را بر حسب میلی ثانیه گزارش کرد |
تست رد شد
public final void testSkipped (TestDescription test, SkipReason reason)
زمانی فراخوانی میشود که آزمایشی نادیده گرفته میشود و به دلیلی که معمولاً انتظار نمیرود اجرا نمیشود. سعی می شود این تست ها مجددا امتحان شوند تا اجرای مناسبی انجام شود.
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
reason | SkipReason : SkipReason |
تست شروع شد
public final void testStarted (TestDescription test, long startTime)
جایگزینی برای testStarted(com.android.tradefed.result.TestDescription)
که در آن زمان شروع آزمایش را نیز مشخص می کنیم، همراه با ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
برای اندازه گیری دقیق .
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
startTime | long : زمان شروع آزمایش، اندازهگیری شده از طریق System.currentTimeMillis() |
تست شروع شد
public final void testStarted (TestDescription test)
موارد تست پاسخ به تماس
پارامترها | |
---|---|
test | TestDescription : تست را مشخص می کند |
روش های محافظت شده
پاکسازی
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
این روش را نادیده بگیرید تا در صورت نیاز نوع متریک را تغییر دهید. متریک به طور پیش فرض روی نوع پردازش شده تنظیم شده است.
برمی گرداند | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
برمی گرداند | |
---|---|
String |