IBuildInfo

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo


Enthält Informationen zum zu testenden Build.

Zusammenfassung

Konstanten

String REMOTE_FILE_PREFIX

Im Namen verwendetes Präfix, das angibt, dass der Download der Datei verzögert wird.

String REMOTE_FILE_VERSION

Die Remote-Datei hat keine Versionen.

String UNKNOWN_BUILD_ID

Standardwert, wenn die Build-ID unbekannt ist.

Öffentliche Methoden

default void addAppPackageFile(File appPackageFile, String version)

Fügt die lokale APK-Datei und die zugehörige Version hinzu.

abstract void addBuildAttribute(String attributeName, String attributeValue)

Fügen Sie ein Build-Attribut hinzu.

default void addBuildAttributes( buildAttributes)

Build-Attribute hinzufügen

default void allowStagingRemoteFile(boolean stageRemoteFile)

Legt die Berechtigung fest, das Staging von Remote-Dateien zuzulassen.

abstract void cleanUp()

Temporäre Build-Dateien bereinigen

abstract void cleanUp( doNotDelete)

Version von cleanUp(), in der einige Dateien nicht gelöscht wurden.

abstract IBuildInfo clone()

Es wird das IBuildInfo-Objekt geklont.

default getAppPackageFiles()

Ruft eine Kopie der lokalen APK-Datei(en) und ihrer Versionen ab.

abstract getBuildAttributes()

Ruft eine Reihe von Name/Wert-Paaren zusätzlicher Attribute ab, die den Build beschreiben.

abstract String getBuildBranch()

Optionale Methode zum Zurückgeben des Versionsverwaltungszweigs, den der getestete Build war aus denen produziert werden.

abstract String getBuildFlavor()

Optionale Methode zum Zurückgeben des Build-Typs, der getestet wird.

abstract String getBuildId()

Gibt die eindeutige Kennung des zu testenden Builds zurück.

abstract String getBuildTargetName()

Gibt den vollständigen Namen für den zu testenden Build zurück.

abstract String getDeviceSerial()
abstract File getFile(String name)

Hilfsmethode zum Abrufen einer Datei mit einem bestimmten Namen.

default File getFile(BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Datei mit einem angegebenen BuildInfoFileKey.

abstract getFiles()

Gibt alle in dieser BuildInfo gespeicherten VersionedFile-Werte zurück.

abstract getProperties()

Gibt eine Kopie der Attribute zurück, die aktuell für IBuildInfo festgelegt sind.

default getRemoteFiles()

Rufen Sie die Pfade für Build-Artefakte ab, deren Download verzögert wird.

abstract String getTestTag()

Gibt einen eindeutigen Namen für die ausgeführten Tests zurück.

default String getVersion(BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Dateiversion mit einem angegebenen BuildInfoFileKey.

abstract String getVersion(String name)

Hilfsmethode zum Abrufen einer Dateiversion mit vorgegebenem Namen.

default VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen eines VersionedFile mit einem angegebenen BuildInfoFileKey.

default VersionedFile getVersionedFile(String name)

Hilfsmethode zum Abrufen einer VersionedFile mit einem bestimmten Namen.

default getVersionedFileKeys()

Gibt die Schlüssel zurück, die für die Abfrage von VersionedFile über getFile(BuildInfoFileKey) verfügbar sind.

default getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Liste von VersionedFiles, die einem bestimmten BuildInfoFileKey zugeordnet sind.

default void removeBuildAttribute(String attributeName)

Entfernt einen bestimmten Attributnamen aus dem Tracking.

abstract void setBuildBranch(String branch)

Build-Zweig festlegen

abstract void setBuildFlavor(String buildFlavor)

Build-Flavor festlegen.

abstract void setBuildId(String buildId)

Legt die eindeutige Kennung des zu testenden Builds fest.

abstract void setDeviceSerial(String serial)

Legen Sie die mit diesem Build verknüpfte ITestDevice-Seriennummer fest.

abstract void setFile(String name, File file, String version)

Speichert eine Datei mit dem angegebenen Namen in diesen Build-Informationen.

default void setFile(BuildInfoKey.BuildInfoFileKey key, File file, String version)

Speichert eine Datei mit einem bestimmten BuildInfoFileKey in diesen Build-Informationen.

abstract void setProperties(BuildInfoProperties... properties)

Legen Sie BuildInfoProperties für die Instanz IBuildInfo fest.

abstract void setTestTag(String testTag)

Legt den eindeutigen Namen für die ausgeführten Tests fest.

default File stageRemoteFile(String fileName, File workingDir)

Stellt eine Datei bereit, die Teil von Remote-Dateien im Stammverzeichnis der Build-Informationen ist.

default BuildInformation.BuildInfo toProto()

Serialisiert die BuildInfo-Instanz in einen protobuf.

Konstanten

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

Im Namen verwendetes Präfix, das angibt, dass der Download der Datei verzögert wird.

Konstantenwert: „remote_file:“

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

Die Remote-Datei hat keine Versionen.

Konstantenwert: „“

UNBEKANNTE_Bau-ID

public static final String UNKNOWN_BUILD_ID

Standardwert, wenn die Build-ID unbekannt ist.

Konstantenwert: „-1“

Öffentliche Methoden

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

Fügt die lokale APK-Datei und die zugehörige Version hinzu. Beachten Sie, dass APK-Dateien von getAppPackageFiles() in der Reihenfolge, in der sie mit dieser Methode hinzugefügt wurden.

Parameter
appPackageFile File

version String

Attribut „addBuildAttribute“

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

Fügen Sie ein Build-Attribut hinzu. Das Überschreiben eines vorhandenen Attributsname ist nicht möglich.

Parameter
attributeName String: der eindeutige Attributname

attributeValue String: der Attributwert

addBuildAttributes

public void addBuildAttributes ( buildAttributes)

Build-Attribute hinzufügen

Parameter
buildAttributes : Zuordnung der hinzuzufügenden Attribute

allowStagingRemoteFile

public void allowStagingRemoteFile (boolean stageRemoteFile)

Legt die Berechtigung fest, das Staging von Remote-Dateien zuzulassen.

Parameter
stageRemoteFile boolean

CleanUp

public abstract void cleanUp ()

Temporäre Build-Dateien bereinigen

CleanUp

public abstract void cleanUp ( doNotDelete)

Version von cleanUp(), in der einige Dateien nicht gelöscht wurden.

Parameter
doNotDelete

Klonen

public abstract IBuildInfo clone ()

Es wird das IBuildInfo-Objekt geklont.

Returns
IBuildInfo

getAppPackageFiles

public  getAppPackageFiles ()

Ruft eine Kopie der lokalen APK-Datei(en) und ihrer Versionen ab. Die zurückgegebene Bestellung stimmt mit der Reihenfolge überein, in der die APK-Dateien zu IAppBuildInfo hinzugefügt wurden.

Returns

getBuildAttributes

public abstract  getBuildAttributes ()

Ruft eine Reihe von Name/Wert-Paaren zusätzlicher Attribute ab, die den Build beschreiben.

Returns
ERROR(/Map) von Build-Attributen. Der Wert ist nicht null, er kann aber leer sein.

GetBuildBranch

public abstract String getBuildBranch ()

Optionale Methode zum Zurückgeben des Versionsverwaltungszweigs, den der getestete Build war aus denen produziert werden.

Returns
String Build-Zweig oder null, falls nicht festgelegt/nicht zutreffend

GetBuildFlavor

public abstract String getBuildFlavor ()

Optionale Methode zum Zurückgeben des Build-Typs, der getestet wird.

Eine gängige Implementierung für Android-Plattform-Builds besteht darin, (Build-Produkt)-(Build-Betriebssystem)-(Build-Variante) erstellen. z. B. generisches-linux-userdebug

Returns
String Build-Flavor oder null, falls nicht festgelegt/nicht zutreffend

getBuildId

public abstract String getBuildId ()

Gibt die eindeutige Kennung des zu testenden Builds zurück. Sollte nie null sein. Die Standardeinstellung ist UNKNOWN_BUILD_ID.

Returns
String

getBuildTargetName

public abstract String getBuildTargetName ()

Gibt den vollständigen Namen für den zu testenden Build zurück.

Eine gängige Implementierung besteht darin, den Build-Zielnamen aus einer Kombination den Build-Flavor und den Branch-Namen. [ie (Filialname)-(Geschmack aufbauen)]

Returns
String

getDeviceSerial

public abstract String getDeviceSerial ()

Returns
String Die ITestDevice-Seriennummer, auf der dieser Build ausgeführt wurde. Gibt null zurück, wenn mit diesem Build kein Gerät verknüpft ist.

getFile

public abstract File getFile (String name)

Hilfsmethode zum Abrufen einer Datei mit einem bestimmten Namen.

Returns
File Bilddatei oder null, falls sie nicht gefunden wird

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Datei mit einem angegebenen BuildInfoFileKey.

Parameter
key BuildInfoKey.BuildInfoFileKey: die angeforderte BuildInfoFileKey.

Returns
File Bilddatei oder null, falls sie nicht gefunden wird

getFiles

public abstract  getFiles ()

Gibt alle in dieser BuildInfo gespeicherten VersionedFile-Werte zurück.

Returns

getProperties

public abstract  getProperties ()

Gibt eine Kopie der Attribute zurück, die aktuell für IBuildInfo festgelegt sind.

Returns

getRemoteFiles

public  getRemoteFiles ()

Rufen Sie die Pfade für Build-Artefakte ab, deren Download verzögert wird.

Returns

getTestTag

public abstract String getTestTag ()

Gibt einen eindeutigen Namen für die ausgeführten Tests zurück.

Returns
String

getVersion

public String getVersion (BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Dateiversion mit einem angegebenen BuildInfoFileKey.

Parameter
key BuildInfoKey.BuildInfoFileKey: Die angeforderte BuildInfoFileKey.

Returns
String Image-Version oder null, falls nicht gefunden

getVersion

public abstract String getVersion (String name)

Hilfsmethode zum Abrufen einer Dateiversion mit vorgegebenem Namen.

Returns
String Image-Version oder null, falls nicht gefunden

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen eines VersionedFile mit einem angegebenen BuildInfoFileKey.

Parameter
key BuildInfoKey.BuildInfoFileKey: Die angeforderte BuildInfoFileKey.

Returns
VersionedFile Die versionierte Datei oder null, falls sie nicht gefunden wird

getVersionedFile

public VersionedFile getVersionedFile (String name)

Hilfsmethode zum Abrufen einer VersionedFile mit einem bestimmten Namen.

Returns
VersionedFile Die versionierte Datei oder null, falls sie nicht gefunden wird

getVersionedFileKeys

public  getVersionedFileKeys ()

Gibt die Schlüssel zurück, die für die Abfrage von VersionedFile über getFile(BuildInfoFileKey) verfügbar sind.

Returns

getVersionedFiles

public  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Liste von VersionedFiles, die einem bestimmten BuildInfoFileKey zugeordnet sind. Gibt an, ob der Schlüssel das Speichern einer Liste zulässt.

Parameter
key BuildInfoKey.BuildInfoFileKey: Die angeforderte BuildInfoFileKey.

Returns
Die versionierte Datei oder null, falls sie nicht gefunden wird

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Entfernt einen bestimmten Attributnamen aus dem Tracking.

Parameter
attributeName String: Attribut zum Beenden des Trackings

SetBuildBranch

public abstract void setBuildBranch (String branch)

Build-Zweig festlegen

Parameter
branch String: der Zweigname

Flavor festlegen

public abstract void setBuildFlavor (String buildFlavor)

Build-Flavor festlegen.

setBuildId

public abstract void setBuildId (String buildId)

Legt die eindeutige Kennung des zu testenden Builds fest. Sollte nie null sein.

Parameter
buildId String

SetDeviceSerial

public abstract void setDeviceSerial (String serial)

Legen Sie die mit diesem Build verknüpfte ITestDevice-Seriennummer fest.

Parameter
serial String: die Seriennummer des ITestDevice, mit dem dieser Build ausgeführt wurde.

SetFile

public abstract void setFile (String name, 
                File file, 
                String version)

Speichert eine Datei mit dem angegebenen Namen in diesen Build-Informationen.

Parameter
name String: der eindeutige Name der Datei

file File: die lokale ERROR(/File)

version String: die Dateiversion

SetFile

public void setFile (BuildInfoKey.BuildInfoFileKey key, 
                File file, 
                String version)

Speichert eine Datei mit einem bestimmten BuildInfoFileKey in diesen Build-Informationen.

Parameter
key BuildInfoKey.BuildInfoFileKey: der eindeutige Name der Datei basierend auf BuildInfoFileKey.

file File: die lokale ERROR(/File)

version String: die Dateiversion

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

Legen Sie BuildInfoProperties für die Instanz IBuildInfo fest. Alle überschreiben vorhandenen Eigenschaften.

Parameter
properties BuildInfoProperties: Die Liste der hinzuzufügenden Attribute.

setTestTag

public abstract void setTestTag (String testTag)

Legt den eindeutigen Namen für die ausgeführten Tests fest.

Parameter
testTag String

StageRemoteFile

public File stageRemoteFile (String fileName, 
                File workingDir)

Stellt eine Datei bereit, die Teil von Remote-Dateien im Stammverzeichnis der Build-Informationen ist.

TODO(b/138416078): Diese Schnittstelle und ihr Aufrufer entfernen, wenn Module für einen Test erforderlich sind ordnungsgemäß in das Verzeichnis des Testmoduls selbst ausgegeben werden kann.

Parameter
fileName String: Name der Datei, die sich in den Remote-Dateien befinden soll.

workingDir File: Ein ERROR(/File)-Objekt des Verzeichnisses für das Staging der Datei.

Returns
File Das ERROR(/File)-Objekt der Datei, die im lokalen „workingDir“ bereitgestellt wird.

toProto

public BuildInformation.BuildInfo toProto ()

Serialisiert die BuildInfo-Instanz in einen protobuf.

Returns
BuildInformation.BuildInfo