BasePostProcessor
public abstract class BasePostProcessor
extends Object
implements IPostProcessor
java.lang.Objek | |
↳ | com.android.tradefed.postprocessor.BasePostProcessor |
IPostProcessor
dasar yang harus diperluas oleh setiap implementasi. Pastikan metode pasca pemrosesan dipanggil sebelum pelapor hasil akhir.
Ringkasan
Konstruktor publik | |
---|---|
BasePostProcessor () |
Metode publik | |
---|---|
final ITestInvocationListener | init ( ITestInvocationListener listener) Langkah inisialisasi dari post processor. |
final void | invocationEnded (long elapsedTime) Melaporkan bahwa pemanggilan telah dihentikan, baik berhasil atau karena beberapa kondisi kesalahan. |
final void | invocationFailed ( FailureDescription failure) Melaporkan pemanggilan yang tidak lengkap karena beberapa kondisi kesalahan. |
final void | invocationFailed (Throwable cause) Melaporkan pemanggilan yang tidak lengkap karena beberapa kondisi kesalahan. |
final void | invocationStarted ( IInvocationContext context) Pendengar Doa untuk penerusan |
final boolean | isDisabled () Mengembalikan True jika seluruh objek dinonaktifkan (lewati penyiapan dan pembongkaran). |
final void | logAssociation (String dataName, LogFile logFile) Dalam beberapa kasus, log harus sangat terkait dengan kasus pengujian, tetapi kesempatan untuk melakukannya langsung Memperbarui asosiasi log-to-test. |
processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) Terapkan metode ini untuk menggabungkan metrik dan log di semua pengujian. | |
abstract | processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) Terapkan metode ini untuk menghasilkan kumpulan metrik baru dari metrik dan log yang ada. |
processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) Terapkan metode ini untuk memposting metrik dan log proses dari setiap pengujian. | |
final void | setLogSaver ( ILogSaver logSaver) Setel |
void | setUp () Ganti metode ini di prosesor postingan anak untuk diinisialisasi sebelum pengujian berjalan. |
final void | testAssumptionFailure ( TestDescription test, String trace) Dipanggil saat tes atom menandai bahwa kondisi tersebut dianggap salah |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) Dipanggil saat tes atom menandai bahwa kondisi tersebut dianggap salah |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Alternatif untuk |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Melaporkan akhir eksekusi dari kasus uji individu. |
final void | testFailed ( TestDescription test, FailureDescription failure) Melaporkan kegagalan kasus uji individu. |
final void | testFailed ( TestDescription test, String trace) Melaporkan kegagalan kasus uji individu. |
final void | testIgnored ( TestDescription test) Dipanggil saat pengujian tidak akan dijalankan, umumnya karena metode pengujian dianotasi dengan org.junit.Ignore. |
final void | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Gunakan metode ini untuk mencatat file dari implementasi PostProcessor. |
final void | testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile) Dipanggil saat log pengujian disimpan. |
final void | testModuleEnded () Melaporkan akhir dari sebuah modul yang dijalankan. |
final void | testModuleStarted ( IInvocationContext moduleContext) Melaporkan awal dari modul yang sedang berjalan. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Melaporkan akhir uji coba. |
final void | testRunFailed ( FailureDescription failure) Uji coba laporan gagal diselesaikan karena kegagalan yang dijelaskan oleh |
final void | testRunFailed (String errorMessage) Uji coba laporan gagal diselesaikan karena kesalahan fatal. |
final void | testRunStarted (String runName, int testCount, int attemptNumber) Melaporkan awal uji coba. |
final void | testRunStarted (String runName, int testCount) Uji coba callback |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Melaporkan awal uji coba. |
final void | testRunStopped (long elapsedTime) Uji coba laporan berhenti sebelum selesai karena permintaan pengguna. |
final void | testStarted ( TestDescription test, long startTime) Alternatif untuk |
final void | testStarted ( TestDescription test) Test case callback |
Metode yang dilindungi | |
---|---|
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 dari post processor. Dipastikan untuk dipanggil sebelum panggilan balik tes apa pun.
Parameter | |
---|---|
listener | ITestInvocationListener |
Pengembalian | |
---|---|
ITestInvocationListener |
doaBerakhir
public final void invocationEnded (long elapsedTime)
Melaporkan bahwa pemanggilan telah dihentikan, baik berhasil atau karena beberapa kondisi kesalahan.
Akan dipanggil secara otomatis oleh kerangka kerja TradeFederation.Parameter | |
---|---|
elapsedTime | long : waktu berlalu dari doa dalam ms |
doa Gagal
public final void invocationFailed (FailureDescription failure)
Melaporkan pemanggilan yang tidak lengkap karena beberapa kondisi kesalahan.
Akan dipanggil secara otomatis oleh kerangka kerja TradeFederation.
Parameter | |
---|---|
failure | FailureDescription : FailureDescription menjelaskan penyebab kegagalan |
doa Gagal
public final void invocationFailed (Throwable cause)
Melaporkan pemanggilan yang tidak lengkap karena beberapa kondisi kesalahan.
Akan dipanggil secara otomatis oleh kerangka kerja TradeFederation.Parameter | |
---|---|
cause | Throwable : ERROR(/Throwable) penyebab kegagalan |
invocationStarted
public final void invocationStarted (IInvocationContext context)
Pendengar Doa untuk penerusan
Parameter | |
---|---|
context | IInvocationContext : informasi tentang doa |
Dinonaktifkan
public final boolean isDisabled ()
Mengembalikan True jika seluruh objek dinonaktifkan (lewati penyiapan dan pembongkaran). Salah sebaliknya.
Pengembalian | |
---|---|
boolean |
logAssociation
public final void logAssociation (String dataName, LogFile logFile)
Dalam beberapa kasus, log harus sangat terkait dengan kasus pengujian, tetapi kesempatan untuk melakukannya langsung testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
panggilan balik tidak dimungkinkan. Dengan demikian, panggilan balik ini memungkinkan untuk memberikan asosiasi yang kuat secara eksplisit.
Memperbarui asosiasi log-to-test. Jika metode ini dipanggil selama pengujian, maka log milik pengujian; jika tidak, itu akan menjadi run log.
Parameter | |
---|---|
dataName | String : Nama data |
logFile | LogFile : LogFile yang telah dicatat sebelumnya dan harus dikaitkan dengan kasus uji. |
processAllTestMetricsAndLogs
publicprocessAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)
Terapkan metode ini untuk menggabungkan metrik dan log di semua pengujian. Metrik yang keluar dari metode ini akan dilaporkan sebagai metrik yang dijalankan. Hanya metrik yang baru dibuat yang harus dikembalikan, dan dengan nama kunci unik (benturan dengan kunci yang ada tidak diperbolehkan).
Parameter | |
---|---|
allTestMetrics | ListMultimap : HashMultimap yang menyimpan metrik dari setiap pengujian yang dikelompokkan berdasarkan nama metrik. |
allTestLogs | TestDescription setiap pengujian sebagai kunci. |
Pengembalian | |
---|---|
Kumpulan metrik yang baru dibuat dari semua metrik pengujian. |
processRunMetricsAndLogs
public abstractprocessRunMetricsAndLogs ( rawMetrics, runLogs)
Terapkan metode ini untuk menghasilkan kumpulan metrik baru dari metrik dan log yang ada. Hanya metrik yang baru dibuat yang harus dikembalikan, dan dengan nama kunci unik (benturan dengan kunci yang ada tidak diperbolehkan).
Parameter | |
---|---|
rawMetrics | |
runLogs |
Pengembalian | |
---|---|
Kumpulan metrik yang baru dibuat dari metrik yang dijalankan. |
processTestMetricsAndLogs
publicprocessTestMetricsAndLogs (TestDescription testDescription, testMetrics, testLogs)
Terapkan metode ini untuk memposting metrik dan log proses dari setiap pengujian. Hanya metrik yang baru dibuat yang harus dikembalikan, dan dengan nama kunci unik (benturan dengan kunci yang ada tidak diperbolehkan).
Parameter | |
---|---|
testDescription | TestDescription : Objek TestDescription yang mendeskripsikan pengujian. |
testMetrics | |
testLogs |
Pengembalian | |
---|---|
Kumpulan metrik yang baru dibuat dari metrik pengujian. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Setel ILogSaver
untuk mengizinkan pelaksana menyimpan file.
Parameter | |
---|---|
logSaver | ILogSaver : ILogSaver |
mempersiapkan
public void setUp ()
Ganti metode ini di prosesor postingan anak untuk diinisialisasi sebelum pengujian berjalan.
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Dipanggil saat tes atom menandai bahwa kondisi tersebut dianggap salah
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
trace | String : tumpukan jejak kegagalan |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Dipanggil saat tes atom menandai bahwa kondisi tersebut dianggap salah
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
failure | FailureDescription : FailureDescription 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. Kombinasikan dengan testStarted(com.android.tradefed.result.TestDescription, long)
untuk pengukuran yang akurat.
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
endTime | long : waktu pengujian berakhir, diukur melalui ERROR(/System#currentTimeMillis()) |
testMetrics | ERROR(/Map) dari metrik yang dipancarkan |
testEnded
public final void testEnded (TestDescription test,testMetrics)
Melaporkan akhir eksekusi dari kasus uji individual.
Jika testFailed(TestDescription, FailureDescription)
tidak dipanggil, tes ini lulus. Juga menampilkan metrik kunci/nilai apa pun yang mungkin telah dikeluarkan selama eksekusi kasus pengujian.
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
testMetrics | ERROR(/Map) dari metrik yang dipancarkan |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Melaporkan kegagalan kasus uji individu.
Akan dipanggil antara testStarted dan testEnded.
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
failure | FailureDescription : FailureDescription menjelaskan kegagalan dan konteksnya. |
testFailed
public final void testFailed (TestDescription test, String trace)
Melaporkan kegagalan kasus uji individu.
Akan dipanggil antara testStarted dan testEnded.
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
trace | String : tumpukan jejak kegagalan |
testIgnored
public final void testIgnored (TestDescription test)
Dipanggil saat pengujian tidak akan dijalankan, umumnya karena metode pengujian dianotasi dengan org.junit.Ignore.
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
testLog
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Gunakan metode ini untuk mencatat file dari implementasi PostProcessor.
Parameter | |
---|---|
dataName | String : nama deskriptif ERROR(/String) dari data. misalnya "device_logcat". Catatan dataName mungkin tidak unik per pemanggilan. yaitu pelaksana harus dapat menangani banyak panggilan dengan dataName yang sama |
dataType | LogDataType : LogDataType dari data |
dataStream | InputStreamSource : InputStreamSource dari data. Pelaksana harus memanggil createInputStream untuk mulai membaca data, dan memastikan untuk menutup InputStream yang dihasilkan setelah selesai. Penelepon 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 ERROR(/String) dari data. misalnya "device_logcat". Catatan dataName mungkin tidak unik per pemanggilan. yaitu pelaksana harus dapat menangani banyak panggilan dengan dataName yang sama |
dataType | LogDataType : LogDataType dari data |
dataStream | InputStreamSource : InputStreamSource dari 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 dari file yang disimpan. |
testModuleEnded
public final void testModuleEnded ()
Melaporkan akhir dari sebuah modul yang dijalankan.
testModuleStarted
public final void testModuleStarted (IInvocationContext moduleContext)
Melaporkan awal dari modul yang sedang berjalan. Callback ini dikaitkan dengan testModuleEnded()
dan opsional dalam urutannya. Ini hanya digunakan selama menjalankan yang menggunakan modul: pelari berbasis suite.
Parameter | |
---|---|
moduleContext | IInvocationContext : IInvocationContext dari modul. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Melaporkan akhir uji coba. FIXME: Kami tidak dapat memiliki dua antarmuka Map<> dengan tipe yang berbeda, jadi kami harus menggunakan HashMap di sini.
Parameter | |
---|---|
elapsedTime | long : perangkat melaporkan waktu berlalu, dalam milidetik |
runMetrics | Metric . |
testRunFailed
public final void testRunFailed (FailureDescription failure)
Uji coba laporan gagal diselesaikan karena kegagalan yang dijelaskan oleh FailureDescription
.
Parameter | |
---|---|
failure | FailureDescription : FailureDescription menjelaskan kegagalan dan konteksnya. |
testRunFailed
public final void testRunFailed (String errorMessage)
Uji coba laporan gagal diselesaikan karena kesalahan fatal.
Parameter | |
---|---|
errorMessage | String : ERROR(/String) menjelaskan alasan untuk menjalankan kegagalan. |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Melaporkan awal uji coba.
Parameter | |
---|---|
runName | String : nama uji coba |
testCount | int : jumlah total pengujian dalam uji coba |
attemptNumber | int : nomor urut, mengidentifikasi upaya berbeda dari runName yang sama yang berjalan berkali-kali. tryNumber adalah 0-diindeks dan harus bertambah setiap kali proses baru terjadi. misalnya, pengujian diulang ulang sebanyak 3 kali, harus memiliki total 4 proses di bawah runName yang sama dan nomor percobaan dari 0 hingga 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Uji coba callback
Parameter | |
---|---|
runName | String : nama uji coba |
testCount | int : jumlah total pengujian dalam uji coba |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Melaporkan awal uji coba.
Parameter | |
---|---|
runName | String : nama uji coba |
testCount | int : jumlah total pengujian dalam uji coba |
attemptNumber | int : nomor urut, mengidentifikasi upaya berbeda dari runName yang sama yang berjalan berkali-kali. tryNumber adalah 0-diindeks dan harus bertambah setiap kali proses baru terjadi. misalnya, pengujian diulang ulang sebanyak 3 kali, harus memiliki total 4 proses di bawah runName yang sama dan nomor percobaan dari 0 hingga 3. |
startTime | long : waktu proses dimulai, diukur melalui ERROR(/System#currentTimeMillis()) |
testRunStopped
public final void testRunStopped (long elapsedTime)
Uji coba laporan berhenti sebelum selesai karena permintaan pengguna.
TODO: saat ini tidak digunakan, pertimbangkan untuk menghapus
Parameter | |
---|---|
elapsedTime | long : perangkat melaporkan waktu berlalu, dalam milidetik |
testStarted
public final void testStarted (TestDescription test, long startTime)
Alternatif untuk testStarted(com.android.tradefed.result.TestDescription)
tempat kami juga menentukan kapan pengujian dimulai, dikombinasikan dengan ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
untuk pengukuran yang akurat .
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
startTime | long : waktu pengujian dimulai, diukur melalui ERROR(/System#currentTimeMillis()) |
testStarted
public final void testStarted (TestDescription test)
Test case callback
Parameter | |
---|---|
test | TestDescription : mengidentifikasi tes |
Metode yang dilindungi
getMetricType
protected MetricMeasurement.DataType getMetricType ()
Ganti metode ini untuk mengubah jenis metrik jika diperlukan. Secara default, metrik disetel ke jenis yang diproses.
Pengembalian | |
---|---|
MetricMeasurement.DataType |
getRunName
protected String getRunName ()
Pengembalian | |
---|---|
String |