2017-04-27 10:08:57 +00:00
|
|
|
require 'spec_helper'
|
|
|
|
|
2017-07-10 14:24:02 +00:00
|
|
|
describe WebHookService do
|
2017-08-02 19:55:11 +00:00
|
|
|
let(:project) { create(:project) }
|
2017-04-27 10:08:57 +00:00
|
|
|
let(:project_hook) { create(:project_hook) }
|
|
|
|
let(:headers) do
|
|
|
|
{
|
|
|
|
'Content-Type' => 'application/json',
|
|
|
|
'X-Gitlab-Event' => 'Push Hook'
|
|
|
|
}
|
|
|
|
end
|
|
|
|
let(:data) do
|
|
|
|
{ before: 'oldrev', after: 'newrev', ref: 'ref' }
|
|
|
|
end
|
2017-09-07 11:29:12 +00:00
|
|
|
let(:service_instance) { described_class.new(project_hook, data, :push_hooks) }
|
2017-04-27 10:08:57 +00:00
|
|
|
|
2018-03-13 22:38:25 +00:00
|
|
|
describe '#initialize' do
|
|
|
|
it 'allow_local_requests is true if hook is a SystemHook' do
|
|
|
|
instance = described_class.new(build(:system_hook), data, :system_hook)
|
|
|
|
expect(instance.request_options[:allow_local_requests]).to be_truthy
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'allow_local_requests is false if hook is not a SystemHook' do
|
|
|
|
%i(project_hook service_hook web_hook_log).each do |hook|
|
|
|
|
instance = described_class.new(build(hook), data, hook)
|
|
|
|
expect(instance.request_options[:allow_local_requests]).to be_falsey
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-04-27 10:08:57 +00:00
|
|
|
describe '#execute' do
|
2017-08-10 22:31:42 +00:00
|
|
|
before do
|
2017-04-27 10:08:57 +00:00
|
|
|
project.hooks << [project_hook]
|
|
|
|
|
|
|
|
WebMock.stub_request(:post, project_hook.url)
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'when token is defined' do
|
|
|
|
let(:project_hook) { create(:project_hook, :token) }
|
|
|
|
|
|
|
|
it 'POSTs to the webhook URL' do
|
|
|
|
service_instance.execute
|
|
|
|
expect(WebMock).to have_requested(:post, project_hook.url).with(
|
|
|
|
headers: headers.merge({ 'X-Gitlab-Token' => project_hook.token })
|
|
|
|
).once
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'POSTs to the webhook URL' do
|
|
|
|
service_instance.execute
|
|
|
|
expect(WebMock).to have_requested(:post, project_hook.url).with(
|
|
|
|
headers: headers
|
|
|
|
).once
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'POSTs the data as JSON' do
|
|
|
|
service_instance.execute
|
|
|
|
expect(WebMock).to have_requested(:post, project_hook.url).with(
|
|
|
|
headers: headers
|
|
|
|
).once
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'catches exceptions' do
|
|
|
|
WebMock.stub_request(:post, project_hook.url).to_raise(StandardError.new('Some error'))
|
|
|
|
|
|
|
|
expect { service_instance.execute }.to raise_error(StandardError)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'handles exceptions' do
|
2017-07-27 12:52:42 +00:00
|
|
|
exceptions = [SocketError, OpenSSL::SSL::SSLError, Errno::ECONNRESET, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Net::OpenTimeout, Net::ReadTimeout]
|
2017-04-27 10:08:57 +00:00
|
|
|
exceptions.each do |exception_class|
|
|
|
|
exception = exception_class.new('Exception message')
|
|
|
|
|
|
|
|
WebMock.stub_request(:post, project_hook.url).to_raise(exception)
|
2017-07-20 15:12:06 +00:00
|
|
|
expect(service_instance.execute).to eq({ status: :error, message: exception.message })
|
2017-04-27 10:08:57 +00:00
|
|
|
expect { service_instance.execute }.not_to raise_error
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'handles 200 status code' do
|
|
|
|
WebMock.stub_request(:post, project_hook.url).to_return(status: 200, body: 'Success')
|
|
|
|
|
2017-07-20 15:12:06 +00:00
|
|
|
expect(service_instance.execute).to include({ status: :success, http_status: 200, message: 'Success' })
|
2017-04-27 10:08:57 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
it 'handles 2xx status codes' do
|
|
|
|
WebMock.stub_request(:post, project_hook.url).to_return(status: 201, body: 'Success')
|
|
|
|
|
2017-07-20 15:12:06 +00:00
|
|
|
expect(service_instance.execute).to include({ status: :success, http_status: 201, message: 'Success' })
|
2017-04-27 10:08:57 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
context 'execution logging' do
|
|
|
|
let(:hook_log) { project_hook.web_hook_logs.last }
|
|
|
|
|
|
|
|
context 'with success' do
|
|
|
|
before do
|
|
|
|
WebMock.stub_request(:post, project_hook.url).to_return(status: 200, body: 'Success')
|
|
|
|
service_instance.execute
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'log successful execution' do
|
|
|
|
expect(hook_log.trigger).to eq('push_hooks')
|
|
|
|
expect(hook_log.url).to eq(project_hook.url)
|
|
|
|
expect(hook_log.request_headers).to eq(headers)
|
|
|
|
expect(hook_log.response_body).to eq('Success')
|
|
|
|
expect(hook_log.response_status).to eq('200')
|
|
|
|
expect(hook_log.execution_duration).to be > 0
|
|
|
|
expect(hook_log.internal_error_message).to be_nil
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'with exception' do
|
|
|
|
before do
|
|
|
|
WebMock.stub_request(:post, project_hook.url).to_raise(SocketError.new('Some HTTP Post error'))
|
|
|
|
service_instance.execute
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'log failed execution' do
|
|
|
|
expect(hook_log.trigger).to eq('push_hooks')
|
|
|
|
expect(hook_log.url).to eq(project_hook.url)
|
|
|
|
expect(hook_log.request_headers).to eq(headers)
|
|
|
|
expect(hook_log.response_body).to eq('')
|
|
|
|
expect(hook_log.response_status).to eq('internal error')
|
|
|
|
expect(hook_log.execution_duration).to be > 0
|
|
|
|
expect(hook_log.internal_error_message).to eq('Some HTTP Post error')
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-08-01 14:30:29 +00:00
|
|
|
context 'with unsafe response body' do
|
|
|
|
before do
|
|
|
|
WebMock.stub_request(:post, project_hook.url).to_return(status: 200, body: "\xBB")
|
|
|
|
service_instance.execute
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'log successful execution' do
|
|
|
|
expect(hook_log.trigger).to eq('push_hooks')
|
|
|
|
expect(hook_log.url).to eq(project_hook.url)
|
|
|
|
expect(hook_log.request_headers).to eq(headers)
|
|
|
|
expect(hook_log.response_body).to eq('')
|
|
|
|
expect(hook_log.response_status).to eq('200')
|
|
|
|
expect(hook_log.execution_duration).to be > 0
|
|
|
|
expect(hook_log.internal_error_message).to be_nil
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-04-27 10:08:57 +00:00
|
|
|
context 'should not log ServiceHooks' do
|
|
|
|
let(:service_hook) { create(:service_hook) }
|
2017-07-25 17:09:00 +00:00
|
|
|
let(:service_instance) { described_class.new(service_hook, data, 'service_hook') }
|
2017-04-27 10:08:57 +00:00
|
|
|
|
|
|
|
before do
|
|
|
|
WebMock.stub_request(:post, service_hook.url).to_return(status: 200, body: 'Success')
|
|
|
|
end
|
|
|
|
|
|
|
|
it { expect { service_instance.execute }.not_to change(WebHookLog, :count) }
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe '#async_execute' do
|
|
|
|
let(:system_hook) { create(:system_hook) }
|
2017-08-15 17:44:37 +00:00
|
|
|
|
2017-04-27 10:08:57 +00:00
|
|
|
it 'enqueue WebHookWorker' do
|
2017-11-29 15:30:17 +00:00
|
|
|
expect(WebHookWorker).to receive(:perform_async).with(project_hook.id, data, 'push_hooks')
|
2017-04-27 10:08:57 +00:00
|
|
|
|
2017-07-25 17:09:00 +00:00
|
|
|
described_class.new(project_hook, data, 'push_hooks').async_execute
|
2017-04-27 10:08:57 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|