AxeWatcherGitInfo Klasse

De AxeWatcherGitInfo klasse houdt expliciete Git-metadata vast voor een axe Watcher testrun. Geef een instantie door aan setGitInfo() op AxeWatcherOptions om automatische Git-detectie te omzeilen.

Gebruik deze klasse wanneer:

• Je tests worden uitgevoerd in een repository die gescheiden is van de testrepository
• De Git-binary niet beschikbaar is in je CI-omgeving
• De repository een ondiepe kloon is of in een losgekoppelde HEAD-toestand verkeert

branch , commitShaen url zijn de gitvolle velden: een sessie ingediend zonder alle drie wordt opgenomen als gitloos en opgeslagen, maar de Axe Developer Hub schakelt over naar de gitloze sessieweergave, waar de tak- en commitgeschiedenis van eerdere sessies niet zichtbaar zal zijn. Het indienen van een volgende sessie met alle drie de velden herstelt de gitvolle weergave. Als slechts één of twee van de drie aanwezig zijn, laat Axe Watcher alle gitvolle velden vallen, neemt de sessie op als gitloos en voegt een waarschuwing toe aan de reactie. De overige velden zijn optioneel. Zie Git-metadata verstrekken voor gebruiksvoorbeelden.

Constructor

AxeWatcherGitInfo()

Creëert een nieuwe instantie met alle velden niet ingesteld.

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

Methoden

setBranch(String branch)

Stelt de naam van de Git-tak in. Vereist om de testrun te koppelen aan een tak en commit in Axe Developer Hub.

Parameters:

• branch - Taknaam, bijvoorbeeld "main"

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setTag(String tag)

Stelt de Git-tag in.

Parameters:

• tag - Tagnaam, bijvoorbeeld "v1.2.3"

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setDefaultBranch(String defaultBranch)

Stelt de standaardtak van de repository in. Zonder dit veld kan Axe Developer Hub niet identificeren welke tak de standaard is, waardoor vergelijkingen van feature-branches met de standaardtak niet beschikbaar zullen zijn.

Parameters:

• defaultBranch - Standaardtaknaam, bijvoorbeeld "main"

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setCommitSha(String commitSha)

Stelt de commit SHA in. Vereist om de testrun te koppelen aan een tak en commit in Axe Developer Hub.

Parameters:

• commitSha - Volledige of afgekorte commit-hash, bijvoorbeeld "abc1234"

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setCommitAuthor(String commitAuthor)

Geeft de weergavenaam van de commit-auteur op. Als dit wordt weggelaten, wordt de auteur onbeschikbaar weergegeven in de Axe Developer Hub.

Parameters:

• commitAuthor - Weergavenaam auteur

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setCommitEmail(String commitEmail)

Stelt het e-mailadres van de commit-auteur in.

Parameters:

• commitEmail - E-mailadres van de auteur

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setCommitMessage(String commitMessage)

Stelt het volledige commitbericht in. Als dit wordt weggelaten, verschijnt het commitbericht als onbeschikbaar in de Axe Developer Hub.

Parameters:

• commitMessage - Het volledige commitbericht

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setUrl(String url)

Stelt de externe URL van de repository in. Vereist om de testuitvoering te koppelen aan een tak en commit in Axe Developer Hub.

Parameters:

• url - Externe URL, bijvoorbeeld "https://github.com/org/repo"

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

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

setIsDirty(boolean isDirty)

Stelt in of de werkboom niet-gecommitteerde wijzigingen heeft. Stel in op true als er niet-gecommitteerde wijzigingen zijn, of false als de werkboom schoon is. Als u deze methode niet aanroept, wordt de werkboom gemeld als schoon (false).

Parameters:

• isDirty - true als er niet-gecommitteerde wijzigingen zijn

Retourneert:

• AxeWatcherGitInfo - De huidige instantie voor methode-koppeling

Voorbeeld:

new AxeWatcherGitInfo().setIsDirty(true);

getBranch()

Retourneert: String - De taknaam, of null indien niet ingesteld.

getTag()

Retourneert: String - De tag, of null indien niet ingesteld.

getDefaultBranch()

Retourneert: String - De standaard taknaam, of null indien niet ingesteld.

getCommitSha()

Retourneert: String - De commit SHA, of null indien niet ingesteld.

getCommitAuthor()

Retourneert: String - De weergavenaam van de commitauteur, of null indien niet ingesteld.

getCommitEmail()

Retourneert: String - Het e-mailadres van de commitauteur, of null indien niet ingesteld.

getCommitMessage()

Retourneert: String - Het commitbericht, of null indien niet ingesteld.

getUrl()

Retourneert: String - De externe URL van de repository, of null indien niet ingesteld.

getIsDirty()

Retourneert: Boolean - true indien gewijzigd, false indien schoon, of null indien setIsDirty() nooit is aangeroepen.

Zie ook

• AxeWatcherOptions
• AxeWatcher
• Git-metadata verstrekken