Hooks, que podem ser traduzidos como “ganchos”, são pequenos scripts que podem ser adicionados dentro do diretório “.git/hooks/”, existente em todo projeto que utilize o Git como ferramenta de controle de versão, para efetuar ações disparadas por alguns eventos, como pre-commit, post-commit etc (para conhecer todos os eventos visite o Git Community Book).

Quando executamos o comando “git init”, alguns scripts são copiados no diretório de hooks do projeto, porém por padrão ficam desabilitados. Para ativar um script de hook basta remover o sufixo “.sample” do nome dos scripts. Obviamente, não basta apenas ativar o script, é necessário que o desenvolvedor customize o script para realizar alguma ação desejada.

Bom, a principal intenção deste post é demonstrar uma das possibilidades de aplicação deste recurso do Git, a efetivação de commits que não quebrem os testes unitários (JUnit, no caso do Java, e RSpec, no caso do Ruby). Isso é muito útil pois evita que builds nos servidores de Integração Contínua (como o Jenkins) sejam quebrados, pois qualquer commit local dos desenvolvedores estará sendo, mesmo que forçadamente, validados. É, eu sei, no mundo ideal isso não deveria ser necessário, pois todos os desenvolvedores deveriam ter noção de que mesmo alterações ínfimas no código podem ter resultados catastróficos e, por livre e espontânea vontade, deveriam executar com frequência os testes unitários, mesmo porque são rápidos e não causam qualquer tipo de overhead no dia-a-dia do desenvolvedor, aliás, muito pelo contrário!

Bom, recentemente escrevi dois hooks para validação dos commits, um para projetos Java que rodem os testes através do Maven e outro para projetos Ruby que utilizem o RSpec. Ombos os scripts são muito simples e podem ser facilmente adaptados para projetos que usam Gradle, Test-Unit, TestNG, Shoulda etc.

A listagem abaixo mostra o Git hook pre-commit para validação da integridade dos testes unitários para projetos Java com Maven:

#!/usr/bin/env ruby

puts "Git hook pre-commit: #{__FILE__}"
puts "Executing maven tests: mvn clean test"

output_filename="#{Time.now.strftime("%Y-%m-%d_%H-%M")}_git_precommit_tests_result.log"
output=`mvn clean test > /tmp/#{output_filename}`  

if $?.success?
  puts "#################################################################"
  puts "No errors were found o/"
  puts "#################################################################"
else
  puts "#################################################################"
  puts "Commit aborted!"
  puts "WTF are you doing? Sorry, but some errors were found, dude!"
  puts "For more informations, read the file: #{output_filename}"
  puts "#################################################################"
  exit 1
end

Download Git hook pre-commit para Java

A listagem abaixo mostra o Git hook pre-commit para validação da integridade dos testes unitários para projetos Ruby com RSpec:

#!/usr/bin/env ruby

puts "Git hook pre-commit: #{__FILE__}"
puts "Executing RSpec tests..."

html_path = "tmp/spec_results.html"
`spec -f h:#{html_path} -f l spec` # run the spec. save html results to html_path

# find out how many errors were found
html = open(html_path).read
examples = html.match(/(d+) example/)[0].to_i rescue 0
failures = html.match(/(d+) failure/)[0].to_i rescue 0
pending = html.match(/(d+) pending/)[0].to_i rescue 0  

if failures.zero?
  puts "#################################################################"
  puts "No errors were found o/"
  puts "0 failures! #{examples} run, #{pending} pending"
  puts "#################################################################"
else
  puts "#################################################################"
  puts "Commit aborted!"
  puts "WTF are you doing? Sorry, but some errors were found, dude!"
  puts "#{failures} failures! #{examples} run, #{pending} pending"
  puts "View tests results at #{File.expand_path(html_path)}"
  puts "#################################################################"
  exit 1
end

Download Git hook pre-commit para Ruby

Bom é isso, para quem quiser conhecer mais sobre o recurso de Hooks do Git, vale a leitura do Capítulo 5 do Git Community Book, exclusivamente dedicado aos Hooks.