Classe AxeWatcherGitInfo

La classe AxeWatcherGitInfo contient des métadonnées Git explicites pour un test Axe Watcher. Passez une instance à setGitInfo() sur AxeWatcherOptions pour éviter la détection Git automatique.

Utilisez cette classe lorsque :

• Vos tests s'exécutent dans un dépôt distinct du dépôt sous test
• Le binaire Git n'est pas disponible dans votre environnement CI
• Le dépôt est un clone superficiel ou est dans un état de HEAD détaché

branch, commitSha, et url sont les champs gitful. Si le projet n'est pas encore verrouillé sur une forme de données, une session soumise sans les trois est enregistrée comme Gitless, et le projet se verrouille sur Gitless à l'avenir. Une fois qu'un projet est verrouillé sur Git, une session manquant l'un des trois est rejetée lors de l'ingestion : les résultats ne sont pas sauvegardés. Consultez Exécution refusée : la forme des données ou le dépôt ne correspond pas au projet pour le message de rejet et comment le résoudre. Les autres champs sont facultatifs.

Voir Fournir des métadonnées Git pour des exemples d'utilisation. Un clonage superficiel ou un état HEAD détaché, mentionné ci-dessus comme une raison d'utiliser cette classe, est également une cause fréquente du rejet : voir Exécution Rejetée : La Structure des Données ou le Référentiel Ne Correspond pas au Projet.

Constructeur

AxeWatcherGitInfo()

Crée une nouvelle instance sans champs définis.

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

Méthodes

setBranch(String branch)

Définit le nom de la branche Git. Requis pour que l'exécution du test soit liée à une branche et un commit dans Axe Developer Hub.

Paramètres :

• branch - Nom de la branche, par exemple "main"

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

setCommitAuthor(String commitAuthor)

Définit le nom d'affichage de l'auteur du commit. Si omis, l'auteur apparaît comme indisponible dans Axe Developer Hub.

Paramètres :

• commitAuthor - Nom d'affichage de l'auteur

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

setCommitEmail(String commitEmail)

Définit l'adresse e-mail de l'auteur du commit.

Paramètres :

• commitEmail - Adresse e-mail de l'auteur

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

setCommitMessage(String commitMessage)

Définit le message de commit complet. Si omis, le message de commit apparaît comme indisponible dans Axe Developer Hub.

Paramètres :

• commitMessage - Le message complet du commit

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

setCommitSha(String commitSha)

Définit le SHA du commit. Requis pour que l'exécution du test soit liée à une branche et un commit dans Axe Developer Hub.

Paramètres :

• commitSha - Hash de commit complet ou abrégé, par exemple "abc1234"

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

setDefaultBranch(String defaultBranch)

Définit la branche par défaut du dépôt. Sans ce champ, Axe Developer Hub ne peut pas identifier quelle branche est la par défaut, de sorte que les comparaisons de branches de fonctionnalités contre la branche par défaut ne seront pas disponibles.

Paramètres :

• defaultBranch - Nom de la branche par défaut, par exemple "main"

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

setIsDirty(boolean isDirty)

Définit si l'arborescence de travail a des modifications non validées. Défini sur true s'il y a des modifications non validées, ou false si l'arborescence de travail est propre. Si vous n'appelez pas cette méthode, l'arborescence de travail est déclarée propre (false).

Paramètres :

• isDirty - true s'il y a des modifications non validées

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

new AxeWatcherGitInfo().setIsDirty(true);

setTag(String tag)

Définit le tag Git.

Paramètres :

• tag - Nom du tag, par exemple "v1.2.3"

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

setUrl(String url)

Définit l'URL distante du dépôt. Nécessaire pour que l'exécution de test soit liée à une branche et un commit dans Axe Developer Hub.

Paramètres :

• url - URL distante, par exemple "https://github.com/org/repo"

Résultats :

• AxeWatcherGitInfo - L'instance actuelle pour le chaînage de méthodes

Exemple :

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

getBranch()

Résultats : String - Le nom de la branche, ou null si non défini.

getCommitAuthor()

Résultats : String - Le nom d'affichage de l'auteur du commit, ou null si non défini.

getCommitEmail()

Résultats : String - L'adresse e-mail de l'auteur du commit, ou null si non défini.

getCommitMessage()

Résultats : String - Le message du commit, ou null si non défini.

getCommitSha()

Résultats : String - Le SHA du commit, ou null si non défini.

getDefaultBranch()

Résultats : String - Le nom de la branche par défaut, ou null si non défini.

getIsDirty()

Résultats : Boolean - true si sale, false si propre, ou null si setIsDirty() n'a jamais été appelé.

getTag()

Résultats : String - Le tag, ou null si non défini.

getUrl()

Résultats : String - L'URL distante du dépôt, ou null si non défini.

Voir aussi

• AxeWatcherOptions
• AxeWatcher
• Fournir des métadonnées Git