summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/alert_management/payload/base_spec.rb
diff options
context:
space:
mode:
Diffstat (limited to 'spec/lib/gitlab/alert_management/payload/base_spec.rb')
-rw-r--r--spec/lib/gitlab/alert_management/payload/base_spec.rb210
1 files changed, 210 insertions, 0 deletions
diff --git a/spec/lib/gitlab/alert_management/payload/base_spec.rb b/spec/lib/gitlab/alert_management/payload/base_spec.rb
new file mode 100644
index 00000000000..e0f63bad05d
--- /dev/null
+++ b/spec/lib/gitlab/alert_management/payload/base_spec.rb
@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::AlertManagement::Payload::Base do
+ let_it_be(:project) { create(:project) }
+ let(:raw_payload) { {} }
+ let(:payload_class) { described_class }
+
+ subject(:parsed_payload) { payload_class.new(project: project, payload: raw_payload) }
+
+ describe '.attribute' do
+ subject { parsed_payload.test }
+
+ context 'with a single path provided' do
+ let(:payload_class) do
+ Class.new(described_class) do
+ attribute :test, paths: [['test']]
+ end
+ end
+
+ it { is_expected.to be_nil }
+
+ context 'and a matching value' do
+ let(:raw_payload) { { 'test' => 'value' } }
+
+ it { is_expected.to eq 'value' }
+ end
+ end
+
+ context 'with multiple paths provided' do
+ let(:payload_class) do
+ Class.new(described_class) do
+ attribute :test, paths: [['test'], %w(alt test)]
+ end
+ end
+
+ it { is_expected.to be_nil }
+
+ context 'and a matching value' do
+ let(:raw_payload) { { 'alt' => { 'test' => 'value' } } }
+
+ it { is_expected.to eq 'value' }
+ end
+ end
+
+ context 'with a fallback provided' do
+ let(:payload_class) do
+ Class.new(described_class) do
+ attribute :test, paths: [['test']], fallback: -> { 'fallback' }
+ end
+ end
+
+ it { is_expected.to eq('fallback') }
+
+ context 'and a matching value' do
+ let(:raw_payload) { { 'test' => 'value' } }
+
+ it { is_expected.to eq 'value' }
+ end
+ end
+
+ context 'with a time type provided' do
+ let(:test_time) { Time.current.change(usec: 0) }
+
+ let(:payload_class) do
+ Class.new(described_class) do
+ attribute :test, paths: [['test']], type: :time
+ end
+ end
+
+ it { is_expected.to be_nil }
+
+ context 'with a compatible matching value' do
+ let(:raw_payload) { { 'test' => test_time.to_s } }
+
+ it { is_expected.to eq test_time }
+ end
+
+ context 'with a value in rfc3339 format' do
+ let(:raw_payload) { { 'test' => test_time.rfc3339 } }
+
+ it { is_expected.to eq test_time }
+ end
+
+ context 'with an incompatible matching value' do
+ let(:raw_payload) { { 'test' => 'bad time' } }
+
+ it { is_expected.to be_nil }
+ end
+ end
+
+ context 'with an integer type provided' do
+ let(:payload_class) do
+ Class.new(described_class) do
+ attribute :test, paths: [['test']], type: :integer
+ end
+ end
+
+ it { is_expected.to be_nil }
+
+ context 'with a compatible matching value' do
+ let(:raw_payload) { { 'test' => '15' } }
+
+ it { is_expected.to eq 15 }
+ end
+
+ context 'with an incompatible matching value' do
+ let(:raw_payload) { { 'test' => String } }
+
+ it { is_expected.to be_nil }
+ end
+
+ context 'with an incompatible matching value' do
+ let(:raw_payload) { { 'test' => 'apple' } }
+
+ it { is_expected.to be_nil }
+ end
+ end
+ end
+
+ describe '#alert_params' do
+ before do
+ allow(parsed_payload).to receive(:title).and_return('title')
+ allow(parsed_payload).to receive(:description).and_return('description')
+ end
+
+ subject { parsed_payload.alert_params }
+
+ it { is_expected.to eq({ description: 'description', project_id: project.id, title: 'title' }) }
+ end
+
+ describe '#gitlab_fingerprint' do
+ subject { parsed_payload.gitlab_fingerprint }
+
+ it { is_expected.to be_nil }
+
+ context 'when plain_gitlab_fingerprint is defined' do
+ before do
+ allow(parsed_payload)
+ .to receive(:plain_gitlab_fingerprint)
+ .and_return('fingerprint')
+ end
+
+ it 'returns a fingerprint' do
+ is_expected.to eq(Digest::SHA1.hexdigest('fingerprint'))
+ end
+ end
+ end
+
+ describe '#environment' do
+ let_it_be(:environment) { create(:environment, project: project, name: 'production') }
+
+ subject { parsed_payload.environment }
+
+ before do
+ allow(parsed_payload).to receive(:environment_name).and_return(environment_name)
+ end
+
+ context 'without an environment name' do
+ let(:environment_name) { nil }
+
+ it { is_expected.to be_nil }
+ end
+
+ context 'with a non-matching environment name' do
+ let(:environment_name) { 'other_environment' }
+
+ it { is_expected.to be_nil }
+ end
+
+ context 'with a matching environment name' do
+ let(:environment_name) { 'production' }
+
+ it { is_expected.to eq(environment) }
+ end
+ end
+
+ describe '#resolved?' do
+ before do
+ allow(parsed_payload).to receive(:status).and_return(status)
+ end
+
+ subject { parsed_payload.resolved? }
+
+ context 'when status is not defined' do
+ let(:status) { nil }
+
+ it { is_expected.to be_falsey }
+ end
+
+ context 'when status is not resovled' do
+ let(:status) { 'firing' }
+
+ it { is_expected.to be_falsey }
+ end
+
+ context 'when status is resovled' do
+ let(:status) { 'resolved' }
+
+ it { is_expected.to be_truthy }
+ end
+ end
+
+ describe '#has_required_attributes?' do
+ subject { parsed_payload.has_required_attributes? }
+
+ it { is_expected.to be(true) }
+ end
+end