1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Projects::HooksController, feature_category: :webhooks do
include AfterNextHelpers
let_it_be(:project) { create(:project) }
let(:user) { project.first_owner }
before do
sign_in(user)
end
describe '#index' do
it 'renders index with 200 status code' do
get :index, params: { namespace_id: project.namespace, project_id: project }
expect(response).to have_gitlab_http_status(:ok)
expect(response).to render_template(:index)
end
end
describe '#update' do
let_it_be(:hook) { create(:project_hook, project: project) }
let(:params) do
{ namespace_id: project.namespace, project_id: project, id: hook.id }
end
context 'with an existing token' do
hook_params = {
token: WebHook::SECRET_MASK,
url: "http://example.com"
}
it 'does not change a token' do
expect do
post :update, params: params.merge({ hook: hook_params })
end.not_to change { hook.reload.token }
expect(response).to have_gitlab_http_status(:found)
expect(flash[:alert]).to be_blank
end
end
it 'adds, updates and deletes URL variables' do
hook.update!(url_variables: { 'a' => 'bar', 'b' => 'woo' })
params[:hook] = {
url_variables: [
{ key: 'a', value: 'updated' },
{ key: 'b', value: nil },
{ key: 'c', value: 'new' }
]
}
put :update, params: params
expect(response).to have_gitlab_http_status(:found)
expect(flash[:notice]).to include('was updated')
expect(hook.reload.url_variables).to eq(
'a' => 'updated',
'c' => 'new'
)
end
it 'adds, updates and deletes custom headers' do
hook.update!(custom_headers: { 'a' => 'bar', 'b' => 'woo' })
params[:hook] = {
custom_headers: [
{ key: 'a', value: 'updated' },
{ key: 'c', value: 'new' }
]
}
put :update, params: params
expect(response).to have_gitlab_http_status(:found)
expect(flash[:notice]).to include('was updated')
expect(hook.reload.custom_headers).to eq(
'a' => 'updated',
'c' => 'new'
)
end
it 'does not update custom headers with the secret mask' do
hook.update!(custom_headers: { 'a' => 'bar' })
params[:hook] = {
custom_headers: [
{ key: 'a', value: WebHook::SECRET_MASK },
{ key: 'c', value: 'new' }
]
}
put :update, params: params
expect(response).to have_gitlab_http_status(:found)
expect(flash[:notice]).to include('was updated')
expect(hook.reload.custom_headers).to eq(
'a' => 'bar',
'c' => 'new'
)
end
end
describe '#edit' do
let_it_be(:hook) { create(:project_hook, project: project) }
let(:params) do
{ namespace_id: project.namespace, project_id: project, id: hook.id }
end
render_views
it 'does not error if the hook cannot be found' do
get :edit, params: params.merge(id: non_existing_record_id)
expect(response).to have_gitlab_http_status(:not_found)
end
it 'assigns hook_logs' do
get :edit, params: params
expect(assigns[:hook]).to be_present
expect(assigns[:hook_logs]).to be_empty
it_renders_correctly
end
it 'handles when logs are present' do
create_list(:web_hook_log, 3, web_hook: hook)
get :edit, params: params
expect(assigns[:hook]).to be_present
expect(assigns[:hook_logs].count).to eq 3
it_renders_correctly
end
it 'can paginate logs' do
create_list(:web_hook_log, 21, web_hook: hook)
get :edit, params: params.merge(page: 2)
expect(assigns[:hook]).to be_present
expect(assigns[:hook_logs].count).to eq 1
it_renders_correctly
end
def it_renders_correctly
expect(response).to have_gitlab_http_status(:ok)
expect(response).to render_template(:edit)
expect(response).to render_template('shared/hook_logs/_index')
end
end
describe '#create' do
it 'sets all parameters' do
hook_params = {
enable_ssl_verification: true,
token: 'TEST TOKEN',
url: 'http://example.com',
branch_filter_strategy: 'regex',
push_events: true,
tag_push_events: true,
merge_requests_events: true,
issues_events: true,
confidential_note_events: true,
confidential_issues_events: true,
note_events: true,
job_events: true,
pipeline_events: true,
wiki_page_events: true,
deployment_events: true,
custom_webhook_template: '{"test":"test"}',
url_variables: [{ key: 'token', value: 'some secret value' }]
}
params = { namespace_id: project.namespace, project_id: project, hook: hook_params }
expect { post :create, params: params }.to change(ProjectHook, :count).by(1)
project_hook = ProjectHook.order_id_desc.take
expect(project_hook).to have_attributes(
**hook_params.merge(url_variables: { 'token' => 'some secret value' })
)
expect(response).to have_gitlab_http_status(:found)
expect(flash[:alert]).to be_blank
end
it 'alerts the user if the new hook is invalid' do
hook_params = {
token: "TEST\nTOKEN",
url: "http://example.com"
}
post :create, params: { namespace_id: project.namespace, project_id: project, hook: hook_params }
expect(flash[:alert]).to be_present
expect(ProjectHook.count).to eq(0)
end
end
describe 'DELETE #destroy' do
let!(:hook) { create(:project_hook, project: project) }
let!(:log) { create(:web_hook_log, web_hook: hook) }
let(:params) { { namespace_id: project.namespace, project_id: project, id: hook } }
it_behaves_like 'Web hook destroyer'
context 'when user does not have permission' do
let(:user) { create(:user, developer_of: project) }
it 'renders a 404' do
delete :destroy, params: params
expect(response).to have_gitlab_http_status(:not_found)
end
end
end
describe '#test' do
let(:hook) { create(:project_hook, project: project) }
context 'when the hook executes successfully' do
before do
stub_request(:post, hook.url).to_return(status: 200)
end
it 'informs the user' do
post :test, params: { namespace_id: project.namespace, project_id: project, id: hook }
expect(flash[:notice]).to include('executed successfully')
expect(flash[:notice]).to include('HTTP 200')
end
end
context 'when the hook runs, but fails' do
before do
stub_request(:post, hook.url).to_return(status: 400)
end
it 'informs the user' do
post :test, params: { namespace_id: project.namespace, project_id: project, id: hook }
expect(flash[:alert]).to include('executed successfully but')
expect(flash[:alert]).to include('HTTP 400')
end
end
context 'when the hook fails completely' do
before do
allow_next(::TestHooks::ProjectService)
.to receive(:execute).and_return(ServiceResponse.error(message: 'All is woe'))
end
it 'informs the user' do
post :test, params: { namespace_id: project.namespace, project_id: project, id: hook }
expect(flash[:alert]).to include('failed: All is woe')
end
end
context 'when the endpoint receives requests above the limit', :freeze_time, :clean_gitlab_redis_rate_limiting do
before do
allow(Gitlab::ApplicationRateLimiter).to receive(:rate_limits)
.and_return(web_hook_test: { threshold: 1, interval: 1.minute })
end
it 'prevents making test requests' do
expect_next_instance_of(TestHooks::ProjectService) do |service|
expect(service).to receive(:execute).and_return(ServiceResponse.success(payload: { http_status: 200 }))
end
2.times { post :test, params: { namespace_id: project.namespace, project_id: project, id: hook } }
expect(response.body).to eq(_('This endpoint has been requested too many times. Try again later.'))
expect(response).to have_gitlab_http_status(:too_many_requests)
end
end
end
end
|