AxeWatcherGitInfo-Klasse

Die AxeWatcherGitInfo-Klasse enthält explizite Git-Metadaten für einen Axe Watcher-Testlauf. Ü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 sind die gitful Felder: Eine Sitzung, die ohne alle drei eingereicht wird, wird als gitless aufgezeichnet und gespeichert, aber der Axe Developer Hub wechselt zur gitless Sitzungsansicht, in der Branch- und Commithistorie von vorherigen Sitzungen nicht sichtbar werden. Das Einreichen einer späteren Sitzung mit allen drei Feldern stellt die gitful Ansicht wieder her. Wenn nur eines oder zwei der drei vorhanden sind, entfernt Axe Watcher alle gitful Felder, zeichnet die Sitzung als gitless auf und enthält eine Warnung in der Antwort. Die verbleibenden 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 - Branch-Name, z.B. "main"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz für Methodenkettung

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 für Methodenkettung

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 - Standard-Branch-Name, z.B. "main"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz für Methodenkettung

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 - Vollständiger oder verkürzter Commit-Hash, z.B. "abc1234"

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz für Methodenkettung

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 - Autoren-Anzeigename

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz für Methodenkettung

Beispiel:

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

setCommitEmail(String commitEmail)

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

Parameter:

• commitEmail - Autoren-E-Mail-Adresse

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz für Methodenkettung

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 für Methodenkettung

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 für Methodenkettung

Beispiel:

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

setIsDirty(boolean isDirty)

Legt fest, ob der Arbeitsbaum nicht übergebene Änderungen hat. Setzen Sie auf true, wenn es nicht übergebene Änderungen gibt, 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 es nicht übergebene Änderungen gibt

Rückgabe:

• AxeWatcherGitInfo - Die aktuelle Instanz für Methodenkettung

Beispiel:

new AxeWatcherGitInfo().setIsDirty(true);

getBranch()

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

getTag()

Rückgabe: String - Das Tag oder null, wenn nicht gesetzt.

getDefaultBranch()

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

getCommitSha()

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

getCommitAuthor()

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

getCommitEmail()

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

getCommitMessage()

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

getUrl()

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

getIsDirty()

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

Siehe auch

• AxeWatcherOptions
• AxeWatcher
• Bereitstellung von Git-Metadaten