ResultDBReporter
public
class
ResultDBReporter
extends Object
implements
IConfigurationReceiver,
ILogSaverListener,
ISupportGranularResults,
ITestSummaryListener
| java.lang.Object | |
| ↳ | com.android.tradefed.result.resultdb.ResultDBReporter |
Trình báo cáo kết quả tải kết quả kiểm thử lên ResultDB.
Tóm tắt
Trường | |
|---|---|
protected
IInvocationContext |
mContext
|
protected
boolean |
mEnableAlTestProperties
|
Hàm khởi tạo công khai | |
|---|---|
ResultDBReporter()
|
|
Phương thức công khai | |
|---|---|
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ờ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ử. |
boolean
|
isDisabled()
|
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 |
void
|
setConfiguration(IConfiguration configuration)
Chèn |
void
|
setLogSaver(ILogSaver logSaver)
Đặt |
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. |
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 |
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 |
void
|
testEnded(TestDescription test, long endTime, HashMap<String, MetricMeasurement.Metric> testMetrics)
Phương án thay thế cho |
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ẻ. |
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ẻ. |
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ẻ. |
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. |
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Cung cấp nhật ký hoặc dữ liệu gỡ lỗi được liên kết từ lệnh gọi kiểm thử. |
void
|
testModuleEnded()
Báo cáo thời điểm kết thúc một lần 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 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ử. |
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 |
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ử. |
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ử. |
void
|
testRunStopped(long elapsedTime)
Chạy thử báo cáo bị dừng trước khi hoàn tất do người dùng yêu cầu. |
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. |
void
|
testStarted(TestDescription test, long startTime)
Phương án thay thế cho |
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ẻ. |
void
|
uploadStoragePath(String resourceId, String storagePath, LogFile logFile)
Tải đường dẫn lưu trữ của một cấu phần phần mềm kiểm thử AnTS lên ResultDB. |
Trường
mEnableAlTestProperties
protected boolean mEnableAlTestProperties
Hàm khởi tạo công khai
ResultDBReporter
public ResultDBReporter ()
Phương thức công khai
getSummary
public TestSummary getSummary ()
Cho phép InvocationListener trả về một bản tóm tắt.
| Giá trị trả về | |
|---|---|
TestSummary |
Một TestSummary tóm tắt lượt chạy hoặc có giá trị rỗng |
invocationEnded
public 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 |
isDisabled
public boolean isDisabled ()
| Giá trị trả về | |
|---|---|
boolean |
|
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 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ử. |
setConfiguration
public void setConfiguration (IConfiguration configuration)
Chèn IConfiguration đang dùng.
| Tham số | |
|---|---|
configuration |
IConfiguration |
setLogSaver
public void setLogSaver (ILogSaver logSaver)
Đặt ILogSaver để cho phép người triển khai lưu tệp.
| Tham số | |
|---|---|
logSaver |
ILogSaver: ILogSaver |
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 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 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 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 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 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 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ử |
testLog
public void testLog (String dataName,
LogDataType dataType,
InputStreamSource dataStream)Cung cấp nhật ký hoặc dữ liệu gỡ lỗi được liên kết từ lệnh gọi kiểm thử.
Phải được gọi trước ERROR(ITestInvocationListener.invocationFailed(Throwable)/ITestInvocationListener#invocationFailed(java.lang.Throwable) 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ủ lưu trữ và nếu có thể, nhật ký 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à người triển khai phải có thể 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 kết quả khi hoàn tất. Phương thức gọi phải đảm bảo nguồn dữ liệu vẫn hiện diện và có thể truy cập cho đến khi phương thức testLog hoàn tất. |
testModuleEnded
public void testModuleEnded ()
Báo cáo thời điểm kết thúc một lần 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 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 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 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 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 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() |
testRunStopped
public void testRunStopped (long elapsedTime)
Chạy thử báo cáo bị dừng trước khi hoàn tất do người dùng yêu cầu.
TODO: currently unused, consider removing
| Tham số | |
|---|---|
elapsedTime |
long: thiết bị đã báo cáo thời gian đã trôi qua, tính bằng mili giây |
testSkipped
public 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 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 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ử |
uploadStoragePath
public void uploadStoragePath (String resourceId,
String storagePath,
LogFile logFile)Tải đường dẫn lưu trữ của một cấu phần phần mềm kiểm thử AnTS lên ResultDB.
Đây là giải pháp tạm thời cho việc di chuyển từ AnTS sang ResultDB (xem go/convergence-tr). Phương thức này sẽ được trình báo cáo AnTS gọi khi đường dẫn lưu trữ của một cấu phần phần mềm có sẵn.
Trình báo cáo AnTS đảm bảo sẽ gọi phương thức này cho mọi cấu phần phần mềm mà trình báo cáo tải lên. Đến lượt, trình báo cáo này sẽ tải tất cả các cấu phần phần mềm như vậy lên ResultDB cùng với mối liên kết kiểm thử chính xác. Để liên kết nhật ký chính xác,bạn phải gọi logAssociation(String,LogFile) cho cùng một mã tài nguyên trước đó. Điều này đảm bảo rằng cấu phần phần mềm đã được theo dõi. Nếu không, cấu phần phần mềm sẽ được liên kết với đơn vị công việc cấp cao nhất của lệnh gọi tradefed.
Bạn không được gọi phương thức này trước invocationStarted(IInvocationContext). Bạn có thể gọi phương thức này sau invocationEnded(long) cho các lệnh gọi do hệ thống nguồn quản lý, vì các lệnh gọi này không được trình báo cáo này hoàn tất. Điều này không áp dụng cho các lệnh gọi được tạo cục bộ và được hoàn tất trong invocationEnded(long).
TODO(b/464941055): Xoá phương thức này sau khi chúng ta có thể di chuyển đúng cách các cấu phần phần mềm AnTS sang ResultDB.
| Tham số | |
|---|---|
resourceId |
String: Mã nhận dạng tài nguyên của cấu phần phần mềm. |
storagePath |
String: Đường dẫn lưu trữ của cấu phần phần mềm (ví dụ: đường dẫn /bigstore/). |
logFile |
LogFile: Đối tượng LogFile được liên kết với cấu phần phần mềm. |