Merge pull request #6474 from jvanbaarsen/post-tag-hook

Add web hooks on tag

Merge pull request #6474 from jvanbaarsen/post-tag-hook
Add web hooks on tag
Dmitriy Zaporozhets
2 parents cc57a25c e6ceec9d
Showing 8 changed files with 152 additions and 32 deletions Show diff stats
app/models/project_hook.rb
app/services/git_tag_push_service.rb
app/views/projects/hooks/index.html.haml
app/workers/post_receive.rb
db/migrate/20140305193308_add_tag_push_hooks_to_project_hook.rb
db/schema.rb
spec/models/project_hook_spec.rb
spec/services/git_tag_push_service_spec.rb
@@ -17,9 +17,10 @@
 class ProjectHook < WebHook
   belongs_to :project
-  attr_accessible :push_events, :issues_events, :merge_requests_events
+  attr_accessible :push_events, :issues_events, :merge_requests_events, :tag_push_events
   scope :push_hooks, -> { where(push_events: true) }
+  scope :tag_push_hooks, -> { where(tag_push_events: true) }
   scope :issue_hooks, -> { where(issues_events: true) }
   scope :merge_request_hooks, -> { where(merge_requests_events: true) }
 end
@@ -0,0 +1,27 @@
+class GitTagPushService
+  attr_accessor :project, :user, :push_data
+  def execute(project, user, oldrev, newrev, ref)
+    @project, @user = project, user
+    @push_data = create_push_data(oldrev, newrev, ref)
+    project.execute_hooks(@push_data.dup, :tag_push_hooks)
+  end
+
+  private
+
+  def create_push_data(oldrev, newrev, ref)
+    data = {
+      ref: ref,
+      before: oldrev,
+      after: newrev,
+      user_id: user.id,
+      user_name: user.name,
+      project_id: project.id,
+      repository: {
+        name: project.name,
+        url: project.url_to_repo,
+        description: project.description,
+        homepage: project.web_url
+      }
+    }
+  end
+end
@@ -27,6 +27,13 @@
           %p.light
             This url will be triggered by a push to the repository
       %div
+        = f.check_box :tag_push_events, class: 'pull-left'
+        .prepend-left-20
+          = f.label :tag_push_events, class: 'list-label' do
+            %strong Tag push events
+          %p.light
+            This url will be triggered when a new tag is pushed to the repository
+      %div
         = f.check_box :issues_events, class: 'pull-left'
         .prepend-left-20
           = f.label :issues_events, class: 'list-label' do
@@ -56,6 +63,6 @@
           .clearfix
             %span.monospace= hook.url
           %p
-            - %w(push_events issues_events merge_requests_events).each do |trigger|
+            - %w(push_events tag_push_events issues_events merge_requests_events).each do |trigger|
               - if hook.send(trigger)
                 %span.label.label-gray= trigger.titleize
@@ -29,10 +29,20 @@ class PostReceive
       return false
     end
-    GitPushService.new.execute(project, user, oldrev, newrev, ref)
+    if tag?(ref)
+      GitTagPushService.new.execute(project, user, oldrev, newrev, ref)
+    else
+      GitPushService.new.execute(project, user, oldrev, newrev, ref)
+    end
   end
   def log(message)
     Gitlab::GitLogger.error("POST-RECEIVE: #{message}")
   end
+
+  private
+
+  def tag?(ref)
+    !!(/refs\/tags\/(.*)/.match(ref))
+  end
 end
@@ -0,0 +1,5 @@
+class AddTagPushHooksToProjectHook < ActiveRecord::Migration
+  def change
+    add_column :web_hooks, :tag_push_events, :boolean, default: false
+  end
+end
@@ -11,15 +11,18 @@
 #
 # It's strongly recommended that you check this file into your version control system.
-ActiveRecord::Schema.define(version: 20140304005354) do
+ActiveRecord::Schema.define(version: 20140305193308) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
   create_table "broadcast_messages", force: true do |t|
     t.text     "message",    null: false
     t.datetime "starts_at"
     t.datetime "ends_at"
     t.integer  "alert_type"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
     t.string   "color"
     t.string   "font"
   end
@@ -27,8 +30,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
   create_table "deploy_keys_projects", force: true do |t|
     t.integer  "deploy_key_id", null: false
     t.integer  "project_id",    null: false
-    t.datetime "created_at",    null: false
-    t.datetime "updated_at",    null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
   add_index "deploy_keys_projects", ["project_id"], name: "index_deploy_keys_projects_on_project_id", using: :btree
@@ -49,8 +52,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.string   "title"
     t.text     "data"
     t.integer  "project_id"
-    t.datetime "created_at",  null: false
-    t.datetime "updated_at",  null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
     t.integer  "action"
     t.integer  "author_id"
   end
@@ -65,8 +68,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
   create_table "forked_project_links", force: true do |t|
     t.integer  "forked_to_project_id",   null: false
     t.integer  "forked_from_project_id", null: false
-    t.datetime "created_at",             null: false
-    t.datetime "updated_at",             null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
   add_index "forked_project_links", ["forked_to_project_id"], name: "index_forked_project_links_on_forked_to_project_id", unique: true, using: :btree
@@ -106,10 +109,10 @@ ActiveRecord::Schema.define(version: 20140304005354) do
   add_index "keys", ["user_id"], name: "index_keys_on_user_id", using: :btree
   create_table "merge_request_diffs", force: true do |t|
-    t.string   "state",                               default: "collected", null: false
-    t.text     "st_commits",       limit: 2147483647
-    t.text     "st_diffs",         limit: 2147483647
-    t.integer  "merge_request_id",                                          null: false
+    t.string   "state",            default: "collected", null: false
+    t.text     "st_commits"
+    t.text     "st_diffs"
+    t.integer  "merge_request_id",                       null: false
     t.datetime "created_at"
     t.datetime "updated_at"
   end
@@ -138,7 +141,7 @@ ActiveRecord::Schema.define(version: 20140304005354) do
   add_index "merge_requests", ["created_at"], name: "index_merge_requests_on_created_at", using: :btree
   add_index "merge_requests", ["milestone_id"], name: "index_merge_requests_on_milestone_id", using: :btree
   add_index "merge_requests", ["source_branch"], name: "index_merge_requests_on_source_branch", using: :btree
-  add_index "merge_requests", ["source_project_id"], name: "index_merge_requests_on_project_id", using: :btree
+  add_index "merge_requests", ["source_project_id"], name: "index_merge_requests_on_source_project_id", using: :btree
   add_index "merge_requests", ["target_branch"], name: "index_merge_requests_on_target_branch", using: :btree
   add_index "merge_requests", ["title"], name: "index_merge_requests_on_title", using: :btree
@@ -147,8 +150,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.integer  "project_id",  null: false
     t.text     "description"
     t.date     "due_date"
-    t.datetime "created_at",  null: false
-    t.datetime "updated_at",  null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
     t.string   "state"
     t.integer  "iid"
   end
@@ -160,8 +163,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.string   "name",                     null: false
     t.string   "path",                     null: false
     t.integer  "owner_id"
-    t.datetime "created_at",               null: false
-    t.datetime "updated_at",               null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
     t.string   "type"
     t.string   "description", default: "", null: false
     t.string   "avatar"
@@ -183,8 +186,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.string   "line_code"
     t.string   "commit_id"
     t.integer  "noteable_id"
-    t.text     "st_diff"
     t.boolean  "system",        default: false, null: false
+    t.text     "st_diff"
   end
   add_index "notes", ["author_id"], name: "index_notes_on_author_id", using: :btree
@@ -217,15 +220,15 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.boolean  "archived",               default: false,    null: false
   end
-  add_index "projects", ["creator_id"], name: "index_projects_on_owner_id", using: :btree
+  add_index "projects", ["creator_id"], name: "index_projects_on_creator_id", using: :btree
   add_index "projects", ["last_activity_at"], name: "index_projects_on_last_activity_at", using: :btree
   add_index "projects", ["namespace_id"], name: "index_projects_on_namespace_id", using: :btree
   create_table "protected_branches", force: true do |t|
     t.integer  "project_id", null: false
     t.string   "name",       null: false
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
   add_index "protected_branches", ["project_id"], name: "index_protected_branches_on_project_id", using: :btree
@@ -235,8 +238,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.string   "title"
     t.string   "token"
     t.integer  "project_id",                  null: false
-    t.datetime "created_at",                  null: false
-    t.datetime "updated_at",                  null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
     t.boolean  "active",      default: false, null: false
     t.string   "project_url"
     t.string   "subdomain"
@@ -249,14 +252,14 @@ ActiveRecord::Schema.define(version: 20140304005354) do
   create_table "snippets", force: true do |t|
     t.string   "title"
-    t.text     "content",    limit: 2147483647
-    t.integer  "author_id",                                    null: false
+    t.text     "content"
+    t.integer  "author_id",                 null: false
     t.integer  "project_id"
     t.datetime "created_at"
     t.datetime "updated_at"
     t.string   "file_name"
     t.datetime "expires_at"
-    t.boolean  "private",                       default: true, null: false
+    t.boolean  "private",    default: true, null: false
     t.string   "type"
   end
@@ -335,8 +338,8 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.integer  "group_access",                   null: false
     t.integer  "group_id",                       null: false
     t.integer  "user_id",                        null: false
-    t.datetime "created_at",                     null: false
-    t.datetime "updated_at",                     null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
     t.integer  "notification_level", default: 3, null: false
   end
@@ -365,6 +368,7 @@ ActiveRecord::Schema.define(version: 20140304005354) do
     t.boolean  "push_events",           default: true,          null: false
     t.boolean  "issues_events",         default: false,         null: false
     t.boolean  "merge_requests_events", default: false,         null: false
+    t.boolean  "tag_push_events",       default: false
   end
   add_index "web_hooks", ["project_id"], name: "index_web_hooks_on_project_id", using: :btree
@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ProjectHook do
+  describe '.push_hooks' do
+    it 'should return hooks for push events only' do
+      hook = create(:project_hook, push_events: true)
+      hook2 = create(:project_hook, push_events: false)
+      expect(ProjectHook.push_hooks).to eq([hook])
+    end
+  end
+
+  describe '.tag_push_hooks' do
+    it 'should return hooks for tag push events only' do
+      hook = create(:project_hook, tag_push_events: true)
+      hook2 = create(:project_hook, tag_push_events: false)
+      expect(ProjectHook.tag_push_hooks).to eq([hook])
+    end
+  end
+end
@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe GitTagPushService do
+  let (:user) { create :user }
+  let (:project) { create :project }
+  let (:service) { GitTagPushService.new }
+
+  before do
+    @ref = 'refs/tags/super-tag'
+    @oldrev = 'b98a310def241a6fd9c9a9a3e7934c48e498fe81'
+    @newrev = 'b19a04f53caeebf4fe5ec2327cb83e9253dc91bb'
+  end
+
+  describe 'Git Tag Push Data' do
+    before do
+      service.execute(project, user, @oldrev, @newrev, @ref)
+      @push_data = service.push_data
+    end
+
+    subject { @push_data }
+
+    it { should include(ref: @ref) }
+    it { should include(before: @oldrev) }
+    it { should include(after: @newrev) }
+    it { should include(user_id: user.id) }
+    it { should include(user_name: user.name) }
+    it { should include(project_id: project.id) }
+
+    context 'With repository data' do
+      subject { @push_data[:repository] }
+
+      it { should include(name: project.name) }
+      it { should include(url: project.url_to_repo) }
+      it { should include(description: project.description) }
+      it { should include(homepage: project.web_url) }
+    end
+  end
+
+  describe "Web Hooks" do
+    context "execute web hooks" do
+      it "when pushing tags" do
+        project.should_receive(:execute_hooks)
+        service.execute(project, user, 'oldrev', 'newrev', 'refs/tags/v1.0.0')
+      end
+    end
+  end
+end
@@ -0,0 +1,27 @@		@@ -0,0 +1,27 @@
	1	+class GitTagPushService
	2	+ attr_accessor :project, :user, :push_data
	3	+ def execute(project, user, oldrev, newrev, ref)
	4	+ @project, @user = project, user
	5	+ @push_data = create_push_data(oldrev, newrev, ref)
	6	+ project.execute_hooks(@push_data.dup, :tag_push_hooks)
	7	+ end
	8	+
	9	+ private
	10	+
	11	+ def create_push_data(oldrev, newrev, ref)
	12	+ data = {
	13	+ ref: ref,
	14	+ before: oldrev,
	15	+ after: newrev,
	16	+ user_id: user.id,
	17	+ user_name: user.name,
	18	+ project_id: project.id,
	19	+ repository: {
	20	+ name: project.name,
	21	+ url: project.url_to_repo,
	22	+ description: project.description,
	23	+ homepage: project.web_url
	24	+ }
	25	+ }
	26	+ end
	27	+end
	@@ -29,10 +29,20 @@ class PostReceive		@@ -29,10 +29,20 @@ class PostReceive
29	return false	29	return false
30	end	30	end
31		31
32	- GitPushService.new.execute(project, user, oldrev, newrev, ref)	32	+ if tag?(ref)
		33	+ GitTagPushService.new.execute(project, user, oldrev, newrev, ref)
		34	+ else
		35	+ GitPushService.new.execute(project, user, oldrev, newrev, ref)
		36	+ end
33	end	37	end
34		38
35	def log(message)	39	def log(message)
36	Gitlab::GitLogger.error("POST-RECEIVE: #{message}")	40	Gitlab::GitLogger.error("POST-RECEIVE: #{message}")
37	end	41	end
		42	+
		43	+ private
		44	+
		45	+ def tag?(ref)
		46	+ !!(/refs\/tags\/(.*)/.match(ref))
		47	+ end
38	end	48	end
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+class AddTagPushHooksToProjectHook < ActiveRecord::Migration
	2	+ def change
	3	+ add_column :web_hooks, :tag_push_events, :boolean, default: false
	4	+ end
	5	+end
@@ -0,0 +1,19 @@		@@ -0,0 +1,19 @@
	1	+require 'spec_helper'
	2	+
	3	+describe ProjectHook do
	4	+ describe '.push_hooks' do
	5	+ it 'should return hooks for push events only' do
	6	+ hook = create(:project_hook, push_events: true)
	7	+ hook2 = create(:project_hook, push_events: false)
	8	+ expect(ProjectHook.push_hooks).to eq([hook])
	9	+ end
	10	+ end
	11	+
	12	+ describe '.tag_push_hooks' do
	13	+ it 'should return hooks for tag push events only' do
	14	+ hook = create(:project_hook, tag_push_events: true)
	15	+ hook2 = create(:project_hook, tag_push_events: false)
	16	+ expect(ProjectHook.tag_push_hooks).to eq([hook])
	17	+ end
	18	+ end
	19	+end
@@ -0,0 +1,47 @@		@@ -0,0 +1,47 @@
	1	+require 'spec_helper'
	2	+
	3	+describe GitTagPushService do
	4	+ let (:user) { create :user }
	5	+ let (:project) { create :project }
	6	+ let (:service) { GitTagPushService.new }
	7	+
	8	+ before do
	9	+ @ref = 'refs/tags/super-tag'
	10	+ @oldrev = 'b98a310def241a6fd9c9a9a3e7934c48e498fe81'
	11	+ @newrev = 'b19a04f53caeebf4fe5ec2327cb83e9253dc91bb'
	12	+ end
	13	+
	14	+ describe 'Git Tag Push Data' do
	15	+ before do
	16	+ service.execute(project, user, @oldrev, @newrev, @ref)
	17	+ @push_data = service.push_data
	18	+ end
	19	+
	20	+ subject { @push_data }
	21	+
	22	+ it { should include(ref: @ref) }
	23	+ it { should include(before: @oldrev) }
	24	+ it { should include(after: @newrev) }
	25	+ it { should include(user_id: user.id) }
	26	+ it { should include(user_name: user.name) }
	27	+ it { should include(project_id: project.id) }
	28	+
	29	+ context 'With repository data' do
	30	+ subject { @push_data[:repository] }
	31	+
	32	+ it { should include(name: project.name) }
	33	+ it { should include(url: project.url_to_repo) }
	34	+ it { should include(description: project.description) }
	35	+ it { should include(homepage: project.web_url) }
	36	+ end
	37	+ end
	38	+
	39	+ describe "Web Hooks" do
	40	+ context "execute web hooks" do
	41	+ it "when pushing tags" do
	42	+ project.should_receive(:execute_hooks)
	43	+ service.execute(project, user, 'oldrev', 'newrev', 'refs/tags/v1.0.0')
	44	+ end
	45	+ end
	46	+ end
	47	+end