AxeWatcherGitInfo-Klasse

Die AxeWatcherGitInfo -Klasse enthält explizite Git-Metadaten für einen Testlauf von Axe Watcher. Übergeben Sie eine Instanz an setGitInfo() auf AxeWatcherOptions , um die automatische Git-Erkennung zu umgehen.

Verwenden Sie diese Klasse, wenn:

• Ihre Tests in einem Repository ausgeführt werden, das vom zu testenden Repository getrennt ist
• Der Git-Binary ist in Ihrer CI-Umgebung nicht verfügbar
• Das Repository ein flacher Klon ist oder sich im Zustand eines getrennten HEAD befindet

branch, commitSha, und url gitless gitless aufgezeichnet und gespeichert, aber Axe Developer Hub wechselt zur gitlosen Sitzungsansicht, in der der Branch- und Commit-Verlauf aus vorherigen Sitzungen nicht sichtbar ist. Wird eine nachfolgende Sitzung mit allen drei Feldern eingereicht, stellt sich die gitvolle Ansicht wieder her. Sind nur ein oder zwei der drei vorhanden, verwirft Axe Watcher alle vollständigen Git-Felder, zeichnet die Sitzung als gitless auf und fügt der Antwort eine Warnung hinzu. Die restlichen Felder sind optional. Siehe Bereitstellung von Git-Metadaten für Anwendungsbeispiele.

Konstruktor

AxeWatcherGitInfo()

Erstellt eine neue Instanz mit allen Feldern im nicht gesetzten Zustand.

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

Methoden

setBranch(String branch)

Setzt den Namen des Git-Zweigs. Erforderlich, damit der Testlauf mit einem Zweig und Commit im Axe Developer Hub verknüpft wird.

Parameter:

• branch - Zweigname, z.B. "main"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setBranch(System.getenv("GIT_BRANCH"));

setTag(String tag)

Setzt das Git-Tag.

Parameter:

• tag - Tag-Name, z.B. "v1.2.3"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setTag(System.getenv("GIT_TAG"));

setDefaultBranch(String defaultBranch)

Setzt den Standardzweig des Repositories. Ohne dieses Feld kann Axe Developer Hub nicht identifizieren, welcher Zweig der Standardzweig ist, sodass Vergleiche von Feature-Zweigen mit dem Standardzweig nicht verfügbar sein werden.

Parameter:

• defaultBranch - Standardzweigname, z.B. "main"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setDefaultBranch("main");

setCommitSha(String commitSha)

Setzt die Commit-SHA. Erforderlich, damit der Testlauf mit einem Zweig und Commit im Axe Developer Hub verknüpft wird.

Parameter:

• commitSha - Volle oder abgekürzte Commit-Hash, z.B. "abc1234"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setCommitSha(System.getenv("GIT_COMMIT"));

setCommitAuthor(String commitAuthor)

Legt den Anzeigenamen des Commit-Autors fest. Wenn nicht angegeben, erscheint der Autor im Axe Developer Hub als nicht verfügbar.

Parameter:

• commitAuthor - Anzeigename des Autors

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setCommitAuthor(System.getenv("GIT_AUTHOR_NAME"));

setCommitEmail(String commitEmail)

Legt die E-Mail-Adresse des Commit-Autors fest.

Parameter:

• commitEmail - E-Mail-Adresse des Autors

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setCommitEmail(System.getenv("GIT_AUTHOR_EMAIL"));

setCommitMessage(String commitMessage)

Legt die vollständige Commit-Nachricht fest. Wenn nicht angegeben, erscheint die Commit-Nachricht im Axe Developer Hub als nicht verfügbar.

Parameter:

• commitMessage - Die vollständige Commit-Nachricht

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setCommitMessage(System.getenv("GIT_COMMIT_MESSAGE"));

setUrl(String url)

Legt die Remote-URL des Repositorys fest. Erforderlich, um den Testrun mit einem Branch und Commit im Axe Developer Hub zu verknüpfen.

Parameter:

• url - Remote-URL, z.B. "https://github.com/org/repo"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setUrl("https://github.com/org/repo");

setIsDirty(boolean isDirty)

Legt fest, ob der Arbeitsbaum nicht gespeicherte Änderungen enthält. Setze auf true , wenn nicht gespeicherte Änderungen vorhanden sind, oder auf false , wenn der Arbeitsbaum sauber ist. Wenn Sie diese Methode nicht aufrufen, wird der Arbeitsbaum als sauber gemeldet (false).

Parameter:

• isDirty - true , wenn nicht gespeicherte Änderungen vorliegen

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz zur Methode-Chaining

Beispiel:

new AxeWatcherGitInfo().setIsDirty(true);

getBranch()

Rückgabe: String - Der Branch-Name, oder null falls nicht gesetzt.

getTag()

Rückgabe: String - Der Tag, oder null falls nicht gesetzt.

getDefaultBranch()

Rückgabe: String - Der Standard-Branch-Name, oder null falls nicht gesetzt.

getCommitSha()

Rückgabe: String - Der Commit-SHA, oder null falls nicht gesetzt.

getCommitAuthor()

Rückgabe: String - Der Anzeigename des Commit-Autors, oder null falls nicht gesetzt.

getCommitEmail()

Rückgabe: String - Die E-Mail-Adresse des Commit-Autors, oder null falls nicht gesetzt.

getCommitMessage()

Rückgabe: String - Die Commit-Nachricht, oder null falls nicht gesetzt.

getUrl()

Rückgabe: String - Die Remote-URL des Repositories oder null falls nicht gesetzt.

getIsDirty()

Rückgabe: Boolean - true bei Änderungen, false wenn sauber, oder null wenn setIsDirty() nie aufgerufen wurde.

Siehe auch

• AxeWatcherOptions
• AxeWatcher
• Bereitstellung von Git-Metadaten