Commit e0627762 authored by Sean Carroll's avatar Sean Carroll Committed by charlie ablett
parent b861b4bc
# frozen_string_literal: true
class FreezePeriodsFinder
def initialize(project, current_user = nil)
@project = project
@current_user = current_user
end
def execute
return Ci::FreezePeriod.none unless Ability.allowed?(@current_user, :read_freeze_period, @project)
@project.freeze_periods
end
end
...@@ -5,6 +5,8 @@ module Ci ...@@ -5,6 +5,8 @@ module Ci
include StripAttribute include StripAttribute
self.table_name = 'ci_freeze_periods' self.table_name = 'ci_freeze_periods'
default_scope { order(created_at: :asc) }
belongs_to :project, inverse_of: :freeze_periods belongs_to :project, inverse_of: :freeze_periods
strip_attributes :freeze_start, :freeze_end strip_attributes :freeze_start, :freeze_end
......
# frozen_string_literal: true
module Ci
class FreezePeriodPolicy < BasePolicy
delegate { @subject.resource_parent }
end
end
...@@ -362,6 +362,10 @@ class ProjectPolicy < BasePolicy ...@@ -362,6 +362,10 @@ class ProjectPolicy < BasePolicy
enable :destroy_deploy_token enable :destroy_deploy_token
enable :read_prometheus_alerts enable :read_prometheus_alerts
enable :admin_terraform_state enable :admin_terraform_state
enable :create_freeze_period
enable :read_freeze_period
enable :update_freeze_period
enable :destroy_freeze_period
end end
rule { public_project & metrics_dashboard_allowed }.policy do rule { public_project & metrics_dashboard_allowed }.policy do
......
---
title: Expose Freeze Periods in REST API
merge_request: 29382
author:
type: added
...@@ -141,6 +141,7 @@ module API ...@@ -141,6 +141,7 @@ module API
mount ::API::Events mount ::API::Events
mount ::API::Features mount ::API::Features
mount ::API::Files mount ::API::Files
mount ::API::FreezePeriods
mount ::API::GroupBoards mount ::API::GroupBoards
mount ::API::GroupClusters mount ::API::GroupClusters
mount ::API::GroupExport mount ::API::GroupExport
......
# frozen_string_literal: true
module API
module Entities
class FreezePeriod < Grape::Entity
expose :id
expose :freeze_start, :freeze_end, :cron_timezone
expose :created_at, :updated_at
end
end
end
# frozen_string_literal: true
module API
class FreezePeriods < Grape::API
include PaginationParams
before { authenticate! }
params do
requires :id, type: String, desc: 'The ID of a project'
end
resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
desc 'Get project freeze periods' do
detail 'This feature was introduced in GitLab 13.0.'
success Entities::FreezePeriod
end
params do
use :pagination
end
get ":id/freeze_periods" do
authorize! :read_freeze_period, user_project
freeze_periods = ::FreezePeriodsFinder.new(user_project, current_user).execute
present paginate(freeze_periods), with: Entities::FreezePeriod, current_user: current_user
end
desc 'Get a single freeze period' do
detail 'This feature was introduced in GitLab 13.0.'
success Entities::FreezePeriod
end
params do
requires :freeze_period_id, type: Integer, desc: 'The ID of a project freeze period'
end
get ":id/freeze_periods/:freeze_period_id" do
authorize! :read_freeze_period, user_project
present freeze_period, with: Entities::FreezePeriod, current_user: current_user
end
desc 'Create a new freeze period' do
detail 'This feature was introduced in GitLab 13.0.'
success Entities::FreezePeriod
end
params do
requires :freeze_start, type: String, desc: 'Freeze Period start'
requires :freeze_end, type: String, desc: 'Freeze Period end'
optional :cron_timezone, type: String, desc: 'Timezone'
end
post ':id/freeze_periods' do
authorize! :create_freeze_period, user_project
freeze_period_params = declared(params, include_parent_namespaces: false)
freeze_period = user_project.freeze_periods.create(freeze_period_params)
if freeze_period.persisted?
present freeze_period, with: Entities::FreezePeriod
else
render_validation_error!(freeze_period)
end
end
desc 'Update a freeze period' do
detail 'This feature was introduced in GitLab 13.0.'
success Entities::FreezePeriod
end
params do
optional :freeze_start, type: String, desc: 'Freeze Period start'
optional :freeze_end, type: String, desc: 'Freeze Period end'
optional :cron_timezone, type: String, desc: 'Freeze Period Timezone'
end
put ':id/freeze_periods/:freeze_period_id' do
authorize! :update_freeze_period, user_project
freeze_period_params = declared(params, include_parent_namespaces: false, include_missing: false)
if freeze_period.update(freeze_period_params)
present freeze_period, with: Entities::FreezePeriod
else
render_validation_error!(freeze_period)
end
end
desc 'Delete a freeze period' do
detail 'This feature was introduced in GitLab 13.0.'
success Entities::FreezePeriod
end
params do
requires :freeze_period_id, type: Integer, desc: 'Freeze Period ID'
end
delete ':id/freeze_periods/:freeze_period_id' do
authorize! :destroy_freeze_period, user_project
destroy_conditionally!(freeze_period)
end
end
helpers do
def freeze_period
@freeze_period ||= user_project.freeze_periods.find(params[:freeze_period_id])
end
end
end
end
# frozen_string_literal: true
require 'spec_helper'
describe FreezePeriodsFinder do
subject(:finder) { described_class.new(project, user).execute }
let(:project) { create(:project, :private) }
let(:user) { create(:user) }
let!(:freeze_period_1) { create(:ci_freeze_period, project: project, created_at: 2.days.ago) }
let!(:freeze_period_2) { create(:ci_freeze_period, project: project, created_at: 1.day.ago) }
shared_examples_for 'returns nothing' do
specify do
is_expected.to be_empty
end
end
shared_examples_for 'returns freeze_periods ordered by created_at asc' do
it 'returns freeze_periods ordered by created_at' do
expect(subject.count).to eq(2)
expect(subject.pluck('id')).to eq([freeze_period_1.id, freeze_period_2.id])
end
end
context 'when user is a maintainer' do
before do
project.add_maintainer(user)
end
it_behaves_like 'returns freeze_periods ordered by created_at asc'
end
context 'when user is a guest' do
before do
project.add_guest(user)
end
it_behaves_like 'returns nothing'
end
context 'when user is a developer' do
before do
project.add_developer(user)
end
it_behaves_like 'returns nothing'
end
context 'when user is not a project member' do
it_behaves_like 'returns nothing'
context 'when project is public' do
let(:project) { create(:project, :public) }
it_behaves_like 'returns nothing'
end
end
end
{
"type": "object",
"required": [
"id",
"freeze_start",
"freeze_end",
"cron_timezone",
"created_at",
"updated_at"
],
"properties": {
"id": { "type": "integer" },
"freeze_start": { "type": "string" },
"freeze_end": { "type": "string"},
"cron_timezone": { "type": "string" },
"created_at": { "type": "string" },
"updated_at": { "type": "string" }
},
"additionalProperties": false
}
{
"type": "array",
"items": { "$ref": "freeze_period.json" }
}
...@@ -5,6 +5,8 @@ require 'spec_helper' ...@@ -5,6 +5,8 @@ require 'spec_helper'
RSpec.describe Ci::FreezePeriod, type: :model do RSpec.describe Ci::FreezePeriod, type: :model do
subject { build(:ci_freeze_period) } subject { build(:ci_freeze_period) }
let(:invalid_cron) { '0 0 0 * *' }
it { is_expected.to belong_to(:project) } it { is_expected.to belong_to(:project) }
it { is_expected.to respond_to(:freeze_start) } it { is_expected.to respond_to(:freeze_start) }
...@@ -13,13 +15,19 @@ RSpec.describe Ci::FreezePeriod, type: :model do ...@@ -13,13 +15,19 @@ RSpec.describe Ci::FreezePeriod, type: :model do
describe 'cron validations' do describe 'cron validations' do
it 'allows valid cron patterns' do it 'allows valid cron patterns' do
freeze_period = build(:ci_freeze_period, freeze_start: '0 23 * * 5') freeze_period = build(:ci_freeze_period)
expect(freeze_period).to be_valid expect(freeze_period).to be_valid
end end
it 'does not allow invalid cron patterns' do it 'does not allow invalid cron patterns on freeze_start' do
freeze_period = build(:ci_freeze_period, freeze_start: '0 0 0 * *') freeze_period = build(:ci_freeze_period, freeze_start: invalid_cron)
expect(freeze_period).not_to be_valid
end
it 'does not allow invalid cron patterns on freeze_end' do
freeze_period = build(:ci_freeze_period, freeze_end: invalid_cron)
expect(freeze_period).not_to be_valid expect(freeze_period).not_to be_valid
end end
......
This diff is collapsed.
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