Clase AxeWatcherGitInfo

La AxeWatcherGitInfo clase contiene metadatos explícitos de Git para una ejecución de prueba de axe Watcher. Pase una instancia a setGitInfo() en AxeWatcherOptions para omitir la detección automática de Git.

Use esta clase cuando:

• Sus pruebas se ejecuten en un repositorio separado del repositorio bajo prueba
• El binario de Git no esté disponible en su entorno de CI
• El repositorio sea un clon superficial o esté en un estado de HEAD separado

branch, commitSha, y url son los campos de git completos: una sesión enviada sin los tres se registra como sin git y se guarda, pero Axe Developer Hub cambia a la vista de sesión sin git, donde el historial de ramas y commits de sesiones anteriores no será visible. Enviar una sesión posterior con los tres campos restaura la vista completa de git. Si solo uno o dos de los tres están presentes, Axe Watcher elimina todos los campos completos de git, registra la sesión como sin git e incluye una advertencia en la respuesta. Los campos restantes son opcionales. Ver Proporcionando Metadatos de Git para ejemplos de uso.

Constructor

AxeWatcherGitInfo()

Crea una nueva instancia con todos los campos sin establecer.

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

Métodos

setBranch(String branch)

Establece el nombre de la rama de Git. Necesario para que la ejecución de prueba esté vinculada a una rama y un commit en Axe Developer Hub.

Parámetros:

• branch - Nombre de la rama, por ejemplo, "main"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setTag(String tag)

Establece la etiqueta de Git.

Parámetros:

• tag - Nombre de la etiqueta, por ejemplo, "v1.2.3"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setDefaultBranch(String defaultBranch)

Establece la rama predeterminada del repositorio. Sin este campo, Axe Developer Hub no puede identificar cuál es la rama predeterminada, por lo que las comparaciones de feature branch contra la rama predeterminada no estarán disponibles.

Parámetros:

• defaultBranch - Nombre de la rama predeterminada, por ejemplo, "main"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setCommitSha(String commitSha)

Establece el SHA del commit. Necesario para que la ejecución de prueba esté vinculada a una rama y un commit en Axe Developer Hub.

Parámetros:

• commitSha - Hash completo o abreviado del commit, por ejemplo, "abc1234"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setCommitAuthor(String commitAuthor)

Establece el nombre para mostrar del autor del commit. Si se omite, el autor aparece como no disponible en Axe Developer Hub.

Parámetros:

• commitAuthor - Nombre para mostrar del autor

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setCommitEmail(String commitEmail)

Establece la dirección de correo electrónico del autor del commit.

Parámetros:

• commitEmail - Dirección de correo electrónico del autor

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setCommitMessage(String commitMessage)

Establece el mensaje completo del commit. Si se omite, el mensaje del commit aparece como no disponible en Axe Developer Hub.

Parámetros:

• commitMessage - El mensaje completo del commit

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setUrl(String url)

Establece la URL remota del repositorio. Es necesario para que la ejecución de prueba esté vinculada a una rama y commit en Axe Developer Hub.

Parámetros:

• url - URL remota, por ejemplo "https://github.com/org/repo"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

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

setIsDirty(boolean isDirty)

Establece si el árbol de trabajo tiene cambios no confirmados. Se establece en true si hay cambios no confirmados, o en false si el árbol de trabajo está limpio. Si no llamas a este método, el árbol de trabajo se reporta como limpio (false).

Parámetros:

• isDirty - true si hay cambios no confirmados

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para encadenamiento de métodos

Ejemplo:

new AxeWatcherGitInfo().setIsDirty(true);

getBranch()

Devoluciones: String - El nombre de la rama, o null si no está configurada.

getTag()

Devoluciones: String - La etiqueta, o null si no está configurada.

getDefaultBranch()

Devoluciones: String - El nombre de la rama predeterminada, o null si no está configurada.

getCommitSha()

Devoluciones: String - El SHA del commit, o null si no está configurada.

getCommitAuthor()

Devoluciones: String - El nombre para mostrar del autor del commit, o null si no está configurada.

getCommitEmail()

Devoluciones: String - La dirección de correo electrónico del autor del commit, o null si no está configurada.

getCommitMessage()

Devoluciones: String - El mensaje del commit, o null si no está configurada.

getUrl()

Devoluciones: String - La URL remota del repositorio, o null si no está configurada.

getIsDirty()

Devoluciones: Boolean - true si está sucio, false si está limpio, o null si setIsDirty() nunca fue llamado.

Ver También

• AxeWatcherOptions
• AxeWatcher
• Proporcionando Metadatos de Git