Bộ xử lý BasePost
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
java.lang.Object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
IPostProcessor
cơ sở mà mọi hoạt động triển khai đều cần mở rộng. Đảm bảo rằng bài đăng
được gọi trước người báo cáo kết quả cuối cùng.
Tóm tắt
Hàm khởi tạo công khai | |
---|---|
BasePostProcessor()
|
Phương thức công khai | |
---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Bước khởi động của trình xử lý bài đăng. |
final
void
|
invocationEnded(long elapsedTime)
Báo cáo rằng lệnh gọi đã kết thúc, dù thành công hay do một số lỗi . |
final
void
|
invocationFailed(FailureDescription failure)
Báo cáo lệnh gọi không hoàn tất do một số điều kiện lỗi. |
final
void
|
invocationFailed(Throwable cause)
Báo cáo lệnh gọi không hoàn tất do một số điều kiện lỗi. |
void
|
invocationSkipped(SkipReason reason)
Báo cáo lệnh gọi là bị bỏ qua |
final
void
|
invocationStarted(IInvocationContext context)
Trình nghe lời gọi để chuyển tiếp |
final
boolean
|
isDisabled()
Trả về True nếu toàn bộ đối tượng bị tắt (bỏ qua cả quá trình thiết lập và chia nhỏ). |
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 một trường hợp kiểm thử, nhưng phải có cơ hội thực hiện
cứ vậy, trên Cập nhật liên kết nhật ký để kiểm tra. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Triển khai phương thức này để tổng hợp chỉ số và nhật ký trên tất cả các chương trình kiểm thử. |
abstract
|
processRunMetricsAndLogs(
Triển khai phương pháp này để tạo tập hợp các chỉ số mới từ các chỉ số và nhật ký. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Triển khai phương thức này để đăng các chỉ số và nhật ký xử lý từ mỗi lượt kiểm thử. |
final
void
|
setLogSaver(ILogSaver logSaver)
Đặt |
void
|
setUp()
Ghi đè phương thức này trong trình xử lý bài đăng con để khởi chạy trước khi chạy kiểm thử. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Được gọi khi một phép kiểm thử nguyên tử gắn cờ cho một điều kiện là false |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Được gọi khi một phép kiểm thử nguyên tử gắn cờ cho một điều kiện là false |
final
void
|
testEnded(TestDescription test, long endTime,
Thay thế cho |
final
void
|
testEnded(TestDescription test,
Báo cáo việc kết thúc 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 bài kiểm thử không được chạy, thường là vì một phương thức kiểm thử được chú thích bằng org.junit.Ignore. |
final
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Sử dụng phương thức này để ghi nhật ký một tệp từ quá trình triển khai PostProcessor. |
final
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Được gọi khi nhật ký kiểm thử được lưu. |
final
void
|
testModuleEnded()
Báo cáo khi kết thúc chạy mô-đun. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Báo cáo việc bắt đầu một mô-đun đang chạy. |
final
void
|
testRunEnded(long elapsedTime,
Báo cáo kết thúc lần chạy thử nghiệm. |
final
void
|
testRunFailed(FailureDescription failure)
Không hoàn tất được quá trình chạy thử nghiệm báo cáo do lỗi theo mô tả trong |
final
void
|
testRunFailed(String errorMessage)
Không hoàn tất được quá trình chạy thử nghiệm báo cáo do xảy ra lỗi nghiêm trọng. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Báo cáo thời điểm bắt đầu chạy kiểm thử. |
final
void
|
testRunStarted(String runName, int testCount)
Kiểm thử chạy lệnh gọi lại |
final
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ử. |
final
void
|
testRunStopped(long elapsedTime)
Đã dừng chạy thử nghiệm báo cáo trước khi hoàn tất do có yêu cầu của người dùng. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Được gọi khi một chương trình kiểm thử bị bỏ qua và không thực thi vì một lý do thường không như mong đợi. |
final
void
|
testStarted(TestDescription test, long startTime)
Thay thế cho |
final
void
|
testStarted(TestDescription test)
Lệnh gọi lại trường hợp kiểm thử |
Phương thức được bảo vệ | |
---|---|
void
|
cleanUp()
|
MetricMeasurement.DataType
|
getMetricType()
Hãy ghi đè phương thức này để thay đổi loại chỉ số (nếu cần). |
String
|
getRunName()
|
Hàm khởi tạo công khai
Bộ xử lý BasePost
public BasePostProcessor ()
Phương thức công khai
khởi tạo
public final ITestInvocationListener init (ITestInvocationListener listener)
Bước khởi động của trình xử lý bài đăng. Đảm bảo được gọi trước bất kỳ hoạt động kiểm thử nào lệnh gọi lại.
Tham số | |
---|---|
listener |
ITestInvocationListener |
Giá trị trả về | |
---|---|
ITestInvocationListener |
gọi đã kết thúc
public final void invocationEnded (long elapsedTime)
Báo cáo rằng lệnh gọi đã kết thúc, dù thành công hay do một số 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 |
kích hoạt không thành công
public final void invocationFailed (FailureDescription failure)
Báo cáo lệnh gọi không hoàn tất 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 lỗi |
kích hoạt không thành công
public final void invocationFailed (Throwable cause)
Báo cáo lệnh gọi không hoàn tất do một số điều kiện lỗi.
Sẽ được khung TradeFederation tự động gọi.
Tham số | |
---|---|
cause |
Throwable : Throwable nguyên nhân gây ra lỗi |
Đã bỏ qua lệnh gọi
public void invocationSkipped (SkipReason reason)
Báo cáo lệnh gọi là bị bỏ qua
Tham số | |
---|---|
reason |
SkipReason |
đã kích hoạt
public final void invocationStarted (IInvocationContext context)
Trình nghe lời gọi để chuyển tiếp
Tham số | |
---|---|
context |
IInvocationContext : thông tin về lệnh gọi |
Đã tắt
public final boolean isDisabled ()
Trả về True nếu toàn bộ đối tượng bị tắt (bỏ qua cả quá trình thiết lập và chia nhỏ). Nếu không thì là False.
Giá trị trả về | |
---|---|
boolean |
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 một trường hợp kiểm thử, nhưng phải có cơ hội thực hiện
cứ vậy, trên testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
trực tiếp
không thể gọi lại. Do đó, lệnh gọi lại này cho phép cung cấp mối liên kết chặt chẽ
một cách rõ ràng.
Cập nhật liên kết nhật ký để kiểm tra. Nếu phương thức này được gọi trong quá trình kiểm thử, thì nhật ký thuộc về thử nghiệm; nếu không thì đó sẽ là nhật ký chạy.
Tham số | |
---|---|
dataName |
String : Tên của dữ liệu |
logFile |
LogFile : LogFile đã được ghi lại trước đó và nên được liên kết với
trường hợp kiểm thử. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Triển khai phương thức này để tổng hợp chỉ số và nhật ký trên tất cả các chương trình kiểm thử. Các chỉ số bắt nguồn từ phương thức này sẽ được trình báo cáo dưới dạng chỉ số chạy. Bạn chỉ nên tạo các chỉ số mới được tạo được trả về và với tên khoá duy nhất (không được phép xung đột với các khoá hiện có).
Tham số | |
---|---|
allTestMetrics |
ListMultimap : Một HashMultimap lưu trữ các chỉ số từ mỗi lượt kiểm thử được nhóm theo chỉ số
tên. |
allTestLogs |
: Một bản đồ lưu trữ bản đồ các tệp nhật ký của mỗi kiểm thử được khoá theo tên dữ liệu,
bằng cách sử dụng TestDescription của mỗi bài kiểm thử làm khoá. |
Giá trị trả về | |
---|---|
|
Tập hợp các chỉ số mới được tạo từ tất cả các chỉ số kiểm thử. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Triển khai phương pháp này để tạo tập hợp các chỉ số mới từ các chỉ số và nhật ký. Hệ thống chỉ trả về các chỉ số mới tạo và có tên khoá duy nhất (không xung đột với các khoá hiện có).
Tham số | |
---|---|
rawMetrics |
: Tập hợp các chỉ số thô có sẵn để chạy. |
runLogs |
: Tập hợp các tệp nhật ký cho lần chạy kiểm thử. |
Giá trị trả về | |
---|---|
|
Tập hợp các chỉ số mới được tạo từ các chỉ số chạy. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Triển khai phương thức này để đăng các chỉ số và nhật ký xử lý từ mỗi lượt kiểm thử. Chỉ có chỉ số đã tạo sẽ được trả về và với tên khoá duy nhất (không xung đột với các khoá được phép).
Tham số | |
---|---|
testDescription |
TestDescription : Đối tượng TestDescription mô tả kiểm thử. |
testMetrics |
: Tập hợp các chỉ số của phép kiểm thử. |
testLogs |
: Tập hợp các tệp được ghi lại trong quá trình kiểm thử. |
Giá trị trả về | |
---|---|
|
Tập hợp các chỉ số mới được tạo từ các chỉ số kiểm thử. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Đặt ILogSaver
để cho phép trình triển khai lưu tệp.
Tham số | |
---|---|
logSaver |
ILogSaver : ILogSaver |
thiết lập
public void setUp ()
Ghi đè phương thức này trong trình xử lý bài đăng con để khởi chạy trước khi chạy kiểm thử.
thử nghiệmAssumptionKhông thành công
public final void testAssumptionFailure (TestDescription test, String trace)
Được gọi khi một phép kiểm thử nguyên tử gắn cờ cho một điều kiện là false
Tham số | |
---|---|
test |
TestDescription : xác định kiểm thử |
trace |
String : dấu vết ngăn xếp của lỗi |
thử nghiệmAssumptionKhông thành công
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Được gọi khi một phép kiểm thử nguyên tử gắn cờ cho một điều kiện là false
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. |
thử nghiệm đã kết thúc
public final void testEnded (TestDescription test, long endTime,testMetrics)
Thay thế cho 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ố | |
---|---|
test |
TestDescription : xác định kiểm thử |
endTime |
long : thời gian thử nghiệm kết thúc, được đo bằng System.currentTimeMillis() |
testMetrics |
: ERROR(/Map) trong số các chỉ số được đưa ra |
thử nghiệm đã kết thúc
public final void testEnded (TestDescription test,testMetrics)
Báo cáo việc kết thúc thực thi của một trường hợp kiểm thử riêng lẻ.
Nếu bạn không gọi testFailed(TestDescription, FailureDescription)
, thì kiểm thử này đã thành công. Cũng trả về bất kỳ khoá/giá trị nào
các chỉ số có thể được phát ra 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 |
: ERROR(/Map) trong số các chỉ số được đưa ra |
thử nghiệm không thành công
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 trong khoảng thời gian giữa testStarted và testCancelled.
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. |
thử nghiệm không thành công
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 trong khoảng thời gian giữa testStarted và testCancelled.
Tham số | |
---|---|
test |
TestDescription : xác định kiểm thử |
trace |
String : dấu vết ngăn xếp của lỗi |
Đã bỏ qua kiểm thử
public final void testIgnored (TestDescription test)
Được gọi khi một bài kiểm thử không được chạy, thường là vì 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ử |
nhật ký kiểm thử
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Sử dụng phương thức này để ghi nhật ký một tệp từ quá trình triển khai PostProcessor.
Tham số | |
---|---|
dataName |
String : tên mô tả String của dữ liệu. ví dụ: "device_logcat". Ghi chú
dataName không được là duy nhất cho mỗi lệnh gọi. tức là người 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. Trình triển khai nên gọi
createInputStream để bắt đầu đọc dữ liệu và đảm bảo đóng kết quả
InputStream khi hoàn tất. Phương thức gọi phải đảm bảo giữ lại nguồn dữ liệu
có sẵn và có thể truy cập được cho đến khi phương thức testLog hoàn tất. |
testLog đã lưu
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Được gọi khi nhật ký kiểm thử được lưu.
Nên được sử dụng thay cho ITestInvocationListener#testLog(String, LogDataType,
InputStreamSource)
.
Tham số | |
---|---|
dataName |
String : tên mô tả String của dữ liệu. ví dụ: "device_logcat". Ghi chú
dataName không được là duy nhất cho mỗi lệnh gọi. tức là người 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. Trình triển khai nên gọi
createInputStream để bắt đầu đọc dữ liệu và đảm bảo đóng kết quả
InputStream khi hoàn tất. |
logFile |
LogFile : LogFile chứa siêu dữ liệu của tệp đã lưu. |
thử nghiệmMô-đun đã kết thúc
public final void testModuleEnded ()
Báo cáo khi kết thúc chạy mô-đun.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Báo cáo việc bắt đầu một mô-đun đang chạy. 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ự. Chỉ được dùng trong lần chạy có sử dụng
mô-đun: trình chạy dựa trên bộ sản phẩm.
Tham số | |
---|---|
moduleContext |
IInvocationContext : IInvocationContext của mô-đun. |
testRun kết thúc
public final void testRunEnded (long elapsedTime,runMetrics)
Báo cáo kết thúc lần chạy thử nghiệm. FIXME: Chúng tôi không thể có hai Bản đồ<> giao diện khác loại, vì vậy, chúng tôi phải sử dụng HashMap ở đây.
Tham số | |
---|---|
elapsedTime |
long : thời gian đã trôi qua theo báo cáo của thiết bị, tính bằng mili giây |
runMetrics |
: các cặp khoá-giá trị được báo cáo khi kết thúc lượt chạy kiểm thử bằng Metric . |
testRunFailed không thành công
public final void testRunFailed (FailureDescription failure)
Không hoàn tất được quá trình chạy thử nghiệm báo cáo do lỗi theo mô tả trong FailureDescription
.
Tham số | |
---|---|
failure |
FailureDescription : FailureDescription mô tả lỗi và ngữ cảnh của lỗi. |
testRunFailed không thành công
public final void testRunFailed (String errorMessage)
Không hoàn tất được quá trình chạy thử nghiệm báo cáo do xảy ra lỗi nghiêm trọng.
Tham số | |
---|---|
errorMessage |
String : String mô tả lý do không chạy được. |
Đã bắt đầu kiểm thử
public final 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 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. Số tryNumber được lập chỉ mục 0 và sẽ tăng mỗi lần
một lần chạy mới sẽ xảy ra. ví dụ: Một quy trình kiểm thử chi tiết được thử lại 3 lần, kết quả sẽ có tổng cộng 4 lần
chạy trong cùng một runName và cố gắng dùng số là từ 0 đến 3. |
Đã bắt đầu kiểm thử
public final void testRunStarted (String runName, int testCount)
Kiểm thử chạy lệnh gọi lại
Tham số | |
---|---|
runName |
String : tên chạy kiểm thử |
testCount |
int : tổng số kiểm thử trong lần chạy kiểm thử |
Đã bắt đầu kiểm thử
public final 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 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. Số tryNumber được lập chỉ mục 0 và sẽ tăng mỗi khi một
lần chạy mới sẽ diễn ra. ví dụ: Một bài kiểm thử được thử lại ở cấp độ chi tiết 3 lần, và tổng cộng sẽ có 4 lần chạy
trong cùng một runName và cố gắngNumber là từ 0 đến 3. |
startTime |
long : thời gian bắt đầu chạy, được đo bằng System.currentTimeMillis() |
testRunSĐã dừng
public final void testRunStopped (long elapsedTime)
Đã dừng chạy thử nghiệm báo cáo trước khi hoàn tất do có yêu cầu của người dùng.
VIỆC CẦN LÀM: hiện không sử dụng, hãy cân nhắc xoá
Tham số | |
---|---|
elapsedTime |
long : thời gian đã trôi qua theo báo cáo của thiết bị, tính bằng mili giây |
Đã bỏ qua kiểm thử
public final void testSkipped (TestDescription test, SkipReason reason)
Được gọi khi một chương trình kiểm thử bị bỏ qua và không thực thi vì một lý do thường không như mong đợi. Hệ thống sẽ thử lại các lượt kiểm thử này để có được lượt thực thi phù hợp.
Tham số | |
---|---|
test |
TestDescription : xác định kiểm thử |
reason |
SkipReason : SkipReason |
đã bắt đầu thử nghiệm
public final void testStarted (TestDescription test, long startTime)
Thay thế cho testStarted(com.android.tradefed.result.TestDescription)
, trong đó chúng ta cũng chỉ định thời điểm 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ố | |
---|---|
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() |
đã bắt đầu thử nghiệm
public final void testStarted (TestDescription test)
Lệnh gọi lại trường hợp kiểm thử
Tham số | |
---|---|
test |
TestDescription : xác định kiểm thử |
Phương thức được bảo vệ
dọn dẹp
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Hãy ghi đè phương thức này để thay đổi loại chỉ số (nếu cần). Theo mặc định, chỉ số được đặt thành loại đã xử lý.
Giá trị trả về | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Giá trị trả về | |
---|---|
String |