CollectingTestListener

public class CollectingTestListener
extends Object implements IDisableable, ILogSaverListener, ITestInvocationListener

java.lang.Object
↳	com.android.tradefed.result.CollectingTestListener

Classi di sottoclasse dirette note JsonHttpTestResultReporter, LUCIResultReporter, MetricsXMLResultReporter, ModuleListener, ReportPassedTests, ResultAggregator, ShardListener, SuiteResultReporter, XmlResultReporter JsonHttpTestResultReporter Un report sui risultati che codifica i risultati delle metriche di test e le informazioni su branch e dispositivo in JSON e li invia tramite POST a un endpoint di servizio HTTP  LUCIResultReporter Un report sui risultati che salva i risultati dei test necessari per ResultDB e LUCI in formato JSON (go/result-sink) e registra la posizione del file nella console.  MetricsXMLResultReporter MetricsXMLResultReporter scrive le metriche di test e di esecuzione in un file XML in una cartella specificata dal parametro metrics-folder nella fase invocationEnded del test.  ModuleListener Listener collegato a ogni IRemoteTest di ogni modulo per raccogliere l'elenco dei risultati.  ReportPassedTests Segnala in un file i possibili filtri per escludere il test superato.  ResultAggregator Inoltra i risultati in modo aggregato, se necessario, in base alla strategia di ripetizione adottata.  ShardListener Un ITestInvocationListener che raccoglie i risultati da uno shard di chiamata (ovvero una suddivisione di chiamate da eseguire in parallelo su più risorse) e li inoltra a un altro ascoltatore.  SuiteResultReporter Raccogliere i risultati dei test per un'intera chiamata della suite e generare i risultati finali.  XmlResultReporter Scrive i risultati di JUnit in file XML in un formato coerente con XMLJUnitResultFormatter di Ant.

Classi di sottoclasse indirette note FormattedGeneratorReporter, XmlFormattedGeneratorReporter FormattedGeneratorReporter Report che consente di generare report in un determinato formato.  XmlFormattedGeneratorReporter Implementazione del FormattedGeneratorReporter che formatta la suite in un formato XML.

---

Un ITestInvocationListener che raccoglierà tutti i risultati del test.

Sebbene le strutture di 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 è deprecato. Affidati a IBuildInfo da getInvocationContext().
TestRunResult	getCurrentRunResults() Recupera i risultati dell'esecuzione del test corrente.
int	getExpectedTests() Restituisce il numero di test previsti.
IInvocationContext	getInvocationContext() Restituisce il contesto di chiamata registrato tramite invocationStarted(com.android.tradefed.invoker.IInvocationContext)
	getMergedTestRunResults() Restituisce la raccolta unita dei risultati di tutte le esecuzioni in diversi tentativi.
IInvocationContext	getModuleContextForRunResult(String testRunName) Restituisce il IInvocationContext del modulo associato ai risultati.
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 modulo.
int	getNumAllFailedTestRuns() Restituisce il numero totale di esecuzioni di test in uno stato di errore
int	getNumAllFailedTests() Restituisce il numero totale di test in uno stato di errore (solo i test non riusciti, gli errori di ipotesi 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 il tipo di stato precedente
int	getNumTotalTests() Restituisce il numero totale di test completati per tutte le esecuzioni.
IBuildInfo	getPrimaryBuildInfo() Restituisce le informazioni sulla build principale registrate tramite invocationStarted(com.android.tradefed.invoker.IInvocationContext).
	getRunResults() Questo metodo è deprecato. Utilizza getMergedTestRunResults()
TestRunResult	getTestRunAtAttempt(String testRunName, int attempt) Restituire il TestRunResult per un singolo tentativo.
int	getTestRunAttemptCount(String testRunName) Restituisce il numero di tentativi per un determinato nome di esecuzione del test.
	getTestRunAttempts(String testRunName) Recupera tutti i tentativi per un TestRunResult di una determinata esecuzione del test.
	getTestRunForAttempts(int attempt) Recupera tutti i risultati per un determinato tentativo.
	getTestRunNames() Restituisce tutti i nomi per tutte le esecuzioni del test.
boolean	hasFailedTests() Restituisce se l'invocazione ha avuto test di fallimento o di presupposto non riusciti.
boolean	hasTestRunResultsForName(String testRunName) Restituisce se un determinato nome di esecuzione del test ha risultati.
void	invocationEnded(long elapsedTime) Segnala che l'invocazione è terminata, con esito positivo o a causa di una condizione di errore.
void	invocationFailed(Throwable cause) Segnala un'invocazione incompleta a causa di una condizione di errore.
void	invocationSkipped(SkipReason reason) Segnala un'invocazione come ignorata
void	invocationStarted(IInvocationContext context) Segnala l'inizio dell'invocazione del test.
boolean	isDisabled() Restituisce True se l'intero oggetto è disabilitato (salta la configurazione e lo smantellamento).
void	logAssociation(String dataName, LogFile logFile) In alcuni casi, il log deve essere strettamente associato a un test case, ma non è possibile farlo nel callback diretto testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile).
void	setBuildInfo(IBuildInfo buildInfo) Questo metodo è deprecato. Non è più necessario per i test.
void	setDisable(boolean isDisabled) Imposta se l'oggetto deve essere disattivato.
void	setMergeStrategy(MergeStrategy strategy) Imposta il valore MergeStrategy da utilizzare per l'unione dei risultati.
void	testAssumptionFailure(TestDescription test, String trace) Viene chiamato quando un test atomico segnala che presuppone una condizione falsa
void	testAssumptionFailure(TestDescription test, FailureDescription failure) Viene chiamato quando un test atomico segnala che presuppone una condizione falsa
void	testEnded(TestDescription test, long endTime, testMetrics) Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) in cui possiamo specificare direttamente l'ora di fine.
void	testEnded(TestDescription test, testMetrics) Segnala il termine dell'esecuzione di un singolo test case.
void	testFailed(TestDescription test, FailureDescription failure) Segnala l'errore di un singolo test case.
void	testFailed(TestDescription test, String trace) Segnala l'errore di un singolo test case.
void	testIgnored(TestDescription test) Viene chiamato quando un test non verrà eseguito, in genere perché un metodo di test è annotato con org.junit.Ignore.
void	testModuleEnded() Segnala la fine dell'esecuzione di un modulo.
void	testModuleStarted(IInvocationContext moduleContext) Segnala l'inizio dell'esecuzione di un modulo.
void	testRunEnded(long elapsedTime, runMetrics) Segnala la fine dell'esecuzione del test.
void	testRunFailed(FailureDescription failure) L'esecuzione del test dei report non è riuscita a causa di un errore descritto da FailureDescription.
void	testRunFailed(String errorMessage) L'esecuzione del test dei report non è riuscita a causa di un errore fatale.
void	testRunStarted(String name, int numTests, int attemptNumber) Segnala l'inizio di un'esecuzione del test.
void	testRunStarted(String name, int numTests) Segnala l'inizio di un'esecuzione del test.
void	testRunStarted(String name, int numTests, int attemptNumber, long startTime) Segnala l'inizio di un'esecuzione del test.
void	testRunStopped(long elapsedTime) L'esecuzione del test dei report è stata interrotta prima del completamento a causa di una richiesta dell'utente.
void	testSkipped(TestDescription test, SkipReason reason) Viene chiamato quando un test viene saltato e non viene eseguito per un motivo in genere imprevisto.
void	testStarted(TestDescription test, long startTime) Alternativa a testStarted(com.android.tradefed.result.TestDescription) in cui viene specificato anche quando è stato avviato il test, combinata con ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) per una misurazione accurata.
void	testStarted(TestDescription test) Segnala l'inizio di un singolo test case.

Metodi protetti
final void	clearModuleLogFiles() Consente di pulire il file del modulo in modo da evitare di trasportarlo per troppo tempo.
final void	clearResultsForName(String testRunName) Consente di cancellare i risultati per un determinato nome di esecuzione.
void	setIsAggregrateMetrics(boolean aggregate) Attiva/disattiva l'opzione "Metriche aggregate"

Costruttori pubblici

CollectingTestListener

public CollectingTestListener ()

Metodi pubblici

getBuildInfo

public IBuildInfo getBuildInfo ()

Questo metodo è deprecato.
affidati alla IBuildInfo da getInvocationContext().

Restituisce le informazioni sulla build.

Ritorni
IBuildInfo

getCurrentRunResults

public TestRunResult getCurrentRunResults ()

Recupera i risultati dell'esecuzione del test corrente.

Tieni presente che i risultati potrebbero non essere completi. Ti consigliamo di testare il valore di TestRunResult.isRunComplete() e/o (@link TestRunResult#isRunFailure()}, se opportuno, prima di elaborare i risultati.

Ritorni
TestRunResult	TestRunResult che rappresenta i dati raccolti durante l'ultima esecuzione del test

getExpectedTests

public int getExpectedTests ()

Restituisce il numero di test previsti. Può essere diverso da getNumTotalTests() se alcuni test non sono stati eseguiti.

Ritorni
int

getInvocationContext

public IInvocationContext getInvocationContext ()

Restituisce il contesto di chiamata registrato tramite invocationStarted(com.android.tradefed.invoker.IInvocationContext)

Ritorni
IInvocationContext

getMergedTestRunResults

public  getMergedTestRunResults ()

Restituisce la raccolta unita dei risultati di tutte le esecuzioni in diversi tentativi.

Se sono presenti più risultati, ogni esecuzione del test viene unita e il risultato più recente del test sovrascrive i risultati delle esecuzioni precedenti. Le esecuzioni del test sono ordinate in base al numero di tentativi.

Le metriche per lo 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 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 di esecuzione del test null se non sono presenti 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 modulo.

Ritorni
MultiMap<String, LogFile>

getNumAllFailedTestRuns

public int getNumAllFailedTestRuns ()

Restituisce il numero totale di esecuzioni di test in uno stato di errore

Ritorni
int

getNumAllFailedTests

public int getNumAllFailedTests ()

Restituisce il numero totale di test in uno stato di errore (solo i test non riusciti, gli errori di ipotesi 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 il tipo di stato precedente

Parametri
ddmlibStatus	TestResult.TestStatus

Ritorni
int

getNumTotalTests

public int getNumTotalTests ()

Restituisce il numero totale di test completati per tutte le esecuzioni.

Ritorni
int

getPrimaryBuildInfo

public IBuildInfo getPrimaryBuildInfo ()

Restituisce le informazioni sulla build principale registrate tramite invocationStarted(com.android.tradefed.invoker.IInvocationContext). La build principale è la build restituita dal primo fornitore di build della configurazione in esecuzione. Restituisce null se non è presente alcun contesto (nessuna compilazione per lo scenario di test).

Ritorni
IBuildInfo

getRunResults

public  getRunResults ()

Questo metodo è deprecato.
Utilizza getMergedTestRunResults()

Restituisce i risultati di tutte le esecuzioni del test.

Ritorni

getTestRunAtAttempt

public TestRunResult getTestRunAtAttempt (String testRunName, 
                int attempt)

Restituire il TestRunResult per un singolo tentativo.

Parametri
testRunName	String: il nome assegnato da {testRunStarted(String, int).
attempt	int: l'ID tentativo.

Ritorni
TestRunResult	L'TestRunResult per il nome e l'ID tentativo specificati o null se non esiste.

getTestRunAttemptCount

public int getTestRunAttemptCount (String testRunName)

Restituisce il numero di tentativi per un determinato nome di esecuzione del test.

Parametri
testRunName	String: il nome assegnato da {testRunStarted(String, int).

Ritorni
int

getTestRunAttempts

public  getTestRunAttempts (String testRunName)

Recupera tutti i tentativi per un TestRunResult di una determinata esecuzione del test.

Parametri
testRunName	String: il nome assegnato da {testRunStarted(String, int).

Ritorni
	Tutti i TestRunResult per una determinata esecuzione del test, ordinati per tentativi.

getTestRunForAttempts

public  getTestRunForAttempts (int attempt)

Recupera tutti i risultati per un determinato tentativo.

Parametri
attempt	int: il tentativo per cui vogliamo i risultati.

Ritorni
	Tutti i TestRunResult per un determinato tentativo.

getTestRunNames

public  getTestRunNames ()

Restituisce tutti i nomi per tutte le esecuzioni del test.

Queste esecuzioni di test potrebbero essere state eseguite più volte con tentativi diversi.

Ritorni

hasFailedTests

public boolean hasFailedTests ()

Restituisce se l'invocazione ha avuto test di fallimento o di presupposto non riusciti.

Ritorni
boolean

hasTestRunResultsForName

public boolean hasTestRunResultsForName (String testRunName)

Restituisce se un determinato nome di esecuzione del test ha risultati.

Parametri
testRunName	String: il nome assegnato da {testRunStarted(String, int).

Ritorni
boolean

invocationEnded

public void invocationEnded (long elapsedTime)

Segnala che l'invocazione è terminata, con esito positivo o a causa di una condizione di errore.

Verrà chiamato automaticamente dal framework TradeFederation.

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

invocationFailed

public void invocationFailed (Throwable cause)

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

Verrà chiamato automaticamente dal framework TradeFederation.

Parametri
cause	Throwable: la causa Throwable dell'errore

invocationSkipped

public void invocationSkipped (SkipReason reason)

Segnala un'invocazione come ignorata

Parametri
reason	SkipReason

invocationStarted

public void invocationStarted (IInvocationContext context)

Segnala l'inizio dell'invocazione del test.

Verrà chiamato automaticamente dal framework TradeFederation. I reporter devono eseguire l'override di questo metodo per supportare i report su più dispositivi.

Parametri
context	IInvocationContext: informazioni sull'invocazione

isDisabled

public boolean isDisabled ()

Restituisce True se l'intero oggetto è disabilitato (salta la configurazione e lo smantellamento). Falso negli altri casi.

Ritorni
boolean

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

In alcuni casi, il log deve essere strettamente associato a un test case, ma non è possibile farlo nel callback diretto testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile). Pertanto, questo callback consente di fornire un'associazione forte in modo esplicito.

Parametri
dataName	String: il nome dei dati
logFile	LogFile: il LogFile registrato in precedenza e da associare allo scenario di test.

setBuildInfo

public void setBuildInfo (IBuildInfo buildInfo)

Questo metodo è deprecato.
Non più necessario per i test.

Imposta le informazioni sulla compilazione. Da utilizzare solo per i test.

Parametri
buildInfo	IBuildInfo

setDisable

public void setDisable (boolean isDisabled)

Imposta se l'oggetto deve essere disattivato. Disattivato significa che sia i passaggi di configurazione sia quelli di smantellamento devono essere saltati. Può essere utilizzato per disattivare un oggetto per impostazione predefinita nel constructor predefinito.

Parametri
isDisabled	boolean: lo stato in cui deve essere inserito l'oggetto.

setMergeStrategy

public void setMergeStrategy (MergeStrategy strategy)

Imposta il valore MergeStrategy da utilizzare per l'unione dei risultati.

Parametri
strategy	MergeStrategy

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                String trace)

Viene chiamato quando un test atomico segnala che presuppone una condizione falsa

Parametri
test	TestDescription: identifica il test
trace	String: analisi dello stack dell'errore

testAssumptionFailure

public void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

Viene 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 void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

Alternativa a ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) in cui 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 di fine del test, misurata tramite System.currentTimeMillis()
testMetrics	: un ERROR(/Map) delle metriche emesse

testEnded

public void testEnded (TestDescription test, 
                 testMetrics)

Segnala il termine dell'esecuzione di un singolo test case.

Se testFailed(TestDescription, FailureDescription) non è stato invocato, questo test è stato superato. Restituisce anche eventuali metriche chiave/valore che potrebbero essere state emesse durante l'esecuzione del test case.

Parametri
test	TestDescription: identifica il test
testMetrics	: un ERROR(/Map) delle metriche emesse

testFailed

public void testFailed (TestDescription test, 
                FailureDescription failure)

Segnala l'errore 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 void testFailed (TestDescription test, 
                String trace)

Segnala l'errore di un singolo test case.

Verrà chiamato tra testStarted e testEnded.

Parametri
test	TestDescription: identifica il test
trace	String: analisi dello stack dell'errore

testIgnored

public void testIgnored (TestDescription test)

Viene chiamato quando un test non verrà eseguito, in genere perché un metodo di test è annotato con org.junit.Ignore.

Parametri
test	TestDescription: identifica il test

testModuleEnded

public void testModuleEnded ()

Segnala la fine dell'esecuzione di un modulo.

testModuleStarted

public 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 un'esecuzione che utilizza i moduli: runner basati su suite.

Parametri
moduleContext	IInvocationContext: il IInvocationContext del modulo.

testRunEnded

public void testRunEnded (long elapsedTime, 
                 runMetrics)

Segnala la fine dell'esecuzione del test.

Parametri
elapsedTime	long: tempo trascorso segnalato dal dispositivo, in millisecondi
runMetrics	: coppie chiave-valore registrate al termine di un'esecuzione del test

testRunFailed

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.

testRunFailed

public void testRunFailed (String errorMessage)

L'esecuzione del test dei report non è riuscita a causa di un errore fatale.

Parametri
errorMessage	String: String che descrive il motivo dell'errore di esecuzione.

testRunStarted

public void testRunStarted (String name, 
                int numTests, 
                int attemptNumber)

Segnala l'inizio di un'esecuzione del test.

Parametri
name	String: il 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 eseguiti più volte. Il numero di tentativi è indicizzato da 0 e deve aumentare ogni volta che viene eseguita una nuova esecuzione. Ad esempio, un test viene riavviato granularmente 3 volte, deve avere 4 esecuzioni totali con lo stesso nome esecuzione e il numero di tentativi va da 0 a 3.

testRunStarted

public void testRunStarted (String name, 
                int numTests)

Segnala l'inizio di un'esecuzione del test.

Parametri
name	String: il 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 del test.

Parametri
name	String: il 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 eseguiti più volte. Il numero di tentativi è indicizzato da 0 e deve aumentare ogni volta che viene eseguita una nuova esecuzione. Ad esempio, un test viene riavviato granularmente 3 volte, deve avere 4 esecuzioni totali con lo stesso nome esecuzione e il numero di tentativi va da 0 a 3.
startTime	long: l'ora di inizio dell'esecuzione, misurata tramite System.currentTimeMillis()

testRunStopped

public void testRunStopped (long elapsedTime)

L'esecuzione del test dei report è stata interrotta prima del completamento a causa di una richiesta dell'utente.

TODO: currently unused, consider removing

Parametri
elapsedTime	long: tempo trascorso segnalato dal dispositivo, in millisecondi

testSkipped

public void testSkipped (TestDescription test, 
                SkipReason reason)

Viene chiamato quando un test viene saltato e non viene eseguito per un motivo in genere imprevisto. Verrà tentato di ripetere questi test per ottenere un'esecuzione corretta.

Parametri
test	TestDescription: identifica il test
reason	SkipReason: SkipReason

testStarted

public void testStarted (TestDescription test, 
                long startTime)

Alternativa a testStarted(com.android.tradefed.result.TestDescription) in cui viene specificato anche quando è stato avviato il test, combinata 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()

testStarted

public void testStarted (TestDescription test)

Segnala l'inizio di un singolo test case. Interfaccia precedente, da utilizzare con testStarted(com.android.tradefed.result.TestDescription), se possibile.

Parametri
test	TestDescription: identifica il test

Metodi protetti

clearModuleLogFiles

protected final void clearModuleLogFiles ()

Consente di pulire il file del modulo in modo da evitare di trasportarlo per troppo tempo.

clearResultsForName

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 come aggregatore dei risultati.

Parametri
testRunName	String

setIsAggregrateMetrics

protected void setIsAggregrateMetrics (boolean aggregate)

Attiva/disattiva l'opzione "Metriche aggregate"

Parametri
aggregate	boolean