BaseDeviceMetric Collector
public class BaseDeviceMetricCollector
extends Object
implements IMetricCollector
java.lang.Oggetto | |
↳ | com.android.tradefed.device.metric.BaseDeviceMetricCollector |
Implementazione di base di IMetricCollector
che consente di avviare e interrompere la raccolta su onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)
e ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))
.
Riepilogo
Campi | |
---|---|
public static final String | TEST_CASE_EXCLUDE_GROUP_OPTION |
public static final String | TEST_CASE_INCLUDE_GROUP_OPTION
|
Costruttori pubblici | |
---|---|
BaseDeviceMetricCollector () |
Metodi pubblici | |
---|---|
final | getBuildInfos () Restituisce l'elenco delle informazioni sulla build disponibili nell'invocazione. |
final | getDevices () Restituisce l'elenco dei dispositivi disponibili nell'invocazione. |
File | getFileFromTestArtifacts (String fileName) Recuperare il file dagli artefatti di test o dagli artefatti del modulo e memorizzarlo nella cache in una mappa per le chiamate successive. |
final ITestInvocationListener | getInvocationListener () Restituisce l' |
String | getModuleName () |
final | getRealDevices () Restituisce tutti i dispositivi non stub dall'elenco |
String | getRunName () Restituisce il nome dell'esecuzione di test |
ITestInvocationListener | init ( IInvocationContext context, ITestInvocationListener listener) Inizializzazione del raccoglitore con il contesto corrente e dove inoltrare i risultati. |
final void | invocationEnded (long elapsedTime) Segnala che la chiamata è stata terminata, con successo oa causa di qualche condizione di errore. |
final void | invocationFailed ( FailureDescription failure) Segnala una chiamata incompleta a causa di una condizione di errore. |
final void | invocationFailed (Throwable cause) Segnala una chiamata incompleta a causa di una condizione di errore. |
final void | invocationStarted ( IInvocationContext context) Invocazione Listener per l'inoltro |
final boolean | isDisabled () Restituisce True se l'intero oggetto è disabilitato (salta sia l'installazione che lo smontaggio). |
final void | logAssociation (String dataName, LogFile logFile) Non utilizzare l'implementazione interna del raccoglitore di metriche. |
void | onTestAssumptionFailure ( DeviceMetricData testData, TestDescription test) Richiamata quando un caso di test fallisce con presupposto fallito. |
void | onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) Richiamata al termine di un test case. |
void | onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) onTestEnd ( DeviceMetricData testData, currentTestCaseMetrics) Richiamata al termine di un test case. |
void | onTestFail ( DeviceMetricData testData, TestDescription test) Richiamata quando un test case fallisce. |
void | onTestModuleEnded () Consente di catturare l'evento di chiusura del modulo. |
void | onTestModuleStarted () Consente di catturare l'evento avviato dal modulo. |
void | onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) onTestRunEnd ( DeviceMetricData runData, currentRunMetrics) Richiamata al termine di un'esecuzione di prova. |
void | onTestRunFailed ( DeviceMetricData testData, FailureDescription failure) Callback per gli eventi testRunFailed |
void | onTestRunStart ( DeviceMetricData runData) Richiamata all'avvio di un'esecuzione di prova. |
void | onTestStart ( DeviceMetricData testData) Richiamata all'avvio di un test case. |
final void | setDisable (boolean isDisabled) Imposta se l'oggetto deve essere disabilitato. |
final void | setLogSaver ( ILogSaver logSaver) Non utilizzare l'implementazione interna del raccoglitore di metriche. |
final void | testAssumptionFailure ( TestDescription test, String trace) Chiamato quando un test atomico segnala che presuppone una condizione falsa |
final void | testAssumptionFailure ( TestDescription test, FailureDescription failure) Chiamato quando un test atomico segnala che presuppone una condizione falsa |
final void | testEnded ( TestDescription test, long endTime, testMetrics) testEnded ( TestDescription test, long endTime, testMetrics) Alternativa a |
final void | testEnded ( TestDescription test, testMetrics) testEnded ( TestDescription test, testMetrics) Riporta la fine dell'esecuzione di un singolo test case. |
final void | testFailed ( TestDescription test, FailureDescription failure) Segnala il fallimento di un singolo test case. |
final void | testFailed ( TestDescription test, String trace) Segnala il fallimento di un singolo test case. |
final void | testIgnored ( TestDescription test) Chiamato quando un test non verrà eseguito, generalmente perché un metodo di test è annotato con org.junit.Ignore. |
final void | testLog (String dataName, LogDataType dataType, InputStreamSource dataStream) Fornisce i dati di log o debug associati dalla chiamata di test. |
final void | testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile) Non utilizzare l'implementazione interna del raccoglitore di metriche. |
final void | testModuleEnded () Segnala la fine dell'esecuzione di un modulo. |
final void | testModuleStarted ( IInvocationContext moduleContext) Segnala l'inizio di un modulo in esecuzione. |
final void | testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics) Segnala la fine dell'esecuzione del test. |
final void | testRunFailed ( FailureDescription failure) L'esecuzione del test dei report non è riuscita a essere completata a causa di un errore descritto da |
final void | testRunFailed (String errorMessage) L'esecuzione del test dei rapporti non è riuscita a essere completata a causa di un errore irreversibile. |
final void | testRunStarted (String runName, int testCount, int attemptNumber) Segnala l'inizio di un'esecuzione di prova. |
final void | testRunStarted (String runName, int testCount) Callback di esecuzione di test |
final void | testRunStarted (String runName, int testCount, int attemptNumber, long startTime) Segnala l'inizio di un'esecuzione di prova. |
final void | testRunStopped (long elapsedTime) Segnala l'interruzione dell'esecuzione del test prima del completamento a causa di una richiesta dell'utente. |
final void | testStarted ( TestDescription test, long startTime) Alternativa a |
final void | testStarted ( TestDescription test) Callback dei casi di test |
Campi
TEST_CASE_EXCLUDE_GROUP_OPTION
public static final String TEST_CASE_EXCLUDE_GROUP_OPTION
TEST_CASE_INCLUDE_GROUP_OPTION
public static final String TEST_CASE_INCLUDE_GROUP_OPTION
Costruttori pubblici
BaseDeviceMetric Collector
public BaseDeviceMetricCollector ()
Metodi pubblici
getBuildInfos
public finalgetBuildInfos ()
Restituisce l'elenco delle informazioni sulla build disponibili nell'invocazione.
ritorna | |
---|---|
getDevices
public finalgetDevices ()
Restituisce l'elenco dei dispositivi disponibili nell'invocazione.
ritorna | |
---|---|
getFileFromTestArtifacts
public File getFileFromTestArtifacts (String fileName)
Recuperare il file dagli artefatti di test o dagli artefatti del modulo e memorizzarlo nella cache in una mappa per le chiamate successive.
Parametri | |
---|---|
fileName | String : nome del file da cercare negli artefatti. |
ritorna | |
---|---|
File | File dall'artefatto di test o dall'artefatto del modulo. Restituisce null se il file non viene trovato. |
getInvocazioneListener
public final ITestInvocationListener getInvocationListener ()
Restituisce l' ITestInvocationListener
originale a cui stiamo inoltrando i risultati.
ritorna | |
---|---|
ITestInvocationListener |
getModuleName
public String getModuleName ()
ritorna | |
---|---|
String |
getRealDevices
public finalgetRealDevices ()
Restituisce tutti i dispositivi non stub dall'elenco getDevices()
.
ritorna | |
---|---|
getRunName
public String getRunName ()
Restituisce il nome dell'esecuzione di test mRunName
che attiva il programma di raccolta.
ritorna | |
---|---|
String | mRunName, il nome dell'esecuzione di test corrente. |
dentro
public ITestInvocationListener init (IInvocationContext context, ITestInvocationListener listener)
Inizializzazione del raccoglitore con il contesto corrente e dove inoltrare i risultati. Verrà chiamato solo una volta per istanza e si prevede che il raccoglitore aggiorni il suo contesto interno e il suo ascoltatore. Init non verrà mai chiamato durante un'esecuzione di test sempre prima.
Non eseguire l'override a meno che tu non sappia cosa stai facendo.
Parametri | |
---|---|
context | IInvocationContext : IInvocationContext per la chiamata in corso. |
listener | ITestInvocationListener : ITestInvocationListener dove inserire i risultati. |
ritorna | |
---|---|
ITestInvocationListener | il nuovo ascoltatore avvolgendo quello originale. |
Getta | |
---|---|
DeviceNotAvailableException |
invocazioneEnded
public final void invocationEnded (long elapsedTime)
Segnala che la chiamata è stata terminata, con successo oa causa di qualche condizione di errore.
Verrà richiamato automaticamente dal framework TradeFederation.Parametri | |
---|---|
elapsedTime | long : il tempo trascorso dell'invocazione in ms |
invocazione non riuscita
public final void invocationFailed (FailureDescription failure)
Segnala una chiamata incompleta a causa di una condizione di errore.
Verrà richiamato automaticamente dal framework TradeFederation.
Parametri | |
---|---|
failure | FailureDescription : la FailureDescription che descrive la causa dell'errore |
invocazione non riuscita
public final void invocationFailed (Throwable cause)
Segnala una chiamata incompleta a causa di una condizione di errore.
Verrà richiamato automaticamente dal framework TradeFederation.Parametri | |
---|---|
cause | Throwable : la causa Throwable del fallimento |
invocazioneAvviato
public final void invocationStarted (IInvocationContext context)
Invocazione Listener per l'inoltro
Parametri | |
---|---|
context | IInvocationContext : informazioni sulla chiamata |
è disabilitato
public final boolean isDisabled ()
Restituisce True se l'intero oggetto è disabilitato (salta sia l'installazione che lo smontaggio). Falso altrimenti.
ritorna | |
---|---|
boolean |
logAssociazione
public final void logAssociation (String dataName, LogFile logFile)
Non utilizzare l'implementazione interna del raccoglitore di metriche. Questo è puro inoltro.
Parametri | |
---|---|
dataName | String : il nome dei dati |
logFile | LogFile : il LogFile che è stato registrato in precedenza e deve essere associato al test case. |
onTestAssumptionFailure
public void onTestAssumptionFailure (DeviceMetricData testData, TestDescription test)
Richiamata quando un caso di test fallisce con presupposto fallito.
Parametri | |
---|---|
testData | DeviceMetricData : il DeviceMetricData contenente i dati per il test case. |
test | TestDescription : la TestDescription del test case in corso. |
Getta | |
---|---|
DeviceNotAvailableException |
suTestEnd
public void onTestEnd (DeviceMetricData testData,currentTestCaseMetrics, TestDescription test)
Richiamata al termine di un test case. Questo dovrebbe essere il momento della pulizia.
Parametri | |
---|---|
testData | DeviceMetricData : il DeviceMetricData contenente i dati per il test case. Sarà lo stesso oggetto di onTestStart(com.android.tradefed.device.metric.DeviceMetricData) . |
currentTestCaseMetrics | ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) . |
test | TestDescription : la TestDescription del test case in corso. |
Getta | |
---|---|
DeviceNotAvailableException |
suTestEnd
public void onTestEnd (DeviceMetricData testData,currentTestCaseMetrics)
Richiamata al termine di un test case. Questo dovrebbe essere il momento della pulizia.
Parametri | |
---|---|
testData | DeviceMetricData : il DeviceMetricData contenente i dati per il test case. Sarà lo stesso oggetto di onTestStart(com.android.tradefed.device.metric.DeviceMetricData) . |
currentTestCaseMetrics | ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) . |
Getta | |
---|---|
DeviceNotAvailableException |
onTestFail
public void onTestFail (DeviceMetricData testData, TestDescription test)
Richiamata quando un test case fallisce.
Parametri | |
---|---|
testData | DeviceMetricData : il DeviceMetricData contenente i dati per il test case. |
test | TestDescription : la TestDescription del test case in corso. |
Getta | |
---|---|
DeviceNotAvailableException |
onTestModuleEnded
public void onTestModuleEnded ()
Consente di catturare l'evento di chiusura del modulo.
Getta | |
---|---|
DeviceNotAvailableException |
onTestModuleStarted
public void onTestModuleStarted ()
Consente di catturare l'evento avviato dal modulo.
Getta | |
---|---|
DeviceNotAvailableException |
suTestRunEnd
public void onTestRunEnd (DeviceMetricData runData,currentRunMetrics)
Richiamata al termine di un'esecuzione di test. Questo dovrebbe essere il momento della pulizia.
Parametri | |
---|---|
runData | DeviceMetricData : DeviceMetricData contenente i dati per l'esecuzione. Sarà lo stesso oggetto di onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) . |
currentRunMetrics | ERROR(/#testRunEnded(long,Map)) . |
Getta | |
---|---|
DeviceNotAvailableException |
onTestRunFailed
public void onTestRunFailed (DeviceMetricData testData, FailureDescription failure)
Callback per gli eventi testRunFailed
Getta | |
---|---|
DeviceNotAvailableException |
suTestRunStart
public void onTestRunStart (DeviceMetricData runData)
Richiamata all'avvio di un'esecuzione di prova.
Parametri | |
---|---|
runData | DeviceMetricData : DeviceMetricData contenente i dati per l'esecuzione. |
Getta | |
---|---|
DeviceNotAvailableException |
suTestStart
public void onTestStart (DeviceMetricData testData)
Richiamata all'avvio di un test case.
Parametri | |
---|---|
testData | DeviceMetricData : il DeviceMetricData contenente i dati per il test case. |
Getta | |
---|---|
DeviceNotAvailableException |
setDisattiva
public final void setDisable (boolean isDisabled)
Imposta se l'oggetto deve essere disabilitato. Disabilitato significa che i passaggi di installazione e smontaggio devono essere saltati. Può essere utilizzato per rendere un oggetto disabilitato per impostazione predefinita nel costruttore predefinito.
Parametri | |
---|---|
isDisabled | boolean : lo stato in cui deve essere inserito l'oggetto. |
setLogSaver
public final void setLogSaver (ILogSaver logSaver)
Non utilizzare l'implementazione interna del raccoglitore di metriche. Questo è puro inoltro.
Parametri | |
---|---|
logSaver | ILogSaver : ILogSaver |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, String trace)
Chiamato quando un test atomico segnala che presuppone una condizione falsa
Parametri | |
---|---|
test | TestDescription : identifica il test |
trace | String : traccia dello stack dell'errore |
testAssumptionFailure
public final void testAssumptionFailure (TestDescription test, FailureDescription failure)
Chiamato quando un test atomico segnala che presuppone una condizione falsa
Parametri | |
---|---|
test | TestDescription : identifica il test |
failure | FailureDescription : FailureDescription che descrive l'errore e il relativo contesto. |
testTerminato
public final void testEnded (TestDescription test, long endTime,testMetrics)
Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
dove possiamo specificare direttamente l'ora di fine. Combina con testStarted(com.android.tradefed.result.TestDescription, long)
per una misurazione accurata.
Parametri | |
---|---|
test | TestDescription : identifica il test |
endTime | long : l'ora in cui è terminato il test, misurato tramite System.currentTimeMillis() |
testMetrics | ERROR(/Map) delle metriche emesse |
testTerminato
public final void testEnded (TestDescription test,testMetrics)
Riporta la fine dell'esecuzione di un singolo test case.
Se testFailed(TestDescription, FailureDescription)
non è stato richiamato, questo test ha avuto esito positivo. Restituisce anche qualsiasi metrica chiave/valore che potrebbe essere stata emessa durante l'esecuzione del caso di test.
Parametri | |
---|---|
test | TestDescription : identifica il test |
testMetrics | ERROR(/Map) delle metriche emesse |
testFailed
public final void testFailed (TestDescription test, FailureDescription failure)
Segnala il fallimento di un singolo test case.
Verrà chiamato tra testStarted e testEnded.
Parametri | |
---|---|
test | TestDescription : identifica il test |
failure | FailureDescription : FailureDescription che descrive l'errore e il relativo contesto. |
testFailed
public final void testFailed (TestDescription test, String trace)
Segnala il fallimento di un singolo test case.
Verrà chiamato tra testStarted e testEnded.
Parametri | |
---|---|
test | TestDescription : identifica il test |
trace | String : traccia dello stack dell'errore |
testIgnorato
public final void testIgnored (TestDescription test)
Chiamato quando un test non verrà eseguito, generalmente perché un metodo di test è annotato con org.junit.Ignore.
Parametri | |
---|---|
test | TestDescription : identifica il test |
testLog
public final void testLog (String dataName, LogDataType dataType, InputStreamSource dataStream)
Fornisce i dati di log o debug associati dalla chiamata di test.
Deve essere chiamato primaERROR(/ITestInvocationListener#invocationFailed(Throwable))
o ERROR(/ITestInvocationListener#invocationEnded(long))
Il framework TradeFederation chiamerà automaticamente questo metodo, fornendo il log dell'host e, se applicabile, il logcat del dispositivo.Parametri | |
---|---|
dataName | String : un nome descrittivo String dei dati. ad esempio "device_logcat". Nota dataName potrebbe non essere univoco per chiamata. cioè gli implementatori devono essere in grado di gestire più chiamate con lo stesso dataName |
dataType | LogDataType : il LogDataType dei dati |
dataStream | InputStreamSource : InputStreamSource dei dati. Gli implementatori dovrebbero chiamare createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante al termine. I chiamanti devono assicurarsi che l'origine dei dati rimanga presente e accessibile fino al completamento del metodo testLog. |
testLogSalvato
public final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Non utilizzare l'implementazione interna del raccoglitore di metriche. Questo è puro inoltro.
Parametri | |
---|---|
dataName | String : un nome descrittivo String dei dati. ad esempio "device_logcat". Nota dataName potrebbe non essere univoco per chiamata. cioè gli implementatori devono essere in grado di gestire più chiamate con lo stesso dataName |
dataType | LogDataType : il LogDataType dei dati |
dataStream | InputStreamSource : InputStreamSource dei dati. Gli implementatori dovrebbero chiamare createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante al termine. |
logFile | LogFile : il LogFile contenente i metadati del file salvato. |
testModuleEnded
public final void testModuleEnded ()
Segnala la fine dell'esecuzione di un modulo.
testModuleAvviato
public final void testModuleStarted (IInvocationContext moduleContext)
Segnala l'inizio di un modulo in esecuzione. Questo callback è associato a testModuleEnded()
ed è facoltativo nella sequenza. Viene utilizzato solo durante una corsa che utilizza moduli: corridori basati su suite.
Parametri | |
---|---|
moduleContext | IInvocationContext : IInvocationContext del modulo. |
testRunEnded
public final void testRunEnded (long elapsedTime,runMetrics)
Segnala la fine dell'esecuzione del test. FIXME: non possiamo avere due interfacce Map<> con tipo diverso, quindi dobbiamo usare HashMap qui.
Parametri | |
---|---|
elapsedTime | long : tempo trascorso segnalato dal dispositivo, in millisecondi |
runMetrics | Metric . |
testRunFailed
public final void testRunFailed (FailureDescription failure)
L'esecuzione del test dei report non è riuscita a essere completata a causa di un errore descritto da FailureDescription
.
Parametri | |
---|---|
failure | FailureDescription : FailureDescription che descrive l'errore e il relativo contesto. |
testRunFailed
public final void testRunFailed (String errorMessage)
L'esecuzione del test dei rapporti non è riuscita a essere completata a causa di un errore irreversibile.
Parametri | |
---|---|
errorMessage | String : String che descrive il motivo dell'errore di esecuzione. |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber)
Segnala l'inizio di un'esecuzione di test.
Parametri | |
---|---|
runName | String : il nome dell'esecuzione del test |
testCount | int : numero totale di test nell'esecuzione del test |
attemptNumber | int : numero d'ordine, che identifica i diversi tentativi dello stesso runName che vengono eseguiti più volte. Il tryNumber è indicizzato a 0 e dovrebbe incrementare ogni volta che si verifica una nuova esecuzione. ad esempio, un test viene ritentato in modo granulare 3 volte, dovrebbe avere 4 esecuzioni totali con lo stesso runName e il numero di tentativi è compreso tra 0 e 3. |
testRunStarted
public final void testRunStarted (String runName, int testCount)
Callback di esecuzione di test
Parametri | |
---|---|
runName | String : il nome dell'esecuzione del test |
testCount | int : numero totale di test nell'esecuzione del test |
testRunStarted
public final void testRunStarted (String runName, int testCount, int attemptNumber, long startTime)
Segnala l'inizio di un'esecuzione di test.
Parametri | |
---|---|
runName | String : il nome dell'esecuzione del test |
testCount | int : numero totale di test nell'esecuzione del test |
attemptNumber | int : numero d'ordine, che identifica i diversi tentativi dello stesso runName che vengono eseguiti più volte. Il tryNumber è indicizzato a 0 e dovrebbe incrementare ogni volta che si verifica una nuova esecuzione. ad esempio, un test viene ritentato in modo granulare 3 volte, dovrebbe avere 4 esecuzioni totali con lo stesso runName e il numero di tentativi è compreso tra 0 e 3. |
startTime | long : l'ora di inizio dell'esecuzione, misurata tramite System.currentTimeMillis() |
testRunStopped
public final void testRunStopped (long elapsedTime)
Segnala l'interruzione dell'esecuzione del test prima del completamento a causa di una richiesta dell'utente.
TODO: attualmente inutilizzato, prendere in considerazione la rimozione
Parametri | |
---|---|
elapsedTime | long : tempo trascorso segnalato dal dispositivo, in millisecondi |
testAvviato
public final void testStarted (TestDescription test, long startTime)
Alternativa a testStarted(com.android.tradefed.result.TestDescription)
dove specifichiamo anche quando il test è stato avviato, combinato con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))
per una misura accurata .
Parametri | |
---|---|
test | TestDescription : identifica il test |
startTime | long : l'ora di inizio del test, misurata tramite System.currentTimeMillis() |
testAvviato
public final void testStarted (TestDescription test)
Callback dei casi di test
Parametri | |
---|---|
test | TestDescription : identifica il test |