Revisão de código com Codebrag


Por sermos artesões de software, eu e meus colegas de equipe sempre tentamos ao máximo aderir às boas práticas de código limpo. Implementando os requisitos negociais com a solução mais simples possível, conforme descrito no princípio KISS (Keep It Simple Stupid), criando pequenas funções que fazem somente uma coisa (Responsabilidade única), fazendo com que o código seja auto documentável e fácil de entender.

Ocasionalmente surge uma nova API ou um componente que até o momento você não conhecia, ou talvez uma forma mais otimizada de contar a história que seu código está contando, e seu código precisa ser alterado para adaptar à esta nova API/forma. Também existe a situação em que uma nova funcionalidade ou uma correção de um bug precica ser implementada com rapidez e o desenvolvedor tem que realizar algumas compensações para poder entregar à tempo. Eis que a revisão do código aparece para verificar as janelas quebradas que podem surgir nos exemplos citados.

Existem muitas ferramentas open source que fazem este serviço, mas minhas equipe escolher o Codebrag principalmente porque ele suporta SVN e por causa de sua interface amigável.

Utilizando Codebrag

Esta ferramenta open source é fácil de instalar e configurar, basicamente tudo que você precisa fazer é:

  • Instalar o Git e a JDK 7+;
  • Efetuar o download da última distribuição da ferramenta em codebrag.com;
  • Extrair o arquivo zip;
  • Baixar o seu repositório utilizando Git e colocá-lo na pasta:
    • Para um repositório no Git, basta usar git clone
    • E para um repositório no SVN, você tem que usar git svn clone (no meu caso tive que especificar o parâmetro --username, e a revisão específica ao invés da HEAD, que no final das contas ficou assim git svn clone --username myuser -r140123 https://mysvnrepo.com)
  • Editar o arquivo codebrag.conf, onde você pode colocar o usuário e senha para acessar o seu repositório, e algumas configurações relacionadas à aplicação.
  • Executar o arquivo codebrag.bat caso você esteja usando Windows, ou codebrag.sh para Linux, e feito isso estará rodando!

Terminando os passos anteriores, entre na aplicação e registre seu e-mail, usuário e senha. Após isso, a página inicial irá carregar os commits que não foram revisados. Você pode registrar outros membros clicando na opção "invite team members" e compartilhando o link gerado com eles.

Segue abaixo uma demonstração de como revisar o commit de outra pessoa:


Agora eu loguei com o dono do commit que foi revisado, para demonstrar como dar um retorno sobre o comentário efetuado:


Conclusão

E é isso para este tutorial, dê uma olhada em Codebrag Wiki para informações mais específicas e escute o Podcast Ruby Rogues 216: RR Code Review Culture With Derek Prior para uma ótima discussão sobre revisão de código. Até a próxima!