Commit 01dd19a3 authored by Mikolaj Wawrzyniak's avatar Mikolaj Wawrzyniak

Add starred dashboard create service

parent a1fde82d
# frozen_string_literal: true
# Create Metrics::UsersStarredDashboard entry for given user based on matched dashboard_path, project
module Metrics
module UsersStarredDashboards
class CreateService < ::BaseService
include Stepable
steps :authorize_create_action,
:parse_dashboard_path,
:create
def initialize(user, project, dashboard_path)
@user, @project, @dashboard_path = user, project, dashboard_path
end
def execute
keys = %i[status message starred_dashboard]
status, message, dashboards = execute_steps.values_at(*keys)
if status != :success
ServiceResponse.error(message: message)
else
ServiceResponse.success(payload: dashboards)
end
end
private
attr_reader :user, :project, :dashboard_path
def authorize_create_action(_options)
if Ability.allowed?(user, :create_metrics_user_starred_dashboard, project)
success(user: user, project: project)
else
error(s_('Metrics::UsersStarredDashboards|You are not authorized to add star to this dashboard'))
end
end
def parse_dashboard_path(options)
if dashboard_path_exists?
options[:dashboard_path] = dashboard_path
success(options)
else
error(s_('Metrics::UsersStarredDashboards|Dashboard with requested path can not be found'))
end
end
def create(options)
starred_dashboard = build_starred_dashboard_from(options)
if starred_dashboard.save
success(starred_dashboard: starred_dashboard)
else
error(starred_dashboard.errors.messages)
end
end
def build_starred_dashboard_from(options)
Metrics::UsersStarredDashboard.new(
user: options.fetch(:user),
project: options.fetch(:project),
dashboard_path: options.fetch(:dashboard_path)
)
end
def dashboard_path_exists?
Gitlab::Metrics::Dashboard::Finder
.find_all_paths(project)
.any? { |dashboard| dashboard[:path] == dashboard_path }
end
end
end
end
......@@ -13256,6 +13256,12 @@ msgstr ""
msgid "Metrics::Dashboard::Annotation|You are not authorized to delete this annotation"
msgstr ""
msgid "Metrics::UsersStarredDashboards|Dashboard with requested path can not be found"
msgstr ""
msgid "Metrics::UsersStarredDashboards|You are not authorized to add star to this dashboard"
msgstr ""
msgid "Metrics|Add metric"
msgstr ""
......
# frozen_string_literal: true
require 'spec_helper'
describe Metrics::UsersStarredDashboards::CreateService do
let_it_be(:user) { create(:user) }
let(:dashboard_path) { 'config/prometheus/common_metrics.yml' }
let(:service_instance) { described_class.new(user, project, dashboard_path) }
let(:project) { create(:project) }
let(:starred_dashboard_params) do
{
user: user,
project: project,
dashboard_path: dashboard_path
}
end
shared_examples 'prevented starred dashboard creation' do |message|
it 'returns error response', :aggregate_failures do
expect(Metrics::UsersStarredDashboard).not_to receive(:new)
response = service_instance.execute
expect(response.status).to be :error
expect(response.message).to eql message
end
end
describe '.execute' do
context 'with anonymous user' do
it_behaves_like 'prevented starred dashboard creation', 'You are not authorized to add star to this dashboard'
end
context 'with reporter user' do
before do
project.add_reporter(user)
end
context 'incorrect dashboard_path' do
let(:dashboard_path) { 'something_incorrect.yml' }
it_behaves_like 'prevented starred dashboard creation', 'Dashboard with requested path can not be found'
end
context 'with valid dashboard path' do
it 'creates starred dashboard and returns success response', :aggregate_failures do
expect_next_instance_of(Metrics::UsersStarredDashboard, starred_dashboard_params) do |starred_dashboard|
expect(starred_dashboard).to receive(:save).and_return true
end
response = service_instance.execute
expect(response.status).to be :success
end
context 'Metrics::UsersStarredDashboard has validation errors' do
it 'returns error response', :aggregate_failures do
expect_next_instance_of(Metrics::UsersStarredDashboard, starred_dashboard_params) do |starred_dashboard|
expect(starred_dashboard).to receive(:save).and_return(false)
expect(starred_dashboard).to receive(:errors).and_return(double(messages: { base: ['Model validation error'] }))
end
response = service_instance.execute
expect(response.status).to be :error
expect(response.message).to eql(base: ['Model validation error'])
end
end
end
end
end
end
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment