Classe AxeWatcherGitInfo

A classe AxeWatcherGitInfo contém metadados explícitos do Git para uma execução de teste do axe Watcher. Passe uma instância para setGitInfo() em AxeWatcherOptions para ignorar a detecção automática do Git.

Use esta classe quando:

• Seus testes são executados em um repositório separado do repositório em teste
• O binário do Git não está disponível em seu ambiente de CI
• O repositório é um clone superficial ou está em um estado de HEAD destacado

branch , commitSha, e url são os campos gitful: uma sessão enviada sem os três é registrada como gitless e salva, mas o Axe Developer Hub muda para a visualização de sessão gitless, onde o histórico de branches e commits de sessões anteriores não ficará visível. Enviar uma sessão subsequente com todos os três campos restaura a visualização gitful. Se apenas um ou dois dos três estiverem presentes, o Axe Watcher descarta todos os campos gitful, registra a sessão como gitless e inclui um aviso na resposta. Os campos restantes são opcionais. Veja Fornecendo Metadados do Git para exemplos de uso.

Construtor

AxeWatcherGitInfo()

Cria uma nova instância com todos os campos não definidos.

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

Métodos

setBranch(String branch)

Define o nome do branch do Git. Necessário para que a execução do teste seja vinculada a um branch e commit no Axe Developer Hub.

Parâmetros:

• branch - Nome do branch, por exemplo. "main"

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setTag(String tag)

Define a tag do Git.

Parâmetros:

• tag - Nome da tag, por exemplo. "v1.2.3"

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setDefaultBranch(String defaultBranch)

Define o branch padrão do repositório. Sem este campo, o Axe Developer Hub não pode identificar qual branch é o padrão, então comparações de branch de funcionalidades em relação ao branch padrão não estarão disponíveis.

Parâmetros:

• defaultBranch - Nome do branch padrão, por exemplo. "main"

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setCommitSha(String commitSha)

Define o SHA do commit. Necessário para que a execução do teste seja vinculada a um branch e commit no Axe Developer Hub.

Parâmetros:

• commitSha - Hash completo ou abreviado do commit, por exemplo. "abc1234"

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setCommitAuthor(String commitAuthor)

Define o nome de exibição do autor do commit. Se omitido, o autor aparecerá como indisponível no Axe Developer Hub.

Parâmetros:

• commitAuthor - Nome de exibição do autor

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setCommitEmail(String commitEmail)

Define o endereço de e-mail do autor do commit.

Parâmetros:

• commitEmail - Endereço de email do autor

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setCommitMessage(String commitMessage)

Define a mensagem completa do commit. Se omitida, a mensagem do commit aparecerá como indisponível no Axe Developer Hub.

Parâmetros:

• commitMessage - A mensagem completa do commit

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setUrl(String url)

Define a URL remota do repositório. Necessário para que a execução do teste esteja vinculada a um branch e commit no Axe Developer Hub.

Parâmetros:

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

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

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

setIsDirty(boolean isDirty)

Define se a árvore de trabalho tem alterações não commitadas. Defina como true se houver alterações não commitadas, ou false se a árvore de trabalho estiver limpa. Se você não chamar este método, a árvore de trabalho será reportada como limpa (false).

Parâmetros:

• isDirty - true se houver alterações não commitadas

Retorna:

• AxeWatcherGitInfo - A instância atual para encadeamento de métodos

Exemplo:

new AxeWatcherGitInfo().setIsDirty(true);

getBranch()

Retorna: String - O nome do branch, ou null se não definida.

getTag()

Retorna: String - A tag, ou null se não definida.

getDefaultBranch()

Retorna: String - O nome do branch padrão, ou null se não definida.

getCommitSha()

Retorna: String - O SHA do commit, ou null se não definida.

getCommitAuthor()

Retorna: String - O nome de exibição do autor do commit, ou null se não definida.

getCommitEmail()

Retorna: String - O endereço de email do autor do commit, ou null se não definida.

getCommitMessage()

Retorna: String - A mensagem do commit, ou null se não definida.

getUrl()

Retorna: String - A URL remota do repositório, ou null se não definida.

getIsDirty()

Retorna: Boolean - true se sujo, false se limpo, ou null se setIsDirty() nunca foi chamado.

Veja também

• AxeWatcherOptions
• AxeWatcher
• Fornecendo Metadados do Git