ProtoResultReporter
public
abstract
class
ProtoResultReporter
extends Object
implements
ILogSaverListener,
ISupportGranularResults,
ITestInvocationListener
| java.lang.Object | |
| ↳ | com.android.tradefed.result.proto.ProtoResultReporter |
Result reporter build a TestRecord protobuf with all the results inside. ควรขยายเพื่อจัดการว่าจะทำอย่างไรกับ Proto สุดท้ายใน 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)
ในบางกรณี บันทึกต้องเชื่อมโยงกับกรณีทดสอบอย่างใกล้ชิด แต่ไม่สามารถดำเนินการดังกล่าวใน |
void
|
processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs)
ใช้บันทึกการเรียกใช้เพื่อส่งบันทึกสุดท้ายของการเรียกใช้ทั้งหมดทีละรายการ |
void
|
processFinalProto(TestRecordProto.TestRecord finalRecord)
การจัดการโปรโตคอลสุดท้ายที่มีผลลัพธ์ทั้งหมด |
void
|
processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext)
การจัดการ Proto ของบันทึกการทดสอบการเรียกใช้บางส่วนหลังจากเกิด |
void
|
processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord)
การจัดการ Proto ของบันทึกกรณีทดสอบที่สรุปแล้วหลังจากเกิด |
void
|
processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord)
การจัดการ Proto ของบันทึกกรณีทดสอบบางส่วนหลังจากเกิด |
void
|
processTestModuleEnd(TestRecordProto.TestRecord moduleRecord)
การจัดการโปรโตคอลบันทึกโมดูลที่สรุปแล้วหลังจากเกิด |
void
|
processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord)
การจัดการโปรโตคอลระเบียนโมดูลบางส่วนหลังจากเกิด |
void
|
processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress)
การจัดการโปรโตคอลบันทึกการเรียกใช้ที่เสร็จสมบูรณ์แล้วหลังจากเกิด |
void
|
processTestRunStarted(TestRecordProto.TestRecord runStartedRecord)
การจัดการโปรโตคอลบันทึกการทดสอบบางส่วนหลังจากเกิด |
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)
ทางเลือกแทน |
void
|
testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> 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
|
testModuleEnded()
รายงานการสิ้นสุดการเรียกใช้โมดูล |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
รายงานการเริ่มต้นการทำงานของโมดูล |
final
void
|
testRunEnded(long elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics)
รายงานสิ้นสุดการทดสอบ |
final
void
|
testRunFailed(FailureDescription failure)
การทดสอบการเรียกใช้รายงานไม่สำเร็จเนื่องจากความล้มเหลวที่อธิบายโดย |
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)
ทางเลือกแทน |
final
void
|
testStarted(TestDescription test)
รายงานจุดเริ่มต้นของกรณีทดสอบแต่ละรายการ |
วิธีการที่ได้รับการป้องกัน | |
|---|---|
void
|
afterModuleEnd()
|
void
|
beforeModuleStart()
|
TestRecordProto.ChildReference
|
createModuleChildReference(TestRecordProto.TestRecord record)
สร้างการอ้างอิงย่อยสำหรับโมดูล |
เครื่องมือสร้างสาธารณะ
ProtoResultReporter
public ProtoResultReporter ()
เมธอดสาธารณะ
invocationEnded
public final void invocationEnded (long elapsedTime)
รายงานว่าการเรียกใช้สิ้นสุดลงแล้ว ไม่ว่าจะสำเร็จหรือไม่ก็ตาม หรือเนื่องจากเงื่อนไขข้อผิดพลาดบางอย่าง
เฟรมเวิร์ก TradeFederation จะเรียกใช้โดยอัตโนมัติ
| พารามิเตอร์ | |
|---|---|
elapsedTime |
long: เวลาที่ผ่านไปของการเรียกใช้ในหน่วยมิลลิวินาที |
invocationFailed
public void invocationFailed (FailureDescription failure)
รายงานการเรียกใช้ที่ไม่สมบูรณ์เนื่องจากเงื่อนไขข้อผิดพลาดบางอย่าง
เฟรมเวิร์ก TradeFederation จะเรียกใช้โดยอัตโนมัติ
| พารามิเตอร์ | |
|---|---|
failure |
FailureDescription: FailureDescription ที่อธิบายสาเหตุของการดำเนินการไม่สำเร็จ |
invocationFailed
public void invocationFailed (Throwable cause)
รายงานการเรียกใช้ที่ไม่สมบูรณ์เนื่องจากเงื่อนไขข้อผิดพลาดบางอย่าง
เฟรมเวิร์ก TradeFederation จะเรียกใช้โดยอัตโนมัติ
| พารามิเตอร์ | |
|---|---|
cause |
Throwable: สาเหตุที่ Throwable ทำงานไม่สำเร็จ |
invocationSkipped
public void invocationSkipped (SkipReason reason)
รายงานการเรียกใช้ว่าข้าม
| พารามิเตอร์ | |
|---|---|
reason |
SkipReason |
invocationStarted
public void invocationStarted (IInvocationContext context)
รายงานการเริ่มต้นการเรียกใช้การทดสอบ
เฟรมเวิร์ก TradeFederation จะเรียกใช้โดยอัตโนมัติ ผู้รายงานต้องลบล้าง เมธอดนี้เพื่อรองรับการรายงานจากอุปกรณ์หลายเครื่อง
| พารามิเตอร์ | |
|---|---|
context |
IInvocationContext: ข้อมูลเกี่ยวกับการเรียกใช้ |
logAssociation
public final void logAssociation (String dataName,
LogFile logFile)ในบางกรณี บันทึกต้องเชื่อมโยงกับกรณีทดสอบอย่างใกล้ชิด แต่ไม่สามารถดำเนินการดังกล่าวในtestLogSaved(String,LogDataType,InputStreamSource,LogFile)
การเรียกกลับโดยตรงได้ ดังนั้น Callback นี้จึงช่วยให้เชื่อมโยงได้อย่างชัดเจน
| พารามิเตอร์ | |
|---|---|
dataName |
String: ชื่อข้อมูล |
logFile |
LogFile: LogFile ที่บันทึกไว้ก่อนหน้านี้และควรเชื่อมโยงกับ
กรณีทดสอบ |
processFinalInvocationLogs
public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)
ใช้บันทึกการเรียกใช้เพื่อส่งบันทึกสุดท้ายของการเรียกใช้ทั้งหมดทีละรายการ
| พารามิเตอร์ | |
|---|---|
invocationLogs |
TestRecordProto.TestRecord: Proto ที่เสร็จสมบูรณ์ซึ่งแสดงถึงการเรียกใช้ |
processFinalProto
public void processFinalProto (TestRecordProto.TestRecord finalRecord)
การจัดการโปรโตคอลสุดท้ายที่มีผลลัพธ์ทั้งหมด
| พารามิเตอร์ | |
|---|---|
finalRecord |
TestRecordProto.TestRecord: โปรโตที่เสร็จสมบูรณ์พร้อมผลการเรียกใช้ทั้งหมด |
processStartInvocation
public void processStartInvocation (TestRecordProto.TestRecord invocationStartRecord,
IInvocationContext invocationContext)การจัดการ Proto ของบันทึกการทดสอบการเรียกใช้บางส่วนหลังจากเกิด invocationStarted(IInvocationContext)
| พารามิเตอร์ | |
|---|---|
invocationStartRecord |
TestRecordProto.TestRecord: Proto บางส่วนที่สร้างขึ้นหลังจาก invocationStart |
invocationContext |
IInvocationContext: การเรียกใช้ IInvocationContext |
processTestCaseEnded
public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)
การจัดการ Proto ของบันทึกกรณีทดสอบที่สรุปแล้วหลังจากเกิด testEnded(TestDescription,long,HashMap)
| พารามิเตอร์ | |
|---|---|
testCaseRecord |
TestRecordProto.TestRecord: Proto ที่เสร็จสมบูรณ์ซึ่งแสดงถึงกรณีทดสอบ |
processTestCaseStarted
public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)
การจัดการ Proto ของบันทึกกรณีทดสอบบางส่วนหลังจากเกิด testStarted(TestDescription,long)
| พารามิเตอร์ | |
|---|---|
testCaseStartedRecord |
TestRecordProto.TestRecord: Proto บางส่วนที่แสดงถึงกรณีทดสอบ |
processTestModuleEnd
public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)
การจัดการโปรโตคอลบันทึกโมดูลที่สรุปแล้วหลังจากเกิด testModuleEnded()
| พารามิเตอร์ | |
|---|---|
moduleRecord |
TestRecordProto.TestRecord: โปรโตที่เสร็จสมบูรณ์ซึ่งแสดงโมดูล |
processTestModuleStarted
public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)
การจัดการโปรโตคอลระเบียนโมดูลบางส่วนหลังจากเกิด testModuleStarted(IInvocationContext)
| พารามิเตอร์ | |
|---|---|
moduleStartRecord |
TestRecordProto.TestRecord: Proto บางส่วนที่แสดงโมดูล |
processTestRunEnded
public void processTestRunEnded (TestRecordProto.TestRecord runRecord,
boolean moduleInProgress)การจัดการโปรโตคอลบันทึกการเรียกใช้ที่เสร็จสมบูรณ์แล้วหลังจากเกิด testRunEnded(long,HashMap)
| พารามิเตอร์ | |
|---|---|
runRecord |
TestRecordProto.TestRecord: Proto ที่เสร็จสมบูรณ์ซึ่งแสดงถึงการเรียกใช้ |
moduleInProgress |
boolean: โมดูลอยู่ระหว่างดำเนินการหรือไม่ |
processTestRunStarted
public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)
การจัดการโปรโตคอลบันทึกการทดสอบบางส่วนหลังจากเกิด testRunStarted(String,int)
| พารามิเตอร์ | |
|---|---|
runStartedRecord |
TestRecordProto.TestRecord: Proto บางส่วนที่แสดงการเรียกใช้ |
setGranularResults
public void setGranularResults (boolean granularResults)
| พารามิเตอร์ | |
|---|---|
granularResults |
boolean |
setInlineRecordOfChildren
public void setInlineRecordOfChildren (boolean inline)
| พารามิเตอร์ | |
|---|---|
inline |
boolean |
supportGranularResults
public boolean supportGranularResults ()
แสดงค่า True หากผู้รายงานรองรับผลลัพธ์แบบละเอียด หรือแสดงค่า False หากไม่รองรับ
| การคืนสินค้า | |
|---|---|
boolean |
|
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
เรียกใช้เมื่อการทดสอบแบบอะตอมแจ้งว่ามีการสมมติเงื่อนไขที่เป็นเท็จ
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
trace |
String: สแต็กเทรซของความล้มเหลว |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
เรียกใช้เมื่อการทดสอบแบบอะตอมแจ้งว่ามีการสมมติเงื่อนไขที่เป็นเท็จ
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
failure |
FailureDescription: FailureDescription อธิบายความล้มเหลวและบริบทของความล้มเหลวนั้น |
testEnded
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 ของเมตริกที่ปล่อยออกมา |
testEnded
public void testEnded (TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics)
รายงานจุดสิ้นสุดของการดำเนินการของกรณีทดสอบแต่ละรายการ
หากไม่ได้เรียกใช้ testFailed(TestDescription, FailureDescription) การทดสอบนี้จะผ่าน นอกจากนี้ยังแสดงผลเมตริกคีย์/ค่า
ที่อาจมีการปล่อยออกมาในระหว่างการดำเนินการของกรณีทดสอบด้วย
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
testMetrics |
HashMap: Map ของเมตริกที่ปล่อยออกมา |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
รายงานความล้มเหลวของกรณีทดสอบแต่ละรายการ
จะเรียกใช้ระหว่าง testStarted และ testEnded
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
failure |
FailureDescription: FailureDescription อธิบายความล้มเหลวและบริบทของความล้มเหลวนั้น |
testFailed
public final void testFailed (TestDescription test, String trace)
รายงานความล้มเหลวของกรณีทดสอบแต่ละรายการ
จะเรียกใช้ระหว่าง testStarted และ testEnded
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
trace |
String: สแต็กเทรซของความล้มเหลว |
testIgnored
public final void testIgnored (TestDescription test)
เรียกใช้เมื่อจะไม่ทำการทดสอบ โดยทั่วไปเนื่องจากมีการใส่คำอธิบายประกอบเมธอดทดสอบด้วย org.junit.Ignore
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
testModuleEnded
public final void testModuleEnded ()
รายงานการสิ้นสุดการเรียกใช้โมดูล
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
รายงานการเริ่มต้นการทำงานของโมดูล โดยการเรียกกลับนี้เชื่อมโยงกับ testModuleEnded() และเป็นแบบไม่บังคับในลำดับ โดยจะใช้เฉพาะในระหว่างการเรียกใช้ที่ใช้โมดูล
ซึ่งเป็นโปรแกรมเรียกใช้ตามชุดทดสอบ
| พารามิเตอร์ | |
|---|---|
moduleContext |
IInvocationContext: IInvocationContext ของโมดูล |
testRunEnded
public final void testRunEnded (long elapsedTimeMillis,
HashMap<String, MetricMeasurement.Metric> runMetrics)รายงานสิ้นสุดการทดสอบ FIXME: We cannot have two Map<> interfaces with different type, so we have to use HashMap here.
| พารามิเตอร์ | |
|---|---|
elapsedTimeMillis |
long: อุปกรณ์รายงานเวลาที่ผ่านไปเป็นมิลลิวินาที |
runMetrics |
HashMap: คู่คีย์-ค่าที่รายงานเมื่อสิ้นสุดการทดสอบด้วย Metric |
testRunFailed
public final void testRunFailed (FailureDescription failure)
การทดสอบการเรียกใช้รายงานไม่สำเร็จเนื่องจากความล้มเหลวที่อธิบายโดย FailureDescription
| พารามิเตอร์ | |
|---|---|
failure |
FailureDescription: FailureDescription อธิบายความล้มเหลวและบริบทของความล้มเหลวนั้น |
testRunFailed
public final void testRunFailed (String errorMessage)
การทดสอบการเรียกใช้รายงานไม่สำเร็จเนื่องจากเกิดข้อผิดพลาดร้ายแรง
| พารามิเตอร์ | |
|---|---|
errorMessage |
String: String อธิบายเหตุผลที่การเรียกใช้ล้มเหลว |
testRunStarted
public void testRunStarted (String runName,
int testCount,
int attemptNumber)รายงานการเริ่มต้นการทดสอบ
| พารามิเตอร์ | |
|---|---|
runName |
String: ชื่อการทดสอบ |
testCount |
int: จำนวนการทดสอบทั้งหมดในการทดสอบ |
attemptNumber |
int: หมายเลขคำสั่งซื้อ ซึ่งระบุความพยายามต่างๆ ของ runName เดียวกัน
ที่เรียกใช้หลายครั้ง attemptNumber มีดัชนีเป็น 0 และควรเพิ่มขึ้นทุกครั้งที่
มีการเรียกใช้ใหม่ เช่น หากมีการลองใหม่แบบละเอียด 3 ครั้ง การทดสอบควรมีการเรียกใช้ทั้งหมด 4 ครั้ง
ภายใต้ runName เดียวกัน และ attemptNumber จะมีค่าตั้งแต่ 0 ถึง 3 |
testRunStarted
public final void testRunStarted (String runName,
int testCount)รายงานการเริ่มต้นการทดสอบ
| พารามิเตอร์ | |
|---|---|
runName |
String: ชื่อการทดสอบ |
testCount |
int: จำนวนการทดสอบทั้งหมดในการทดสอบ |
testRunStarted
public void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)รายงานการเริ่มต้นการทดสอบ
| พารามิเตอร์ | |
|---|---|
runName |
String: ชื่อการทดสอบ |
testCount |
int: จำนวนการทดสอบทั้งหมดในการทดสอบ |
attemptNumber |
int: หมายเลขคำสั่งซื้อ ซึ่งระบุความพยายามต่างๆ ของ runName เดียวกัน
ที่เรียกใช้หลายครั้ง attemptNumber จะมีดัชนีเป็น 0 และควรเพิ่มขึ้นทุกครั้งที่มีการเรียกใช้ใหม่ เช่น หากมีการลองใหม่แบบละเอียด 3 ครั้ง การทดสอบควรมีการเรียกใช้ทั้งหมด 4 ครั้งภายใต้ runName เดียวกัน และ attemptNumber จะมีค่าตั้งแต่ 0 ถึง 3 |
startTime |
long: เวลาที่การวิ่งเริ่มต้น ซึ่งวัดผ่าน System.currentTimeMillis() |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
เรียกใช้เมื่อข้ามการทดสอบและไม่ได้ดำเนินการด้วยเหตุผลที่ไม่คาดคิด ระบบจะพยายามลองทดสอบเหล่านี้อีกครั้งเพื่อให้ดำเนินการได้อย่างถูกต้อง
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
reason |
SkipReason: SkipReason |
testStarted
public final void testStarted (TestDescription test, long startTime)
ทางเลือกแทน testStarted(TestDescription) ซึ่งเรายังระบุเวลาที่เริ่มการทดสอบ
ร่วมกับ testEnded(TestDescription,long,Map) เพื่อการวัดที่แม่นยำ
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
startTime |
long: เวลาที่การทดสอบเริ่มต้น วัดผ่าน System.currentTimeMillis() |
testStarted
public final void testStarted (TestDescription test)
รายงานจุดเริ่มต้นของกรณีทดสอบแต่ละรายการ อินเทอร์เฟซรุ่นเก่าควรใช้ testStarted(TestDescription) เมื่อเป็นไปได้
| พารามิเตอร์ | |
|---|---|
test |
TestDescription: ระบุการทดสอบ |
วิธีการที่ได้รับการป้องกัน
afterModuleEnd
protected void afterModuleEnd ()
beforeModuleStart
protected void beforeModuleStart ()
createModuleChildReference
protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)
สร้างการอ้างอิงย่อยสำหรับโมดูล
| พารามิเตอร์ | |
|---|---|
record |
TestRecordProto.TestRecord |
| การคืนสินค้า | |
|---|---|
TestRecordProto.ChildReference |
|