Executar lint e teste de unidade

  • 6 minutos

O GitHub Actions pode ser usado para automatizar tarefas disparadas por eventos. Para disparar verificações de qualidade de código quando uma solicitação de pull é criada, você precisará:

  • Verificar seu código com linters e testes de unidade.
  • Integrar verificações de código com solicitações pull.

Verificar o código

Há dois tipos comuns de verificações que são interessantes fazer em seu código: linters e testes de unidade.

Você pode usar linters para verificar se o código está de acordo com as diretrizes de qualidade que sua organização definiu. Por exemplo, para fazer lint do código com Flake8, você vai criar um arquivo de configuração .flake8, que contém as regras às quais seu código deve aderir.

Para verificar se o código funciona conforme o esperado, você pode criar testes de unidade. Para testar facilmente partes específicas do seu código, os scripts devem conter funções. Você pode testar funções em seus scripts criando arquivos de teste. Uma ferramenta popular para testar o código do Python é o Pytest.

Dica

Saiba mais sobre como executar testes de unidade com o Pytest.

Para verificar seu código usando GitHub Actions, você precisará:

  • Instale a ferramenta (Flake8 ou Pytest).
  • Executar os testes especificando as pastas do repositório que precisam ser verificadas.

Dica

Você pode verificar o código automaticamente com o GitHub Actions ou manualmente no Visual Studio Code. Saiba mais sobre como verificar seu código localmente.

Integrar verificações de código com solicitações pull.

Para disparar um fluxo de trabalho do GitHub Actions quando uma solicitação de pull é criada, use on: pull_request.

Você quer se certificar de que uma solicitação de pull só possa ser mesclada quando todas as verificações de qualidade tiverem sido aprovadas.

Para integrar as verificações de código a todas as solicitações de pull direcionadas à ramificação principal, você deve fazer o seguinte:

  1. Navegue até a guia Configurações em seu repositório.
  2. Selecione Ramificações.
  3. Habilite exigir que as verificações de status sejam aprovadas antes da mesclagem na regra de proteção de branch da ramificação principal.

Captura de tela da configuração para exigir verificações de status antes da mesclagem.

Aqui, você pode pesquisar e selecionar seus linters e testes de unidade para defini-los conforme exigência. Sempre que você criar uma solicitação de pull, observará que ela vai disparar o GitHub Actions e somente quando os fluxos de trabalho forem aprovados com êxito, você poderá mesclar a solicitação de pull.

Observação

Para configurar as verificações de código para serem exigidas antes de mesclar uma solicitação de pull, seu trabalho precisa ter um nome no fluxo de trabalho do GitHub Actions. Assim, você conseguirá encontrar as verificações pesquisando os nomes dos trabalhos.