BasePostProcessor

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 phải mở rộng. Đảm bảo rằng các phương thức xử lý sau được gọi trước trình 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 chạy của trình xử lý hậu kỳ.

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 một lệnh gọi chưa hoàn chỉnh do một số điều kiện lỗi.

final 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

final void invocationStarted(IInvocationContext context)

Trình nghe lệnh 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à gỡ bỏ).

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 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.

Cập nhật mối liên kết nhật ký-kiểm thử.

processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

Triển khai phương thức này để tổng hợp các chỉ số và nhật ký trên tất cả các bài kiểm thử.

abstract processRunMetricsAndLogs( rawMetrics, runLogs)

Triển khai phương thức 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)

Triển khai phương thức này để đăng các chỉ số và nhật ký xử lý từ mỗi lần kiểm thử.

final void setLogSaver(ILogSaver logSaver)

Đặt ILogSaver để cho phép người triển khai lưu tệp.

void setUp()

Ghi đè phương thức này trong trình xử lý sau 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 kiểm thử nguyên tử gắn cờ giả định một điều kiện là sai

final void testAssumptionFailure(TestDescription test, 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

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.

final void testEnded(TestDescription test, testMetrics)

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ẻ.

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 chương 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.

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

Sử dụng phương thức 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 thử đượ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 thời điểm bắt đầu chạy một mô-đun.

final void testRunEnded(long elapsedTime, runMetrics)

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

final 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ả.

final void testRunFailed(String errorMessage)

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.

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ử lệnh gọi lại khi chạy

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)

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.

final void testSkipped(TestDescription test, 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.

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 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.

final void testStarted(TestDescription test)

Lệnh gọi lại của trường hợp kiểm thử

Phương thức được bảo vệ

void cleanUp()
MetricMeasurement.DataType getMetricType()

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

BasePostProcessor

public BasePostProcessor ()

Phương thức công khai

khởi tạo

public final ITestInvocationListener init (ITestInvocationListener listener)

Bước khởi chạy của trình xử lý hậu kỳ. Đảm bảo được gọi trước mọi lệnh gọi lại kiểm thử.

Tham số
listener ITestInvocationListener

Giá trị trả về
ITestInvocationListener

invocationEnded

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 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 final 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 final 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 final void invocationStarted (IInvocationContext context)

Trình nghe lệnh gọi để chuyển tiếp

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

isDisabled

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à gỡ bỏ). Nếu không thì giá trị sẽ 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 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.

Cập nhật mối liên kết nhật ký-kiểm thử. 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ề quá trình kiểm thử; nếu không, đó 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à phải được liên kết với trường hợp kiểm thử.

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

Triển khai phương thức này để tổng hợp các chỉ số và nhật ký trên tất cả các bài kiểm thử. Các chỉ số xuất phát từ phương thức này sẽ được báo cáo dưới dạng chỉ số chạy. Chỉ các chỉ số mới tạo mới được trả về và có tên khoá duy nhất (không được trùng lặp với các khoá hiện có).

Tham số
allTestMetrics ListMultimap: HashMultimap lưu trữ các chỉ số từ mỗi lần kiểm thử được nhóm theo tên chỉ số.
allTestLogs : Một bản đồ lưu trữ bản đồ tệp nhật ký của mỗi bài kiểm thử được khoá theo tên dữ liệu của các tệp đó, 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 tạo từ tất cả các chỉ số kiểm thử.

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

Triển khai phương thức 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 tạo mới được trả về và có tên khoá duy nhất (không được phép trùng lặp với các khoá hiện có).

Tham số
rawMetrics : Tập hợp các chỉ số thô có sẵn cho lầ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ừ chỉ số chạy.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (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ần kiểm thử. Chỉ các chỉ số mới được tạo mới được trả về và có tên khoá duy nhất (không được trùng lặp với các khoá hiện có).

Tham số
testDescription TestDescription: Đối tượng TestDescription mô tả kiểm thử.
testMetrics : Tập hợp các chỉ số từ kiểm thử.
testLogs : Tập hợp các tệp được ghi nhật ký 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 người triển khai lưu tệp.

Tham số
logSaver ILogSaver: ILogSaver

setUp

public void setUp ()

Ghi đè phương thức này trong trình xử lý sau con để khởi chạy trước khi chạy kiểm thử.

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                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ố
test TestDescription: xác định kiểm thử
trace String: dấu vết ngăn xếp của lỗi

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                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ố
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 final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

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ố
test TestDescription: xác định kiểm thử
endTime long: thời gian kết thúc kiểm thử, được đo lường thông 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 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ố
test TestDescription: xác định kiểm thử
testMetrics : ERROR(/Map) của các chỉ số được phát ra

testFailed

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 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 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 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 final void testIgnored (TestDescription test)

Được gọi khi một chương 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 final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

Sử dụng phương thức này để ghi nhật ký 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". 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.

testLogSaved

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 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". 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.
logFile LogFile: LogFile chứa siêu dữ liệu 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 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 final void testRunEnded (long elapsedTime, 
                 runMetrics)

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

Tham số
elapsedTime 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 final 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 final void testRunFailed (String errorMessage)

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ố
errorMessage String: String mô tả lý do không chạy được.

testRunStarted

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 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 final void testRunStarted (String runName, 
                int testCount)

Kiểm thử lệnh gọi lại khi chạy

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 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 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 final void testRunStopped (long elapsedTime)

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ố
elapsedTime long: thời gian đã trôi qua do thiết bị báo cáo, tính bằng mili giây

testSkipped

public final void testSkipped (TestDescription test, 
                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ố
test TestDescription: xác định kiểm thử
reason SkipReason: SkipReason

testStarted

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 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ố
test 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 final void testStarted (TestDescription test)

Lệnh gọi lại của 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ệ

cleanUp

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

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