Commit 83360bc2 authored by Doug Stull's avatar Doug Stull Committed by Igor Drozdov

Refactor ci minutes email notification

- to incorporate already existing logic
  in recently refactored ci minutes
  area.
parent 7418c7de
......@@ -29,6 +29,18 @@ module Ci
contextual_map.dig(stage, :style)
end
def no_remaining_minutes?
stage == :exceeded
end
def running_out?
[:danger, :warning].include?(stage)
end
def stage_percentage
PERCENTAGES[stage]
end
private
attr_reader :context, :stage
......
......@@ -370,6 +370,10 @@ module EE
end
end
def owners_emails
owners.pluck(:email)
end
private
def custom_project_templates_group_allowed
......
......@@ -20,8 +20,6 @@ module EE
LICENSE_PLANS_TO_NAMESPACE_PLANS = NAMESPACE_PLANS_TO_LICENSE_PLANS.invert.freeze
PLANS = (NAMESPACE_PLANS_TO_LICENSE_PLANS.keys + [Plan::FREE]).freeze
CI_USAGE_ALERT_LEVELS = [30, 5].freeze
prepended do
include EachBatch
......@@ -55,6 +53,8 @@ module EE
delegate :shared_runners_minutes, :shared_runners_seconds, :shared_runners_seconds_last_reset,
:extra_shared_runners_minutes, to: :namespace_statistics, allow_nil: true
delegate :email, to: :owner, allow_nil: true, prefix: true
# Opportunistically clear the +file_template_project_id+ if invalid
before_validation :clear_file_template_project_id
......
......@@ -4,49 +4,55 @@ module Ci
module Minutes
class EmailNotificationService < ::BaseService
def execute
return unless ::Gitlab.com?
return unless namespace.shared_runners_minutes_limit_enabled?
notify_on_total_usage
notify_on_partial_usage
notify
end
private
def recipients
namespace.user? ? [namespace.owner.email] : namespace.owners.pluck(:email) # rubocop:disable CodeReuse/ActiveRecord
attr_reader :notification
def notify
@notification = ::Ci::Minutes::Notification.new(project, nil)
if notification.no_remaining_minutes?
notify_total_usage
elsif notification.running_out?
notify_partial_usage
end
end
def notify_on_total_usage
return unless namespace.shared_runners_minutes_used? && namespace.last_ci_minutes_notification_at.nil?
def notify_total_usage
return if namespace.last_ci_minutes_notification_at
namespace.update_columns(last_ci_minutes_notification_at: Time.current)
CiMinutesUsageMailer.notify(namespace, recipients).deliver_later
end
def notify_on_partial_usage
return if namespace.shared_runners_minutes_used?
return if namespace.last_ci_minutes_usage_notification_level == current_alert_level
return if alert_levels.max < namespace.shared_runners_remaining_minutes_percent
def notify_partial_usage
return if already_notified_running_out
namespace.update_columns(last_ci_minutes_usage_notification_level: current_alert_level)
namespace.update_columns(last_ci_minutes_usage_notification_level: current_alert_percentage)
CiMinutesUsageMailer.notify_limit(namespace, recipients, current_alert_level).deliver_later
CiMinutesUsageMailer.notify_limit(namespace, recipients, current_alert_percentage).deliver_later
end
def namespace
@namespace ||= project.shared_runners_limit_namespace
def already_notified_running_out
namespace.last_ci_minutes_usage_notification_level == current_alert_percentage
end
def alert_levels
@alert_levels ||= EE::Namespace::CI_USAGE_ALERT_LEVELS.sort
def recipients
namespace.user? ? [namespace.owner_email] : namespace.owners_emails
end
def current_alert_level
remaining_percent = namespace.shared_runners_remaining_minutes_percent
def namespace
@namespace ||= project.shared_runners_limit_namespace
end
@current_alert_level ||= alert_levels.find { |level| level >= remaining_percent }
def current_alert_percentage
notification.stage_percentage
end
end
end
......
......@@ -6,7 +6,7 @@ module EE
UpdateBuildMinutesService.new(build.project, nil).execute(build)
# We need to use `reset` on `project` because their AR associations have been cached
# and `Namespace#namespace_statistics` will return stale data.
::Ci::Minutes::EmailNotificationService.new(build.project.reset).execute
::Ci::Minutes::EmailNotificationService.new(build.project.reset).execute if ::Gitlab.com?
StoreSecurityScansWorker.perform_async(build.id)
......
......@@ -41,6 +41,7 @@ RSpec.describe Ci::Minutes::Notification do
allow(group).to receive(:shared_runners_remaining_minutes).and_return(4)
end
describe '#show?' do
it 'has warning notification' do
expect(subject.show?(user)).to be_truthy
expect(subject.text).to match(/.*\shas 30% or less Shared Runner Pipeline minutes remaining/)
......@@ -48,11 +49,31 @@ RSpec.describe Ci::Minutes::Notification do
end
end
describe '#running_out?' do
it 'is running out of minutes' do
expect(subject.running_out?).to be_truthy
end
end
describe '#no_remaining_minutes?' do
it 'has not ran out of minutes' do
expect(subject.no_remaining_minutes?).to be_falsey
end
end
describe '#stage_percentage' do
it 'provides percentage for current alert level' do
expect(subject.stage_percentage).to eq 30
end
end
end
context 'when at the danger level' do
before do
allow(group).to receive(:shared_runners_remaining_minutes).and_return(1)
end
describe '#show?' do
it 'has danger notification' do
expect(subject.show?(user)).to be_truthy
expect(subject.text).to match(/.*\shas 5% or less Shared Runner Pipeline minutes remaining/)
......@@ -60,11 +81,31 @@ RSpec.describe Ci::Minutes::Notification do
end
end
describe '#running_out?' do
it 'is running out of minutes' do
expect(subject.running_out?).to be_truthy
end
end
describe '#no_remaining_minutes?' do
it 'has not ran out of minutes' do
expect(subject.no_remaining_minutes?).to be_falsey
end
end
describe '#stage_percentage' do
it 'provides percentage for current alert level' do
expect(subject.stage_percentage).to eq 5
end
end
end
context 'when right at the limit for notification' do
before do
allow(group).to receive(:shared_runners_remaining_minutes).and_return(6)
end
describe '#show?' do
it 'has warning notification' do
expect(subject.show?(user)).to be_truthy
expect(subject.text).to match(/.*\shas 30% or less Shared Runner Pipeline minutes remaining/)
......@@ -72,15 +113,54 @@ RSpec.describe Ci::Minutes::Notification do
end
end
describe '#running_out?' do
it 'is running out of minutes' do
expect(subject.running_out?).to be_truthy
end
end
describe '#no_remaining_minutes?' do
it 'has not ran out of minutes' do
expect(subject.no_remaining_minutes?).to be_falsey
end
end
describe '#stage_percentage' do
it 'provides percentage for current alert level' do
expect(subject.stage_percentage).to eq 30
end
end
end
context 'when usage has exceeded the limit' do
let(:group) { create(:group, :with_used_build_minutes_limit) }
describe '#show?' do
it 'has exceeded notification' do
expect(subject.show?(user)).to be_truthy
expect(subject.text).to match(/.*\shas exceeded its pipeline minutes quota/)
expect(subject.style).to eq :danger
end
end
describe '#running_out?' do
it 'does not have any minutes left' do
expect(subject.running_out?).to be_falsey
end
end
describe '#no_remaining_minutes?' do
it 'has run out of minutes out of minutes' do
expect(subject.no_remaining_minutes?).to be_truthy
end
end
describe '#stage_percentage' do
it 'provides percentage for current alert level' do
expect(subject.stage_percentage).to eq 0
end
end
end
end
end
......@@ -91,25 +171,28 @@ RSpec.describe Ci::Minutes::Notification do
end
context 'when not permitted to see notifications' do
describe '#show?' do
it 'has no notifications set' do
expect(subject.show?(user)).to be_falsey
end
end
end
end
context 'when at project level' do
describe '#show?' do
context 'when eligible to see notifications' do
before do
group.add_developer(user)
end
describe '#show?' do
it_behaves_like 'queries for notifications' do
subject do
threshold = described_class.new(injected_project, nil)
threshold.show?(user)
end
end
end
it_behaves_like 'has notifications' do
subject { described_class.new(injected_project, nil) }
......@@ -128,22 +211,22 @@ RSpec.describe Ci::Minutes::Notification do
end
end
end
end
context 'when at namespace level' do
describe '#show?' do
context 'when eligible to see notifications' do
before do
group.add_developer(user)
end
context 'with a project that has runners enabled inside namespace' do
describe '#show?' do
it_behaves_like 'queries for notifications' do
subject do
threshold = described_class.new(nil, injected_group)
threshold.show?(user)
end
end
end
it_behaves_like 'has notifications' do
subject { described_class.new(nil, injected_group) }
......@@ -170,5 +253,4 @@ RSpec.describe Ci::Minutes::Notification do
end
end
end
end
end
......@@ -23,6 +23,7 @@ RSpec.describe Namespace do
it { is_expected.to delegate_method(:trial?).to(:gitlab_subscription) }
it { is_expected.to delegate_method(:trial_ends_on).to(:gitlab_subscription) }
it { is_expected.to delegate_method(:upgradable?).to(:gitlab_subscription) }
it { is_expected.to delegate_method(:email).to(:owner).with_prefix.allow_nil }
shared_examples 'plan helper' do |namespace_plan|
let(:namespace) { create(:namespace_with_plan, plan: "#{plan_name}_plan") }
......
......@@ -430,7 +430,7 @@ RSpec.describe Group do
context 'group with associated push_rules record' do
context 'with its own push rule' do
let(:push_rule) { create(:push_rule )}
let(:push_rule) { create(:push_rule) }
it 'returns its own push rule' do
group.update(push_rule: push_rule)
......@@ -941,4 +941,16 @@ RSpec.describe Group do
end
end
end
describe '#owners_emails' do
let(:user) { create(:user, email: 'bob@example.com') }
before do
group.add_owner(user)
end
subject { group.owners_emails }
it { is_expected.to match([user.email]) }
end
end
......@@ -32,12 +32,6 @@ RSpec.describe Ci::Minutes::EmailNotificationService do
create(:namespace_statistics, namespace: namespace, shared_runners_seconds: ci_minutes_used * 60)
end
let(:gitlab_dot_com) { true }
before do
allow(Gitlab).to receive(:com?).and_return(gitlab_dot_com)
end
describe '#execute' do
let(:extra_ci_minutes) { 0 }
let(:namespace) do
......@@ -46,17 +40,6 @@ RSpec.describe Ci::Minutes::EmailNotificationService do
subject { described_class.new(project).execute }
context 'when it is not GitLab.com' do
let(:gitlab_dot_com) { false }
let(:ci_minutes_used) { 2500 }
it 'does not send the email to all the owners' do
expect(CiMinutesUsageMailer).not_to receive(:notify)
subject
end
end
context 'with a personal namespace' do
before do
namespace.update(owner_id: user.id)
......@@ -169,8 +152,6 @@ RSpec.describe Ci::Minutes::EmailNotificationService do
end
before do
stub_const("EE::Namespace::CI_USAGE_ALERT_LEVELS", [30, 5])
namespace.add_owner(user)
namespace.add_owner(user_2)
end
......@@ -182,16 +163,7 @@ RSpec.describe Ci::Minutes::EmailNotificationService do
end
context 'when available minutes have reached the first level of alert' do
context 'when it is not GitLab.com' do
let(:gitlab_dot_com) { false }
let(:ci_minutes_used) { 1500 }
it_behaves_like 'no notification is sent'
end
context 'when quota is unlimited' do
# Gitlab.com? => true is required in order to excercise the notification
let(:gitlab_dot_com) { true }
let(:ci_minutes_used) { 1500 }
before do
......
......@@ -21,6 +21,7 @@ RSpec.describe BuildFinishedWorker do
end
describe '#perform' do
context 'when on .com' do
before do
allow(Gitlab).to receive(:com?).and_return(true)
allow_any_instance_of(EE::Project).to receive(:shared_runners_minutes_limit_enabled?).and_return(true)
......@@ -49,4 +50,17 @@ RSpec.describe BuildFinishedWorker do
subject
end
end
context 'when not on .com' do
before do
allow(Gitlab).to receive(:com?).and_return(false)
end
it 'does not notify the owners of Groups' do
expect(::Ci::Minutes::EmailNotificationService).not_to receive(:new)
subject
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