پردازنده پایه
public abstract class BasePostProcessor
extends Object implements IPostProcessor
| شیء جاوا | |
| ↳ | 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)شنوندگان فراخوانی برای ارسال |
final boolean | isDisabled ()اگر کل شیء غیرفعال باشد (از هر دو مرحله راهاندازی و جداسازی صرف نظر شود)، مقدار True برمیگرداند. |
final void | logAssociation (String dataName, LogFile logFile) در برخی موارد، log باید به شدت با یک مورد آزمایشی مرتبط باشد، اما امکان انجام این کار در فراخوانی مستقیم ارتباط بین گزارش و تست را بهروزرسانی میکند. |
| processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,این روش را برای تجمیع معیارها و گزارشها در تمام تستها پیادهسازی کنید. |
abstract | processRunMetricsAndLogs (این روش را برای تولید مجموعهای از معیارهای جدید از معیارها و گزارشهای موجود پیادهسازی کنید. |
| processTestMetricsAndLogs ( TestDescription testDescription,این روش را برای ارسال معیارها و گزارشهای فرآیند از هر آزمایش پیادهسازی کنید. |
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, جایگزینی برای |
final void | testEnded ( TestDescription test,پایان اجرای یک مورد آزمایشی (test case) را گزارش میدهد. |
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,پایان اجرای آزمایش را گزارش میدهد. |
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 () |
سازندگان عمومی
پردازنده پایه
public BasePostProcessor ()
روشهای عمومی
اولیه
public final ITestInvocationListener init (ITestInvocationListener listener)
مرحله مقداردهی اولیه پسپردازنده. تضمین میشود که قبل از هر یک از فراخوانیهای تست، فراخوانی شود.
| پارامترها | |
|---|---|
listener | ITestInvocationListener |
| بازگشتها | |
|---|---|
ITestInvocationListener | |
فراخوان پایان یافت
public final void invocationEnded (long elapsedTime)
گزارش میدهد که فراخوانی، چه با موفقیت و چه به دلیل وجود برخی خطاها، خاتمه یافته است.
به طور خودکار توسط چارچوب TradeFederation فراخوانی خواهد شد.
| پارامترها | |
|---|---|
elapsedTime | long : زمان سپری شده از فراخوانی بر حسب میلیثانیه |
فراخوانی ناموفق
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 |
فراخوان شروع شد
public final void invocationStarted (IInvocationContext context)
شنوندگان فراخوانی برای ارسال
| پارامترها | |
|---|---|
context | IInvocationContext : اطلاعاتی درباره فراخوانی |
غیرفعال شده است
public final boolean isDisabled ()
اگر کل شیء غیرفعال باشد (از هر دو مرحله راهاندازی و جداسازی صرف نظر شود)، مقدار True برمیگرداند. در غیر این صورت، مقدار False برمیگرداند.
| بازگشتها | |
|---|---|
boolean | |
انجمن ورود به سیستم
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) امکانپذیر نیست. بنابراین، این فراخوانی امکان ارائه یک ارتباط قوی را به طور صریح فراهم میکند.
ارتباط log-to-test را بهروزرسانی میکند. اگر این متد در حین تست فراخوانی شود، آنگاه log متعلق به تست است؛ در غیر این صورت، یک log اجرا خواهد بود.
| پارامترها | |
|---|---|
dataName | String : نام داده |
logFile | LogFile : LogFile که قبلاً لاگ شده و باید با مورد آزمایشی مرتبط باشد. |
پردازش همه تستها و گزارشها
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 | : مجموعه فایلهای ثبتشده در طول آزمایش. |
| بازگشتها | |
|---|---|
| مجموعهای از معیارهای تازه تولید شده از معیارهای آزمایشی. |
تنظیم لاگ سیور
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)
پایان اجرای یک مورد آزمایشی (test case) را گزارش میدهد.
اگر 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 : تست را مشخص میکند. |
تست لاگ
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 موجود و در دسترس باقی میماند. |
testLogذخیره شده
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 که شامل متا دیتای فایل ذخیره شده است. |
testModuleEnd
public final void testModuleEnded ()
پایان اجرای یک ماژول را گزارش میدهد.
ماژول تست شروع شد
public final void testModuleStarted (IInvocationContext moduleContext)
شروع اجرای یک ماژول را گزارش میدهد. این فراخوانی با testModuleEnded() مرتبط است و در دنباله اختیاری است. فقط در طول اجرایی که از اجراکنندههای مبتنی بر modules: suite استفاده میکند، استفاده میشود.
| پارامترها | |
|---|---|
moduleContext | IInvocationContext : همان IInvocationContext مربوط به ماژول است. |
تست اجرا شده
public final void testRunEnded (long elapsedTime,
runMetrics) پایان اجرای آزمایش را گزارش میدهد.
| پارامترها | |
|---|---|
elapsedTime | long : زمان سپری شده گزارش شده توسط دستگاه، بر حسب میلی ثانیه |
runMetrics | جفتهای کلید-مقدار که در پایان اجرای تست گزارش میشوند |
تست اجرا ناموفق
public final void testRunFailed (FailureDescription failure)
گزارش میدهد که اجرای آزمایشی به دلیل خرابی شرح داده شده توسط FailureDescription ، با شکست مواجه شده است.
| پارامترها | |
|---|---|
failure | FailureDescription : FailureDescription خرابی و زمینه آن را توصیف میکند. |
تست اجرا ناموفق
public final void testRunFailed (String errorMessage)
گزارشها حاکی از آن است که اجرای آزمایشی به دلیل یک خطای مهلک با شکست مواجه شده است.
| پارامترها | |
|---|---|
errorMessage | String : String دلیل عدم موفقیت در اجرا را توصیف میکند. |
تست شروع شد
public final void testRunStarted (String runName,
int testCount,
int attemptNumber)شروع یک آزمایش را گزارش میدهد.
| پارامترها | |
|---|---|
runName | String : نام اجرای آزمایشی |
testCount | int : تعداد کل تستها در اجرای تست |
attemptNumber | int : شماره ترتیب، که تلاشهای مختلف یک runName را که چندین بار اجرا شدهاند، مشخص میکند. شماره تلاش با اندیس ۰ اندیسگذاری شده است و باید هر بار که یک اجرای جدید اتفاق میافتد، افزایش یابد. به عنوان مثال، یک تست ۳ بار به صورت جزئی تکرار میشود، باید ۴ بار در کل تحت یک runName اجرا شود و شماره تلاش از ۰ تا ۳ است. |
تست شروع شد
public final void testRunStarted (String runName,
int testCount)فراخوانیهای مجدد اجرای آزمایشی
| پارامترها | |
|---|---|
runName | String : نام اجرای آزمایشی |
testCount | int : تعداد کل تستها در اجرای تست |
تست شروع شد
public final void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)شروع یک آزمایش را گزارش میدهد.
| پارامترها | |
|---|---|
runName | String : نام اجرای آزمایشی |
testCount | int : تعداد کل تستها در اجرای تست |
attemptNumber | int : شماره ترتیب، که تلاشهای مختلف یک runName را که چندین بار اجرا شدهاند، مشخص میکند. شماره تلاش با اندیس ۰ اندیسگذاری شده است و باید هر بار که یک اجرای جدید اتفاق میافتد، افزایش یابد. به عنوان مثال، یک تست ۳ بار به صورت جزئی تکرار میشود، باید ۴ بار در کل تحت یک runName اجرا شود و شماره تلاش از ۰ تا ۳ است. |
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 ()
نوع داده getMetric
protected MetricMeasurement.DataType getMetricType ()
در صورت نیاز، برای تغییر نوع معیار، این متد را بازنویسی کنید. به طور پیشفرض، معیار روی نوع پردازششده تنظیم شده است.
| بازگشتها | |
|---|---|
MetricMeasurement.DataType | |
نام اجرا را دریافت کنید
protected String getRunName ()
| بازگشتها | |
|---|---|
String | |