ProtoResultReporter

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

java.lang.Object
↳	com.android.tradefed.result.proto.ProtoResultReporter

Các lớp con trực tiếp đã biết FileProtoResultReporter, StreamProtoResultReporter FileProtoResultReporter Trình báo cáo Proto kết xuất TestRecord vào một tệp.  StreamProtoResultReporter Một cách triển khai ProtoResultReporter

Các lớp con gián tiếp đã biết InvocationProtoResultReporter, ModuleProtoResultReporter InvocationProtoResultReporter Reporters để lưu trữ thông tin bộ nhớ đệm ở cấp độ lệnh gọi và danh sách các mô-đun của bộ nhớ đệm  ModuleProtoResultReporter Một trình báo cáo kết quả chỉ dùng để báo cáo kết quả ở cấp mô-đun.

---

Trình báo cáo kết quả tạo một protobuf TestRecord có chứa tất cả kết quả. Cần được mở rộng để xử lý những việc cần làm với proto cuối cùng trong processFinalProto(TestRecord).

Tóm tắt

Hàm khởi tạo công khai
ProtoResultReporter()

Phương thức công khai
final void	invocationEnded(long elapsedTime) Báo cáo rằng lời gọi đã chấm dứt, cho dù thành công hay do một số điều kiện lỗi.
void	invocationFailed(FailureDescription failure) Báo cáo một lệnh gọi chưa hoàn chỉnh do một số điều kiện lỗi.
void	invocationFailed(Throwable cause) Báo cáo một lệnh gọi chưa hoàn chỉnh do một số điều kiện lỗi.
void	invocationSkipped(SkipReason reason) Báo cáo một lệnh gọi là đã bỏ qua
void	invocationStarted(IInvocationContext context) Báo cáo thời điểm bắt đầu lệnh gọi kiểm thử.
final void	logAssociation(String dataName, LogFile logFile) Trong một số trường hợp, nhật ký phải được liên kết chặt chẽ với các trường hợp kiểm thử, nhưng không thể thực hiện việc này trên lệnh gọi lại testLogSaved(String,LogDataType,InputStreamSource,LogFile) trực tiếp.
void	processFinalInvocationLogs(TestRecordProto.TestRecord invocationLogs) Sử dụng bản ghi lệnh gọi để gửi lần lượt tất cả nhật ký cuối cùng của lệnh gọi.
void	processFinalProto(TestRecordProto.TestRecord finalRecord) Xử lý proto cuối cùng với tất cả kết quả.
void	processStartInvocation(TestRecordProto.TestRecord invocationStartRecord, IInvocationContext invocationContext) Xử lý giao thức bản ghi kiểm thử lệnh gọi một phần sau khi invocationStarted(IInvocationContext) xảy ra.
void	processTestCaseEnded(TestRecordProto.TestRecord testCaseRecord) Xử lý giao thức bản ghi trường hợp kiểm thử đã hoàn tất sau khi testEnded(TestDescription,long,HashMap) xảy ra.
void	processTestCaseStarted(TestRecordProto.TestRecord testCaseStartedRecord) Xử lý giao thức bản ghi trường hợp kiểm thử một phần sau khi testStarted(TestDescription,long) xảy ra.
void	processTestModuleEnd(TestRecordProto.TestRecord moduleRecord) Xử lý proto bản ghi mô-đun đã hoàn tất sau khi testModuleEnded() xảy ra.
void	processTestModuleStarted(TestRecordProto.TestRecord moduleStartRecord) Xử lý proto bản ghi mô-đun một phần sau khi testModuleStarted(IInvocationContext) xảy ra.
void	processTestRunEnded(TestRecordProto.TestRecord runRecord, boolean moduleInProgress) Xử lý proto bản ghi lượt chạy đã hoàn tất sau khi testRunEnded(long,HashMap) xảy ra.
void	processTestRunStarted(TestRecordProto.TestRecord runStartedRecord) Xử lý proto bản ghi chạy thử một phần sau khi testRunStarted(String,int) xảy ra.
void	setGranularResults(boolean granularResults)
void	setInlineRecordOfChildren(boolean inline)
boolean	supportGranularResults() Trả về True nếu trình báo cáo hỗ trợ kết quả chi tiết, trả về false trong trường hợp ngược lại.
final void	testAssumptionFailure(TestDescription test, String trace) Được gọi khi một kiểm thử nguyên tử gắn cờ rằng kiểm thử đó giả định một điều kiện sai
final void	testAssumptionFailure(TestDescription test, FailureDescription failure) Được gọi khi một kiểm thử nguyên tử gắn cờ rằng kiểm thử đó giả định một điều kiện sai
final void	testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics) Phương án thay thế cho testEnded(TestDescription,Map), trong đó chúng ta có thể chỉ định trực tiếp thời gian kết thúc.
void	testEnded(TestDescription test, HashMap<String, MetricMeasurement.Metric> testMetrics) Báo cáo thời điểm kết thúc quá trình thực thi của một trường hợp kiểm thử riêng lẻ.
final void	testFailed(TestDescription test, FailureDescription failure) Báo cáo lỗi của một trường hợp kiểm thử riêng lẻ.
final void	testFailed(TestDescription test, String trace) Báo cáo lỗi của một trường hợp kiểm thử riêng lẻ.
final void	testIgnored(TestDescription test) Được gọi khi một quy trình kiểm thử sẽ không chạy, thường là do một phương thức kiểm thử được chú thích bằng org.junit.Ignore.
final void	testModuleEnded() Báo cáo thời điểm kết thúc một lần chạy mô-đun.
final void	testModuleStarted(IInvocationContext moduleContext) Báo cáo thời điểm bắt đầu chạy một mô-đun.
final void	testRunEnded(long elapsedTimeMillis, HashMap<String, MetricMeasurement.Metric> runMetrics) Báo cáo thời điểm kết thúc một lần chạy kiểm thử.
final void	testRunFailed(FailureDescription failure) Không hoàn tất được quá trình chạy thử báo cáo do lỗi được mô tả bằng FailureDescription.
final void	testRunFailed(String errorMessage) Không thể hoàn tất quá trình chạy thử báo cáo do gặp lỗi nghiêm trọng.
void	testRunStarted(String runName, int testCount, int attemptNumber) Báo cáo thời điểm bắt đầu một lần chạy kiểm thử.
final void	testRunStarted(String runName, int testCount) Báo cáo thời điểm bắt đầu một lần chạy kiểm thử.
void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) Báo cáo thời điểm bắt đầu một lần chạy kiểm thử.
final void	testSkipped(TestDescription test, SkipReason reason) Được gọi khi một bài kiểm thử bị bỏ qua và không thực thi vì một lý do thường không mong muốn.
final void	testStarted(TestDescription test, long startTime) Phương án thay thế cho testStarted(TestDescription), trong đó chúng ta cũng chỉ định thời điểm bắt đầu kiểm thử, kết hợp với testEnded(TestDescription,long,Map) để đo lường chính xác.
final void	testStarted(TestDescription test) Báo cáo thời điểm bắt đầu một trường hợp kiểm thử riêng lẻ.

Phương thức được bảo vệ
void	afterModuleEnd()
void	beforeModuleStart()
TestRecordProto.ChildReference	createModuleChildReference(TestRecordProto.TestRecord record) Tạo một tham chiếu con cho một mô-đun.

Hàm khởi tạo công khai

ProtoResultReporter

public ProtoResultReporter ()

Phương thức công khai

invocationEnded

public final void invocationEnded (long elapsedTime)

Báo cáo rằng lời gọi đã chấm dứt, cho dù thành công hay do một số điều kiện lỗi.

Sẽ được khung TradeFederation tự động gọi.

Tham số
elapsedTime	long: thời gian đã trôi qua của lệnh gọi (tính bằng mili giây)

invocationFailed

public void invocationFailed (FailureDescription failure)

Báo cáo một lệnh gọi chưa hoàn chỉnh do một số điều kiện lỗi.

Sẽ được khung TradeFederation tự động gọi.

Tham số
failure	FailureDescription: FailureDescription mô tả nguyên nhân gây ra lỗi

invocationFailed

public void invocationFailed (Throwable cause)

Báo cáo một lệnh gọi chưa hoàn chỉnh do một số điều kiện lỗi.

Sẽ được khung TradeFederation tự động gọi.

Tham số
cause	Throwable: nguyên nhân Throwable gây ra lỗi

invocationSkipped

public void invocationSkipped (SkipReason reason)

Báo cáo một lệnh gọi là đã bỏ qua

Tham số
reason	SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

Báo cáo thời điểm bắt đầu lệnh gọi kiểm thử.

Sẽ được khung TradeFederation tự động gọi. Người báo cáo cần ghi đè phương thức này để hỗ trợ báo cáo trên nhiều thiết bị.

Tham số
context	IInvocationContext: thông tin về lệnh gọi

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

Trong một số trường hợp, nhật ký phải được liên kết chặt chẽ với các trường hợp kiểm thử, nhưng không thể thực hiện việc này trên lệnh gọi lại testLogSaved(String,LogDataType,InputStreamSource,LogFile) trực tiếp. Do đó, lệnh gọi lại này cho phép cung cấp một mối liên kết rõ ràng một cách tường minh.

Tham số
dataName	String: Tên của dữ liệu
logFile	LogFile: LogFile đã được ghi nhật ký trước đó và phải được liên kết với trường hợp kiểm thử.

processFinalInvocationLogs

public void processFinalInvocationLogs (TestRecordProto.TestRecord invocationLogs)

Sử dụng bản ghi lệnh gọi để gửi lần lượt tất cả nhật ký cuối cùng của lệnh gọi.

Tham số
invocationLogs	TestRecordProto.TestRecord: Proto đã hoàn tất đại diện cho lệnh gọi.

processFinalProto

public void processFinalProto (TestRecordProto.TestRecord finalRecord)

Xử lý proto cuối cùng với tất cả kết quả.

Tham số
finalRecord	TestRecordProto.TestRecord: Proto đã hoàn tất với tất cả kết quả của lệnh gọi.

processStartInvocation

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

Xử lý giao thức bản ghi kiểm thử lệnh gọi một phần sau khi invocationStarted(IInvocationContext) xảy ra.

Tham số
invocationStartRecord	TestRecordProto.TestRecord: Proto một phần được điền sẵn sau invocationStart.
invocationContext	IInvocationContext: Lệnh gọi IInvocationContext.

processTestCaseEnded

public void processTestCaseEnded (TestRecordProto.TestRecord testCaseRecord)

Xử lý giao thức bản ghi trường hợp kiểm thử đã hoàn tất sau khi testEnded(TestDescription,long,HashMap) xảy ra.

Tham số
testCaseRecord	TestRecordProto.TestRecord: Proto cuối cùng đại diện cho một trường hợp kiểm thử.

processTestCaseStarted

public void processTestCaseStarted (TestRecordProto.TestRecord testCaseStartedRecord)

Xử lý giao thức bản ghi trường hợp kiểm thử một phần sau khi testStarted(TestDescription,long) xảy ra.

Tham số
testCaseStartedRecord	TestRecordProto.TestRecord: Proto một phần đại diện cho trường hợp kiểm thử.

processTestModuleEnd

public void processTestModuleEnd (TestRecordProto.TestRecord moduleRecord)

Xử lý proto bản ghi mô-đun đã hoàn tất sau khi testModuleEnded() xảy ra.

Tham số
moduleRecord	TestRecordProto.TestRecord: Proto cuối cùng đại diện cho mô-đun.

processTestModuleStarted

public void processTestModuleStarted (TestRecordProto.TestRecord moduleStartRecord)

Xử lý proto bản ghi mô-đun một phần sau khi testModuleStarted(IInvocationContext) xảy ra.

Tham số
moduleStartRecord	TestRecordProto.TestRecord: Proto một phần đại diện cho mô-đun.

processTestRunEnded

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

Xử lý proto bản ghi lượt chạy đã hoàn tất sau khi testRunEnded(long,HashMap) xảy ra.

Tham số
runRecord	TestRecordProto.TestRecord: Proto cuối cùng đại diện cho lượt chạy.
moduleInProgress	boolean: mô-đun có đang được thực hiện hay không.

processTestRunStarted

public void processTestRunStarted (TestRecordProto.TestRecord runStartedRecord)

Xử lý proto bản ghi chạy thử một phần sau khi testRunStarted(String,int) xảy ra.

Tham số
runStartedRecord	TestRecordProto.TestRecord: Proto một phần đại diện cho lượt chạy.

setGranularResults

public void setGranularResults (boolean granularResults)

Tham số
granularResults	boolean

setInlineRecordOfChildren

public void setInlineRecordOfChildren (boolean inline)

Tham số
inline	boolean

supportGranularResults

public boolean supportGranularResults ()

Trả về True nếu trình báo cáo hỗ trợ kết quả chi tiết, trả về false trong trường hợp ngược lại.

Giá trị trả về
boolean

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

Được gọi khi một kiểm thử nguyên tử gắn cờ rằng kiểm thử đó giả định một điều kiện sai

Tham số
test	TestDescription: xác định kiểm thử
trace	String: dấu vết ngăn xếp của lỗi

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Được gọi khi một kiểm thử nguyên tử gắn cờ rằng kiểm thử đó giả định một điều kiện sai

Tham số
test	TestDescription: xác định kiểm thử
failure	FailureDescription: FailureDescription mô tả lỗi và ngữ cảnh của lỗi đó.

testEnded

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

Phương án thay thế cho testEnded(TestDescription,Map), trong đó chúng ta có thể chỉ định trực tiếp thời gian kết thúc. Kết hợp với testStarted(TestDescription,long) để đo lường chính xác.

Tham số
test	TestDescription: xác định kiểm thử
endTime	long: thời gian kết thúc kiểm thử, được đo bằng System.currentTimeMillis()
testMetrics	HashMap: một Map của các chỉ số được phát ra

testEnded

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

Báo cáo thời điểm kết thúc quá trình thực thi của một trường hợp kiểm thử riêng lẻ.

Nếu testFailed(TestDescription, FailureDescription) không được gọi, thì kiểm thử này sẽ thành công. Cũng trả về mọi chỉ số khoá/giá trị có thể đã được phát trong quá trình thực thi trường hợp kiểm thử.

Tham số
test	TestDescription: xác định kiểm thử
testMetrics	HashMap: một Map của các chỉ số được phát ra

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Báo cáo lỗi của một trường hợp kiểm thử riêng lẻ.

Sẽ được gọi giữa testStarted và testEnded.

Tham số
test	TestDescription: xác định kiểm thử
failure	FailureDescription: FailureDescription mô tả lỗi và ngữ cảnh của lỗi đó.

testFailed

public final void testFailed (TestDescription test, 
                String trace)

Báo cáo lỗi của một trường hợp kiểm thử riêng lẻ.

Sẽ được gọi giữa testStarted và testEnded.

Tham số
test	TestDescription: xác định kiểm thử
trace	String: dấu vết ngăn xếp của lỗi

testIgnored

public final void testIgnored (TestDescription test)

Được gọi khi một quy trình kiểm thử sẽ không chạy, thường là do một phương thức kiểm thử được chú thích bằng org.junit.Ignore.

Tham số
test	TestDescription: xác định kiểm thử

testModuleEnded

public final void testModuleEnded ()

Báo cáo thời điểm kết thúc một lần chạy mô-đun.

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

Báo cáo thời điểm bắt đầu chạy một mô-đun. Lệnh gọi lại này được liên kết với testModuleEnded() và không bắt buộc trong chuỗi. Thao tác này chỉ được dùng trong quá trình chạy sử dụng các mô-đun: trình chạy dựa trên bộ.

Tham số
moduleContext	IInvocationContext: IInvocationContext của mô-đun.

testRunEnded

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

Báo cáo thời điểm kết thúc một lần chạy kiểm thử. FIXME: Chúng ta không thể có hai giao diện Map<> có kiểu khác nhau, vì vậy, chúng ta phải sử dụng HashMap ở đây.

Tham số
elapsedTimeMillis	long: thiết bị đã báo cáo thời gian đã trôi qua, tính bằng mili giây
runMetrics	HashMap: các cặp khoá-giá trị được báo cáo ở cuối một lần chạy kiểm thử bằng Metric.

testRunFailed

public final void testRunFailed (FailureDescription failure)

Không hoàn tất được quá trình chạy thử báo cáo do lỗi được mô tả bằng FailureDescription.

Tham số
failure	FailureDescription: FailureDescription mô tả lỗi và ngữ cảnh của lỗi đó.

testRunFailed

public final void testRunFailed (String errorMessage)

Không thể hoàn tất quá trình chạy thử báo cáo do gặp lỗi nghiêm trọng.

Tham số
errorMessage	String: String mô tả lý do khiến lần chạy không thành công.

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

Báo cáo thời điểm bắt đầu một lần chạy kiểm thử.

Tham số
runName	String: tên của lần chạy kiểm thử
testCount	int: tổng số kiểm thử trong lần chạy kiểm thử
attemptNumber	int: số thứ tự, xác định các lần thử khác nhau của cùng một runName chạy nhiều lần. attemptNumber được lập chỉ mục từ 0 và sẽ tăng lên mỗi khi có một lần chạy mới. Ví dụ: Một bài kiểm thử được thử lại chi tiết 3 lần, thì bài kiểm thử đó sẽ có tổng cộng 4 lần chạy trong cùng một runName và attemptNumber sẽ từ 0 đến 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Báo cáo thời điểm bắt đầu một lần chạy kiểm thử.

Tham số
runName	String: tên của lần chạy kiểm thử
testCount	int: tổng số kiểm thử trong lần chạy kiểm thử

testRunStarted

public void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

Báo cáo thời điểm bắt đầu một lần chạy kiểm thử.

Tham số
runName	String: tên của lần chạy kiểm thử
testCount	int: tổng số kiểm thử trong lần chạy kiểm thử
attemptNumber	int: số thứ tự, xác định các lần thử khác nhau của cùng một runName chạy nhiều lần. attemptNumber được lập chỉ mục từ 0 và sẽ tăng lên mỗi khi có một lần chạy mới. Ví dụ: Một bài kiểm thử được thử lại chi tiết 3 lần, thì bài kiểm thử đó sẽ có tổng cộng 4 lần chạy trong cùng một runName và attemptNumber sẽ từ 0 đến 3.
startTime	long: thời gian bắt đầu chạy, được đo bằng System.currentTimeMillis()

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

Được gọi khi một bài kiểm thử bị bỏ qua và không thực thi vì một lý do thường không mong muốn. Các kiểm thử này sẽ được thử lại để cố gắng thực hiện đúng cách.

Tham số
test	TestDescription: xác định kiểm thử
reason	SkipReason: SkipReason

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

Phương án thay thế cho testStarted(TestDescription), trong đó chúng ta cũng chỉ định thời điểm bắt đầu kiểm thử, kết hợp với testEnded(TestDescription,long,Map) để đo lường chính xác.

Tham số
test	TestDescription: xác định kiểm thử
startTime	long: thời gian bắt đầu kiểm thử, được đo bằng System.currentTimeMillis()

testStarted

public final void testStarted (TestDescription test)

Báo cáo thời điểm bắt đầu một trường hợp kiểm thử riêng lẻ. Giao diện cũ, nên dùng testStarted(TestDescription) bất cứ khi nào có thể.

Tham số
test	TestDescription: xác định kiểm thử

Phương thức được bảo vệ

afterModuleEnd

protected void afterModuleEnd ()

beforeModuleStart

protected void beforeModuleStart ()

createModuleChildReference

protected TestRecordProto.ChildReference createModuleChildReference (TestRecordProto.TestRecord record)

Tạo một tham chiếu con cho một mô-đun.

Tham số
record	TestRecordProto.TestRecord

Trả về
TestRecordProto.ChildReference