summaryrefslogtreecommitdiff
path: root/spec/models/performance_monitoring/prometheus_dashboard_spec.rb
diff options
context:
space:
mode:
Diffstat (limited to 'spec/models/performance_monitoring/prometheus_dashboard_spec.rb')
-rw-r--r--spec/models/performance_monitoring/prometheus_dashboard_spec.rb102
1 files changed, 102 insertions, 0 deletions
diff --git a/spec/models/performance_monitoring/prometheus_dashboard_spec.rb b/spec/models/performance_monitoring/prometheus_dashboard_spec.rb
new file mode 100644
index 00000000000..e6fc03a0fb6
--- /dev/null
+++ b/spec/models/performance_monitoring/prometheus_dashboard_spec.rb
@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PerformanceMonitoring::PrometheusDashboard do
+ let(:json_content) do
+ {
+ "dashboard" => "Dashboard Title",
+ "templating" => {
+ "variables" => {
+ "variable1" => %w(value1 value2 value3)
+ }
+ },
+ "panel_groups" => [{
+ "group" => "Group Title",
+ "panels" => [{
+ "type" => "area-chart",
+ "title" => "Chart Title",
+ "y_label" => "Y-Axis",
+ "metrics" => [{
+ "id" => "metric_of_ages",
+ "unit" => "count",
+ "label" => "Metric of Ages",
+ "query_range" => "http_requests_total"
+ }]
+ }]
+ }]
+ }
+ end
+
+ describe '.from_json' do
+ subject { described_class.from_json(json_content) }
+
+ it 'creates a PrometheusDashboard object' do
+ expect(subject).to be_a PerformanceMonitoring::PrometheusDashboard
+ expect(subject.dashboard).to eq(json_content['dashboard'])
+ expect(subject.panel_groups).to all(be_a PerformanceMonitoring::PrometheusPanelGroup)
+ end
+
+ describe 'validations' do
+ context 'when dashboard is missing' do
+ before do
+ json_content['dashboard'] = nil
+ end
+
+ subject { described_class.from_json(json_content) }
+
+ it { expect { subject }.to raise_error(ActiveModel::ValidationError) }
+ end
+
+ context 'when panel groups are missing' do
+ before do
+ json_content['panel_groups'] = []
+ end
+
+ subject { described_class.from_json(json_content) }
+
+ it { expect { subject }.to raise_error(ActiveModel::ValidationError) }
+ end
+ end
+ end
+
+ describe '.find_for' do
+ let(:project) { build_stubbed(:project) }
+ let(:user) { build_stubbed(:user) }
+ let(:environment) { build_stubbed(:environment) }
+ let(:path) { ::Metrics::Dashboard::SystemDashboardService::DASHBOARD_PATH }
+
+ context 'dashboard has been found' do
+ it 'uses dashboard finder to find and load dashboard data and returns dashboard instance', :aggregate_failures do
+ expect(Gitlab::Metrics::Dashboard::Finder).to receive(:find).with(project, user, environment: environment, dashboard_path: path).and_return(status: :success, dashboard: json_content)
+
+ dashboard_instance = described_class.find_for(project: project, user: user, path: path, options: { environment: environment })
+
+ expect(dashboard_instance).to be_instance_of described_class
+ expect(dashboard_instance.environment).to be environment
+ expect(dashboard_instance.path).to be path
+ end
+ end
+
+ context 'dashboard has NOT been found' do
+ it 'returns nil' do
+ allow(Gitlab::Metrics::Dashboard::Finder).to receive(:find).and_return(status: :error)
+
+ dashboard_instance = described_class.find_for(project: project, user: user, path: path, options: { environment: environment })
+
+ expect(dashboard_instance).to be_nil
+ end
+ end
+ end
+
+ describe '#to_yaml' do
+ subject { prometheus_dashboard.to_yaml }
+
+ let(:prometheus_dashboard) { described_class.from_json(json_content) }
+ let(:expected_yaml) do
+ "---\npanel_groups:\n- panels:\n - metrics:\n - id: metric_of_ages\n unit: count\n label: Metric of Ages\n query: \n query_range: http_requests_total\n type: area-chart\n title: Chart Title\n y_label: Y-Axis\n weight: \n group: Group Title\n priority: \ndashboard: Dashboard Title\n"
+ end
+
+ it { is_expected.to eq(expected_yaml) }
+ end
+end