IBuildInfo

public interface IBuildInfo

com.android.tradefed.build.IBuildInfo


Enthält Informationen zum zu testenden Build.

Zusammenfassung

Konstanten

String REMOTE_FILE_PREFIX

Präfix im Namen, das angibt, dass der Download der Datei verzögert erfolgen soll.

String REMOTE_FILE_VERSION

Die Remotedatei ist nicht versioniert.

String UNKNOWN_BUILD_ID

Standardwert, wenn die Build-ID unbekannt ist.

Öffentliche Methoden

default void addAppPackageFile(File appPackageFile, String version)

Die lokale APK-Datei und die zugehörige Version werden hinzugefügt.

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)

Hiermit wird die Berechtigung festgelegt, um das Staging remoter Dateien zuzulassen.

abstract void cleanUp()

Temporäre Build-Dateien bereinigen

abstract void cleanUp( doNotDelete)

Version von cleanUp(), bei der einige Dateien nicht gelöscht werden.

abstract IBuildInfo clone()

Das IBuildInfo-Objekt wird geklont.

default getAppPackageFiles()

Hiermit wird eine Kopie der lokalen App-APK-Dateien und ihrer Versionen abgerufen.

abstract getBuildAttributes()

Eine Reihe von Name/Wert-Paaren mit zusätzlichen Attributen, die den Build beschreiben.

abstract String getBuildBranch()

Optionale Methode, um den Quellkontrollzweig zurückzugeben, aus dem der getestete Build erstellt wurde.

abstract String getBuildFlavor()

Optionale Methode, um den Typ des getesteten Builds zurückzugeben.

abstract String getBuildId()

Die eindeutige Kennung des zu testenden Builds.

abstract String getBuildTargetName()

Gibt den vollständigen Namen des getesteten Builds zurück.

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

Hilfsmethode zum Abrufen einer Datei mit dem angegebenen Namen.

default File getFile(BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Datei mit einer angegebenen BuildInfoFileKey.

abstract getFiles()

Gibt alle in diesem BuildInfo gespeicherten VersionedFile zurück.

abstract getProperties()

Gibt eine Kopie der derzeit für die IBuildInfo festgelegten Properties zurück.

default getRemoteFiles()

Pfade für Build-Artefakte abrufen, 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 einer angegebenen BuildInfoFileKey.

abstract String getVersion(String name)

Hilfsmethode zum Abrufen einer Dateiversion mit dem angegebenen Namen.

default VersionedFile getVersionedFile(BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer VersionedFile mit einer bestimmten BuildInfoFileKey.

default VersionedFile getVersionedFile(String name)

Hilfsmethode zum Abrufen einer VersionedFile mit einem bestimmten Namen.

default getVersionedFileKeys()

Gibt die Schlüssel zurück, mit denen VersionedFile über getFile(BuildInfoFileKey) abgefragt werden kann.

default getVersionedFiles(BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Liste von VersionedFiles, die mit einer bestimmten BuildInfoFileKey verknüpft sind.

default void removeBuildAttribute(String attributeName)

Entfernt ein bestimmtes attributeName aus dem Tracking.

abstract void setBuildBranch(String branch)

Build-Zweig festlegen

abstract void setBuildFlavor(String buildFlavor)

Legen Sie die Build-Variante fest.

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)

Hier wird eine Datei mit dem angegebenen Namen gespeichert.

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

Hier wird eine Datei mit einer BuildInfoFileKey gespeichert.

abstract void setProperties(BuildInfoProperties... properties)

Legen Sie die BuildInfoProperties für die IBuildInfo-Instanz fest.

abstract void setTestTag(String testTag)

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

default File stageRemoteFile(String fileName, File workingDir)

Stellen Sie eine Datei, die zu den Remotedateien gehört, im Stammverzeichnis der Build-Informationen bereit.

default BuildInformation.BuildInfo toProto()

Serialisieren Sie die BuildInfo-Instanz in einen Protobuf.

Konstanten

REMOTE_FILE_PREFIX

public static final String REMOTE_FILE_PREFIX

Präfix im Namen, das angibt, dass der Download der Datei verzögert erfolgen soll.

Konstanter Wert: "remote_file:"

REMOTE_FILE_VERSION

public static final String REMOTE_FILE_VERSION

Die Remotedatei ist nicht versioniert.

Konstanter Wert: ""

UNKNOWN_BUILD_ID

public static final String UNKNOWN_BUILD_ID

Standardwert, wenn die Build-ID unbekannt ist.

Konstanter Wert: "-1"

Öffentliche Methoden

addAppPackageFile

public void addAppPackageFile (File appPackageFile, 
                String version)

Die lokale APK-Datei und die zugehörige Version werden hinzugefügt. Hinweis: APKs werden von getAppPackageFiles() in der Reihenfolge zurückgegeben, in der sie mit dieser Methode hinzugefügt wurden.

Parameter
appPackageFile File

version String

addBuildAttribute

public abstract void addBuildAttribute (String attributeName, 
                String attributeValue)

Fügen Sie ein Build-Attribut hinzu. Dadurch kann ein vorhandenes Attribut nicht überschrieben werden.

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)

Hiermit wird die Berechtigung festgelegt, um das Staging remoter Dateien zuzulassen.

Parameter
stageRemoteFile boolean

cleanUp

public abstract void cleanUp ()

Temporäre Build-Dateien bereinigen

cleanUp

public abstract void cleanUp ( doNotDelete)

Version von cleanUp(), bei der einige Dateien nicht gelöscht werden.

Parameter
doNotDelete

clone

public abstract IBuildInfo clone ()

Das IBuildInfo-Objekt wird geklont.

Returns
IBuildInfo

getAppPackageFiles

public  getAppPackageFiles ()

Hiermit wird eine Kopie der lokalen App-APK-Dateien und ihrer Versionen abgerufen. Die zurückgegebene Reihenfolge stimmt mit der Reihenfolge überein, in der die APKs der IAppBuildInfo hinzugefügt wurden.

Returns

getBuildAttributes

public abstract  getBuildAttributes ()

Eine Reihe von Name/Wert-Paaren mit zusätzlichen Attributen, die den Build beschreiben.

Returns
eine ERROR(/Map) von Build-Attributen. Muss nicht null sein, kann aber leer sein.

getBuildBranch

public abstract String getBuildBranch ()

Optionale Methode, um den Quellkontrollzweig zurückzugeben, aus dem der getestete Build erstellt wurde.

Returns
String den Build-Branch oder null, wenn nicht festgelegt/nicht zutreffend

getBuildFlavor

public abstract String getBuildFlavor ()

Optionale Methode, um den Typ des getesteten Builds zurückzugeben.

Eine gängige Implementierung für Builds der Android-Plattform ist die Rückgabe von (Build-Produkt)-(Build-Betriebssystem)-(Build-Variante). ie generic-linux-userdebug

Returns
String die Build-Variante oder null, wenn nicht festgelegt/nicht zutreffend

getBuildId

public abstract String getBuildId ()

Die eindeutige Kennung des zu testenden Builds. Darf niemals null sein. Die Standardeinstellung ist UNKNOWN_BUILD_ID.

Returns
String

getBuildTargetName

public abstract String getBuildTargetName ()

Gibt den vollständigen Namen des getesteten Builds zurück.

Eine gängige Implementierung besteht darin, den Namen des Build-Ziels aus einer Kombination aus Build-Variante und Branch-Namen zu erstellen. [z. B. (Branch-Name)-(Build-Variante)]

Returns
String

getDeviceSerial

public abstract String getDeviceSerial ()

Returns
String die ITestDevice-Seriennummer, unter 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 dem angegebenen Namen.

Returns
File die Bilddatei oder null, falls nicht gefunden

getFile

public File getFile (BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Datei mit einer angegebenen BuildInfoFileKey.

Parameter
key BuildInfoKey.BuildInfoFileKey: die angeforderte BuildInfoFileKey.

Returns
File die Bilddatei oder null, falls nicht gefunden

getFiles

public abstract  getFiles ()

Gibt alle in diesem BuildInfo gespeicherten VersionedFile zurück.

Returns

getProperties

public abstract  getProperties ()

Gibt eine Kopie der derzeit für die IBuildInfo festgelegten Properties zurück.

Returns

getRemoteFiles

public  getRemoteFiles ()

Pfade für Build-Artefakte abrufen, 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 einer angegebenen BuildInfoFileKey.

Parameter
key BuildInfoKey.BuildInfoFileKey: Die angeforderte BuildInfoFileKey.

Returns
String die Bildversion oder null, falls nicht gefunden

getVersion

public abstract String getVersion (String name)

Hilfsmethode zum Abrufen einer Dateiversion mit dem angegebenen Namen.

Returns
String die Bildversion oder null, falls nicht gefunden

getVersionedFile

public VersionedFile getVersionedFile (BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer VersionedFile mit einer bestimmten BuildInfoFileKey.

Parameter
key BuildInfoKey.BuildInfoFileKey: Die angeforderte BuildInfoFileKey.

Returns
VersionedFile Die versionierte Datei oder null, falls nicht gefunden

getVersionedFile

public VersionedFile getVersionedFile (String name)

Hilfsmethode zum Abrufen einer VersionedFile mit einem bestimmten Namen.

Returns
VersionedFile Die versionierte Datei oder null, falls nicht gefunden

getVersionedFileKeys

public  getVersionedFileKeys ()

Gibt die Schlüssel zurück, mit denen VersionedFile über getFile(BuildInfoFileKey) abgefragt werden kann.

Returns

getVersionedFiles

public  getVersionedFiles (BuildInfoKey.BuildInfoFileKey key)

Hilfsmethode zum Abrufen einer Liste von VersionedFiles, die mit einer bestimmten BuildInfoFileKey verknüpft sind. Ob der Schlüssel das Speichern einer Liste zulässt.

Parameter
key BuildInfoKey.BuildInfoFileKey: Die angeforderte BuildInfoFileKey.

Returns
Die versionierte Datei oder null, falls nicht gefunden

removeBuildAttribute

public void removeBuildAttribute (String attributeName)

Entfernt ein bestimmtes attributeName aus dem Tracking.

Parameter
attributeName String: das Attribut, für das das Tracking beendet werden soll

setBuildBranch

public abstract void setBuildBranch (String branch)

Build-Zweig festlegen

Parameter
branch String: den Namen des Branches

setBuildFlavor

public abstract void setBuildFlavor (String buildFlavor)

Legen Sie die Build-Variante fest.

setBuildId

public abstract void setBuildId (String buildId)

Legt die eindeutige Kennung des zu testenden Builds fest. Darf niemals 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 der ITestDevice, mit der dieser Build ausgeführt wurde.

setFile

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

Hier wird eine Datei mit dem angegebenen Namen gespeichert.

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)

Hier wird eine Datei mit einer BuildInfoFileKey gespeichert.

Parameter
key BuildInfoKey.BuildInfoFileKey: der eindeutige Name der Datei, der auf BuildInfoFileKey basiert.

file File: die lokale ERROR(/File)

version String: die Dateiversion

setProperties

public abstract void setProperties (BuildInfoProperties... properties)

Legen Sie die BuildInfoProperties für die IBuildInfo-Instanz fest. Vorhandene Eigenschaften werden überschrieben.

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

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)

Stellen Sie eine Datei, die zu den Remotedateien gehört, im Stammverzeichnis der Build-Informationen bereit.

TODO(b/138416078): Diese Schnittstelle und ihren Aufrufer entfernen, wenn Module, die für einen Test erforderlich sind, richtig erstellt und in das Verzeichnis des Testmoduls selbst ausgegeben werden können.

Parameter
fileName String: Name der Datei, die in Remotedateien gefunden werden soll.

workingDir File: ein ERROR(/File)-Objekt des Verzeichnisses, in dem die Datei bereitgestellt werden soll.

Returns
File das ERROR(/File)-Objekt der Datei, die im lokalen Arbeitsverzeichnis bereitgestellt wurde.

toProto

public BuildInformation.BuildInfo toProto ()

Serialisieren Sie die BuildInfo-Instanz in einen Protobuf.

Returns
BuildInformation.BuildInfo