BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

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


L' IPostProcessor di base che ogni implementazione dovrebbe estendere. Assicurarsi che i metodi di post-elaborazione vengano chiamati prima dei reporter del risultato finale.

Riepilogo

Costruttori pubblici

BasePostProcessor ()

Metodi pubblici

final ITestInvocationListener init ( ITestInvocationListener listener)

Fase di inizializzazione del post processore.

final void invocationEnded (long elapsedTime)

Segnala che l'invocazione è terminata, con successo o a causa di qualche condizione di errore.

final void invocationFailed ( FailureDescription failure)

Segnala un'invocazione incompleta a causa di qualche condizione di errore.

final void invocationFailed (Throwable cause)

Segnala un'invocazione incompleta a causa di qualche condizione di errore.

void invocationSkipped ( SkipReason reason)

Segnala un'invocazione come saltata

final void invocationStarted ( IInvocationContext context)

Listener di invocazione per l'inoltro

final boolean isDisabled ()

Restituisce True se l'intero oggetto è disabilitato (salta sia la configurazione che lo smontaggio).

final void logAssociation (String dataName, LogFile logFile)

In alcuni casi, il log deve essere fortemente associato a un test case, ma l'opportunità di farlo sul comando diretto testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) la richiamata non è possibile.

Aggiorna l'associazione log-to-test.

processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs) processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)

Implementa questo metodo per aggregare parametri e log di tutti i test.

abstract processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs) processRunMetricsAndLogs ( rawMetrics, runLogs)

Implementare questo metodo per generare una serie di nuovi parametri dai parametri e dai log esistenti.

processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs) processTestMetricsAndLogs ( TestDescription testDescription, testMetrics, testLogs)

Implementa questo metodo per pubblicare le metriche e i log del processo di ciascun test.

final void setLogSaver ( ILogSaver logSaver)

Impostare ILogSaver per consentire all'implementatore di salvare i file.

void setUp ()

Sostituisci questo metodo nei post processori secondari per inizializzarlo prima dell'esecuzione del test.

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 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) dove possiamo specificare direttamente l'ora di fine.

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)

Riporta il fallimento di un singolo test case.

final void testFailed ( TestDescription test, String trace)

Riporta 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)

Utilizza questo metodo per registrare un file dall'implementazione PostProcessor.

final void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)

Chiamato quando il registro del test viene salvato.

final void testModuleEnded ()

Segnala la fine dell'esecuzione di un modulo.

final void testModuleStarted ( IInvocationContext moduleContext)

Segnala l'inizio dell'esecuzione di un modulo.

final void testRunEnded (long elapsedTime, runMetrics) testRunEnded (long elapsedTime, runMetrics)

Riporta la fine dell'esecuzione del test.

final void testRunFailed ( FailureDescription failure)

Impossibile completare l'esecuzione del test dei report a causa di un errore descritto da FailureDescription .

final void testRunFailed (String errorMessage)

Impossibile completare l'esecuzione del test dei report 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)

Test di esecuzione dei callback

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'esecuzione del test interrotta prima del completamento a causa di una richiesta dell'utente.

final void testSkipped ( TestDescription test, SkipReason reason)

Chiamato quando un test viene saltato e non viene eseguito per un motivo solitamente non previsto.

final void testStarted ( TestDescription test, long startTime)

Alternativa a testStarted(com.android.tradefed.result.TestDescription) dove specifichiamo anche quando è stato avviato il test, combinato con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) per una misurazione accurata .

final void testStarted ( TestDescription test)

Callback dei casi di test

Metodi protetti

MetricMeasurement.DataType getMetricType ()

Sostituisci questo metodo per modificare il tipo di metrica, se necessario.

String getRunName ()

Costruttori pubblici

BasePostProcessor

public BasePostProcessor ()

Metodi pubblici

dentro

public final ITestInvocationListener init (ITestInvocationListener listener)

Fase di inizializzazione del post processore. Assicurati di essere chiamato prima di qualsiasi callback del test.

Parametri
listener ITestInvocationListener

ritorna
ITestInvocationListener

invocationEnded

public final void invocationEnded (long elapsedTime)

Segnala che l'invocazione è terminata, con successo o a causa di qualche condizione di errore.

Verrà chiamato automaticamente dal framework TradeFederation.

Parametri
elapsedTime long : il tempo trascorso dell'invocazione in ms

invocazioneFailed

public final void invocationFailed (FailureDescription failure)

Segnala un'invocazione incompleta a causa di qualche condizione di errore.

Verrà chiamato automaticamente dal framework TradeFederation.

Parametri
failure FailureDescription : la FailureDescription che descrive la causa dell'errore

invocazioneFailed

public final void invocationFailed (Throwable cause)

Segnala un'invocazione incompleta a causa di qualche condizione di errore.

Verrà chiamato automaticamente dal framework TradeFederation.

Parametri
cause Throwable : la causa Throwable del fallimento

invocationSkipped

public void invocationSkipped (SkipReason reason)

Segnala un'invocazione come saltata

Parametri
reason SkipReason

invocationStarted

public final void invocationStarted (IInvocationContext context)

Listener di invocazione per l'inoltro

Parametri
context IInvocationContext : informazioni sull'invocazione

è disabilitato

public final boolean isDisabled ()

Restituisce True se l'intero oggetto è disabilitato (salta sia la configurazione che lo smontaggio). Falso altrimenti.

ritorna
boolean

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

In alcuni casi, il log deve essere fortemente associato a un test case, ma l'opportunità di farlo sul comando diretto testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) la richiamata non è possibile. Pertanto, questo callback consente di fornire esplicitamente un'associazione forte.

Aggiorna l'associazione log-to-test. Se questo metodo viene chiamato durante un test, il log appartiene al test; altrimenti sarà un registro di esecuzione.

Parametri
dataName String : il nome dei dati

logFile LogFile : il LogFile che è stato registrato in precedenza e che dovrebbe essere associato al test case.

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

Implementa questo metodo per aggregare parametri e log di tutti i test. Le metriche risultanti da questo metodo verranno riportate come metriche di esecuzione. Dovrebbero essere restituiti solo i parametri appena generati e con un nome di chiave univoco (non sono consentite collisioni con chiavi esistenti).

Parametri
allTestMetrics ListMultimap : una HashMultimap che memorizza le metriche di ciascun test raggruppate per nomi di metriche.

allTestLogs : una mappa che memorizza la mappa dei file di registro di ciascun test codificati in base ai nomi dei dati, utilizzando la TestDescription di ciascun test come chiavi.

ritorna
L'insieme di metriche appena generate da tutte le metriche di test.

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

Implementare questo metodo per generare una serie di nuovi parametri dai parametri e dai log esistenti. Dovrebbero essere restituiti solo i parametri appena generati e con un nome di chiave univoco (non sono consentite collisioni con chiavi esistenti).

Parametri
rawMetrics : l'insieme di metriche grezze disponibili per l'esecuzione.

runLogs : l'insieme di file di registro per l'esecuzione del test.

ritorna
L'insieme di parametri appena generati dai parametri di esecuzione.

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

Implementa questo metodo per pubblicare metriche e log del processo da ciascun test. Dovrebbero essere restituiti solo i parametri appena generati e con un nome di chiave univoco (non sono consentite collisioni con chiavi esistenti).

Parametri
testDescription TestDescription : l'oggetto TestDescription che descrive il test.

testMetrics : l'insieme di metriche del test.

testLogs : l'insieme di file registrati durante il test.

ritorna
L'insieme di metriche appena generate dalle metriche di test.

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

Impostare ILogSaver per consentire all'implementatore di salvare i file.

Parametri
logSaver ILogSaver : ILogSaver

impostare

public void setUp ()

Sostituisci questo metodo nei post processori secondari per inizializzarlo prima dell'esecuzione del test.

testAssunzioneFailure

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 di errore

testAssunzioneFailure

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.

testEnded

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. Combinalo 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, misurata tramite System.currentTimeMillis()

testMetrics : un ERROR(/Map) delle metriche emesse

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

Riporta la fine dell'esecuzione di un singolo test case.

Se testFailed(TestDescription, FailureDescription) non è stato richiamato, il test è stato superato. Restituisce inoltre qualsiasi metrica chiave/valore che potrebbe essere stata emessa durante l'esecuzione del test case.

Parametri
test TestDescription : identifica il test

testMetrics : un ERROR(/Map) delle metriche emesse

prova non riuscita

public final void testFailed (TestDescription test, 
                FailureDescription failure)

Riporta il fallimento di un singolo caso di test.

Verrà chiamato tra testStarted e testEnded.

Parametri
test TestDescription : identifica il test

failure FailureDescription : FailureDescription che descrive l'errore e il relativo contesto.

prova non riuscita

public final void testFailed (TestDescription test, 
                String trace)

Riporta il fallimento di un singolo test case.

Verrà chiamato tra testStarted e testEnded.

Parametri
test TestDescription : identifica il test

trace String : traccia dello stack di 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)

Utilizza questo metodo per registrare un file dall'implementazione PostProcessor.

Parametri
dataName String : una String nome descrittivo dei dati. ad esempio "device_logcat". Nota dataName potrebbe non essere univoco per invocazione. cioè gli implementatori devono essere in grado di gestire più chiamate con lo stesso dataName

dataType LogDataType : il LogDataType dei dati

dataStream InputStreamSource : l' InputStreamSource dei dati. Gli implementatori dovrebbero chiamare createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante una volta completato. I chiamanti devono garantire che l'origine dei dati rimanga presente e accessibile fino al completamento del metodo testLog.

testLogSaved

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Chiamato quando il registro del test viene salvato.

Dovrebbe essere utilizzato al posto di ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) .

Parametri
dataName String : una String nome descrittivo dei dati. ad esempio "device_logcat". Nota dataName potrebbe non essere univoco per invocazione. cioè gli implementatori devono essere in grado di gestire più chiamate con lo stesso dataName

dataType LogDataType : il LogDataType dei dati

dataStream InputStreamSource : l' InputStreamSource dei dati. Gli implementatori dovrebbero chiamare createInputStream per iniziare a leggere i dati e assicurarsi di chiudere l'InputStream risultante una volta completato.

logFile LogFile : il LogFile contenente i metadati del file salvato.

testModuleEnded

public final void testModuleEnded ()

Segnala la fine dell'esecuzione di un modulo.

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

Segnala l'inizio dell'esecuzione di un modulo. 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 : l' 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 : il dispositivo ha riportato il tempo trascorso, in millisecondi

runMetrics : coppie chiave-valore riportate al termine di un'esecuzione di test con Metric .

testRunFailed

public final void testRunFailed (FailureDescription failure)

Impossibile completare l'esecuzione del test dei report 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)

Impossibile completare l'esecuzione del test dei report 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 prova.

Parametri
runName String : il nome dell'esecuzione del test

testCount int : numero totale di test nell'esecuzione del test

attemptNumber int : numero dell'ordine, che identifica i diversi tentativi dello stesso runName eseguiti più volte. Il tryNumber è indicizzato a 0 e dovrebbe incrementare ogni volta che si verifica una nuova esecuzione. Ad esempio, un test granulare viene ripetuto 3 volte, dovrebbe avere 4 esecuzioni totali con lo stesso runName e il tryNumber è compreso tra 0 e 3.

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

Test di esecuzione dei callback

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

Parametri
runName String : il nome dell'esecuzione del test

testCount int : numero totale di test nell'esecuzione del test

attemptNumber int : numero dell'ordine, che identifica i diversi tentativi dello stesso runName eseguiti più volte. Il tryNumber è indicizzato a 0 e dovrebbe incrementare ogni volta che si verifica una nuova esecuzione. Ad esempio, un test granulare viene ripetuto 3 volte, dovrebbe avere 4 esecuzioni totali con lo stesso runName e il tryNumber è 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'esecuzione del test interrotta prima del completamento a causa di una richiesta dell'utente.

TODO: attualmente inutilizzato, valuta la possibilità di rimuoverlo

Parametri
elapsedTime long : il dispositivo ha riportato il tempo trascorso, in millisecondi

testSaltato

public final void testSkipped (TestDescription test, 
                SkipReason reason)

Chiamato quando un test viene saltato e non viene eseguito per un motivo solitamente non previsto. Si tenterà di ripetere questi test per tentare di ottenere una corretta esecuzione.

Parametri
test TestDescription : identifica il test

reason SkipReason : SkipReason

testAvviato

public final void testStarted (TestDescription test, 
                long startTime)

Alternativa a testStarted(com.android.tradefed.result.TestDescription) dove specifichiamo anche quando è stato avviato il test, combinato con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) per una misurazione 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

Metodi protetti

getMetricType

protected MetricMeasurement.DataType getMetricType ()

Sostituisci questo metodo per modificare il tipo di metrica, se necessario. Per impostazione predefinita, la metrica è impostata sul tipo elaborato.

ritorna
MetricMeasurement.DataType

getRunName

protected String getRunName ()

ritorna
String