debian-mirror-gitlab/spec/requests/api/metrics/dashboard/annotations_spec.rb

137 lines
4.8 KiB
Ruby
Raw Normal View History

2020-04-22 19:07:51 +05:30
# frozen_string_literal: true
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe API::Metrics::Dashboard::Annotations do
2020-04-22 19:07:51 +05:30
let_it_be(:user) { create(:user) }
let_it_be(:project) { create(:project, :private, :repository, namespace: user.namespace) }
let_it_be(:environment) { create(:environment, project: project) }
2021-09-30 23:02:18 +05:30
2020-04-22 19:07:51 +05:30
let(:dashboard) { 'config/prometheus/common_metrics.yml' }
let(:starting_at) { Time.now.iso8601 }
let(:ending_at) { 1.hour.from_now.iso8601 }
let(:params) { attributes_for(:metrics_dashboard_annotation, environment: environment, starting_at: starting_at, ending_at: ending_at, dashboard_path: dashboard)}
2020-05-24 23:13:21 +05:30
shared_examples 'POST /:source_type/:id/metrics_dashboard/annotations' do |source_type|
let(:url) { "/#{source_type.pluralize}/#{source.id}/metrics_dashboard/annotations" }
before do
2020-04-22 19:07:51 +05:30
project.add_developer(user)
end
2020-05-24 23:13:21 +05:30
context "with :source_type == #{source_type.pluralize}" do
context 'with correct permissions' do
context 'with valid parameters' do
it 'creates a new annotation', :aggregate_failures do
post api(url, user), params: params
expect(response).to have_gitlab_http_status(:created)
expect(json_response["#{source_type}_id"]).to eq(source.id)
expect(json_response['starting_at'].to_time).to eq(starting_at.to_time)
expect(json_response['ending_at'].to_time).to eq(ending_at.to_time)
expect(json_response['description']).to eq(params[:description])
expect(json_response['dashboard_path']).to eq(dashboard)
2020-04-22 19:07:51 +05:30
end
2020-05-24 23:13:21 +05:30
end
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
context 'with invalid parameters' do
it 'returns error messsage' do
post api(url, user), params: { dashboard_path: '', starting_at: nil, description: nil }
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
expect(response).to have_gitlab_http_status(:bad_request)
expect(json_response['message']).to include({ "starting_at" => ["can't be blank"], "description" => ["can't be blank"], "dashboard_path" => ["can't be blank"] })
2020-04-22 19:07:51 +05:30
end
2020-05-24 23:13:21 +05:30
end
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
context 'with undeclared params' do
before do
params[:undeclared_param] = 'xyz'
end
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
it 'filters out undeclared params' do
expect(::Metrics::Dashboard::Annotations::CreateService).to receive(:new).with(user, hash_excluding(:undeclared_param))
post api(url, user), params: params
2020-04-22 19:07:51 +05:30
end
end
2020-05-24 23:13:21 +05:30
context 'with special characers in dashboard_path in request body' do
let(:dashboard_escaped) { 'config/prometheus/common_metrics%26copy.yml' }
let(:dashboard_unescaped) { 'config/prometheus/common_metrics&copy.yml' }
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
shared_examples 'special characters unescaped' do
let(:expected_params) do
{
'starting_at' => starting_at.to_time,
'ending_at' => ending_at.to_time,
"#{source_type}" => source,
'dashboard_path' => dashboard_unescaped,
'description' => params[:description]
}
end
it 'unescapes the dashboard_path', :aggregate_failures do
expect(::Metrics::Dashboard::Annotations::CreateService).to receive(:new).with(user, expected_params)
post api(url, user), params: params
end
2020-04-22 19:07:51 +05:30
end
2020-05-24 23:13:21 +05:30
context 'with escaped characters' do
it_behaves_like 'special characters unescaped' do
let(:dashboard) { dashboard_escaped }
end
end
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
context 'with unescaped characers' do
it_behaves_like 'special characters unescaped' do
let(:dashboard) { dashboard_unescaped }
end
2020-04-22 19:07:51 +05:30
end
end
end
2020-05-24 23:13:21 +05:30
context 'without correct permissions' do
let_it_be(:guest) { create(:user) }
2020-04-22 19:07:51 +05:30
before do
2020-05-24 23:13:21 +05:30
project.add_guest(guest)
2020-04-22 19:07:51 +05:30
end
2020-05-24 23:13:21 +05:30
it 'returns error message' do
post api(url, guest), params: params
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2020-04-22 19:07:51 +05:30
end
end
end
end
2020-05-24 23:13:21 +05:30
describe 'environment' do
it_behaves_like 'POST /:source_type/:id/metrics_dashboard/annotations', 'environment' do
let(:source) { environment }
end
end
describe 'group cluster' do
it_behaves_like 'POST /:source_type/:id/metrics_dashboard/annotations', 'cluster' do
let_it_be(:group) { create(:group) }
let_it_be(:cluster) { create(:cluster_for_group, groups: [group]) }
before do
group.add_developer(user)
end
let(:source) { cluster }
end
end
describe 'project cluster' do
it_behaves_like 'POST /:source_type/:id/metrics_dashboard/annotations', 'cluster' do
let_it_be(:cluster) { create(:cluster, projects: [project]) }
let(:source) { cluster }
end
end
2020-04-22 19:07:51 +05:30
end