Configuration globale

public class GlobalConfiguration
extends Object implements IGlobalConfiguration

java.lang.Object
com.android.tradefed.config.GlobalConfiguration


Une implémentation IGlobalConfiguration qui stocke les objets de configuration chargés dans une carte

Résumé

Des champs

public static final String CREDENTIAL_FACTORY_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MONITOR_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

public static final String GLOBAL_CONFIG_SERVER

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_VARIABLE

public static final String HOST_MONITOR_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String KEY_STORE_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

public static final String SCHEDULER_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

public static final String WTF_HANDLER_TYPE_NAME

Méthodes publiques

void cleanup ()

Nettoyage approprié lors de l'arrêt du tradefed.

File cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste blanche et affichez-la dans un fichier XML.

File cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs) cloneConfigWithFilter ( exclusionPatterns, IConfigOptionValueTransformer transformer, boolean deepCopy, String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste blanche tout en permettant la manipulation des valeurs d'option et la sortie vers un fichier XML.

File cloneConfigWithFilter (String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste autorisée et affichez-la dans un fichier XML.

static createGlobalConfiguration (String[] args)

Configure le singleton GlobalConfiguration pour cette instance TF.

ICommandScheduler getCommandScheduler ()

Obtient le ICommandScheduler à utiliser à partir de la configuration.

Object getConfigurationObject (String typeName)

Obtient l'objet de configuration personnalisé avec le nom donné.

ICredentialFactory getCredentialFactory ()

Obtient ICredentialFactory pour créer des informations d’identification.

String getDescription ()
DeviceManagementGrpcServer getDeviceManagementServer ()

Renvoie le DeviceManagementGrpcServer ou null s'il n'est pas défini.

IDeviceManager getDeviceManager ()

Obtient le IDeviceManager à utiliser à partir de la configuration.

static IDeviceManager getDeviceManagerInstance ()

Renvoie une référence à l'instance singleton DeviceManager pour cette instance TF.

getDeviceMonitors ()

Obtient la liste des IDeviceMonitor à partir de la configuration globale.

IDeviceSelection getDeviceRequirements ()

Obtient l' IDeviceSelection à utiliser à partir de la configuration.

TradefedFeatureServer getFeatureServer ()

Renvoie le TradefedFeatureServer ou null s'il n'est pas défini.

IConfigurationServer getGlobalConfigServer ()

Obtient le serveur de configuration global.

static getHostMonitorInstances ()
getHostMonitors ()

Obtient la liste de IHostMonitor à partir de la configuration globale.

IHostOptions getHostOptions ()

Obtient les IHostOptions à utiliser à partir de la configuration.

IHostResourceManager getHostResourceManager ()

Obtient le IHostResourceManager de la configuration globale.

static IGlobalConfiguration getInstance ()

Renvoie une référence à l'instance singleton GlobalConfiguration pour cette instance TF.

IKeyStoreFactory getKeyStoreFactory ()

Obtient le IKeyStoreFactory à utiliser à partir de la configuration.

getMultiDeviceRecoveryHandlers ()

Obtient la liste des IMultiDeviceRecovery à utiliser à partir de la configuration.

String getName ()
getOptionValues (String optionName)

Obtenez une liste des valeurs des options.

getResourceMetricCollectors ()

Obtient la liste des IResourceMetricCollector à partir de la configuration globale.

ISandboxFactory getSandboxFactory ()

Obtenez une usine sandbox qui peut être utilisée pour exécuter une invocation

IShardHelper getShardingStrategy ()

Renvoie le IShardHelper qui définit la manière de partitionner une configuration.

TestInvocationManagementServer getTestInvocationManagementSever ()

Renvoie le TestInvocationManagementServer ou null s'il n'est pas défini.

ITerribleFailureHandler getWtfHandler ()

Obtient le ITerribleFailureHandler à utiliser à partir de la configuration.

void injectOptionValue (String optionName, String optionValue)

Injectez une valeur d’option dans l’ensemble des objets de configuration.

void injectOptionValue (String optionName, String optionKey, String optionValue)

Injectez une valeur d’option dans l’ensemble des objets de configuration.

void printCommandUsage (boolean importantOnly, PrintStream out)

Génère un texte d'aide à l'utilisation de la ligne de commande pour cette configuration sur printStream donné.

void setCommandScheduler ( ICommandScheduler scheduler)

Définissez le ICommandScheduler , en remplaçant toutes les valeurs existantes.

void setConfigurationFactory ( IConfigurationFactory configFactory)

Définissez IConfigurationFactory pour cette configuration.

void setConfigurationObject (String typeName, Object configObject)

Méthode générique pour définir l'objet de configuration avec le nom donné, en remplaçant toute valeur existante.

void setConfigurationObjectList (String typeName, configList) setConfigurationObjectList (String typeName, configList)

Méthode générique pour définir la liste d'objets de configuration pour le nom donné, en remplaçant toute valeur existante.

void setDeviceManagementServer ( DeviceManagementGrpcServer server)

Définit le DeviceManagementGrpcServer .

void setDeviceManager ( IDeviceManager manager)

Définissez le IDeviceManager , en remplaçant toutes les valeurs existantes.

void setDeviceMonitor ( IDeviceMonitor monitor)

Définissez le IDeviceMonitor .

void setDeviceRequirements ( IDeviceSelection devRequirements)

Définissez IDeviceSelection , en remplaçant toutes les valeurs existantes.

void setHostMonitors ( hostMonitors) setHostMonitors ( hostMonitors)

Définissez la liste IHostMonitor .

void setHostOptions ( IHostOptions hostOptions)

Définissez le IHostOptions , en remplaçant toutes les valeurs existantes.

void setHostResourceManager ( IHostResourceManager hostResourceManager)

Définissez le IHostResourceManager , en remplaçant toutes les valeurs existantes.

void setInvocationServer ( TestInvocationManagementServer server)

Définit le TestInvocationManagementServer .

void setKeyStoreFactory ( IKeyStoreFactory factory)

Définissez le IKeyStoreFactory , en remplaçant toutes les valeurs existantes.

setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

Définir les champs Option de configuration globale avec un ensemble donné d'arguments de ligne de commande

Voir ArgsOptionParser pour le format attendu

void setOriginalConfig (String config)

Définit la configuration d'origine utilisée pour créer la configuration globale.

void setResourceMetricCollector ( IResourceMetricCollector collector)

Définit le IResourceMetricCollector .

void setSandboxFactory ( ISandboxFactory factory)

Définissez ISandboxFactory , en remplaçant toutes les valeurs existantes.

void setShardingStrategy ( IShardHelper sharding)

Définit le IShardHelper à utiliser lors du partitionnement d’une configuration.

void setTradefedFeatureServer ( TradefedFeatureServer server)

Définit le TradefedFeatureServer .

void setWtfHandler ( ITerribleFailureHandler wtfHandler)

Définissez le ITerribleFailureHandler .

void setup ()

Configuration appropriée au début de tradefed.

void validateOptions ()

Validez les valeurs des options.

Méthodes protégées

IConfigurationFactory getConfigurationFactory ()

Des champs

CREDENTIAL_FACTORY_TYPE_NAME

public static final String CREDENTIAL_FACTORY_TYPE_NAME

DEVICE_MANAGER_TYPE_NAME

public static final String DEVICE_MANAGER_TYPE_NAME

DEVICE_MONITOR_TYPE_NAME

public static final String DEVICE_MONITOR_TYPE_NAME

DEVICE_REQUIREMENTS_TYPE_NAME

public static final String DEVICE_REQUIREMENTS_TYPE_NAME

GLOBAL_CONFIG_SERVER

public static final String GLOBAL_CONFIG_SERVER

GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_SERVER_CONFIG_VARIABLE

GLOBAL_CONFIG_VARIABLE

public static final String GLOBAL_CONFIG_VARIABLE

HOST_MONITOR_TYPE_NAME

public static final String HOST_MONITOR_TYPE_NAME

HOST_OPTIONS_TYPE_NAME

public static final String HOST_OPTIONS_TYPE_NAME

HOST_RESOURCE_MANAGER_TYPE_NAME

public static final String HOST_RESOURCE_MANAGER_TYPE_NAME

KEY_STORE_TYPE_NAME

public static final String KEY_STORE_TYPE_NAME

MULTI_DEVICE_RECOVERY_TYPE_NAME

public static final String MULTI_DEVICE_RECOVERY_TYPE_NAME

RESOURCE_METRIC_COLLECTOR_TYPE_NAME

public static final String RESOURCE_METRIC_COLLECTOR_TYPE_NAME

SANDBOX_FACTORY_TYPE_NAME

public static final String SANDBOX_FACTORY_TYPE_NAME

SCHEDULER_TYPE_NAME

public static final String SCHEDULER_TYPE_NAME

SHARDING_STRATEGY_TYPE_NAME

public static final String SHARDING_STRATEGY_TYPE_NAME

TF_DEVICE_MANAGEMENT_SERVER_NAME

public static final String TF_DEVICE_MANAGEMENT_SERVER_NAME

TF_FEATURE_SERVER_NAME

public static final String TF_FEATURE_SERVER_NAME

TF_INVOCATION_SERVER_NAME

public static final String TF_INVOCATION_SERVER_NAME

WTF_HANDLER_TYPE_NAME

public static final String WTF_HANDLER_TYPE_NAME

Méthodes publiques

nettoyer

public void cleanup ()

Nettoyage approprié lors de l'arrêt du tradefed.

cloneConfigWithFilter

public File cloneConfigWithFilter ( exclusionPatterns, 
                String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste blanche et affichez-la dans un fichier XML.

Paramètres
exclusionPatterns : Le modèle du nom de classe à exclure du dump.

allowlistConfigs String : un tableau String de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null , a default list should be used.
Retour
File le fichier contenant la nouvelle configuration globale filtrée.

cloneConfigWithFilter

public File cloneConfigWithFilter ( exclusionPatterns, 
                IConfigOptionValueTransformer transformer, 
                boolean deepCopy, 
                String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste blanche tout en permettant la manipulation des valeurs d'option et la sortie vers un fichier XML.

Paramètres
exclusionPatterns : Le modèle du nom de classe à exclure du dump.

transformer IConfigOptionValueTransformer

deepCopy boolean

allowlistConfigs String : un tableau String de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null , a default list should be used.
Retour
File le fichier contenant la nouvelle configuration globale filtrée.

cloneConfigWithFilter

public File cloneConfigWithFilter (String... allowlistConfigs)

Filtrez la configuration globale en fonction d'une liste autorisée et affichez-la dans un fichier XML.

Par exemple, pour la configuration suivante : <xml> <configuration> <device_monitor class="com.android.tradefed.device.DeviceMonitorMultiplexer" /> <wtf_handler class="com.android.tradefed.log.TerribleFailureEmailHandler" /> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

toutes les configurations sauf "key_store" seront filtrées et donneront un fichier de configuration avec le contenu suivant : <xml> <configuration> <key_store class="com.android.tradefed.util.keystore.JSONFileKeyStoreFactory" /> </configuration> </xml>

Paramètres
allowlistConfigs String : un tableau String de configurations à inclure dans le nouveau fichier XML. S'il est défini sur null , a default list should be used.
Retour
File le fichier contenant la nouvelle configuration globale filtrée.

createGlobalConfiguration

public static  createGlobalConfiguration (String[] args)

Configure le singleton GlobalConfiguration pour cette instance TF. Doit être appelé une et une seule fois, avant que quoi que ce soit ne tente d'appeler getInstance()

Paramètres
args String

Retour

Jetés
IllegalStateException si on l'appelle plus d'une fois
ConfigurationException

getCommandScheduler

public ICommandScheduler getCommandScheduler ()

Obtient le ICommandScheduler à utiliser à partir de la configuration.

Retour
ICommandScheduler le ICommandScheduler . Ne retournera jamais null.

getConfigurationObject

public Object getConfigurationObject (String typeName)

Obtient l'objet de configuration personnalisé avec le nom donné.

Paramètres
typeName String : le type unique de l'objet de configuration

Retour
Object l'objet ou null si l'objet portant ce nom n'est pas trouvé

getCredentialFactory

public ICredentialFactory getCredentialFactory ()

Obtient ICredentialFactory pour créer des informations d’identification.

Retour
ICredentialFactory ICredentialFactory ou null si aucun n’a été spécifié.

obtenirDescription

public String getDescription ()

Retour
String une brève description lisible par l'utilisateur de cette Configuration

getDeviceManagementServer

public DeviceManagementGrpcServer getDeviceManagementServer ()

Renvoie le DeviceManagementGrpcServer ou null s'il n'est pas défini.

Retour
DeviceManagementGrpcServer

obtenirDeviceManager

public IDeviceManager getDeviceManager ()

Obtient le IDeviceManager à utiliser à partir de la configuration. Gère l’ensemble des appareils disponibles pour les tests

Retour
IDeviceManager le IDeviceManager fourni dans la configuration.

getDeviceManagerInstance

public static IDeviceManager getDeviceManagerInstance ()

Renvoie une référence à l'instance singleton DeviceManager pour cette instance TF.

Retour
IDeviceManager

Jetés
IllegalStateException si createGlobalConfiguration(String[]) n'a pas déjà été appelé.

getDeviceMonitors

public  getDeviceMonitors ()

Obtient la liste des IDeviceMonitor à partir de la configuration globale.

Retour
la liste des IDeviceMonitor de la configuration globale, ou null si aucun n'a été spécifié.

getDeviceRequirements

public IDeviceSelection getDeviceRequirements ()

Obtient l' IDeviceSelection à utiliser à partir de la configuration. Représente un filtre global sur quels appareils le DeviceManager peut voir.

Retour
IDeviceSelection le IDeviceSelection fourni dans la configuration.

getFeatureServer

public TradefedFeatureServer getFeatureServer ()

Renvoie le TradefedFeatureServer ou null s'il n'est pas défini.

Retour
TradefedFeatureServer

getGlobalConfigServer

public IConfigurationServer getGlobalConfigServer ()

Obtient le serveur de configuration global. Le serveur de configuration global est utilisé pour obtenir les configurations d'hôte d'un serveur au lieu de les obtenir à partir de fichiers locaux.

Retour
IConfigurationServer

getHostMonitorInstances

public static  getHostMonitorInstances ()

Retour

getHostMonitors

public  getHostMonitors ()

Obtient la liste de IHostMonitor à partir de la configuration globale.

Retour
la liste des IHostMonitor de la configuration globale, ou null si aucun n'a été spécifié.

getHostOptions

public IHostOptions getHostOptions ()

Obtient les IHostOptions à utiliser à partir de la configuration.

Retour
IHostOptions le IDeviceManager fourni dans la configuration.

getHostResourceManager

public IHostResourceManager getHostResourceManager ()

Obtient le IHostResourceManager de la configuration globale.

Retour
IHostResourceManager le IHostResourceManager de la configuration globale, ou l'implémentation par défaut LocalHostResourceManager si aucun n'est spécifié dans la configuration de l'hôte.

obtenirInstance

public static IGlobalConfiguration getInstance ()

Renvoie une référence à l'instance singleton GlobalConfiguration pour cette instance TF.

Retour
IGlobalConfiguration

Jetés
IllegalStateException si createGlobalConfiguration(String[]) n'a pas déjà été appelé.

getKeyStoreFactory

public IKeyStoreFactory getKeyStoreFactory ()

Obtient le IKeyStoreFactory à utiliser à partir de la configuration.

Retour
IKeyStoreFactory IKeyStoreFactory ou null si aucune fabrique de magasins de clés n'est définie.

getMultiDeviceRecoveryHandlers

public  getMultiDeviceRecoveryHandlers ()

Obtient la liste des IMultiDeviceRecovery à utiliser à partir de la configuration.

Retour
la liste des IMultiDeviceRecovery , ou null s'il n'est pas défini.

obtenirNom

public String getName ()

Retour
String le nom de cette Configuration

obtenirOptionValues

public  getOptionValues (String optionName)

Obtenez une liste des valeurs des options.

Paramètres
optionName String : le nom de l'option de la carte

Retour
une liste des valeurs de l'option donnée. null si le nom de l'option n'existe pas.

getResourceMetricCollectors

public  getResourceMetricCollectors ()

Obtient la liste des IResourceMetricCollector à partir de la configuration globale.

Retour
la liste des IResourceMetricCollector de la configuration globale ou null si aucun n'a été spécifié.

getSandboxFactory

public ISandboxFactory getSandboxFactory ()

Obtenez une usine sandbox qui peut être utilisée pour exécuter une invocation

Retour
ISandboxFactory

getShardingStrategy

public IShardHelper getShardingStrategy ()

Renvoie le IShardHelper qui définit la manière de partitionner une configuration.

Retour
IShardHelper

getTestInvocationManagementSever

public TestInvocationManagementServer getTestInvocationManagementSever ()

Renvoie le TestInvocationManagementServer ou null s'il n'est pas défini.

Retour
TestInvocationManagementServer

getWtfHandler

public ITerribleFailureHandler getWtfHandler ()

Obtient le ITerribleFailureHandler à utiliser à partir de la configuration. Gère ce qu'il faut faire en cas de survenance d'un WTF (What a Terrible Failure).

Retour
ITerribleFailureHandler le ITerribleFailureHandler fourni dans la configuration, ou null si aucun gestionnaire n'est défini

injectOptionValue

public void injectOptionValue (String optionName, 
                String optionValue)

Injectez une valeur d’option dans l’ensemble des objets de configuration.

Utile pour fournir des valeurs pour les options générées dynamiquement.

Paramètres
optionName String : le nom de l'option

optionValue String : la ou les valeurs de l'option

Jetés
ConfigurationException

injectOptionValue

public void injectOptionValue (String optionName, 
                String optionKey, 
                String optionValue)

Injectez une valeur d’option dans l’ensemble des objets de configuration.

Utile pour fournir des valeurs pour les options générées dynamiquement.

Paramètres
optionName String : le nom de l'option de la carte

optionKey String : la clé d'option de la carte

optionValue String : la valeur de l'option de carte

Jetés
ConfigurationException

printCommandUsage

public void printCommandUsage (boolean importantOnly, 
                PrintStream out)

Génère un texte d'aide à l'utilisation de la ligne de commande pour cette configuration sur printStream donné.

Paramètres
importantOnly boolean

out PrintStream : l' ERROR(/PrintStream) à utiliser.

Jetés
com.android.tradefed.config.ConfigurationException
ConfigurationException

setCommandScheduler

public void setCommandScheduler (ICommandScheduler scheduler)

Définissez le ICommandScheduler , en remplaçant toutes les valeurs existantes.

setConfigurationFactory

public void setConfigurationFactory (IConfigurationFactory configFactory)

Définissez IConfigurationFactory pour cette configuration.

Paramètres
configFactory IConfigurationFactory

setConfigurationObject

public void setConfigurationObject (String typeName, 
                Object configObject)

Méthode générique pour définir l'objet de configuration avec le nom donné, en remplaçant toute valeur existante.

Paramètres
typeName String : le nom unique du type d'objet de configuration.

configObject Object : l'objet de configuration

Jetés
ConfigurationException

setConfigurationObjectList

public void setConfigurationObjectList (String typeName, 
                 configList)

Méthode générique pour définir la liste d'objets de configuration pour le nom donné, en remplaçant toute valeur existante.

Paramètres
typeName String : le nom unique du type d'objet de configuration.

configList : la liste des objets de configuration

Jetés
ConfigurationException

setDeviceManagementServer

public void setDeviceManagementServer (DeviceManagementGrpcServer server)

Définit le DeviceManagementGrpcServer .

Paramètres
server DeviceManagementGrpcServer

setDeviceManager

public void setDeviceManager (IDeviceManager manager)

Définissez le IDeviceManager , en remplaçant toutes les valeurs existantes. Ceci définit le gestionnaire des appareils de test

setDeviceMonitor

public void setDeviceMonitor (IDeviceMonitor monitor)

Définissez le IDeviceMonitor .

Paramètres
monitor IDeviceMonitor : Le moniteur

setDeviceRequirements

public void setDeviceRequirements (IDeviceSelection devRequirements)

Définissez IDeviceSelection , en remplaçant toutes les valeurs existantes. Cela définit un filtre de périphérique global sur lequel les périphériques que le DeviceManager peut voir.

setHostMonitors

public void setHostMonitors ( hostMonitors)

Définissez la liste IHostMonitor .

Paramètres
hostMonitors : La liste des moniteurs

setHostOptions

public void setHostOptions (IHostOptions hostOptions)

Définissez le IHostOptions , en remplaçant toutes les valeurs existantes.

setHostResourceManager

public void setHostResourceManager (IHostResourceManager hostResourceManager)

Définissez le IHostResourceManager , en remplaçant toutes les valeurs existantes.

setInvocationServer

public void setInvocationServer (TestInvocationManagementServer server)

Définit le TestInvocationManagementServer .

Paramètres
server TestInvocationManagementServer

setKeyStoreFactory

public void setKeyStoreFactory (IKeyStoreFactory factory)

Définissez le IKeyStoreFactory , en remplaçant toutes les valeurs existantes.

setOptionsFromCommandLineArgs

public  setOptionsFromCommandLineArgs ( listArgs)

Définir les champs Option de configuration globale avec un ensemble donné d'arguments de ligne de commande

Voir ArgsOptionParser pour le format attendu

Paramètres
listArgs : les arguments de la ligne de commande

Retour
les arguments non consommés

Jetés
ConfigurationException

setOriginalConfig

public void setOriginalConfig (String config)

Définit la configuration d'origine utilisée pour créer la configuration globale.

Paramètres
config String

setResourceMetricCollector

public void setResourceMetricCollector (IResourceMetricCollector collector)

Définit le IResourceMetricCollector .

Paramètres
collector IResourceMetricCollector

setSandboxFactory

public void setSandboxFactory (ISandboxFactory factory)

Définissez ISandboxFactory , en remplaçant toutes les valeurs existantes.

setShardingStrategy

public void setShardingStrategy (IShardHelper sharding)

Définit le IShardHelper à utiliser lors du partitionnement d’une configuration.

Paramètres
sharding IShardHelper

setTradefedFeatureServer

public void setTradefedFeatureServer (TradefedFeatureServer server)

Définit le TradefedFeatureServer .

Paramètres
server TradefedFeatureServer

setWtfHandler

public void setWtfHandler (ITerribleFailureHandler wtfHandler)

Définissez le ITerribleFailureHandler .

Paramètres
wtfHandler ITerribleFailureHandler : le gestionnaire WTF

installation

public void setup ()

Configuration appropriée au début de tradefed.

Jetés
ConfigurationException

validerOptions

public void validateOptions ()

Validez les valeurs des options.

Actuellement, cela validera simplement que toutes les options obligatoires ont été définies

Jetés
ConfigurationException

Méthodes protégées

getConfigurationFactory

protected IConfigurationFactory getConfigurationFactory ()

Retour
IConfigurationFactory