BasePostBộ xử lý

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ý hậu kỳ được gọi trước các trình báo cáo kết quả cuối cùng.

Bản tóm tắt

nhà thầu công cộng

BasePostProcessor ()

Phương thức công khai

final ITestInvocationListener init ( ITestInvocationListener listener)

Bước khởi tạo của bộ xử lý bài đăng.

final void invocationEnded (long elapsedTime)

Báo cáo rằng lời 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 không đầy đủ 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 không đầy đủ do một số điều kiện lỗi.

final void invocationStarted ( IInvocationContext context)

Yêu cầu Listeners để 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á 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 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 testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) .

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 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 số liệu quy trình và nhật ký từ mỗi bài kiểm tra.

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 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 thử nghiệm nguyên tử báo hiệ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 thử nghiệm nguyên tử báo hiệ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 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.

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 cá nhân.

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 cá nhân.

final void testIgnored ( TestDescription test)

Được gọi khi không chạy thử nghiệm, thường là do phương pháp 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ự khởi đầ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 chạy thử.

final void testRunFailed ( FailureDescription failure)

Báo cáo chạy thử nghiệm không thể hoàn thành do lỗi được mô tả bởi FailureDescription .

final void testRunFailed (String errorMessage)

Báo cáo chạy thử nghiệm không thể hoàn thành do một lỗi nghiêm trọng.

final void testRunStarted (String runName, int testCount, int attemptNumber)

Báo cáo bắt đầu chạy thử.

final void testRunStarted (String runName, int testCount)

Gọi lại chạy thử nghiệm

final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)

Báo cáo bắt đầu chạy thử.

final void testRunStopped (long elapsedTime)

Chạy thử 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 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 .

final void testStarted ( TestDescription test)

Các trường hợp thử nghiệm gọi lại

phương pháp được bảo vệ

MetricMeasurement.DataType getMetricType ()

Ghi đè phương thức này để thay đổi loại chỉ số nếu cần.

String getRunName ()

nhà thầu công cộng

BasePostBộ xử lý

public BasePostProcessor ()

Phương thức công khai

trong đó

public final ITestInvocationListener init (ITestInvocationListener listener)

Bước khởi tạo của bộ xử lý bài đăng. Đảm bảo được gọi trước bất kỳ cuộc gọi lại thử nghiệm nào.

Thông số
listener ITestInvocationListener

trả lại
ITestInvocationListener

lời gọiĐã kết thúc

public final void invocationEnded (long elapsedTime)

Báo cáo rằng lời 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 gọi tự động bởi khung TradeFederation.

Thông số
elapsedTime long : thời gian đã trôi qua của lời gọi tính bằng ms

lời gọiThất bại

public final void invocationFailed (FailureDescription failure)

Báo cáo một lệnh gọi không đầy đủ do một số điều kiện lỗi.

Sẽ được gọi tự động bởi khung TradeFederation.

Thông số
failure FailureDescription : FailureDescription mô tả nguyên nhân lỗi

lời gọiThất bại

public final void invocationFailed (Throwable cause)

Báo cáo một lệnh gọi không đầy đủ do một số điều kiện lỗi.

Sẽ được gọi tự động bởi khung TradeFederation.

Thông số
cause Throwable : nguyên nhân Throwable của sự thất bại

lời gọiBắt đầu

public final void invocationStarted (IInvocationContext context)

Yêu cầu Listeners để 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á bỏ). Sai nếu không.

trả lại
boolean

đăng nhập hiệ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 một 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 testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) . Do đó, cuộc 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 khi kiểm tra, thì nhật ký 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 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 thử nghiệm.

processAllTestMetricsAndLogs

public  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. 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 chỉ số chạy. Chỉ các số liệu mới được tạo mới được trả lại và với tên khóa duy nhất (không cho phép xung đột với các khóa hiện có).

Thông số
allTestMetrics ListMultimap : HashMultimap lưu trữ các chỉ số từ mỗi thử nghiệm được nhóm theo tên chỉ số.

allTestLogs : Một bản đồ lưu trữ bản đồ các tệp nhật ký được khóa bởi tên dữ liệu của mỗi bài kiểm tra, sử dụng TestDescription của mỗi bài kiểm tra làm khóa.

trả lại
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 abstract  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ó. Chỉ các số liệu mới được tạo mới được trả lại và với tên khóa duy nhất (không cho phép xung đột với các khóa hiện có).

Thông số
rawMetrics : Tập hợp các số liệu thô có sẵn cho lần chạy.

runLogs : Tập hợp các tệp nhật ký cho quá trình chạy thử.

trả lại
Tập hợp các chỉ số mới được tạo từ các chỉ số chạy.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Triển khai phương pháp này để đăng số liệu quy trình và nhật ký từ mỗi bài kiểm tra. Chỉ các số liệu mới được tạo mới được trả lại và với tên khóa duy nhất (không cho 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 : Tập hợp các số liệu từ thử nghiệm.

testLogs : Tập hợp các tệp được ghi lại trong quá trình kiểm tra.

trả lại
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

cài đặt

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.

kiểm traGiả địnhThất bại

public final void testAssumptionFailure (TestDescription test, 
                String trace)

Được gọi khi một thử nghiệm nguyên tử báo hiệ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 ngăn xếp của lỗi

kiểm traGiả địnhThất bại

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Được gọi khi một thử nghiệm nguyên tử báo hiệ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ó.

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)) 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 lường chính xác.

Thông số
test TestDescription : xác định bài kiểm tra

endTime long : thời gian test kết thúc, đo qua System.currentTimeMillis()

testMetrics : một ERROR(/Map) của các chỉ số được phát ra

thử nghiệmĐã 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 đã vượt qua. Đồng thời trả về bất kỳ số liệu khóa/giá trị nào có thể đã được đưa 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 : một 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 sự thất bại của một trường hợp thử nghiệm cá nhân.

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 cá nhân.

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 ngăn xếp của lỗi

kiểm traBỏ qua

public final void testIgnored (TestDescription test)

Được gọi khi không chạy thử nghiệm, thường là do phương pháp 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ầ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 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 đượ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 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 tệp đã lưu.

testModuleEnded

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ự khởi đầ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 trình tự. Nó chỉ được sử dụng trong quá trình chạy sử dụng các 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 chạy thử. KHẮC PHỤC: 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 : các cặp khóa-giá trị được báo cáo khi kết thúc quá trình chạy thử nghiệm với Metric .

testRunThất bại

public final void testRunFailed (FailureDescription failure)

Báo cáo chạy thử nghiệm không thể 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ó.

testRunThất bại

public final void testRunFailed (String errorMessage)

Báo cáo chạy thử nghiệm không thể hoàn thành do một lỗi nghiêm trọng.

Thông số
errorMessage String : String mô tả lý do chạy không thành công.

testRunBắt đầu

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

Báo cáo bắt đầu chạy thử.

Thông số
runName String : tên chạy thử nghiệm

testCount int : tổng số bài kiểm tra trong quá trình 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. Cố gắngNumber được lập chỉ mục 0 và sẽ tăng lên mỗi khi một lần chạy mới diễn 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 dưới cùng một tên chạy và số lần thử là từ 0 đến 3.

testRunBắt đầu

public final void testRunStarted (String runName, 
                int testCount)

Gọi lại chạy thử nghiệm

Thông số
runName String : tên chạy thử nghiệm

testCount int : tổng số bài kiểm tra trong quá trình chạy thử

testRunBắt đầu

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

Báo cáo bắt đầu chạy thử.

Thông số
runName String : tên chạy thử nghiệm

testCount int : tổng số bài kiểm tra trong quá trình 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. Cố gắngNumber được lập chỉ mục 0 và sẽ tăng lên mỗi khi một lần chạy mới diễn 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 dưới cùng một tên chạy và số lần thử là từ 0 đến 3.

startTime long : thời gian chạy bắt đầu, được đo thông qua System.currentTimeMillis()

testRunĐã dừng

public final void testRunStopped (long elapsedTime)

Chạy thử báo cáo đã dừng trước khi hoàn thành do yêu cầu của người dùng.

TODO: hiện không được sử dụng, hãy cân nhắ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)

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 bắt đầu kiểm tra, được đo thông qua System.currentTimeMillis()

thử nghiệmBắt đầu

public final void testStarted (TestDescription test)

Các trường hợp thử nghiệm gọi lại

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 thức 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

getRunName

protected String getRunName ()

trả lại
String