BasePostProcessor
public
abstract
class
BasePostProcessor
extends Object
implements
IPostProcessor
| java.lang.Object | |
| ↳ | com.android.tradefed.postprocessor.BasePostProcessor |
IPostProcessor dasar yang harus diperluas oleh setiap penerapan. Pastikan metode
pasca-pemrosesan dipanggil sebelum pelapor hasil akhir.
Ringkasan
Konstruktor publik | |
|---|---|
BasePostProcessor()
|
|
Metode publik | |
|---|---|
final
ITestInvocationListener
|
init(ITestInvocationListener listener)
Langkah inisialisasi post-processor. |
final
void
|
invocationEnded(long elapsedTime)
Melaporkan bahwa pemanggilan telah dihentikan, baik berhasil maupun karena kondisi error tertentu. |
final
void
|
invocationFailed(FailureDescription failure)
Melaporkan pemanggilan yang tidak lengkap karena kondisi error tertentu. |
final
void
|
invocationFailed(Throwable cause)
Melaporkan pemanggilan yang tidak lengkap karena kondisi error tertentu. |
void
|
invocationSkipped(SkipReason reason)
Melaporkan pemanggilan sebagai dilewati |
final
void
|
invocationStarted(IInvocationContext context)
Pemroses Pemanggilan untuk penerusan |
final
boolean
|
isDisabled()
Menampilkan True jika seluruh objek dinonaktifkan (lewati penyiapan dan penguraian). |
final
void
|
logAssociation(String dataName, LogFile logFile)
Dalam beberapa kasus, log harus dikaitkan secara kuat dengan kasus pengujian, tetapi peluang untuk melakukannya pada callback Memperbarui asosiasi log ke pengujian. |
|
processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics,
Terapkan metode ini untuk menggabungkan metrik dan log di semua pengujian. |
abstract
|
processRunMetricsAndLogs(
Terapkan metode ini untuk menghasilkan serangkaian metrik baru dari metrik dan log yang ada. |
|
processTestMetricsAndLogs(TestDescription testDescription,
Terapkan metode ini untuk memproses metrik dan log dari setiap pengujian. |
final
void
|
setLogSaver(ILogSaver logSaver)
Tetapkan |
void
|
setUp()
Ganti metode ini di pemroses pasca-turunan untuk melakukan inisialisasi sebelum pengujian dijalankan. |
final
void
|
testAssumptionFailure(TestDescription test, String trace)
Dipanggil saat pengujian atomik menandai bahwa pengujian tersebut mengasumsikan kondisi yang salah |
final
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Dipanggil saat pengujian atomik menandai bahwa pengujian tersebut mengasumsikan kondisi yang salah |
final
void
|
testEnded(TestDescription test, long endTime,
Alternatif untuk |
final
void
|
testEnded(TestDescription test,
Melaporkan akhir eksekusi kasus pengujian individual. |
final
void
|
testFailed(TestDescription test, FailureDescription failure)
Melaporkan kegagalan kasus pengujian individual. |
final
void
|
testFailed(TestDescription test, String trace)
Melaporkan kegagalan kasus pengujian individual. |
final
void
|
testIgnored(TestDescription test)
Dipanggil saat pengujian tidak akan dijalankan, biasanya karena metode pengujian dianotasi dengan org.junit.Ignore. |
final
void
|
testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)
Gunakan metode ini untuk mencatat file dari penerapan PostProcessor. |
final
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Dipanggil saat log pengujian disimpan. |
final
void
|
testModuleEnded()
Melaporkan akhir proses modul. |
final
void
|
testModuleStarted(IInvocationContext moduleContext)
Melaporkan awal modul berjalan. |
final
void
|
testRunEnded(long elapsedTime,
Melaporkan akhir proses pengujian. |
final
void
|
testRunFailed(FailureDescription failure)
Operasi pengujian laporan gagal diselesaikan karena kegagalan yang dijelaskan oleh |
final
void
|
testRunFailed(String errorMessage)
Uji coba laporan gagal diselesaikan karena terjadi error fatal. |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber)
Melaporkan dimulainya proses pengujian. |
final
void
|
testRunStarted(String runName, int testCount)
Callback uji coba operasi |
final
void
|
testRunStarted(String runName, int testCount, int attemptNumber, long startTime)
Melaporkan dimulainya proses pengujian. |
final
void
|
testRunStopped(long elapsedTime)
Uji coba laporan dihentikan sebelum selesai karena permintaan pengguna. |
final
void
|
testSkipped(TestDescription test, SkipReason reason)
Dipanggil saat pengujian dilewati dan tidak dijalankan karena alasan yang biasanya tidak diharapkan. |
final
void
|
testStarted(TestDescription test, long startTime)
Alternatif untuk |
final
void
|
testStarted(TestDescription test)
Callback kasus pengujian |
Metode yang dilindungi | |
|---|---|
void
|
cleanUp()
|
MetricMeasurement.DataType
|
getMetricType()
Ganti metode ini untuk mengubah jenis metrik jika diperlukan. |
String
|
getRunName()
|
Konstruktor publik
BasePostProcessor
public BasePostProcessor ()
Metode publik
init
public final ITestInvocationListener init (ITestInvocationListener listener)
Langkah inisialisasi post-processor. Dipastikan dipanggil sebelum callback pengujian apa pun.
| Parameter | |
|---|---|
listener |
ITestInvocationListener |
| Hasil | |
|---|---|
ITestInvocationListener |
|
invocationEnded
public final void invocationEnded (long elapsedTime)
Melaporkan bahwa pemanggilan telah dihentikan, baik berhasil maupun karena kondisi error tertentu.
Akan dipanggil secara otomatis oleh framework TradeFederation.
| Parameter | |
|---|---|
elapsedTime |
long: waktu yang berlalu dari pemanggilan dalam md |
invocationFailed
public final void invocationFailed (FailureDescription failure)
Melaporkan pemanggilan yang tidak lengkap karena kondisi error tertentu.
Akan dipanggil secara otomatis oleh framework TradeFederation.
| Parameter | |
|---|---|
failure |
FailureDescription: FailureDescription yang menjelaskan penyebab kegagalan |
invocationFailed
public final void invocationFailed (Throwable cause)
Melaporkan pemanggilan yang tidak lengkap karena kondisi error tertentu.
Akan dipanggil secara otomatis oleh framework TradeFederation.
| Parameter | |
|---|---|
cause |
Throwable: Throwable penyebab kegagalan |
invocationSkipped
public void invocationSkipped (SkipReason reason)
Melaporkan pemanggilan sebagai dilewati
| Parameter | |
|---|---|
reason |
SkipReason |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Pemroses Pemanggilan untuk penerusan
| Parameter | |
|---|---|
context |
IInvocationContext: informasi tentang pemanggilan |
isDisabled
public final boolean isDisabled ()
Menampilkan True jika seluruh objek dinonaktifkan (lewati penyiapan dan penguraian). Salah untuk sebaliknya.
| Hasil | |
|---|---|
boolean |
|
logAssociation
public final void logAssociation (String dataName,
LogFile logFile)Dalam beberapa kasus, log harus dikaitkan secara kuat dengan kasus pengujian, tetapi peluang untuk melakukannya pada callback testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
langsung tidak memungkinkan. Oleh karena itu, callback ini memungkinkan untuk memberikan asosiasi yang kuat secara eksplisit.
Memperbarui asosiasi log ke pengujian. Jika metode ini dipanggil selama pengujian, log tersebut akan menjadi milik pengujian; jika tidak, log tersebut akan menjadi log operasi.
| Parameter | |
|---|---|
dataName |
String: Nama data |
logFile |
LogFile: LogFile yang dicatat sebelumnya dan harus dikaitkan dengan
kasus pengujian. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Terapkan metode ini untuk menggabungkan metrik dan log di semua pengujian. Metrik yang dihasilkan dari metode ini akan dilaporkan sebagai metrik run. Hanya metrik yang baru dibuat yang harus ditampilkan, dan dengan nama kunci yang unik (tidak boleh ada konflik dengan kunci yang ada).
| Parameter | |
|---|---|
allTestMetrics |
ListMultimap: HashMultimap yang menyimpan metrik dari setiap pengujian yang dikelompokkan menurut nama metrik. |
allTestLogs |
: Peta yang menyimpan peta file log setiap pengujian yang dikelompokkan berdasarkan nama datanya,
menggunakan TestDescription setiap pengujian sebagai kunci. |
| Hasil | |
|---|---|
|
Kumpulan metrik yang baru dibuat dari semua metrik pengujian. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Terapkan metode ini untuk menghasilkan serangkaian metrik baru dari metrik dan log yang ada. Hanya metrik yang baru dibuat yang harus ditampilkan, dan dengan nama kunci yang unik (tidak boleh ada konflik dengan kunci yang ada).
| Parameter | |
|---|---|
rawMetrics |
: Kumpulan metrik mentah yang tersedia untuk proses. |
runLogs |
: Kumpulan file log untuk uji coba. |
| Hasil | |
|---|---|
|
Kumpulan metrik yang baru dibuat dari metrik proses. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Terapkan metode ini untuk memproses metrik dan log dari setiap pengujian. Hanya metrik yang baru dibuat yang harus ditampilkan, dan dengan nama kunci yang unik (tidak boleh ada konflik dengan kunci yang ada).
| Parameter | |
|---|---|
testDescription |
TestDescription: Objek TestDescription yang menjelaskan pengujian. |
testMetrics |
: Kumpulan metrik dari pengujian. |
testLogs |
: Set file yang dicatat selama pengujian. |
| Hasil | |
|---|---|
|
Kumpulan metrik yang baru dibuat dari metrik pengujian. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Tetapkan ILogSaver untuk mengizinkan penerapan menyimpan file.
| Parameter | |
|---|---|
logSaver |
ILogSaver: ILogSaver |
setUp
public void setUp ()
Ganti metode ini di pemroses pasca-turunan untuk melakukan inisialisasi sebelum pengujian dijalankan.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Dipanggil saat pengujian atomik menandai bahwa pengujian tersebut mengasumsikan kondisi yang salah
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
trace |
String: stack trace kegagalan |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Dipanggil saat pengujian atomik menandai bahwa pengujian tersebut mengasumsikan kondisi yang salah
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
failure |
FailureDescription: FailureDescription yang menjelaskan kegagalan dan konteksnya. |
testEnded
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternatif untuk ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) tempat kita dapat menentukan waktu berakhir
secara langsung. Gabungkan dengan testStarted(com.android.tradefed.result.TestDescription, long) untuk pengukuran yang akurat.
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
endTime |
long: waktu berakhirnya pengujian, diukur melalui System.currentTimeMillis() |
testMetrics |
: ERROR(/Map) metrik yang dikeluarkan |
testEnded
public final void testEnded (TestDescription test,testMetrics)
Melaporkan akhir eksekusi kasus pengujian individual.
Jika testFailed(TestDescription, FailureDescription) tidak dipanggil, pengujian ini lulus. Juga menampilkan metrik key/value
yang mungkin telah dikeluarkan selama eksekusi kasus pengujian.
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
testMetrics |
: ERROR(/Map) metrik yang dikeluarkan |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Melaporkan kegagalan kasus pengujian individual.
Akan dipanggil antara testStarted dan testEnded.
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
failure |
FailureDescription: FailureDescription yang menjelaskan kegagalan dan konteksnya. |
testFailed
public final void testFailed (TestDescription test, String trace)
Melaporkan kegagalan kasus pengujian individual.
Akan dipanggil antara testStarted dan testEnded.
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
trace |
String: stack trace kegagalan |
testIgnored
public final void testIgnored (TestDescription test)
Dipanggil saat pengujian tidak akan dijalankan, biasanya karena metode pengujian dianotasi dengan org.junit.Ignore.
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
testLog
public final void testLog (String dataName,
LogDataType dataType,
InputStreamSource dataStream)Gunakan metode ini untuk mencatat file dari penerapan PostProcessor.
| Parameter | |
|---|---|
dataName |
String: nama deskriptif String data. Misalnya, "device_logcat". Catatan
dataName mungkin tidak unik per pemanggilan. Artinya, pelaksana harus dapat menangani
beberapa panggilan dengan dataName yang sama |
dataType |
LogDataType: LogDataType data |
dataStream |
InputStreamSource: InputStreamSource data. Pelaksana harus memanggil
createInputStream untuk mulai membaca data, dan memastikan untuk menutup
InputStream yang dihasilkan setelah selesai. Pemanggil harus memastikan sumber data tetap ada dan dapat diakses hingga metode testLog selesai. |
testLogSaved
public final void testLogSaved (String dataName,
LogDataType dataType,
InputStreamSource dataStream,
LogFile logFile)Dipanggil saat log pengujian disimpan.
Harus digunakan sebagai pengganti ITestInvocationListener.testLog(String, LogDataType,
InputStreamSource).
| Parameter | |
|---|---|
dataName |
String: nama deskriptif String data. Misalnya, "device_logcat". Catatan
dataName mungkin tidak unik per pemanggilan. Artinya, pelaksana harus dapat menangani
beberapa panggilan dengan dataName yang sama |
dataType |
LogDataType: LogDataType data |
dataStream |
InputStreamSource: InputStreamSource data. Pelaksana harus memanggil
createInputStream untuk mulai membaca data, dan memastikan untuk menutup
InputStream yang dihasilkan setelah selesai. |
logFile |
LogFile: LogFile yang berisi meta data file yang disimpan. |
testModuleEnded
public final void testModuleEnded ()
Melaporkan akhir proses modul.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Melaporkan awal modul berjalan. Callback ini terkait dengan testModuleEnded() dan bersifat opsional dalam urutan. Hanya digunakan selama menjalankan modul yang menggunakan
runner berbasis rangkaian pengujian.
| Parameter | |
|---|---|
moduleContext |
IInvocationContext: IInvocationContext modul. |
testRunEnded
public final void testRunEnded (long elapsedTime,
runMetrics) Melaporkan akhir proses pengujian.
| Parameter | |
|---|---|
elapsedTime |
long: waktu berlalu yang dilaporkan perangkat, dalam milidetik |
runMetrics |
: pasangan nilai kunci yang dilaporkan di akhir proses pengujian |
testRunFailed
public final void testRunFailed (FailureDescription failure)
Operasi pengujian laporan gagal diselesaikan karena kegagalan yang dijelaskan oleh FailureDescription.
| Parameter | |
|---|---|
failure |
FailureDescription: FailureDescription yang menjelaskan kegagalan dan konteksnya. |
testRunFailed
public final void testRunFailed (String errorMessage)
Uji coba laporan gagal diselesaikan karena terjadi error fatal.
| Parameter | |
|---|---|
errorMessage |
String: String yang menjelaskan alasan kegagalan operasi. |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber)Melaporkan dimulainya proses pengujian.
| Parameter | |
|---|---|
runName |
String: nama operasi pengujian |
testCount |
int: jumlah total pengujian dalam operasi pengujian |
attemptNumber |
int: nomor pesanan, yang mengidentifikasi berbagai upaya runName yang sama
yang dijalankan beberapa kali. attemptNumber diindeks 0 dan harus bertambah setiap kali
ada run baru. Misalnya, pengujian dicoba ulang secara terperinci 3 kali, maka totalnya harus ada 4
run dalam runName yang sama dan attemptNumber-nya adalah dari 0 hingga 3. |
testRunStarted
public final void testRunStarted (String runName,
int testCount)Callback uji coba operasi
| Parameter | |
|---|---|
runName |
String: nama operasi pengujian |
testCount |
int: jumlah total pengujian dalam operasi pengujian |
testRunStarted
public final void testRunStarted (String runName,
int testCount,
int attemptNumber,
long startTime)Melaporkan dimulainya proses pengujian.
| Parameter | |
|---|---|
runName |
String: nama operasi pengujian |
testCount |
int: jumlah total pengujian dalam operasi pengujian |
attemptNumber |
int: nomor pesanan, yang mengidentifikasi berbagai upaya runName yang sama
yang dijalankan beberapa kali. attemptNumber diindeks 0 dan harus bertambah setiap kali
ada run baru. Misalnya, pengujian dicoba ulang secara terperinci 3 kali, sehingga total ada 4 run
dengan runName yang sama dan attemptNumber dari 0 hingga 3. |
startTime |
long: waktu mulai eksekusi, diukur melalui System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Uji coba laporan dihentikan sebelum selesai karena permintaan pengguna.
TODO: saat ini tidak digunakan, pertimbangkan untuk menghapusnya
| Parameter | |
|---|---|
elapsedTime |
long: waktu berlalu yang dilaporkan perangkat, dalam milidetik |
testSkipped
public final void testSkipped (TestDescription test, SkipReason reason)
Dipanggil saat pengujian dilewati dan tidak dijalankan karena alasan yang biasanya tidak diharapkan. Pengujian ini akan dicoba lagi untuk mendapatkan eksekusi yang tepat.
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
reason |
SkipReason: SkipReason |
testStarted
public final void testStarted (TestDescription test, long startTime)
Alternatif untuk testStarted(com.android.tradefed.result.TestDescription) yang juga menentukan kapan pengujian dimulai, dikombinasikan dengan ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) untuk pengukuran yang akurat.
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
startTime |
long: waktu dimulainya pengujian, diukur melalui System.currentTimeMillis() |
testStarted
public final void testStarted (TestDescription test)
Callback kasus pengujian
| Parameter | |
|---|---|
test |
TestDescription: mengidentifikasi pengujian |
Metode yang dilindungi
cleanUp
protected void cleanUp ()
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Ganti metode ini untuk mengubah jenis metrik jika diperlukan. Secara default, metrik disetel ke jenis yang diproses.
| Hasil | |
|---|---|
MetricMeasurement.DataType |
|
getRunName
protected String getRunName ()
| Hasil | |
|---|---|
String |
|