debian-mirror-gitlab/spec/requests/api/services_spec.rb

268 lines
8.7 KiB
Ruby
Raw Normal View History

2019-12-26 22:10:19 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
require "spec_helper"
2020-07-28 23:09:34 +05:30
RSpec.describe API::Services do
2020-03-13 15:44:24 +05:30
let_it_be(:user) { create(:user) }
let_it_be(:user2) { create(:user) }
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
let_it_be(:project, reload: true) do
2018-03-17 18:26:18 +05:30
create(:project, creator_id: user.id, namespace: user.namespace)
end
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
describe "GET /projects/:id/services" do
it 'returns authentication error when unauthenticated' do
get api("/projects/#{project.id}/services")
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2020-03-13 15:44:24 +05:30
end
it "returns error when authenticated but user is not a project owner" do
project.add_developer(user2)
get api("/projects/#{project.id}/services", user2)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2020-03-13 15:44:24 +05:30
end
context 'project with services' do
let!(:active_service) { create(:emails_on_push_service, project: project, active: true) }
let!(:service) { create(:custom_issue_tracker_service, project: project, active: false) }
it "returns a list of all active services" do
get api("/projects/#{project.id}/services", user)
aggregate_failures 'expect successful response with all active services' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2020-03-13 15:44:24 +05:30
expect(json_response).to be_an Array
expect(json_response.count).to eq(1)
expect(json_response.first['slug']).to eq('emails-on-push')
expect(response).to match_response_schema('public_api/v4/services')
end
end
end
end
2015-09-25 12:07:36 +05:30
Service.available_services_names.each do |service|
2019-10-12 21:52:04 +05:30
describe "PUT /projects/:id/services/#{service.dasherize}" do
2015-09-25 12:07:36 +05:30
include_context service
2014-09-02 18:07:02 +05:30
2016-09-13 17:45:13 +05:30
it "updates #{service} settings" do
2019-02-15 15:39:39 +05:30
put api("/projects/#{project.id}/services/#{dashed_service}", user), params: service_attrs
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
current_service = project.services.first
2019-09-04 21:01:54 +05:30
events = current_service.event_names.empty? ? ["foo"].freeze : current_service.event_names
query_strings = []
events.each do |event|
query_strings << "#{event}=#{!current_service[event]}"
end
query_strings = query_strings.join('&')
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
put api("/projects/#{project.id}/services/#{dashed_service}?#{query_strings}", user), params: service_attrs
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2020-03-13 15:44:24 +05:30
expect(json_response['slug']).to eq(dashed_service)
2019-09-04 21:01:54 +05:30
events.each do |event|
next if event == "foo"
expect(project.services.first[event]).not_to eq(current_service[event]),
"expected #{!current_service[event]} for event #{event} for service #{current_service.title}, got #{current_service[event]}"
end
2015-09-25 12:07:36 +05:30
end
2015-09-11 14:41:01 +05:30
2016-09-13 17:45:13 +05:30
it "returns if required fields missing" do
2015-09-25 12:07:36 +05:30
attrs = service_attrs
2015-09-11 14:41:01 +05:30
2015-09-25 12:07:36 +05:30
required_attributes = service_attrs_list.select do |attr|
service_klass.validators_on(attr).any? do |v|
v.class == ActiveRecord::Validations::PresenceValidator
end
end
2015-09-11 14:41:01 +05:30
2015-09-25 12:07:36 +05:30
if required_attributes.empty?
2020-04-22 19:07:51 +05:30
expected_code = :ok
2015-09-25 12:07:36 +05:30
else
2015-12-23 02:04:40 +05:30
attrs.delete(required_attributes.sample)
2020-04-22 19:07:51 +05:30
expected_code = :bad_request
2015-09-25 12:07:36 +05:30
end
2016-09-13 17:45:13 +05:30
2019-02-15 15:39:39 +05:30
put api("/projects/#{project.id}/services/#{dashed_service}", user), params: attrs
2015-09-11 14:41:01 +05:30
2020-04-22 19:07:51 +05:30
expect(response).to have_gitlab_http_status(expected_code)
2015-09-25 12:07:36 +05:30
end
2015-09-11 14:41:01 +05:30
end
2014-09-02 18:07:02 +05:30
2019-10-12 21:52:04 +05:30
describe "DELETE /projects/:id/services/#{service.dasherize}" do
2015-09-25 12:07:36 +05:30
include_context service
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
before do
initialize_service(service)
end
2016-09-13 17:45:13 +05:30
it "deletes #{service}" do
2015-09-25 12:07:36 +05:30
delete api("/projects/#{project.id}/services/#{dashed_service}", user)
2015-04-26 12:48:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:no_content)
2015-11-26 14:37:03 +05:30
project.send(service_method).reload
2015-09-25 12:07:36 +05:30
expect(project.send(service_method).activated?).to be_falsey
end
2015-04-26 12:48:37 +05:30
end
2015-09-25 12:07:36 +05:30
describe "GET /projects/:id/services/#{service.dasherize}" do
include_context service
2015-04-26 12:48:37 +05:30
2015-10-24 18:46:33 +05:30
# inject some properties into the service
2019-09-30 21:07:59 +05:30
let!(:initialized_service) { initialize_service(service) }
2015-10-24 18:46:33 +05:30
2016-09-13 17:45:13 +05:30
it 'returns authentication error when unauthenticated' do
2015-10-24 18:46:33 +05:30
get api("/projects/#{project.id}/services/#{dashed_service}")
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:unauthorized)
2015-10-24 18:46:33 +05:30
end
2016-09-13 17:45:13 +05:30
2020-01-01 13:55:28 +05:30
it "returns all properties of service #{service}" do
2015-09-25 12:07:36 +05:30
get api("/projects/#{project.id}/services/#{dashed_service}", user)
2015-04-26 12:48:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-17 18:26:18 +05:30
expect(json_response['properties'].keys).to match_array(service_instance.api_field_names)
2015-09-25 12:07:36 +05:30
end
2015-10-24 18:46:33 +05:30
2016-09-13 17:45:13 +05:30
it "returns error when authenticated but not a project owner" do
2018-03-17 18:26:18 +05:30
project.add_developer(user2)
2015-10-24 18:46:33 +05:30
get api("/projects/#{project.id}/services/#{dashed_service}", user2)
2016-09-13 17:45:13 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2015-10-24 18:46:33 +05:30
end
2014-09-02 18:07:02 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe 'POST /projects/:id/services/:slug/trigger' do
describe 'Mattermost Service' do
let(:service_name) { 'mattermost_slash_commands' }
context 'no service is available' do
it 'returns a not found message' do
post api("/projects/#{project.id}/services/idonotexist/trigger")
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2017-08-17 22:00:37 +05:30
expect(json_response["error"]).to eq("404 Not Found")
end
end
context 'the service exists' do
let(:params) { { token: 'token' } }
context 'the service is not active' do
before do
project.create_mattermost_slash_commands_service(
active: false,
properties: params
)
end
it 'when the service is inactive' do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/services/#{service_name}/trigger"), params: params
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2017-08-17 22:00:37 +05:30
end
end
context 'the service is active' do
before do
project.create_mattermost_slash_commands_service(
active: true,
properties: params
)
end
it 'returns status 200' do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/services/#{service_name}/trigger"), params: params
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
end
end
context 'when the project can not be found' do
it 'returns a generic 404' do
2019-02-15 15:39:39 +05:30
post api("/projects/404/services/#{service_name}/trigger"), params: params
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2017-08-17 22:00:37 +05:30
expect(json_response["message"]).to eq("404 Service Not Found")
end
end
end
end
describe 'Slack Service' do
let(:service_name) { 'slack_slash_commands' }
before do
project.create_slack_slash_commands_service(
active: true,
properties: { token: 'token' }
)
end
it 'returns status 200' do
2019-02-15 15:39:39 +05:30
post api("/projects/#{project.id}/services/#{service_name}/trigger"), params: { token: 'token', text: 'help' }
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
expect(json_response['response_type']).to eq("ephemeral")
end
end
end
2018-03-17 18:26:18 +05:30
describe 'Mattermost service' do
let(:service_name) { 'mattermost' }
let(:params) do
{ webhook: 'https://hook.example.com', username: 'username' }
end
before do
project.create_mattermost_service(
active: true,
properties: params
)
end
it 'accepts a username for update' do
2020-03-13 15:44:24 +05:30
put api("/projects/#{project.id}/services/#{service_name}", user), params: params.merge(username: 'new_username')
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-17 18:26:18 +05:30
expect(json_response['properties']['username']).to eq('new_username')
end
end
2020-03-13 15:44:24 +05:30
describe 'Microsoft Teams service' do
let(:service_name) { 'microsoft-teams' }
let(:params) do
{
webhook: 'https://hook.example.com',
branches_to_be_notified: 'default',
notify_only_broken_pipelines: false
}
end
before do
project.create_microsoft_teams_service(
active: true,
properties: params
)
end
it 'accepts branches_to_be_notified for update' do
put api("/projects/#{project.id}/services/#{service_name}", user), params: params.merge(branches_to_be_notified: 'all')
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2020-03-13 15:44:24 +05:30
expect(json_response['properties']['branches_to_be_notified']).to eq('all')
end
it 'accepts notify_only_broken_pipelines for update' do
put api("/projects/#{project.id}/services/#{service_name}", user), params: params.merge(notify_only_broken_pipelines: true)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2020-03-13 15:44:24 +05:30
expect(json_response['properties']['notify_only_broken_pipelines']).to eq(true)
end
end
2014-09-02 18:07:02 +05:30
end