BasePostProcessor
public abstract class BasePostProcessor
extends Object
implements IPostProcessor
java.lang.Object | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
IPostProcessor
cơ sở mà mọi triển khai sẽ mở rộng. Đảm bảo rằng các phương thức xử lý bài đăng được gọi trước khi trình báo kết quả cuối cùng.
Bản tóm tắt
Nhà thầu xây dựng công cộng | |
---|---|
BasePostProcessor () |
Phương pháp công khai | |
---|---|
final ITestInvocationListener | init ( ITestInvocationListener listener) Bước khởi tạo của bộ xử lý bài. |
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ố điều kiện lỗi. |
final void | invocationFailed ( FailureDescription failure) Báo cáo lệnh gọi không đầy đủ do một số tình trạng lỗi. |
final void | invocationFailed (Throwable cause) Báo cáo lệnh gọi không đầy đủ do một số tình trạng lỗi. |
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ị vô hiệu hóa (bỏ qua cả thiết lập và phân tích). |
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 thử nghiệm, nhưng cơ hội thực hiện điều đó trên Cập nhật liên kết đăng nhập để kiểm tra. |
processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) Triển khai phương pháp này để tổng hợp số liệu và nhật ký trên tất cả các thử nghiệm. | |
abstract | processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) Triển khai phương pháp này để tạo một tập hợp số liệu mới từ các số liệu và nhật ký hiện có. |
processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) Triển khai phương pháp này để đăng số liệu và nhật ký quy trình từ mỗi lần kiểm tra. | |
final void | setLogSaver ( ILogSaver logSaver) Đặt |
void | setUp () Ghi đè phương thức này trong bộ xử lý bài con để khởi tạo trước khi chạy thử nghiệm. |
final void | testAssumptionFailure ( TestDescription test, String trace) Được gọi khi một bài kiểm tra nguyên tử đánh dấu rằng nó giả định một điều kiện sai |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) Được gọi khi một bài kiểm tra nguyên tử đánh dấu rằng nó giả định một điều kiện sai |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Thay thế cho |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Báo cáo kết thúc thực hiện của một trường hợp thử nghiệm riêng lẻ. |
final void | testFailed ( TestDescription test, FailureDescription failure) Báo cáo sự thất bại của một trường hợp thử nghiệm riêng lẻ. |
final void | testFailed ( TestDescription test, String trace) Báo cáo sự thất bại của một trường hợp thử nghiệm riêng lẻ. |
final void | testIgnored ( TestDescription test) Được gọi khi thử nghiệm không được chạy, thường là do phương thức thử nghiệm được chú thích bằng org.junit.Ignore. |
final void | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Sử dụng phương pháp này để ghi nhật ký 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 tra được lưu. |
final void | testModuleEnded () Báo cáo kết thúc chạy mô-đun. |
final void | testModuleStarted ( IInvocationContext moduleContext) Báo cáo sự bắt đầu của một mô-đun đang chạy. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Báo cáo kết thúc quá trình chạy thử. |
final void | testRunFailed ( FailureDescription failure) Báo cáo chạy thử không hoàn thành do lỗi được mô tả bởi |
final void | testRunFailed (String errorMessage) Báo cáo chạy thử không hoàn tất được do có lỗi nghiêm trọng. |
final void | testRunStarted (String runName, int testCount, int attemptNumber) Báo cáo việc bắt đầu chạy thử. |
final void | testRunStarted (String runName, int testCount) Lệnh gọi lại chạy thử nghiệm |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Báo cáo việc bắt đầu chạy thử. |
final void | testRunStopped (long elapsedTime) Báo cáo quá trình chạy thử đã dừng trước khi hoàn thành do yêu cầu của người dùng. |
final void | testStarted ( TestDescription test, long startTime) Giải pháp thay thế cho |
final void | testStarted ( TestDescription test) Lệnh gọi lại trường hợp thử nghiệm |
Phương pháp được bảo vệ | |
---|---|
MetricMeasurement.DataType | getMetricType () Ghi đè phương pháp này để thay đổi loại chỉ số nếu cần. |
String | getRunName () |
Nhà thầu xây dựng công cộng
BasePostProcessor
public BasePostProcessor ()
Phương pháp công khai
trong đó
public final ITestInvocationListener init (ITestInvocationListener listener)
Bước khởi tạo của bộ xử lý bài. Đảm bảo được gọi trước bất kỳ lệnh gọi lại thử nghiệm nào.
Thông số | |
---|---|
listener | ITestInvocationListener |
Trả lại | |
---|---|
ITestInvocationListener |
lời mờ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ố điều kiện lỗi.
Sẽ được khung TradeFederation gọi tự động.Thông số | |
---|---|
elapsedTime | long : thời gian trôi qua của lệnh gọi tính bằng ms |
lời gọi không thành công
public final void invocationFailed (FailureDescription failure)
Báo cáo lệnh gọi không đầy đủ do một số tình trạng lỗi.
Sẽ được khung TradeFederation gọi tự động.
Thông số | |
---|---|
failure | FailureDescription : FailureDescription mô tả nguyên nhân gây ra lỗi |
lời gọi không thành công
public final void invocationFailed (Throwable cause)
Báo cáo lệnh gọi không đầy đủ do một số tình trạng lỗi.
Sẽ được khung TradeFederation gọi tự động.Thông số | |
---|---|
cause | Throwable : nguyên nhân Throwable của sự cố |
lời gọiBắt đầu
public final void invocationStarted (IInvocationContext context)
Trình nghe lời gọi để chuyển tiếp
Thông số | |
---|---|
context | IInvocationContext : thông tin về lời gọi |
bị vô hiệu hóa
public final boolean isDisabled ()
Trả về True nếu toàn bộ đối tượng bị vô hiệu hóa (bỏ qua cả thiết lập và phân tích). Sai nếu không.
Trả lại | |
---|---|
boolean |
logHiệp hội
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 thử nghiệm, nhưng cơ hội thực hiện điều đó trên testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
Không thể gọi lại testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
. Do đó, lệnh gọi lại này cho phép cung cấp một liên kết mạnh mẽ một cách rõ ràng.
Cập nhật liên kết đăng nhập để kiểm tra. Nếu phương thức này được gọi trong quá trình kiểm tra thì nhật ký sẽ thuộc về kiểm tra; nếu không nó sẽ là nhật ký chạy.
Thông số | |
---|---|
dataName | String : Tên 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 thử nghiệm. |
quá trìnhAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Triển khai phương pháp này để tổng hợp số liệu và nhật ký trên tất cả các thử nghiệm. Các số liệu được đưa ra từ phương pháp này sẽ được báo cáo dưới dạng số liệu chạy. Chỉ nên trả về các số liệu mới được tạo và có tên khóa duy nhất (không được phép xung đột với các khóa hiện có).
Thông số | |
---|---|
allTestMetrics | ListMultimap : HashMultimap lưu trữ các số liệu từ mỗi thử nghiệm được nhóm theo tên số liệu. |
allTestLogs | TestDescription của mỗi bài kiểm tra làm khóa. |
Trả lại | |
---|---|
Tập hợp các số liệu mới được tạo từ tất cả các số liệu thử nghiệm. |
quá trìnhRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Triển khai phương pháp này để tạo một tập hợp số liệu mới từ các số liệu và nhật ký hiện có. Chỉ nên trả về các số liệu mới được tạo và có tên khóa duy nhất (không được phép xung đột với các khóa hiện có).
Thông số | |
---|---|
rawMetrics | |
runLogs |
Trả lại | |
---|---|
Tập hợp các số liệu mới được tạo từ các số liệu chạy. |
quá trìnhTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Triển khai phương pháp này để đăng số liệu và nhật ký quy trình từ mỗi lần kiểm tra. Chỉ nên trả về các số liệu mới được tạo và có tên khóa duy nhất (không được phép xung đột với các khóa hiện có).
Thông số | |
---|---|
testDescription | TestDescription : Đối tượng TestDescription mô tả bài kiểm tra. |
testMetrics | |
testLogs |
Trả lại | |
---|---|
Tập hợp các số liệu mới được tạo từ các số liệu thử nghiệm. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Đặt ILogSaver
để cho phép người triển khai lưu tệp.
Thông số | |
---|---|
logSaver | ILogSaver : ILogSaver |
cài đặt
public void setUp ()
Ghi đè phương thức này trong bộ xử lý bài con để khởi tạo trước khi chạy thử nghiệm.
kiểm traGiả địnhThất bại
public final void testAssumptionFailure (TestDescription test, String trace)
Được gọi khi một bài kiểm tra nguyên tử đánh dấu rằng nó giả định một điều kiện sai
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
trace | String : dấu vết lỗi của ngăn xếp |
kiểm traGiả địnhThất bại
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Được gọi khi một bài kiểm tra nguyên tử đánh dấu rằng nó giả định một điều kiện sai
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
failure | FailureDescription : FailureDescription mô tả lỗi và bối cảnh của nó. |
kiểm traĐã kết thúc
public final void testEnded (TestDescription test, long endTime,testMetrics)
Thay thế cho ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
nơi chúng tôi có thể chỉ định trực tiếp thời gian kết thúc. Kết hợp với testStarted(com.android.tradefed.result.TestDescription, long)
để đo chính xác.
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
endTime | long : thời gian thử nghiệm kết thúc, được đo thông qua System.currentTimeMillis() |
testMetrics | ERROR(/Map) của số liệu được phát ra |
kiểm traĐã kết thúc
public final void testEnded (TestDescription test,testMetrics)
Báo cáo kết thúc thực hiện của một trường hợp thử nghiệm riêng lẻ.
Nếu testFailed(TestDescription, FailureDescription)
không được gọi thì thử nghiệm này đã đạt. Đồng thời trả về bất kỳ số liệu khóa/giá trị nào có thể được phát ra trong quá trình thực thi trường hợp kiểm thử.
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
testMetrics | ERROR(/Map) của số liệu được phát ra |
thử nghiệm thất bại
public final void testFailed (TestDescription test, FailureDescription failure)
Báo cáo sự thất bại của một trường hợp thử nghiệm riêng lẻ.
Sẽ được gọi giữa testStarted và testEnded.
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
failure | FailureDescription : FailureDescription mô tả lỗi và bối cảnh của nó. |
thử nghiệm thất bại
public final void testFailed (TestDescription test, String trace)
Báo cáo sự thất bại của một trường hợp thử nghiệm riêng lẻ.
Sẽ được gọi giữa testStarted và testEnded.
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
trace | String : dấu vết lỗi của ngăn xếp |
kiểm traBỏ qua
public final void testIgnored (TestDescription test)
Được gọi khi thử nghiệm không được chạy, thường là do phương thức thử nghiệm được chú thích bằng org.junit.Ignore.
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
nhật ký kiểm tra
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Sử dụng phương pháp này để ghi nhật ký tệp từ quá trình triển khai PostProcessor.
Thông 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ó khả năng xử lý nhiều cuộc gọi với cùng một tên dữ liệu |
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. Người gọi phải đảm bảo nguồn dữ liệu vẫn hiện diệ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 tra được lưu.
Nên sử dụng thay cho ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)
.
Thông 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ó khả năng xử lý nhiều cuộc gọi với cùng một tên dữ liệu |
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. |
logFile | LogFile : LogFile chứa siêu dữ liệu của file đã lưu. |
testModuleĐã kết thúc
public final void testModuleEnded ()
Báo cáo kết thúc chạy mô-đun.
testModuleBắt đầu
public final void testModuleStarted (IInvocationContext moduleContext)
Báo cáo sự bắt đầu của một mô-đun đang chạy. Cuộc gọi lại này được liên kết với testModuleEnded()
và là tùy chọn trong chuỗi. Nó chỉ được sử dụng trong quá trình chạy sử dụng các mô-đun: bộ chạy dựa trên bộ.
Thông số | |
---|---|
moduleContext | IInvocationContext : IInvocationContext của mô-đun. |
thử nghiệmChạyĐã kết thúc
public final void testRunEnded (long elapsedTime,runMetrics)
Báo cáo kết thúc quá trình chạy thử. CỐ ĐỊNH: Chúng tôi không thể có hai giao diện Map<> với loại khác nhau, vì vậy chúng tôi phải sử dụng HashMap tại đây.
Thông số | |
---|---|
elapsedTime | long : thiết bị đã báo cáo thời gian đã trôi qua, tính bằng mili giây |
runMetrics | Metric . |
thử nghiệm Chạy không thành công
public final void testRunFailed (FailureDescription failure)
Báo cáo chạy thử không hoàn thành do lỗi được mô tả bởi FailureDescription
.
Thông số | |
---|---|
failure | FailureDescription : FailureDescription mô tả lỗi và bối cảnh của nó. |
thử nghiệm Chạy không thành công
public final void testRunFailed (String errorMessage)
Báo cáo chạy thử không hoàn tất được do có lỗi nghiêm trọng.
Thông số | |
---|---|
errorMessage | String : String mô tả lý do chạy thất bại. |
thử nghiệmChạyBắt đầu
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Báo cáo việc bắt đầu chạy thử.
Thông số | |
---|---|
runName | String : tên chạy thử |
testCount | int : tổng số bài kiểm tra trong lần chạy 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ố lần thử được lập chỉ mục bằng 0 và sẽ tăng lên mỗi lần chạy mới. ví dụ: Một thử nghiệm được thử lại chi tiết 3 lần, nó phải có tổng cộng 4 lần chạy với cùng một runName và số lần thử là từ 0 đến 3. |
thử nghiệmChạyBắt đầu
public final void testRunStarted (String runName, int testCount)
Lệnh gọi lại chạy thử nghiệm
Thông số | |
---|---|
runName | String : tên chạy thử |
testCount | int : tổng số bài kiểm tra trong lần chạy thử |
thử nghiệmChạyBắt đầu
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Báo cáo việc bắt đầu chạy thử.
Thông số | |
---|---|
runName | String : tên chạy thử |
testCount | int : tổng số bài kiểm tra trong lần chạy 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ố lần thử được lập chỉ mục bằng 0 và sẽ tăng lên mỗi lần chạy mới. ví dụ: Một thử nghiệm được thử lại chi tiết 3 lần, nó phải có tổng cộng 4 lần chạy với cùng một runName và số lần thử là từ 0 đến 3. |
startTime | long : thời gian bắt đầu chạy, được đo thông qua System.currentTimeMillis() |
thử nghiệmRunStopped
public final void testRunStopped (long elapsedTime)
Báo cáo quá trình chạy thử đã dừng trước khi hoàn thành do yêu cầu của người dùng.
TODO: hiện chưa được sử dụng, hãy cân nhắc việc xóa
Thông số | |
---|---|
elapsedTime | long : thiết bị đã báo cáo thời gian đã trôi qua, tính bằng mili giây |
thử nghiệmBắt đầu
public final void testStarted (TestDescription test, long startTime)
Giải pháp thay thế cho testStarted(com.android.tradefed.result.TestDescription)
trong đó chúng tôi cũng chỉ định thời điểm bắt đầu thử nghiệm, kết hợp với ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
để đo lường chính xác .
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
startTime | long : thời gian thử nghiệm bắt đầu, được đo thông qua System.currentTimeMillis() |
thử nghiệmBắt đầu
public final void testStarted (TestDescription test)
Lệnh gọi lại trường hợp thử nghiệm
Thông số | |
---|---|
test | TestDescription : xác định bài kiểm tra |
Phương pháp được bảo vệ
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Ghi đè phương pháp này để thay đổi loại chỉ số nếu cần. Theo mặc định, số liệu được đặt thành loại đã xử lý.
Trả lại | |
---|---|
MetricMeasurement.DataType |
lấy tên chạy
protected String getRunName ()
Trả lại | |
---|---|
String |