Execute linting e testes unitários

  • 6 minutos

As ações do GitHub podem ser usadas para automatizar tarefas acionadas por eventos. Para acionar verificações de qualidade de código quando uma solicitação pull é criada, você precisará:

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

Verifique o seu código

Há dois tipos comuns de verificações que você vai querer fazer em seu código: linters e testes de unidade.

Você pode usar linters para verificar se seu código está de acordo com as diretrizes de qualidade definidas pela sua organização. Por exemplo, para alinhar seu código com Flake8, você criará um .flake8 arquivo de configuração, 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, seus 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 Python é o Pytest.

Gorjeta

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

Para verificar seu código usando as Ações do GitHub, você precisará:

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

Gorjeta

Você pode verificar o código automaticamente com as Ações do GitHub ou manualmente no Visual Studio Code. Saiba mais sobre como verificar seu código localmente.

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

Para acionar um fluxo de trabalho de Ações do GitHub quando uma solicitação pull é criada, você pode usar on: pull_request.

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

Para integrar as verificações de código com quaisquer solicitações pull direcionadas à ramificação principal, você precisará fazer:

  1. Navegue até a guia Configurações no seu repositório.
  2. Selecione Ramos.
  3. Habilite exigir verificações de status para passar antes de mesclar dentro da regra de proteção de ramificação para a ramificação principal.

Screenshot of setting to require status checks before merging.

Aqui, você pode pesquisar e selecionar seus linters e testes de unidade para defini-los conforme necessário. Sempre que você criar uma solicitação pull, notará que ela acionará suas Ações do GitHub e somente quando os fluxos de trabalho passarem com êxito você poderá mesclar a solicitação pull.

Nota

Para configurar as verificações de código necessárias antes de mesclar uma solicitação pull, seu trabalho precisa ter um nome no fluxo de trabalho de Ações do GitHub. Em seguida, você pode encontrar os cheques pesquisando os nomes das vagas.