Classe AxeWatcherGitInfo

La classe AxeWatcherGitInfo contiene i metadati Git espliciti per un test di Axe Watcher. Passa un'istanza a setGitInfo() su AxeWatcherOptions per bypassare il rilevamento automatico di Git.

Usa questa classe quando:

• I tuoi test vengono eseguiti in un repository separato dal repository sotto test
• Il binario Git non è disponibile nel tuo ambiente CI
• Il repository è un clone superficiale o si trova in uno stato di HEAD staccato

branch, commitSha e url sono i campi gitful. Se il progetto non si è ancora bloccato su una forma di dati, una sessione inviata senza tutti e tre viene registrata come Gitless, e il progetto si blocca su Gitless in futuro. Una volta che un progetto è bloccato su Git, una sessione che manca di uno qualsiasi dei tre viene rifiutata all'ingestione: i risultati non vengono salvati. Vedi Esecuzione rifiutata: Forma dei dati o repository non corrisponde al progetto per il messaggio di rifiuto e come risolverlo. I campi rimanenti sono opzionali.

Vedere Fornire Metadati Git per esempi di utilizzo. Un clone superficiale o uno stato HEAD scollegato, menzionati sopra come motivo per usare questa classe, sono anche una causa comune del rifiuto: vedere Esecuzione rifiutata: forma dei dati o repository non corrispondono al progetto.

Costruttore

AxeWatcherGitInfo()

Crea una nuova istanza con tutti i campi non impostati.

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

Metodi

setBranch(String branch)

Imposta il nome del branch Git. Necessario affinché il test run sia collegato a un branch e un commit nell'Axe Developer Hub.

Parametri:

• branch - Nome del ramo, ad esempio "main"

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

setCommitAuthor(String commitAuthor)

Imposta il nome visualizzato dell'autore del commit. Se omesso, l'autore apparirà come non disponibile in Axe Developer Hub.

Parametri:

• commitAuthor - Nome visualizzato dell'autore

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

setCommitEmail(String commitEmail)

Imposta l'indirizzo email dell'autore del commit.

Parametri:

• commitEmail - Indirizzo email dell'autore

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

setCommitMessage(String commitMessage)

Imposta il messaggio del commit completo. Se omesso, il messaggio del commit apparirà come non disponibile in Axe Developer Hub.

Parametri:

• commitMessage - Il messaggio completo del commit

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

setCommitSha(String commitSha)

Imposta lo SHA del commit. Necessario affinché il test run sia collegato a un branch e un commit nell'Axe Developer Hub.

Parametri:

• commitSha - Hash del commit completo o abbreviato, ad esempio "abc1234"

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

setDefaultBranch(String defaultBranch)

Imposta il branch predefinito del repository. Senza questo campo, l'Axe Developer Hub non può identificare quale branch è il predefinito, quindi i confronti tra feature-branch e branch predefinito non saranno disponibili.

Parametri:

• defaultBranch - Nome del ramo predefinito, ad esempio "main"

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

setIsDirty(boolean isDirty)

Imposta se la working tree ha modifiche non confermate. Imposta su true se ci sono modifiche non confermate, o su false se la working tree è pulita. Se non chiami questo metodo, la working tree viene riportata come pulita (false).

Parametri:

• isDirty - true se ci sono modifiche non confermate

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

new AxeWatcherGitInfo().setIsDirty(true);

setTag(String tag)

Imposta il tag Git.

Parametri:

• tag - Nome del tag, ad esempio "v1.2.3"

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

setUrl(String url)

Imposta l'URL remoto del repository. Necessario per collegare l'esecuzione del test a un ramo e a un commit in Axe Developer Hub.

Parametri:

• url - URL remoto, ad esempio "https://github.com/org/repo"

Restituisce:

• AxeWatcherGitInfo - L'istanza corrente per il chaining dei metodi

Esempio:

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

getBranch()

Restituisce: String - Il nome del ramo, o null se non impostato.

getCommitAuthor()

Restituisce: String - Il nome visualizzato dell'autore del commit, o null se non impostato.

getCommitEmail()

Restituisce: String - L'indirizzo email dell'autore del commit, o null se non impostato.

getCommitMessage()

Restituisce: String - Il messaggio del commit, o null se non impostato.

getCommitSha()

Restituisce: String - Lo SHA del commit, o null se non impostato.

getDefaultBranch()

Restituisce: String - Il nome del ramo predefinito, o null se non impostato.

getIsDirty()

Restituisce: Boolean - true se è sporco, false se è pulito, o null se setIsDirty() non è mai stato chiamato.

getTag()

Restituisce: String - Il tag, o null se non impostato.

getUrl()

Restituisce: String - L'URL remoto del repository, o null se non impostato.

Vedi anche

• AxeWatcherOptions
• AxeWatcher
• Fornire Metadati Git