hookspec

v1.1.0(beta)

As the name, hookspec is an git hook test tool. Write hooks like test!

gem install hookspec

or include in Gemfile

gem 'hookspec'

After hookspec gem is installed, you can use 'hookspec' command. Execute the command to initialize hookspec:

bundle exec hookspec install

New a spec file under git_hooks/[hook_type]/ named like FILENAME_spec.rb

# assert branch is not master branch
require 'hookspec'

describe "push" do
  let (:git_env) {HookSpec::GitEnv.new}
  it 'master branch can not be pushed' do
    expect(git_env).not_to be_branch('master')
  end
end

Include rubocop in your Gemfile

describe "rubocop check" do
  let (:git_env) {HookSpec::GitEnv.new}
  it 'rubocop must pass' do
    git_env.diff(model: 'cached', filter: 'AM').each do |f| 
      if f.end_with?('.rb')
        puts `rubocop #{f}`
        expect($?).to be_nil
      end
    end
  end
end

• applypatch-msg
• pre-commit
• post-update
• prepare-commit-msg
• commit-msg
• pre-push
• pre-applypatch
• update
• post-push
• pre-rebase

git_env = HookSpec::GitEnv.new

it 'master branch can not be pushed' do
  expect(git_env).not_to be_branch('master')
end

it 'commit not delete certain files' do
  expect(git_env.diff(model: 'cached', filter: 'D').not_to include_file('README.md')
end

• use git_env.diff(model: model_name, filter: filters)
• filters: A|C|D|M|R|T|U|X|B

# get cached file list with filter 'AM'
git_env.diff(model: 'cached', filter: 'AM')

it 'pull rebase must be setted' do
  expect(git_env.conf_of("pull.rebase")).to eql 'true'
end

git_env.exec("git status")

More features are to be continued...

fork and send pull-request