Move MetricsDashboard to Metrics::Dashboard

2 files changed, 136 insertions, 0 deletions

diff --git a/spec/lib/gitlab/metrics/dashboard/processor_spec.rb b/spec/lib/gitlab/metrics/dashboard/processor_spec.rb
new file mode 100644
index 00000000000..e27ba2f1f4e
--- /dev/null
+++ b/spec/lib/gitlab/metrics/dashboard/processor_spec.rb
@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Metrics::Dashboard::Processor do
+  let(:project) { build(:project) }
+  let(:environment) { build(:environment) }
+  let(:dashboard_yml) { YAML.load_file('spec/fixtures/lib/gitlab/metrics/dashboard/sample_dashboard.yml') }
+
+  describe 'process' do
+    let(:process_params) { [project, environment] }
+    let(:dashboard) { described_class.new(*process_params).process(dashboard_yml) }
+
+    context 'when dashboard config corresponds to common metrics' do
+      let!(:common_metric) { create(:prometheus_metric, :common, identifier: 'metric_a1') }
+
+      it 'inserts metric ids into the config' do
+        target_metric = all_metrics.find { |metric| metric[:id] == 'metric_a1' }
+
+        expect(target_metric).to include(:metric_id)
+        expect(target_metric[:metric_id]).to eq(common_metric.id)
+      end
+    end
+
+    context 'when the project has associated metrics' do
+      let!(:project_response_metric) { create(:prometheus_metric, project: project, group: :response) }
+      let!(:project_system_metric) { create(:prometheus_metric, project: project, group: :system) }
+      let!(:project_business_metric) { create(:prometheus_metric, project: project, group: :business) }
+
+      it 'includes project-specific metrics' do
+        expect(all_metrics).to include get_metric_details(project_system_metric)
+        expect(all_metrics).to include get_metric_details(project_response_metric)
+        expect(all_metrics).to include get_metric_details(project_business_metric)
+      end
+
+      it 'orders groups by priority and panels by weight' do
+        expected_metrics_order = [
+          'metric_a2', # group priority 10, panel weight 2
+          'metric_a1', # group priority 10, panel weight 1
+          'metric_b', # group priority 1, panel weight 1
+          project_business_metric.id, # group priority 0, panel weight nil (0)
+          project_response_metric.id, # group priority -5, panel weight nil (0)
+          project_system_metric.id, # group priority -10, panel weight nil (0)
+        ]
+        actual_metrics_order = all_metrics.map { |m| m[:id] || m[:metric_id] }
+
+        expect(actual_metrics_order).to eq expected_metrics_order
+      end
+    end
+
+    shared_examples_for 'errors with message' do |expected_message|
+      it 'raises a DashboardLayoutError' do
+        error_class = Gitlab::Metrics::Dashboard::Stages::BaseStage::DashboardLayoutError
+
+        expect { dashboard }.to raise_error(error_class, expected_message)
+      end
+    end
+
+    context 'when the dashboard is missing panel_groups' do
+      let(:dashboard_yml) { {} }
+
+      it_behaves_like 'errors with message', 'Top-level key :panel_groups must be an array'
+    end
+
+    context 'when the dashboard contains a panel_group which is missing panels' do
+      let(:dashboard_yml) { { panel_groups: [{}] } }
+
+      it_behaves_like 'errors with message', 'Each "panel_group" must define an array :panels'
+    end
+
+    context 'when the dashboard contains a panel which is missing metrics' do
+      let(:dashboard_yml) { { panel_groups: [{ panels: [{}] }] } }
+
+      it_behaves_like 'errors with message', 'Each "panel" must define an array :metrics'
+    end
+  end
+
+  private
+
+  def all_metrics
+    dashboard[:panel_groups].map do |group|
+      group[:panels].map { |panel| panel[:metrics] }
+    end.flatten
+  end
+
+  def get_metric_details(metric)
+    {
+      query_range: metric.query,
+      unit: metric.unit,
+      label: metric.legend,
+      metric_id: metric.id
+    }
+  end
+end
diff --git a/spec/lib/gitlab/metrics/dashboard/service_spec.rb b/spec/lib/gitlab/metrics/dashboard/service_spec.rb
new file mode 100644
index 00000000000..3f82fd7ebf8
--- /dev/null
+++ b/spec/lib/gitlab/metrics/dashboard/service_spec.rb
@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Gitlab::Metrics::Dashboard::Service, :use_clean_rails_memory_store_caching do
+  let(:project) { build(:project) }
+  let(:environment) { build(:environment) }
+
+  describe 'get_dashboard' do
+    let(:dashboard_schema) { JSON.parse(fixture_file('lib/gitlab/metrics/dashboard/schemas/dashboard.json')) }
+
+    it 'returns a json representation of the environment dashboard' do
+      result = described_class.new(project, environment).get_dashboard
+
+      expect(result.keys).to contain_exactly(:dashboard, :status)
+      expect(result[:status]).to eq(:success)
+
+      expect(JSON::Validator.fully_validate(dashboard_schema, result[:dashboard])).to be_empty
+    end
+
+    it 'caches the dashboard for subsequent calls' do
+      expect(YAML).to receive(:load_file).once.and_call_original
+
+      described_class.new(project, environment).get_dashboard
+      described_class.new(project, environment).get_dashboard
+    end
+
+    context 'when the dashboard is configured incorrectly' do
+      before do
+        allow(YAML).to receive(:load_file).and_return({})
+      end
+
+      it 'returns an appropriate message and status code' do
+        result = described_class.new(project, environment).get_dashboard
+
+        expect(result.keys).to contain_exactly(:message, :http_status, :status)
+        expect(result[:status]).to eq(:error)
+        expect(result[:http_status]).to eq(:unprocessable_entity)
+      end
+    end
+  end
+end