BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object
↳	com.android.tradefed.postprocessor.BasePostProcessor

Các lớp con trực tiếp đã biết AggregatePostProcessor, AveragePostProcessor, BluetoothConnectionSuccessRatePostProcessor, MetricFilePostProcessor, PerfettoGenericPostProcessor, PerfettoTracePostProcessor, StatsdGenericPostProcessor AggregatePostProcessor Một trình tổng hợp chỉ số cung cấp giá trị tối thiểu, tối đa, trung bình, phương sai, độ lệch chuẩn, tổng, số lượng và tuỳ chọn là phân vị cho các chỉ số dạng số được thu thập trong các lần chạy thử nghiệm nhiều lần lặp lại, coi chúng là số thực.  AveragePostProcessor Triển khai trình xử lý hậu kỳ để tính giá trị trung bình của danh sách chỉ số.  BluetoothConnectionSuccessRatePostProcessor Triển khai trình xử lý hậu kỳ để tính tỷ lệ thành công cho một hồ sơ bluetooth Sử dụng "metric-key-match" để chỉ định các chỉ số chứa trạng thái kết nối Bluetooth trong mảng số Ví dụ: [0, 1, 2, 3, 0, 1, 2, 3].  MetricFilePostProcessor Được dùng để tải tệp nhật ký chỉ số được thu thập trong quá trình kiểm thử và cấp độ chạy lên.  PerfettoGenericPostProcessor Một trình xử lý hậu kỳ xử lý tệp proto perfetto chỉ số văn bản/nhị phân thành các cặp khoá-giá trị bằng cách mở rộng đệ quy các thông báo và trường proto có giá trị chuỗi cho đến khi gặp trường có giá trị số.  PerfettoTracePostProcessor Một trình xử lý hậu kỳ truy xuất các tệp dấu vết perfetto từ nhật ký kiểm thử và chạy trình xử lý dấu vết trên các tệp đó để tạo một proto chỉ số perfetto.  StatsdGenericPostProcessor Một trình xử lý hậu kỳ xử lý các báo cáo statsd proto nhị phân thành các cặp khoá-giá trị bằng cách mở rộng báo cáo dưới dạng cấu trúc cây.

Các lớp con gián tiếp đã biết StatsdBeforeAfterGaugeMetricPostProcessor, StatsdEventMetricPostProcessor StatsdBeforeAfterGaugeMetricPostProcessor Một trình xử lý hậu kỳ xử lý các chỉ số đo lường được thu thập theo phương pháp "trước/sau", tức là  StatsdEventMetricPostProcessor Một trình xử lý hậu kỳ xử lý các chỉ số sự kiện trong báo cáo statsd thành các cặp khoá-giá trị, bằng cách sử dụng các trình định dạng được chỉ định trên trình xử lý.

---

IPostProcessor cơ sở mà mọi phương thức 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 cá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 tạo 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, 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 tất 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 tất 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ị vô hiệu hoá (bỏ qua cả quá trình thiết lập và huỷ).
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 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 giữa nhật ký và 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 kiểm thử.
abstract	processRunMetricsAndLogs( rawMetrics, runLogs) Triển khai phương thức này để tạo một nhóm 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 để xử lý sau các chỉ số và nhật ký từ mỗi quy trình 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 các trình xử lý hậu kỳ con để khởi tạo trước khi chạy kiểm thử.
final void	testAssumptionFailure(TestDescription test, String trace) Được gọi khi một kiểm thử đơn vị gắn cờ rằng kiểm thử đó giả định một điều kiện sai
final void	testAssumptionFailure(TestDescription test, FailureDescription failure) Được gọi khi một kiểm thử đơn vị gắn cờ rằng kiểm thử đó giả định một điều kiện sai
final void	testEnded(TestDescription test, long endTime, testMetrics) Phương án thay thế cho ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), trong đó chúng ta có thể chỉ định trực tiếp thời gian kết thúc.
final void	testEnded(TestDescription test, testMetrics) Báo cáo thời điểm 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 quy 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ý 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 về việc kết thúc một lần 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 thử nghiệm.
final void	testRunFailed(FailureDescription failure) Không thể hoàn tất quá trình chạy thử báo cáo do lỗi được mô tả bằng FailureDescription.
final void	testRunFailed(String errorMessage) Không thể hoàn tất quá trình chạy thử báo cáo do gặp 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 một lần chạy thử nghiệm.
final void	testRunStarted(String runName, int testCount) Lệnh gọi lại chạy thử
final void	testRunStarted(String runName, int testCount, int attemptNumber, long startTime) Báo cáo thời điểm bắt đầu một lần chạy thử nghiệm.
final void	testRunStopped(long elapsedTime) Chạy thử báo cáo bị dừng trước khi hoàn tất do người dùng yêu cầu.
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 thường không mong đợi.
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 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

init

public final ITestInvocationListener init (ITestInvocationListener listener)

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

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 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 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 tất 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ị vô hiệu hoá (bỏ qua cả quá trình thiết lập và huỷ). Nếu không thì trả về giá trị 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 các 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 rõ ràng một cách tường minh.

Cập nhật mối liên kết giữa nhật ký và 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ý sẽ thuộc về hoạt động kiểm thử; nếu không, nhật ký sẽ là nhật ký chạy.

Tham số
dataName	String: Tên của dữ liệu
logFile	LogFile: LogFile đã được ghi nhật ký 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 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ỉ những chỉ số mới được tạo mới được trả về và có tên khoá riêng biệt (không được phép trùng lặp với các khoá hiện có).

Tham số
allTestMetrics	ListMultimap: HashMultimap lưu trữ các chỉ số của từng kiểm thử được nhóm theo tên chỉ số.
allTestLogs	: Bản đồ lưu trữ bản đồ của từng tệp nhật ký kiểm thử được khoá theo tên dữ liệu của chúng, sử dụng TestDescription của từng 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 abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

Triển khai phương thức này để tạo một nhóm chỉ số mới từ các chỉ số và nhật ký hiện có. Chỉ trả về các chỉ số mới được tạo và có tên khoá riêng biệ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ượt chạy.
runLogs	: Tập hợp các tệp nhật ký cho lần chạy thử nghiệm.

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 để xử lý sau các chỉ số và nhật ký từ mỗi quy trình kiểm thử. Chỉ trả về các chỉ số mới được tạo và có tên khoá riêng biệt (không được phép trùng lặp với các khoá hiện có).

Tham số
testDescription	TestDescription: Đối tượng TestDescription mô tả bài 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ừ 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 các trình xử lý hậu kỳ con để khởi tạo 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ử đơn vị gắn cờ rằng kiểm thử đó giả định một điều kiện sai

Tham 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

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Được gọi khi một kiểm thử đơn vị gắn cờ rằng kiểm thử đó giả định một điều kiện sai

Tham số
test	TestDescription: xác định bài kiểm tra
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)

Phương án thay thế cho ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)), trong đó chúng ta 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.

Tham số
test	TestDescription: xác định bài kiểm tra
endTime	long: thời gian kết thúc kiểm thử, được đo bằng System.currentTimeMillis()
testMetrics	: một ERROR(/Map) các chỉ số được phát ra

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

Báo cáo thời điểm 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ì quy trình kiểm thử này đã thành công. Cũng trả về mọi chỉ số khoá/giá trị có thể đã được phát trong quá trình thực thi trường hợp kiểm thử.

Tham số
test	TestDescription: xác định bài kiểm tra
testMetrics	: một ERROR(/Map) 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 bài kiểm tra
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 bài kiểm tra
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 quy 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 bài kiểm tra

testLog

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

Bạn nên dùng thuộc tính này 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à 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. 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 về việc kết thúc một lần 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 chuỗi. Nó 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 thử nghiệm.

Tham 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 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 thử báo cáo do lỗi được mô tả bằng FailureDescription.

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 thử báo cáo do gặp lỗi nghiêm trọng.

Tham số
errorMessage	String: String mô tả lý do khiến lần chạy không thành công.

testRunStarted

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

Báo cáo thời điểm bắt đầu một lần chạy thử nghiệm.

Tham số
runName	String: tên của lần chạy 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à sẽ tăng lên mỗi khi có một lần chạy mới. Ví dụ: Một thử nghiệm được thử lại chi tiết 3 lần, thì thử nghiệm đó sẽ có tổng cộng 4 lần chạy trong cùng một runName và attemptNumber từ 0 đến 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Lệnh gọi lại chạy thử

Tham số
runName	String: tên của lần chạy 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 một lần chạy thử nghiệm.

Tham số
runName	String: tên của lần chạy 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à sẽ tăng lên mỗi khi có một lần chạy mới. Ví dụ: Một bài kiểm thử được thử lại chi tiết 3 lần, thì bài kiểm thử đó sẽ có tổng cộng 4 lần chạy 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 bằng System.currentTimeMillis()

testRunStopped

public final void testRunStopped (long elapsedTime)

Chạy thử báo cáo bị dừng trước khi hoàn tất do người dùng yêu cầu.

TODO: currently unused, consider removing

Tham số
elapsedTime	long: thiết bị báo cáo thời gian đã trôi qua, 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 thường không mong đợi. 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 bài kiểm tra
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 bài kiểm tra
startTime	long: thời gian bắt đầu kiểm thử, được đo bằng System.currentTimeMillis()

testStarted

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 bài kiểm tra

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