CollectingTestListener
public
class
CollectingTestListener
extends Object
implements
IDisableable,
ILogSaverListener,
ITestInvocationListener
java.lang.Object | |
🎞 | com.android.tradefed.result.CollectingTestListener |
Un ITestInvocationListener
che raccoglierà tutti i risultati del test.
Sebbene le strutture dati utilizzate in questo oggetto siano sicure per i thread, i callback ITestInvocationListener
devono essere chiamati nell'ordine corretto.
Riepilogo
Costruttori pubblici | |
---|---|
CollectingTestListener()
|
Metodi pubblici | |
---|---|
IBuildInfo
|
getBuildInfo()
Questo metodo è obsoleto.
usa |
TestRunResult
|
getCurrentRunResults()
Restituisce i risultati dell'esecuzione del test attuale. |
int
|
getExpectedTests()
Restituisce il numero di test previsti. |
IInvocationContext
|
getInvocationContext()
Restituisce il contesto di chiamata segnalato tramite |
|
getMergedTestRunResults()
Restituisce la raccolta unita di risultati per tutte le esecuzioni in diversi tentativi. |
IInvocationContext
|
getModuleContextForRunResult(String testRunName)
Restituisce il valore |
MultiMap<String, LogFile>
|
getModuleLogFiles()
Restituisce una copia della mappa contenente tutti i file registrati associati al modulo |
MultiMap<String, LogFile>
|
getNonAssociatedLogFiles()
Restituisce una copia della mappa contenente tutti i file registrati non associati a un'esecuzione di test o a un in maggior dettaglio più avanti in questo modulo. |
int
|
getNumAllFailedTestRuns()
Restituisce il numero totale di esecuzioni di test in stato di errore |
int
|
getNumAllFailedTests()
Restituisce il numero totale di test in stato di errore (solo non riusciti, gli errori presupposti non vengono conteggiati). |
int
|
getNumTestsInState(TestStatus status)
Restituisce il numero di test in un determinato stato per questa esecuzione. |
int
|
getNumTestsInState(TestResult.TestStatus ddmlibStatus)
Per la compatibilità con i tipi di stato precedenti |
int
|
getNumTotalTests()
Restituisce il numero totale di test completi per tutte le esecuzioni. |
IBuildInfo
|
getPrimaryBuildInfo()
Restituisci le informazioni sulla build principale segnalate tramite |
|
getRunResults()
Questo metodo è obsoleto.
Usa |
TestRunResult
|
getTestRunAtAttempt(String testRunName, int attempt)
Restituisci |
int
|
getTestRunAttemptCount(String testRunName)
Restituisce il numero di tentativi per un determinato nome di esecuzione di test. |
|
getTestRunAttempts(String testRunName)
Recupera tutti i tentativi per un |
|
getTestRunForAttempts(int attempt)
Recupera tutti i risultati di un determinato tentativo. |
|
getTestRunNames()
Restituisce tutti i nomi di tutte le esecuzioni di test. |
boolean
|
hasFailedTests()
Restituisce un valore che indica se la chiamata includeva test non riusciti o non superati dal presupposto. |
boolean
|
hasTestRunResultsForName(String testRunName)
Restituisce se un determinato nome di esecuzione di test ha dei risultati. |
void
|
invocationEnded(long elapsedTime)
Report che la chiamata è stata terminata, correttamente o a causa di un errore . |
void
|
invocationFailed(Throwable cause)
Segnala una chiamata incompleta a causa di alcune condizioni di errore. |
void
|
invocationSkipped(SkipReason reason)
Segnala una chiamata come saltata |
void
|
invocationStarted(IInvocationContext context)
Segnala l'inizio della chiamata di test. |
boolean
|
isDisabled()
Restituisce True se l'intero oggetto è disabilitato (saltano configurazione ed eliminazione). |
void
|
logAssociation(String dataName, LogFile logFile)
In alcuni casi, il log deve essere fortemente associato a uno scenario di test, ma la possibilità di farlo
quindi sulla diretta |
void
|
setBuildInfo(IBuildInfo buildInfo)
Questo metodo è obsoleto. Non è più necessario per i test. |
void
|
setDisable(boolean isDisabled)
Consente di impostare se l'oggetto deve essere disabilitato. |
void
|
setMergeStrategy(MergeStrategy strategy)
Consente di impostare l' |
void
|
testAssumptionFailure(TestDescription test, String trace)
Richiamato quando un test atomico segnala che assume una condizione falsa |
void
|
testAssumptionFailure(TestDescription test, FailureDescription failure)
Richiamato quando un test atomico segnala che assume una condizione falsa |
void
|
testEnded(TestDescription test, long endTime,
Alternativa a |
void
|
testEnded(TestDescription test,
Segnala la fine dell'esecuzione di un singolo scenario di test. |
void
|
testFailed(TestDescription test, FailureDescription failure)
Segnala l'errore di un singolo scenario di test. |
void
|
testFailed(TestDescription test, String trace)
Segnala l'errore di un singolo scenario di test. |
void
|
testIgnored(TestDescription test)
Richiamato quando non verrà eseguito un test, in genere perché un metodo di test è annotato con org.junit.Ignora. |
void
|
testModuleEnded()
Segnala la fine dell'esecuzione di un modulo. |
void
|
testModuleStarted(IInvocationContext moduleContext)
Segnala l'inizio di un modulo in esecuzione. |
void
|
testRunEnded(long elapsedTime,
Fine dell'esecuzione del test nei report. |
void
|
testRunFailed(FailureDescription failure)
L'esecuzione del test dei report non è riuscita a causa di un errore descritto da |
void
|
testRunFailed(String errorMessage)
L'esecuzione del test dei report non è riuscita a causa di un errore irreversibile. |
void
|
testRunStarted(String name, int numTests, int attemptNumber)
Segnala l'inizio di un'esecuzione di test. |
void
|
testRunStarted(String name, int numTests)
Segnala l'inizio di un'esecuzione di test. |
void
|
testRunStarted(String name, int numTests, int attemptNumber, long startTime)
Segnala l'inizio di un'esecuzione di test. |
void
|
testRunStopped(long elapsedTime)
Esecuzione di test dei report interrotta prima del completamento a causa di una richiesta dell'utente. |
void
|
testSkipped(TestDescription test, SkipReason reason)
Richiamato quando un test viene ignorato e non è stato eseguito per un motivo solitamente non previsto. |
void
|
testStarted(TestDescription test, long startTime)
Alternativa a |
void
|
testStarted(TestDescription test)
Segnala l'inizio di un singolo scenario di test. |
Metodi protetti | |
---|---|
final
void
|
clearModuleLogFiles()
Consente di ripulire il file del modulo in modo da evitare di contenerlo troppo a lungo. |
final
void
|
clearResultsForName(String testRunName)
Consente di cancellare i risultati per un determinato nome di esecuzione. |
void
|
setIsAggregrateMetrics(boolean aggregate)
Attiva/disattiva le "metriche aggregate" opzione |
Costruttori pubblici
CollectingTestListener
public CollectingTestListener ()
Metodi pubblici
getBuildInfo
public IBuildInfo getBuildInfo ()
Questo metodo è stato ritirato.
fai affidamento su IBuildInfo
di getInvocationContext()
.
Restituisce le informazioni sulla build.
Ritorni | |
---|---|
IBuildInfo |
getCurrentRunResults
public TestRunResult getCurrentRunResults ()
Restituisce i risultati dell'esecuzione del test attuale.
Tieni presente che i risultati potrebbero non essere completi. Ti consigliamo di testare il valore di TestRunResult.isRunComplete()
e/o (@link TestRunResult#isRunFailure()} a seconda dei casi
prima di elaborare i risultati.
Ritorni | |
---|---|
TestRunResult |
TestRunResult che rappresenta i dati raccolti durante l'ultima esecuzione di test |
getexpectedTests
public int getExpectedTests ()
Restituisce il numero di test previsti. Potrebbe differire da getNumTotalTests()
se
alcuni test non sono stati eseguiti.
Ritorni | |
---|---|
int |
getInvocationContext
public IInvocationContext getInvocationContext ()
Restituisce il contesto di chiamata segnalato tramite invocationStarted(com.android.tradefed.invoker.IInvocationContext)
Ritorni | |
---|---|
IInvocationContext |
getMergedTestRunResults
publicgetMergedTestRunResults ()
Restituisce la raccolta unita di risultati per tutte le esecuzioni in diversi tentativi.
Se ci sono più risultati, ogni esecuzione del test viene unita con il risultato del test più recente dei risultati dei test di sovrascrittura delle esecuzioni precedenti. Le esecuzioni di test sono ordinate in base al numero di tentativi.
Le metriche relative allo stesso tentativo verranno unite in base alla preferenza impostata da aggregate-metrics
. Le metriche finali saranno quelle dell'ultimo tentativo.
Ritorni | |
---|---|
|
getModuleContextForRunResult
public IInvocationContext getModuleContextForRunResult (String testRunName)
Restituisce il valore IInvocationContext
del modulo associato ai risultati.
Parametri | |
---|---|
testRunName |
String : il nome assegnato da {testRunStarted(String, int) . |
Ritorni | |
---|---|
IInvocationContext |
Il IInvocationContext del modulo per un determinato nome esecuzione di test null
se non vengono visualizzati risultati per quel nome. |
getModuleLogFiles
public MultiMap<String, LogFile> getModuleLogFiles ()
Restituisce una copia della mappa contenente tutti i file registrati associati al modulo
Ritorni | |
---|---|
MultiMap<String, LogFile> |
getNonAssociatedLogFiles
public MultiMap<String, LogFile> getNonAssociatedLogFiles ()
Restituisce una copia della mappa contenente tutti i file registrati non associati a un'esecuzione di test o a un in maggior dettaglio più avanti in questo modulo.
Ritorni | |
---|---|
MultiMap<String, LogFile> |
getNumAllFailedTestRuns
public int getNumAllFailedTestRuns ()
Restituisce il numero totale di esecuzioni di test in stato di errore
Ritorni | |
---|---|
int |
getNumAllFailedTests
public int getNumAllFailedTests ()
Restituisce il numero totale di test in stato di errore (solo non riusciti, gli errori presupposti non vengono conteggiati).
Ritorni | |
---|---|
int |
getNumTestsInState
public int getNumTestsInState (TestStatus status)
Restituisce il numero di test in un determinato stato per questa esecuzione.
Parametri | |
---|---|
status |
TestStatus |
Ritorni | |
---|---|
int |
getNumTestsInState
public int getNumTestsInState (TestResult.TestStatus ddmlibStatus)
Per la compatibilità con i tipi di stato precedenti
Parametri | |
---|---|
ddmlibStatus |
TestResult.TestStatus |
Ritorni | |
---|---|
int |
getNumTotalTests
public int getNumTotalTests ()
Restituisce il numero totale di test completi per tutte le esecuzioni.
Ritorni | |
---|---|
int |
getPrincipaleInfoBuild
public IBuildInfo getPrimaryBuildInfo ()
Restituisci le informazioni sulla build principale segnalate tramite invocationStarted(com.android.tradefed.invoker.IInvocationContext)
. La build principale è la build restituita dal primo
del provider di build della configurazione in esecuzione. Restituisce null in assenza di contesto (nessuna build in
scenario di test).
Ritorni | |
---|---|
IBuildInfo |
getRunResults
publicgetRunResults ()
Questo metodo è stato ritirato.
Utilizza getMergedTestRunResults()
Restituisce i risultati per tutte le esecuzioni di test.
Ritorni | |
---|---|
|
getTestRunAtRiprova
public TestRunResult getTestRunAtAttempt (String testRunName, int attempt)
Restituisci TestRunResult
per un singolo tentativo.
Parametri | |
---|---|
testRunName |
String : il nome assegnato da {testRunStarted(String, int) . |
attempt |
int : l'ID del tentativo. |
Ritorni | |
---|---|
TestRunResult |
TestRunResult per il nome specificato e l'ID tentativo o null , se presente
inesistente. |
getTestRunRiprovaCount
public int getTestRunAttemptCount (String testRunName)
Restituisce il numero di tentativi per un determinato nome di esecuzione di test.
Parametri | |
---|---|
testRunName |
String : il nome assegnato da {testRunStarted(String, int) . |
Ritorni | |
---|---|
int |
Tentativi di getTestRun
publicgetTestRunAttempts (String testRunName)
Recupera tutti i tentativi per un TestRunResult
di una determinata esecuzione di test.
Parametri | |
---|---|
testRunName |
String : il nome assegnato da {testRunStarted(String, int) . |
Ritorni | |
---|---|
|
Tutti i valori TestRunResult per una determinata esecuzione di test, ordinati per tentativi. |
getTestRunForRiprova
publicgetTestRunForAttempts (int attempt)
Recupera tutti i risultati di un determinato tentativo.
Parametri | |
---|---|
attempt |
int : il tentativo per il quale vogliamo ottenere risultati. |
Ritorni | |
---|---|
|
Tutti i TestRunResult per un determinato tentativo. |
getTestRunNames
publicgetTestRunNames ()
Restituisce tutti i nomi di tutte le esecuzioni di test.
Queste esecuzioni di test possono essere state eseguite più volte con tentativi diversi.
Ritorni | |
---|---|
|
hasFailedTests
public boolean hasFailedTests ()
Restituisce un valore che indica se la chiamata includeva test non riusciti o non superati dal presupposto.
Ritorni | |
---|---|
boolean |
hasTestRunResultsForName
public boolean hasTestRunResultsForName (String testRunName)
Restituisce se un determinato nome di esecuzione di test ha dei risultati.
Parametri | |
---|---|
testRunName |
String : il nome assegnato da {testRunStarted(String, int) . |
Ritorni | |
---|---|
boolean |
chiamata terminata
public void invocationEnded (long elapsedTime)
Report che la chiamata è stata terminata, correttamente o a causa di un errore .
Verrà chiamato automaticamente dal framework TradeFederation.
Parametri | |
---|---|
elapsedTime |
long : il tempo trascorso della chiamata in ms |
chiamata non riuscita
public void invocationFailed (Throwable cause)
Segnala una chiamata incompleta a causa di alcune condizioni di errore.
Verrà chiamato automaticamente dal framework TradeFederation.
Parametri | |
---|---|
cause |
Throwable : la causa Throwable dell'errore |
chiamataIgnorata
public void invocationSkipped (SkipReason reason)
Segnala una chiamata come saltata
Parametri | |
---|---|
reason |
SkipReason |
chiamataIniziata
public void invocationStarted (IInvocationContext context)
Segnala l'inizio della chiamata di test.
Verrà chiamato automaticamente dal framework TradeFederation. I reporter devono eseguire l'override questo metodo per supportare la generazione di report su più dispositivi.
Parametri | |
---|---|
context |
IInvocationContext : informazioni sulla chiamata |
non è disabilitato
public boolean isDisabled ()
Restituisce True se l'intero oggetto è disabilitato (saltano configurazione ed eliminazione). Falso negli altri casi.
Ritorni | |
---|---|
boolean |
logAssociation
public void logAssociation (String dataName, LogFile logFile)
In alcuni casi, il log deve essere fortemente associato a uno scenario di test, ma la possibilità di farlo
quindi sulla diretta testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
non è possibile. Pertanto, questo callback consente di fornire un'associazione
in modo esplicito.
Parametri | |
---|---|
dataName |
String : il nome dei dati |
logFile |
LogFile : il valore LogFile registrato in precedenza e che deve essere associato al
caso di test. |
setBuildInfo
public void setBuildInfo (IBuildInfo buildInfo)
Questo metodo è stato ritirato.
Non è più necessario per i test.
Imposta le informazioni sulla build. Da utilizzare solo per i test.
Parametri | |
---|---|
buildInfo |
IBuildInfo |
impostareDisattiva
public void setDisable (boolean isDisabled)
Consente di impostare se l'oggetto deve essere disabilitato. Disabilitata significa che sia i passaggi di configurazione che quelli di eliminazione deve essere ignorato. Può essere utilizzato per rendere un oggetto disabilitato per impostazione predefinita come costruttore.
Parametri | |
---|---|
isDisabled |
boolean : lo stato in cui deve essere inserito l'oggetto. |
impostaMergeStrategy
public void setMergeStrategy (MergeStrategy strategy)
Consente di impostare l'MergeStrategy
da usare per l'unione dei risultati.
Parametri | |
---|---|
strategy |
MergeStrategy |
testAssumptionFailure
public void testAssumptionFailure (TestDescription test, String trace)
Richiamato quando un test atomico segnala che assume una condizione falsa
Parametri | |
---|---|
test |
TestDescription : identifica il test |
trace |
String : analisi dello stack degli errori |
testAssumptionFailure
public void testAssumptionFailure (TestDescription test, FailureDescription failure)
Richiamato quando un test atomico segnala che assume una condizione falsa
Parametri | |
---|---|
test |
TestDescription : identifica il test |
failure |
FailureDescription : FailureDescription che descrive l'errore e il relativo contesto. |
testTerminato
public void testEnded (TestDescription test, long endTime,testMetrics)
Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))
in cui è possibile specificare l'ora di fine
strato Add. 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 |
: una percentuale pari a ERROR(/Map) delle metriche emesse |
testTerminato
public void testEnded (TestDescription test,testMetrics)
Segnala la fine dell'esecuzione di un singolo scenario di test.
Se testFailed(TestDescription, FailureDescription)
non è stato richiamato, questo test è stato superato. Restituisce anche qualsiasi coppia chiave-valore
metriche emesse durante l'esecuzione dello scenario di test.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
testMetrics |
: una percentuale pari a ERROR(/Map) delle metriche emesse |
testNon riuscito
public void testFailed (TestDescription test, FailureDescription failure)
Segnala l'errore di un singolo scenario 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. |
testNon riuscito
public void testFailed (TestDescription test, String trace)
Segnala l'errore di un singolo scenario di test.
Verrà chiamato tra testStarted e testEnded.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
trace |
String : analisi dello stack degli errori |
testIgnorato
public void testIgnored (TestDescription test)
Richiamato quando non verrà eseguito un test, in genere perché un metodo di test è annotato con org.junit.Ignora.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
testModuloTerminato
public void testModuleEnded ()
Segnala la fine dell'esecuzione di un modulo.
testModuloIniziato
public void testModuleStarted (IInvocationContext moduleContext)
Segnala l'inizio di un modulo in esecuzione. Questo callback è associato a testModuleEnded()
ed è facoltativo nella sequenza. Viene usato solo durante una corsa che usa
moduli: runner basati su suite.
Parametri | |
---|---|
moduleContext |
IInvocationContext : il IInvocationContext del modulo. |
testRunEnded
public void testRunEnded (long elapsedTime,runMetrics)
Fine dell'esecuzione del test nei report. FIXME: Non possiamo avere due mappe<> si interfaccia con tipi diversi, dobbiamo usare HashMap qui.
Parametri | |
---|---|
elapsedTime |
long : tempo trascorso sul dispositivo segnalato, in millisecondi |
runMetrics |
: coppie chiave-valore segnalate al termine di un'esecuzione di test con Metric . |
testRunNon riuscito
public void testRunFailed (FailureDescription failure)
L'esecuzione del test dei report non è riuscita a causa di un errore descritto da FailureDescription
.
Parametri | |
---|---|
failure |
FailureDescription : FailureDescription che descrive l'errore e il relativo contesto. |
testRunNon riuscito
public void testRunFailed (String errorMessage)
L'esecuzione del test dei report non è riuscita a causa di un errore irreversibile.
Parametri | |
---|---|
errorMessage |
String : String che descrive il motivo dell'errore dell'esecuzione. |
testRunStarted
public void testRunStarted (String name, int numTests, int attemptNumber)
Segnala l'inizio di un'esecuzione di test.
Parametri | |
---|---|
name |
String : nome dell'esecuzione del test |
numTests |
int : numero totale di test nell'esecuzione del test |
attemptNumber |
int : numero d'ordine che identifica i diversi tentativi dello stesso runName
che vengono eseguite più volte. Il numero tentato è indicizzato a 0 e deve aumentare ogni volta
quando si verifica una nuova esecuzione. ad es. Un test viene ripetuto tre volte in modo granulare e dovrebbe avere in totale 4
viene eseguito con lo stesso runName e il numero di tentativi è compreso tra 0 e 3. |
testRunStarted
public void testRunStarted (String name, int numTests)
Segnala l'inizio di un'esecuzione di test.
Parametri | |
---|---|
name |
String : nome dell'esecuzione del test |
numTests |
int : numero totale di test nell'esecuzione del test |
testRunStarted
public void testRunStarted (String name, int numTests, int attemptNumber, long startTime)
Segnala l'inizio di un'esecuzione di test.
Parametri | |
---|---|
name |
String : nome dell'esecuzione del test |
numTests |
int : numero totale di test nell'esecuzione del test |
attemptNumber |
int : numero d'ordine che identifica i diversi tentativi dello stesso runName
che vengono eseguite più volte. Il numero di tentativi è indicizzato a 0 e deve aumentare ogni volta che
una nuova esecuzione. ad es. Un test viene ripetuto tre volte in modo granulare e dovrebbe avere in totale 4 esecuzioni.
sotto lo stesso runName e il numero tentato è compreso tra 0 e 3. |
startTime |
long : l'ora di inizio della corsa, misurata tramite System.currentTimeMillis() |
testRunArrestato
public void testRunStopped (long elapsedTime)
Esecuzione di test dei report interrotta prima del completamento a causa di una richiesta dell'utente.
DA FARE: attualmente inutilizzato, valuta la possibilità di rimuoverlo
Parametri | |
---|---|
elapsedTime |
long : tempo trascorso sul dispositivo segnalato, in millisecondi |
testIgnorato
public void testSkipped (TestDescription test, SkipReason reason)
Richiamato quando un test viene ignorato e non è stato eseguito per un motivo solitamente non previsto. Si cercherà di ritentare questi test per ottenere un'esecuzione corretta.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
reason |
SkipReason : SkipReason |
testIniziato
public void testStarted (TestDescription test, long startTime)
Alternativa a testStarted(com.android.tradefed.result.TestDescription)
, dove specifichiamo anche quando il test è stato
iniziare, 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 in cui è iniziato il test, misurata tramite System.currentTimeMillis() |
testIniziato
public void testStarted (TestDescription test)
Segnala l'inizio di un singolo scenario di test. Interfaccia precedente; dovrebbe utilizzare testStarted(com.android.tradefed.result.TestDescription)
quando possibile.
Parametri | |
---|---|
test |
TestDescription : identifica il test |
Metodi protetti
cancella file di logModulo
protected final void clearModuleLogFiles ()
Consente di ripulire il file del modulo in modo da evitare di contenerlo troppo a lungo.
CancellaRisultatiPerNome
protected final void clearResultsForName (String testRunName)
Consente di cancellare i risultati per un determinato nome di esecuzione. Da utilizzare solo in alcuni casi, ad esempio aggregatore di risultati.
Parametri | |
---|---|
testRunName |
String |
setIsAggregrateMetrics
protected void setIsAggregrateMetrics (boolean aggregate)
Attiva/disattiva le "metriche aggregate" opzione
Parametri | |
---|---|
aggregate |
boolean |