diff options
Diffstat (limited to 'spec/presenters/alert_management')
-rw-r--r-- | spec/presenters/alert_management/alert_presenter_spec.rb | 134 | ||||
-rw-r--r-- | spec/presenters/alert_management/prometheus_alert_presenter_spec.rb | 85 |
2 files changed, 103 insertions, 116 deletions
diff --git a/spec/presenters/alert_management/alert_presenter_spec.rb b/spec/presenters/alert_management/alert_presenter_spec.rb index 394007a802f..243301502ce 100644 --- a/spec/presenters/alert_management/alert_presenter_spec.rb +++ b/spec/presenters/alert_management/alert_presenter_spec.rb @@ -4,58 +4,117 @@ require 'spec_helper' RSpec.describe AlertManagement::AlertPresenter do let_it_be(:project) { create(:project) } - - let_it_be(:generic_payload) do + let_it_be(:payload) do { 'title' => 'Alert title', 'start_time' => '2020-04-27T10:10:22.265949279Z', - 'custom' => { 'param' => 73 }, - 'runbook' => 'https://runbook.com' + 'custom' => { + 'alert' => { + 'fields' => %w[one two] + } + }, + 'yet' => { + 'another' => 73 + } } end - let_it_be(:alert) do - create(:alert_management_alert, :with_description, :with_host, :with_service, :with_monitoring_tool, project: project, payload: generic_payload) - end - + let_it_be(:alert) { create(:alert_management_alert, project: project, payload: payload) } let(:alert_url) { "http://localhost/#{project.full_path}/-/alert_management/#{alert.iid}/details" } subject(:presenter) { described_class.new(alert) } describe '#issue_description' do + let_it_be(:alert) { create(:alert_management_alert, project: project, payload: {}) } + let(:markdown_line_break) { ' ' } - it 'returns an alert issue description' do - expect(presenter.issue_description).to eq( - <<~MARKDOWN.chomp - #### Summary + subject { presenter.issue_description } - **Start time:** #{presenter.start_time}#{markdown_line_break} - **Severity:** #{presenter.severity}#{markdown_line_break} - **Service:** #{alert.service}#{markdown_line_break} - **Monitoring tool:** #{alert.monitoring_tool}#{markdown_line_break} - **Hosts:** #{alert.hosts.join(' ')}#{markdown_line_break} - **Description:** #{alert.description}#{markdown_line_break} - **GitLab alert:** #{alert_url} + context 'with an empty payload' do + it do + is_expected.to eq( + <<~MARKDOWN.chomp + **Start time:** #{presenter.start_time}#{markdown_line_break} + **Severity:** #{presenter.severity}#{markdown_line_break} + **GitLab alert:** #{alert_url} - #### Alert Details + MARKDOWN + ) + end + end - **custom.param:** 73#{markdown_line_break} - **runbook:** https://runbook.com - MARKDOWN - ) + context 'with optional alert attributes' do + let_it_be(:alert) do + create(:alert_management_alert, :with_description, :with_host, :with_service, :with_monitoring_tool, project: project, payload: payload) + end + + before do + allow(alert.parsed_payload).to receive(:full_query).and_return('metric > 1') + end + + it do + is_expected.to eq( + <<~MARKDOWN.chomp + **Start time:** #{presenter.start_time}#{markdown_line_break} + **Severity:** #{presenter.severity}#{markdown_line_break} + **full_query:** `metric > 1`#{markdown_line_break} + **Service:** #{alert.service}#{markdown_line_break} + **Monitoring tool:** #{alert.monitoring_tool}#{markdown_line_break} + **Hosts:** #{alert.hosts.join(' ')}#{markdown_line_break} + **Description:** #{alert.description}#{markdown_line_break} + **GitLab alert:** #{alert_url} + + MARKDOWN + ) + end end - end - describe '#metrics_dashboard_url' do - it 'is not defined' do - expect(presenter.metrics_dashboard_url).to be_nil + context 'with incident markdown' do + before do + allow(alert.parsed_payload).to receive(:alert_markdown).and_return('**`markdown example`**') + end + + it do + is_expected.to eq( + <<~MARKDOWN.chomp + **Start time:** #{presenter.start_time}#{markdown_line_break} + **Severity:** #{presenter.severity}#{markdown_line_break} + **GitLab alert:** #{alert_url} + + + --- + + **`markdown example`** + MARKDOWN + ) + end + end + + context 'with metrics_dashboard_url' do + before do + allow(alert.parsed_payload).to receive(:metrics_dashboard_url).and_return('https://gitlab.com/metrics') + end + + it do + is_expected.to eq( + <<~MARKDOWN.chomp + **Start time:** #{presenter.start_time}#{markdown_line_break} + **Severity:** #{presenter.severity}#{markdown_line_break} + **GitLab alert:** #{alert_url} + + [](https://gitlab.com/metrics) + MARKDOWN + ) + end end end - describe '#runbook' do - it 'shows the runbook from the payload' do - expect(presenter.runbook).to eq('https://runbook.com') + describe '#start_time' do + it 'formats the start time of the alert' do + alert.started_at = Time.utc(2019, 5, 5) + + expect(presenter.start_time). to eq('05 May 2019, 12:00AM (UTC)') end end @@ -64,4 +123,17 @@ RSpec.describe AlertManagement::AlertPresenter do expect(presenter.details_url).to match(%r{#{project.web_url}/-/alert_management/#{alert.iid}/details}) end end + + describe '#details' do + subject { presenter.details } + + it 'renders the payload as inline hash' do + is_expected.to eq( + 'title' => 'Alert title', + 'start_time' => '2020-04-27T10:10:22.265949279Z', + 'custom.alert.fields' => %w[one two], + 'yet.another' => 73 + ) + end + end end diff --git a/spec/presenters/alert_management/prometheus_alert_presenter_spec.rb b/spec/presenters/alert_management/prometheus_alert_presenter_spec.rb deleted file mode 100644 index 3cfff3c1b2f..00000000000 --- a/spec/presenters/alert_management/prometheus_alert_presenter_spec.rb +++ /dev/null @@ -1,85 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -RSpec.describe AlertManagement::PrometheusAlertPresenter do - let_it_be(:project) { create(:project) } - let(:payload) do - { - 'annotations' => { - 'title' => 'Alert title', - 'gitlab_incident_markdown' => '**`markdown example`**', - 'custom annotation' => 'custom annotation value' - }, - 'startsAt' => '2020-04-27T10:10:22.265949279Z', - 'generatorURL' => 'http://8d467bd4607a:9090/graph?g0.expr=vector%281%29&g0.tab=1' - } - end - - let!(:alert) do - create(:alert_management_alert, :prometheus, project: project, payload: payload) - end - - let(:alert_url) { "http://localhost/#{project.full_path}/-/alert_management/#{alert.iid}/details" } - - subject(:presenter) { described_class.new(alert) } - - describe '#issue_description' do - let(:markdown_line_break) { ' ' } - - it 'returns an alert issue description' do - expect(presenter.issue_description).to eq( - <<~MARKDOWN.chomp - #### Summary - - **Start time:** #{presenter.start_time}#{markdown_line_break} - **Severity:** #{presenter.severity}#{markdown_line_break} - **full_query:** `vector(1)`#{markdown_line_break} - **Monitoring tool:** Prometheus#{markdown_line_break} - **GitLab alert:** #{alert_url} - - #### Alert Details - - **custom annotation:** custom annotation value - - --- - - **`markdown example`** - MARKDOWN - ) - end - end - - describe '#metrics_dashboard_url' do - subject { presenter.metrics_dashboard_url } - - context 'for a non-prometheus alert' do - it { is_expected.to be_nil } - end - - context 'for a self-managed prometheus alert' do - include_context 'self-managed prometheus alert attributes' - - it { is_expected.to eq(dashboard_url_for_alert) } - end - - context 'for a gitlab-managed prometheus alert' do - include_context 'gitlab-managed prometheus alert attributes' - - it { is_expected.to eq(dashboard_url_for_alert) } - end - end - - describe '#runbook' do - subject { presenter.runbook } - - it { is_expected.to be_nil } - - context 'with runbook in payload' do - let(:expected_runbook) { 'https://awesome-runbook.com' } - let(:payload) { { 'annotations' => { 'runbook' => expected_runbook } } } - - it { is_expected.to eq(expected_runbook) } - end - end -end |