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