hookie 1.0.0 → 1.0.1

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.iml
+.idea/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.3"

data/README.md

@@ -2,6 +2,8 @@
 
 Hookie is a pluggable framework for creating git hooks using Ruby. It was originally designed for writing hooks for gitolite, but should work for any hooks, including local ones.
 
+[![Build Status](https://travis-ci.org/marcins/hookie.png?branch=develop)](https://travis-ci.org/marcins/hookie)
+
 ## Background
 
 After we had setup [HipChat](http://hipchat.com) at our organisation I wanted to get notifications from gitolite pushes pushed to HipChat. I found the [gitolite-hipchat-notification](https://github.com/peplin/gitolite-hipchat-notification) project, and [forked it](https://github.com/marcins/gitolite-hipchat-notification) and cleaned it up a bit for my purposes. However this script wasn't very flexible in that you needed to add it individually to each repo (or suffer with a single config). Then I wanted to add Jenkins build notifications as well, so had to enhance the script to support running multiple tasks. Eventually it was all getting too crufty and so Hookie was born!
@@ -10,9 +12,11 @@ Hookie is designed so that you can have multiple actions take place as a result
 
 Hookie includes those aforementioned plugins for HipChat and Jenkins in the base build.
 
+In addition there is now a FishEye plugin (as of v1.0.1)
+
 ## Acknowledgements
 
-Hookie is built on the base of @peplin's (gitolite-hipchat-notification)[https://github.com/peplin/gitolite-hipchat-notification] project, which was originally forked from (gitolite-campfire-notification)[https://github.com/LegionSB/gitolite-campfire-notification] - the magic of Open Source!
+Hookie is built on the base of @peplin's [gitolite-hipchat-notification](https://github.com/peplin/gitolite-hipchat-notification) project, which was originally forked from [gitolite-campfire-notification](https://github.com/LegionSB/gitolite-campfire-notification) - the magic of Open Source!
 
 Hookie uses [grit](https://github.com/mojombo/grit) for accessing information in git repositories.
 
@@ -50,6 +54,10 @@ You can also install Hookie hooks manually, by adding them to the hooks director
 
 ## Configuration
 
+**NOTE** for gitolite you will need to make the following change to .gitolite.rc or your config keys won't work!
+
+    GIT_CONFIG_KEYS             =>  'hookie\..*',
+
 Hookie was written such that it can be configured using Gitolite's ability to set git config keys via the gitolite-admin repository.
 
 You can set "global" config keys using the special repository @all in gitolite, and override or set project specific keys within the repository itself. This makes it easy to, for example, set your HipChat API key for all repos, but then set the room that gets notified in each repo separately - and this can all be done via the gitolite-admin repository, without requiring access to the git server.
@@ -61,7 +69,7 @@ An example conf/gitolite.conf:
 
     repo testing
         RW+     =   @all
-        config hookie.core.allowedplugins = hipchat,jenkins
+        config hookie.core.allowedplugins = hipchat,jenkins,fisheye
         config hookie.hipchat.room = 123456
         config hookie.jenkins.url = http://jenkins.example.com/job/Test%20Job/build?token=test
         config hookie.jenkins.branches=develop
@@ -72,6 +80,8 @@ An example conf/gitolite.conf:
         config hookie.hipchat.from = "Git Test"
         config hookie.core.web.commit = https://fisheye.example.com/changelog/%REPO%?cs=%COMMIT%
         config hookie.core.web.browse = https://fisheye.example.com/browse/%REPO%
+        config hookie.fisheye.apikey = APIKEY
+        config hookie.fisheye.url = https://fisheye.example.com/rest-service-fecru/admin/repositories-v1/%REPO%/scan
 
 The following core keys are used by the framework:
 
@@ -87,6 +97,7 @@ The following plugins are shipped with Hookie:
 
 * HipChat - posts a notification to a HipChat room in response to a commit
 * Jenkins - triggers a Jenkins build in reponse to a commit
+* FishEye - triggers a scan of a FishEye repository in response to a commit
 
 ### HipChat
 
@@ -106,6 +117,13 @@ The following config keys apply to the Jenkins plugin:
 * **hookie.jenkins.branches** - only trigger a build if the change set includes commits to the branches in this list. Comma separated. Default is to build for any commit.
 * **hookie.jenkins.auth** - the username:token combo to use to authenticate with Jenkins
 
+### FishEye
+
+The following config keys apply to the Fisheye plugin:
+
+* **hookie.fisheye.url** - the FishEye REST API URL (see the [FishEye docs](https://confluence.atlassian.com/display/FISHEYE033/Configuring+Commit+Hooks) for where to find this URL). You should use the placeholder `%REPO%` which will be replaced with the repo name
+* **hookie.fisheye.apikey** - the FishEye REST API Key (see the [FishEye docs](https://confluence.atlassian.com/display/FISHEYE033/Setting+the+REST+API+token) for where to obtain this token)
+
 ## Writing Plugins
 
 Hookie was designed to be extensible by writing your own plugins.

data/Rakefile

@@ -2,3 +2,5 @@ require "bundler/gem_tasks"
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
+
+task :default => [:spec]

data/hookie.gemspec

@@ -2,7 +2,7 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'hookie'
+require 'hookie/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "hookie"
@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["marcins@webqem.com"]
   gem.description   = %q{Hookie provides a way to write git hooks with ruby without too much worrying about any of the plumbing required, you can easily write your own plugins and focus on the core of your functionality. 
 
-    Hookie includes plugins for Jenkins and HipChat.}
+    Hookie includes plugins for Jenkins, FishEye, and HipChat.}
   gem.summary       = %q{Framework for writing gitolite/git hooks with Ruby}
   gem.homepage      = "https://github.com/marcins/hookie"
 
@@ -23,5 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'grit', '~> 2.5.0'
   gem.add_dependency 'diff-lcs', '~> 1.1.3'
 
+  gem.add_development_dependency 'rake', '>= 10.0.3'
   gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'simplecov', '>= 0.4.0'
 end

data/lib/hookie.rb

@@ -1,5 +1 @@
-require_relative "hookie/framework"
-
-module Hookie
-    VERSION = "1.0.0"
-end
+require_relative "hookie/framework"

data/lib/hookie/plugins/empty_plugin.rb

@@ -5,7 +5,6 @@ module Hookie
     class EmptyPlugin < BasePlugin
       def post_receive
         log "Empty Plugin - post_receive"
-        raise "Shite"
       end
     end
   end

data/lib/hookie/plugins/fisheye_plugin.rb

@@ -0,0 +1,54 @@
+require_relative 'base_plugin'
+
+require 'time'
+require 'net/https'
+require 'json'
+
+module Hookie
+  module Plugin
+    class FishEyePlugin < BasePlugin
+      def to_s
+        "FishEye Notifier"
+      end
+
+      def should_run?
+        warnings = []
+        if @framework.changes.empty?
+          log "No changes"
+          return false
+        end
+        warnings << "hookie.fisheye.apikey not set!" unless @config[:apikey]
+        warnings << "hookie.fisheye.url not set!" unless @config[:url]
+
+        log warnings.join(", ") unless warnings.empty?
+
+        warnings.empty?
+      end
+
+      def post_receive
+        log "Sending scan request to FishEye ... "
+        response = notify()
+        if response == []
+          log "Request sent to FishEye"
+        elsif response[:message]
+          log "Error: #{response[:message]}"
+        else
+          log "Unknown response #{response}"
+        end
+      end
+
+      private
+      def notify
+        uri = URI.parse(@config[:url].gsub('%REPO%', @framework.repo_name))
+        http = Net::HTTP.new(uri.host, uri.port, @config[:proxyaddress], @config[:proxyport])
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        request = Net::HTTP::Post.new(uri.path)
+        request['X-Api-Key'] = @config[:apikey]
+
+        JSON.parse(http.request(request).body, {symbolize_names: true})
+      end
+
+    end
+  end
+end

data/lib/hookie/version.rb

@@ -0,0 +1,3 @@
+module Hookie
+    VERSION = "1.0.1"
+end

data/spec/base_plugin_spec.rb

@@ -19,6 +19,11 @@ describe Hookie::BasePlugin do
     it "should initialise" do
 
     end
+
+    it "is runnable" do
+      @plugin.should_run?.should be_true
+    end
+
     it "should correctly derive the plugin name" do
       @plugin.to_s.should eq "Base"
       @plugin.config_key.should eq "base"

data/spec/fisheye_plugin_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'hookie'
+require 'hookie/plugins/fisheye_plugin'
+
+describe Hookie::Plugin::FishEyePlugin do
+  before :each do
+    @hookie = double(Hookie::Framework)
+    @config = double(Grit::Config)
+    @config.stub(:keys).and_return([])
+
+    @hookie.stub(:config).and_return(@config)
+    @hookie.stub(:log)
+  end
+
+  context "FishEye plugin" do
+    before :each do
+      @plugin = Hookie::Plugin::FishEyePlugin.new @hookie
+    end
+
+    context "config" do
+      it "identifies itself" do
+        @plugin.to_s.should eq "FishEye Notifier"
+      end
+
+      it "shouldn't run only when there are no changes" do
+        @hookie.should_receive(:changes).once.and_return([])
+        @plugin.should_run?.should be_false
+      end
+
+      it "shouldn't run when there are changes but config is missing" do
+        @hookie.should_receive(:changes).once.and_return(["something"])
+        @hookie.should_receive(:log).once
+        @plugin.should_run?.should be_false
+      end
+
+      it "should run when there are no changes and config is correct" do
+        @config.should_receive(:keys).and_return(['hookie.fisheye.apikey','hookie.fisheye.url'])
+        @config.should_receive('[]').with('hookie.fisheye.apikey').and_return("ABC123")
+        @config.should_receive('[]').with('hookie.fisheye.url').and_return("http://localhost/test/%REPO%/")
+        plugin = Hookie::Plugin::FishEyePlugin.new @hookie
+        @hookie.should_receive(:changes).once.and_return(["something"])
+        @hookie.should_not_receive(:log)
+        plugin.should_run?.should be_true
+      end
+    end
+
+    it "responds to success" do
+      # FIXME this neds to be better
+      @plugin.should_receive(:notify).and_return([])
+      @hookie.should_receive(:log).with(any_args)
+      @hookie.should_receive(:log).with(@plugin, /sent/)
+      @plugin.post_receive
+    end
+
+    it "responds to failure" do
+      @plugin.should_receive(:notify).and_return({code: 401,  message: "ERROR"})
+      @hookie.should_receive(:log).with(any_args)
+      @hookie.should_receive(:log).with(@plugin, /ERROR/)
+      @plugin.post_receive
+    end
+
+    it "responds to an unknown response" do
+      @plugin.should_receive(:notify).and_return({foo: 'bar'})
+      @hookie.should_receive(:log).with(any_args)
+      @hookie.should_receive(:log).with(@plugin, /unknown/i)
+      @plugin.post_receive
+    end
+  end
+end

data/spec/framework_spec.rb

@@ -13,6 +13,16 @@ describe Hookie do
   context 'initialisation' do
     it "intialises" do
       hookie = Hookie::Framework.new "test_hook", Dir.getwd
+      hookie
+    end
+
+    it "can can use the hook static" do
+      @config.stub(:[])
+      begin
+        Hookie::Framework.hook "foo"
+      rescue SystemExit => e
+        e.status.should be 255
+      end
     end
 
     it "reads changes" do
@@ -29,9 +39,58 @@ describe Hookie do
       change[:ref].should eq "refs/heads/master"
 
       change[:commit].should be commit
+
+      change2 = hookie.changes[1]
+      change2[:old_hash].should eq "0000000000000000000000000000000000000000"
+      change2[:new_hash].should eq "09e6a76d20ae8c8e1d40ce21b6ea586ff860e5d3"
+      change2[:ref].should eq "refs/heads/develop"
     end
   end
 
+  context "runner" do
+    before(:each) do
+      @config.stub(:keys).and_return([])
+      @hookie = Hookie::Framework.new "test_hook", Dir.getwd
+    end
+
+    it "exits if no allowed plugins set" do
+      @config.stub(:[]).with("hookie.core.allowedplugins").and_return(nil)
+      begin
+        @hookie.run_plugins("test")
+      rescue SystemExit => e
+        e.status.should be 255
+      end
+    end
+
+    module Hookie
+      module Plugin
+        class TestPlugin < BasePlugin
+          def test
+            log "ran test"
+          end
+          def errors
+            raise "Fudge"
+          end
+        end
+      end
+    end
+
+   it "runs a plugin" do
+      @config.stub(:keys).and_return(["hookie.core.allowedplugins"])
+      @config.stub(:[]).with("hookie.core.allowedplugins").and_return(["test"])
+      @hookie.should_receive(:log).with(anything, "ran test")
+      @hookie.run_plugins("test")
+    end
+
+   it "handles plugin failure" do
+      @config.stub(:keys).and_return(["hookie.core.allowedplugins"])
+      @config.stub(:[]).with("hookie.core.allowedplugins").and_return(["test"])
+      @hookie.should_receive(:log).with(anything, /exception/i)
+      @hookie.run_plugins("errors")
+    end
+
+  end
+
   context "helpers" do
     before(:each) do
       @hookie = Hookie::Framework.new "test_hook", Dir.getwd
@@ -62,5 +121,53 @@ describe Hookie do
       commit.stub(:id).and_return("ABC")
       @hookie.commit_url(commit).should eq "TEST testrepo TEST ABC"
     end
+
+    it "correctly gets the name of a bare repo" do
+      @repo.stub(:bare).and_return(true)
+      @repo.stub(:path).and_return("/foo/bar/baz.git")
+      @config.stub(:[]).with('hookie.core.repo.name').and_return(nil)
+      @hookie.repo_name.should eq "baz"
+    end
+
+    it "correctly gets the name of a non-bare repo" do
+      @repo.stub(:bare).and_return(false)
+      @repo.stub(:path).and_return("/foo/bar/baz/.git")
+      @config.stub(:[]).with('hookie.core.repo.name').and_return(nil)
+      @hookie.repo_name.should eq "baz"
+    end
+
+    it "collects heads" do
+      def head_helper(name, commit_id)
+        head = double("Grit::Head")
+        head.stub(:name).and_return(name)
+        commit = double("Grit::Commit")
+        commit.stub(:id).and_return(commit_id)
+        head.stub(:commit).and_return(commit)
+        head
+      end
+      heads = [
+        head_helper("one", "1"),
+        head_helper("two", "2"),
+        head_helper("three", "2")
+      ]
+
+      @repo.stub(:heads).with(any_args).and_return(heads)
+      commit = double("Grit::Commit")
+      commit.stub(:id).and_return("1")
+      @hookie.head_names_for_commit(commit).should have(1).items
+    end
+
+    it "logs stuff" do
+      class TestPlugin
+        def to_s
+          "Test"
+        end
+      end
+      plugin = TestPlugin.new
+      Time.stub(:now).and_return(Time.parse("01/04/2013 09:00:00"))
+      @hookie.should_receive(:puts).with("[2013-04-01 09:00:00] Test: test")
+      @hookie.log(plugin, "test")
+    end
+
   end
 end

data/spec/hipchat_plugin_spec.rb

@@ -11,12 +11,17 @@ describe Hookie::Plugin::HipChatPlugin do
     @hookie.stub(:config).and_return(@config)
     @hookie.stub(:log)
   end
+
   context "HipChat plugin" do
     before :each do
       @plugin = Hookie::Plugin::HipChatPlugin.new @hookie
     end
 
     context "config" do
+      it "identifies itself" do
+        @plugin.to_s.should eq "HipChat Notifier"
+      end
+
       it "shouldn't run only when there are no changes" do
         @hookie.should_receive(:changes).once.and_return([])
         @plugin.should_run?.should be_false
@@ -39,13 +44,76 @@ describe Hookie::Plugin::HipChatPlugin do
       end
     end
 
-    it "sends the correct message" do
+    it "responds to success" do
       # FIXME this neds to be better
       @plugin.stub(:format_message).and_return("message")
-      @plugin.should_receive(:speak).with("message").and_return({"status" => "sent"})
-      @hookie.should_receive(:log).twice
+      @plugin.should_receive(:speak).with("message").and_return({:status => "sent"})
+      @hookie.should_receive(:log).with(any_args)
+      @hookie.should_receive(:log).with(@plugin, /sent/)
+      @plugin.post_receive
+    end
+
+    it "responds to failure" do
+      @plugin.stub(:format_message).and_return("message")
+      @plugin.should_receive(:speak).with("message").and_return({error: { message: "ERROR"}})
+      @hookie.should_receive(:log).with(any_args)
+      @hookie.should_receive(:log).with(@plugin, /ERROR/)
       @plugin.post_receive
     end
 
+    it "responds to an unknown response" do
+      @plugin.stub(:format_message).and_return("message")
+      @plugin.should_receive(:speak).with("message").and_return({})
+      @hookie.should_receive(:log).with(any_args)
+      @hookie.should_receive(:log).with(@plugin, /unknown/i)
+      @plugin.post_receive
+    end
+
+    context "message" do
+      def commit_stub(abbrev, author, message)
+        commit = double(Grit::Commit)
+        commit.stub(:id_abbrev).and_return(abbrev)
+        commit.stub(:author).and_return(author)
+        commit.stub(:short_message).and_return(message)
+        commit
+      end
+
+      before :each do
+        @hookie.stub(:repo_url).and_return(nil)
+        @hookie.stub(:repo_name).and_return("REPO")
+        @hookie.stub(:commit_url).and_return("")
+        @hookie.stub(:head_names_for_commit).and_return([])
+      end
+
+      it "properly formats a message for one change" do
+        change = {
+          commit: commit_stub("00000", "Author", "Message")
+        }
+
+        @hookie.stub(:changes).and_return([change])
+        expected_message = "Commits just pushed to REPO:<br/><a href=''>00000</a> Author: Message<br/>"
+
+        @plugin.should_receive(:speak).with(expected_message).and_return({status: "sent"})
+        @plugin.post_receive
+      end
+
+      it "properly formats a message for multiple changes" do
+        stub = commit_stub("00001", "Author2", "Message2")
+        change = [
+          { commit: commit_stub("00000", "Author", "Message") },
+          { commit: stub }
+        ]
+
+        @hookie.stub(:head_names_for_commit).with(stub).and_return(["test"])
+
+        @hookie.stub(:changes).and_return(change)
+        expected_message = "Commits just pushed to REPO:<br/><a href=''>00000</a> Author: Message<br/><a href=''>00001</a> (test) Author2: Message2<br/>"
+
+        @plugin.should_receive(:speak).with(expected_message).and_return({status: "sent"})
+        @plugin.post_receive
+
+      end
+
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 require 'rspec'
 require 'hookie'
 

data/travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hookie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,10 +75,26 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: ! "Hookie provides a way to write git hooks with ruby without too much
   worrying about any of the plumbing required, you can easily write your own plugins
   and focus on the core of your functionality. \n\n    Hookie includes plugins for
-  Jenkins and HipChat."
+  Jenkins, FishEye, and HipChat."
 email:
 - marcins@webqem.com
 executables:
@@ -71,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -81,13 +114,17 @@ files:
 - lib/hookie/framework.rb
 - lib/hookie/plugins/base_plugin.rb
 - lib/hookie/plugins/empty_plugin.rb
+- lib/hookie/plugins/fisheye_plugin.rb
 - lib/hookie/plugins/hipchat_plugin.rb
 - lib/hookie/plugins/jenkins_plugin.rb
+- lib/hookie/version.rb
 - spec/base_plugin_spec.rb
+- spec/fisheye_plugin_spec.rb
 - spec/framework_spec.rb
 - spec/hipchat_plugin_spec.rb
 - spec/jenkins_plugin_spec.rb
 - spec/spec_helper.rb
+- travis.yml
 homepage: https://github.com/marcins/hookie
 licenses: []
 post_install_message: 
@@ -108,12 +145,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Framework for writing gitolite/git hooks with Ruby
 test_files:
 - spec/base_plugin_spec.rb
+- spec/fisheye_plugin_spec.rb
 - spec/framework_spec.rb
 - spec/hipchat_plugin_spec.rb
 - spec/jenkins_plugin_spec.rb