SubprocessResultsReporter

public class SubprocessResultsReporter
extends Object implements ILogSaverListener, ISupportGranularResults, ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.SubprocessResultsReporter

Các lớp con trực tiếp đã biết LegacySubprocessResultsReporter LegacySubprocessResultsReporter Việc triển khai báo cáo kết quả quy trình con bị đóng băng sẽ vẫn tương thích với các phiên bản TF/CTS trước đó (ví dụ: 8 trở lên), mặc dù có thay đổi trong siêu lớp của báo cáo.

---

Triển khai ITestInvocationListener được chỉ định là trình báo cáo kết quả và chuyển tiếp từ quy trình con kết quả kiểm thử, lần chạy kiểm thử, lệnh gọi kiểm thử.

Tóm tắt

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

Phương thức công khai
void	close()
TestSummary	getSummary() Cho phép InvocationListener trả về một bản tóm tắt.
void	invocationEnded(long elapsedTime) Báo cáo rằng lệnh gọi đã kết thúc, 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	invocationStarted(IInvocationContext context) Báo cáo thời điểm bắt đầu lệnh gọi kiểm thử.
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 một 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, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) trực tiếp.
void	printEvent(String key, Object event) Trình trợ giúp để in khoá sự kiện, sau đó là đối tượng json.
void	setOutputTestLog(boolean outputTestLog) Đặt xem chúng ta có nên xuất kết quả kiểm thử được ghi nhật ký hay không.
boolean	supportGranularResults() Trả về True nếu trình báo cáo hỗ trợ kết quả chi tiết, trả về false nếu không.
void	testAssumptionFailure(TestDescription testId, String trace) Được gọi khi một kiểm thử nguyên tử gắn cờ giả định một điều kiện là sai
void	testAssumptionFailure(TestDescription testId, FailureDescription failure) Được gọi khi một kiểm thử nguyên tử gắn cờ giả định một điều kiện là sai
void	testEnded(TestDescription testId, long endTime, metrics) Thay thế ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), trong đó chúng ta có thể chỉ định thời gian kết thúc trực tiếp.
void	testEnded(TestDescription testId, metrics) Báo cáo kết thúc quá trình thực thi của một trường hợp kiểm thử riêng lẻ.
void	testFailed(TestDescription testId, FailureDescription failure) Báo cáo lỗi của một trường hợp kiểm thử riêng lẻ.
void	testFailed(TestDescription testId, String reason) Báo cáo lỗi của một trường hợp kiểm thử riêng lẻ.
void	testIgnored(TestDescription testId) Được gọi khi một 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.
void	testLog(String dataName, LogDataType dataType, InputStreamSource dataStream) Cung cấp nhật ký hoặc dữ liệu gỡ lỗi liên quan từ lệnh gọi kiểm thử.
void	testModuleEnded() Báo cáo kết thúc quá trình chạy mô-đun.
void	testModuleStarted(IInvocationContext moduleContext) Báo cáo thời điểm bắt đầu chạy một mô-đun.
void	testRunEnded(long time, runMetrics) Báo cáo kết thúc quá trình chạy kiểm thử.
void	testRunFailed(FailureDescription failure) Không thể hoàn tất quá trình chạy kiểm thử báo cáo do lỗi do FailureDescription mô tả.
void	testRunFailed(String reason) Không thể hoàn tất quá trình chạy kiểm thử báo cáo do 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 chạy kiểm thử.
void	testRunStarted(String runName, int testCount) Báo cáo thời điểm bắt đầu 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 chạy kiểm thử.
void	testRunStopped(long arg0) Quá trình chạy kiểm thử báo cáo đã dừng trước khi hoàn tất do yêu cầu của người dùng.
void	testSkipped(TestDescription testId, SkipReason reason) Được gọi khi một kiểm thử bị bỏ qua và không thực thi vì một lý do không thường xảy ra.
void	testStarted(TestDescription testId, long startTime) Thay thế cho testStarted(com.android.tradefed.result.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 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) để đo lường chính xác.
void	testStarted(TestDescription testId) Báo cáo thời điểm bắt đầu một trường hợp kiểm thử riêng lẻ.

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

SubprocessResultsReporter

public SubprocessResultsReporter ()

Phương thức công khai

đóng

public void close ()

getSummary

public TestSummary getSummary ()

Cho phép InvocationListener trả về một bản tóm tắt.

Giá trị trả về
TestSummary	TestSummary tóm tắt quá trình chạy hoặc giá trị rỗng

invocationEnded

public void invocationEnded (long elapsedTime)

Báo cáo rằng lệnh gọi đã kết thúc, 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

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. Trình báo cáo cần ghi đè phương thức này để hỗ trợ báo cáo nhiều thiết bị.

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

logAssociation

public 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 một 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, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.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 mạnh mẽ một cách rõ ràng.

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

printEvent

public void printEvent (String key, 
                Object event)

Trình trợ giúp để in khoá sự kiện, sau đó là đối tượng json.

Tham số
key	String
event	Object

setOutputTestLog

public void setOutputTestLog (boolean outputTestLog)

Đặt xem chúng ta có nên xuất kết quả kiểm thử được ghi nhật ký hay không.

Tham số
outputTestLog	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 nếu không.

Giá trị trả về
boolean

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                String trace)

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

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

testAssumptionFailure

public void testAssumptionFailure (TestDescription testId, 
                FailureDescription failure)

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

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

testEnded

public void testEnded (TestDescription testId, 
                long endTime, 
                 metrics)

Thay thế ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), trong đó chúng ta có thể chỉ định thời gian kết thúc trực tiếp. Kết hợp với testStarted(com.android.tradefed.result.TestDescription, long) để đo lường chính xác.

Tham số
testId	TestDescription: xác định kiểm thử
endTime	long: thời gian kiểm thử kết thúc, được đo lường thông qua System.currentTimeMillis()
metrics	: ERROR(/Map) của các chỉ số được phát ra

testEnded

public void testEnded (TestDescription testId, 
                 metrics)

Báo cáo 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 đã vượt qua. Ngoài ra, hàm này còn trả về mọi chỉ số khoá/giá trị có thể đã được phát ra trong quá trình thực thi trường hợp kiểm thử.

Tham số
testId	TestDescription: xác định kiểm thử
metrics	: ERROR(/Map) của các chỉ số được phát ra

testFailed

public void testFailed (TestDescription testId, 
                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ố
testId	TestDescription: xác định kiểm thử
failure	FailureDescription: FailureDescription mô tả lỗi và ngữ cảnh của lỗi đó.

testFailed

public void testFailed (TestDescription testId, 
                String reason)

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ố
testId	TestDescription: xác định kiểm thử
reason	String: dấu vết ngăn xếp của lỗi

testIgnored

public void testIgnored (TestDescription testId)

Được gọi khi một 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ố
testId	TestDescription: xác định kiểm thử

testLog

public void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

Cung cấp nhật ký hoặc dữ liệu gỡ lỗi liên quan từ lệnh gọi kiểm thử.

Phải được gọi trước ERROR(/ITestInvocationListener#invocationFailed(Throwable)) hoặc ERROR(/ITestInvocationListener#invocationEnded(long))

Khung TradeFederation sẽ tự động gọi phương thức này, cung cấp nhật ký máy chủ và nếu có, logcat của thiết bị.

Tham số
dataName	String: tên mô tả String của dữ liệu. Ví dụ: "device_logcat". Lưu ý: dataName có thể không phải là duy nhất cho mỗi lệnh gọi. Tức là trình triển khai phải có khả năng xử lý nhiều lệnh gọi có cùng dataName
dataType	LogDataType: LogDataType của dữ liệu
dataStream	InputStreamSource: InputStreamSource của dữ liệu. Người triển khai nên gọi createInputStream để bắt đầu đọc dữ liệu và đảm bảo đóng InputStream thu được khi hoàn tất. Phương thức gọi phải đảm bảo nguồn dữ liệu vẫn có và có thể truy cập được cho đến khi phương thức testLog hoàn tất.

testModuleEnded

public void testModuleEnded ()

Báo cáo kết thúc quá trình chạy mô-đun.

testModuleStarted

public 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 trình tự. Tệp 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 void testRunEnded (long time, 
                 runMetrics)

Báo cáo kết thúc quá trình chạy kiểm thử.

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

testRunFailed

public void testRunFailed (FailureDescription failure)

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

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

testRunFailed

public void testRunFailed (String reason)

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

Tham số
reason	String: String mô tả lý do không chạy được.

testRunStarted

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

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

Tham số
runName	String: tên lần chạy kiểm thử
testCount	int: tổng số bài 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à phải tăng lên mỗi khi một lần chạy mới diễn ra. Ví dụ: Một kiểm thử được thử lại chi tiết 3 lần, thì tổng số lần chạy sẽ là 4 lần trong cùng một runName và attemptNumber sẽ từ 0 đến 3.

testRunStarted

public void testRunStarted (String runName, 
                int testCount)

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

Tham số
runName	String: tên lần chạy kiểm thử
testCount	int: tổng số bài 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 chạy kiểm thử.

Tham số
runName	String: tên lần chạy kiểm thử
testCount	int: tổng số bài 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à phải tăng lên mỗi khi một lần chạy mới diễn ra. Ví dụ: Một kiểm thử được thử lại chi tiết 3 lần, thì tổng số lần chạy sẽ là 4 lần 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 lường thông qua System.currentTimeMillis()

testRunStopped

public void testRunStopped (long arg0)

Quá trình chạy kiểm thử báo cáo đã dừng trước khi hoàn tất do yêu cầu của người dùng.

TODO: currently unused, consider removing

Tham số
arg0	long: thời gian đã trôi qua do thiết bị báo cáo, tính bằng mili giây

testSkipped

public void testSkipped (TestDescription testId, 
                SkipReason reason)

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

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

testStarted

public void testStarted (TestDescription testId, 
                long startTime)

Thay thế cho testStarted(com.android.tradefed.result.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 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) để đo lường chính xác.

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

testStarted

public void testStarted (TestDescription testId)

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 sử dụng testStarted(com.android.tradefed.result.TestDescription) bất cứ khi nào có thể.

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