پروتو-ریپورتر

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

شیء جاوا
↳ 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)

در برخی موارد، log باید به شدت با یک مورد آزمایشی مرتبط باشد، اما امکان انجام این کار در فراخوانی مستقیم 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)

مدیریت رکورد جزئی ماژول proto پس از وقوع testModuleStarted(IInvocationContext) .

void processTestRunEnded (TestRecordProto.TestRecord runRecord, boolean moduleInProgress)

مدیریت پروتوی رکورد اجرای نهایی شده پس از وقوع testRunEnded(long,HashMap) .

void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

مدیریت رکورد اجرای آزمایشی جزئی proto پس از وقوع 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)

پایان اجرای یک مورد آزمایشی (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 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)

شروع یک مورد آزمایشی (test case) منفرد را گزارش می‌دهد.

روش‌های محافظت‌شده

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

یک مرجع فرزند برای یک ماژول ایجاد می‌کند.

سازندگان عمومی

پروتو-ریپورتر 

public ProtoResultReporter ()

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

فراخوان پایان یافت 

public final void invocationEnded (long elapsedTime)

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

به طور خودکار توسط چارچوب TradeFederation فراخوانی خواهد شد.

پارامترها
elapsedTime long : زمان سپری شده از فراخوانی بر حسب میلی‌ثانیه

فراخوانی ناموفق 

public void invocationFailed (FailureDescription failure)

به دلیل وجود برخی شرایط خطا، فراخوانی ناقص را گزارش می‌دهد.

به طور خودکار توسط چارچوب TradeFederation فراخوانی خواهد شد.

پارامترها
failure FailureDescription : FailureDescription علت خرابی را توصیف می‌کند.

فراخوانی ناموفق 

public void invocationFailed (Throwable cause)

به دلیل وجود برخی شرایط خطا، فراخوانی ناقص را گزارش می‌دهد.

به طور خودکار توسط چارچوب TradeFederation فراخوانی خواهد شد.

پارامترها
cause Throwable : علت Throwable خرابی

فراخوانی رد شد 

public void invocationSkipped (SkipReason reason)

یک فراخوانی را به عنوان رد شده گزارش می‌دهد

پارامترها
reason SkipReason

فراخوان شروع شد 

public void invocationStarted (IInvocationContext context)

شروع فراخوانی تست را گزارش می‌دهد.

به طور خودکار توسط چارچوب TradeFederation فراخوانی می‌شود. گزارشگران برای پشتیبانی از گزارش‌دهی چندین دستگاه، باید این متد را بازنویسی کنند.

پارامترها
context IInvocationContext : اطلاعاتی درباره فراخوانی

انجمن ورود به سیستم 

public final void logAssociation (String dataName, 
                LogFile logFile)

در برخی موارد، log باید به شدت با یک مورد آزمایشی مرتبط باشد، اما امکان انجام این کار در فراخوانی مستقیم testLogSaved(String,LogDataType,InputStreamSource,LogFile) امکان‌پذیر نیست. بنابراین، این فراخوانی امکان ارائه یک ارتباط قوی را به طور صریح فراهم می‌کند.

پارامترها
dataName String : نام داده

logFile LogFile : LogFile که قبلاً لاگ شده و باید با مورد آزمایشی مرتبط باشد.

processFinalInvocationLogs 

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

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

پارامترها
invocationLogs TestRecordProto.TestRecord : پروتوی نهایی‌شده که نشان‌دهنده‌ی فراخوانی است.

فرآیندFinalProto 

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

مدیریت نمونه اولیه نهایی با تمام نتایج.

پارامترها
finalRecord TestRecordProto.TestRecord : پروتوی نهایی شده به همراه تمام نتایج فراخوانی.

فراخوانی شروع فرآیند 

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

مدیریت پروتوی رکورد آزمایشی فراخوانی جزئی پس از وقوع invocationStarted(IInvocationContext) .

پارامترها
invocationStartRecord TestRecordProto.TestRecord : نمونه اولیه جزئی که پس از فراخوانی Start ایجاد شده است.

invocationContext IInvocationContext : فراخوانی IInvocationContext .

فرآیند TestCaseپایان یافت 

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

مدیریت پروتوی رکورد نهایی کیس تست پس از وقوع testEnded(TestDescription,long,HashMap) .

پارامترها
testCaseRecord TestRecordProto.TestRecord : نمونه اولیه نهایی که نشان‌دهنده یک مورد آزمایشی است.

فرآیندTestCaseStarted 

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

مدیریت رکورد نمونه آزمایشی جزئی پس از وقوع testStarted(TestDescription,long) .

پارامترها
testCaseStartedRecord TestRecordProto.TestRecord : نمونه اولیه جزئی که نمونه آزمایشی را نشان می‌دهد.

پایان ماژول تست فرآیند 

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

مدیریت پروتوی رکورد ماژول نهایی شده پس از وقوع testModuleEnded() ‎.

پارامترها
moduleRecord TestRecordProto.TestRecord : نمونه‌ی نهایی که نشان‌دهنده‌ی ماژول است.

processTestModuleStarted 

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

مدیریت رکورد جزئی ماژول proto پس از وقوع testModuleStarted(IInvocationContext) .

پارامترها
moduleStartRecord TestRecordProto.TestRecord : نمونه اولیه جزئی که ماژول را نشان می‌دهد.

فرآیندTestRunEnd 

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

مدیریت پروتوی رکورد اجرای نهایی شده پس از وقوع testRunEnded(long,HashMap) .

پارامترها
runRecord TestRecordProto.TestRecord : نمونه‌ی نهایی که نشان‌دهنده‌ی اجرا است.

moduleInProgress boolean : مشخص می‌کند که آیا یک ماژول در حال انجام است یا خیر.

processTestRunStarted 

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

مدیریت رکورد اجرای آزمایشی جزئی proto پس از وقوع testRunStarted(String,int) .

پارامترها
runStartedRecord TestRecordProto.TestRecord : نمونه اولیه جزئی که نشان‌دهنده اجرا است.

setGranularResults 

public void setGranularResults (boolean granularResults)

پارامترها
granularResults boolean

setInlineRecordOfChildren 

public void setInlineRecordOfChildren (boolean inline)

پارامترها
inline boolean

پشتیبانی از نتایج گرانولار 

public boolean supportGranularResults ()

اگر گزارشگر از نتایج جزئی پشتیبانی کند، مقدار True و در غیر این صورت مقدار False را برمی‌گرداند.

بازگشت‌ها
boolean

آزمون فرض شکست 

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, 
                HashMap<String, MetricMeasurement.Metric> testMetrics)

جایگزینی برای testEnded(TestDescription,Map) که در آن می‌توانیم زمان پایان را مستقیماً مشخص کنیم. برای اندازه‌گیری دقیق‌تر، آن را با testStarted(TestDescription,long) ترکیب کنید.

پارامترها
test TestDescription : تست را مشخص می‌کند.

endTime long : زمان پایان تست، که از طریق System.currentTimeMillis() اندازه‌گیری می‌شود.

testMetrics HashMap : Map از معیارهای منتشر شده

آزمون پایان یافت 

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

پایان اجرای یک مورد آزمایشی (test case) را گزارش می‌دهد.

اگر testFailed(TestDescription, FailureDescription) فراخوانی نشده باشد، این تست با موفقیت انجام شده است. همچنین هر معیار کلید/مقداری را که ممکن است در طول اجرای مورد تست منتشر شده باشد، برمی‌گرداند.

پارامترها
test TestDescription : تست را مشخص می‌کند.

testMetrics HashMap : 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 : تست را مشخص می‌کند.

testModuleEnd 

public final void testModuleEnded ()

پایان اجرای یک ماژول را گزارش می‌دهد.

ماژول تست شروع شد 

public final void testModuleStarted (IInvocationContext moduleContext)

شروع اجرای یک ماژول را گزارش می‌دهد. این فراخوانی با testModuleEnded() مرتبط است و در دنباله اختیاری است. فقط در طول اجرایی که از اجراکننده‌های مبتنی بر modules: suite استفاده می‌کند، استفاده می‌شود.

پارامترها
moduleContext IInvocationContext : همان IInvocationContext مربوط به ماژول است.

تست اجرا شده 

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

پایان اجرای تست را گزارش می‌دهد. رفع مشکل: ما نمی‌توانیم دو رابط Map<> با انواع مختلف داشته باشیم، بنابراین باید از HashMap در اینجا استفاده کنیم.

پارامترها
elapsedTimeMillis long : زمان سپری شده گزارش شده توسط دستگاه، بر حسب میلی ثانیه

runMetrics HashMap : جفت‌های کلید-مقدار که در پایان اجرای تست با Metric گزارش می‌شوند.

تست اجرا ناموفق 

public final void testRunFailed (FailureDescription failure)

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

پارامترها
failure FailureDescription : FailureDescription خرابی و زمینه آن را توصیف می‌کند.

تست اجرا ناموفق 

public final void testRunFailed (String errorMessage)

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

پارامترها
errorMessage String : String دلیل عدم موفقیت در اجرا را توصیف می‌کند.

تست شروع شد 

public 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 void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

شروع یک آزمایش را گزارش می‌دهد.

پارامترها
runName String : نام اجرای آزمایشی

testCount int : تعداد کل تست‌ها در اجرای تست

attemptNumber int : شماره ترتیب، که تلاش‌های مختلف یک runName را که چندین بار اجرا شده‌اند، مشخص می‌کند. شماره تلاش با اندیس ۰ اندیس‌گذاری شده است و باید هر بار که یک اجرای جدید اتفاق می‌افتد، افزایش یابد. به عنوان مثال، یک تست ۳ بار به صورت جزئی تکرار می‌شود، باید ۴ بار در کل تحت یک runName اجرا شود و شماره تلاش از ۰ تا ۳ است.

startTime long : زمان شروع اجرا، که از طریق System.currentTimeMillis() اندازه‌گیری می‌شود.

آزمون رد شد 

public final void testSkipped (TestDescription test, 
                SkipReason reason)

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

پارامترها
test TestDescription : تست را مشخص می‌کند.

reason SkipReason : SkipReason

تست شروع شد 

public final void testStarted (TestDescription test, 
                long startTime)

جایگزینی برای testStarted(TestDescription) که در آن زمان شروع تست را نیز مشخص می‌کنیم، و برای اندازه‌گیری دقیق‌تر با testEnded(TestDescription,long,Map) ترکیب می‌شود.

پارامترها
test TestDescription : تست را مشخص می‌کند.

startTime long : زمان شروع تست، که از طریق System.currentTimeMillis() اندازه‌گیری می‌شود.

تست شروع شد 

public final void testStarted (TestDescription test)

شروع یک مورد آزمایشی (test case) را گزارش می‌دهد. رابط‌های قدیمی‌تر، در صورت امکان باید testStarted(TestDescription) استفاده کنند.

پارامترها
test TestDescription : تست را مشخص می‌کند.

روش‌های محافظت‌شده

بعد از پایان ماژول 

protected void afterModuleEnd ()

قبل از شروع ماژول 

protected void beforeModuleStart ()

مرجع فرزند ماژول را ایجاد کنید 

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

یک مرجع فرزند برای یک ماژول ایجاد می‌کند.

پارامترها
record TestRecordProto.TestRecord

بازگشت‌ها
TestRecordProto.ChildReference