From 552a3d2fd939d3f8a56cfad9fad62227c1d5aa89 Mon Sep 17 00:00:00 2001
From: Sarah Yasonik <syasonik@gitlab.com>
Date: Wed, 1 May 2019 10:16:03 +0000
Subject: Update metrics dashboard API to load yml from repo

Updates the EnvironmentController#metrics_dashboard endpoint
to support a "dashboard" param, which can be used to specify
the filepath of a dashboard configuration from a project
repository. Dashboard configurations are expected to be
stored in .gitlab/dashboards/.

Updates dashboard post-processing steps to exclude custom
metrics, which should only display on the system dashboard.
---
 spec/support/helpers/metrics_dashboard_helpers.rb | 43 +++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 spec/support/helpers/metrics_dashboard_helpers.rb

(limited to 'spec/support')

diff --git a/spec/support/helpers/metrics_dashboard_helpers.rb b/spec/support/helpers/metrics_dashboard_helpers.rb
new file mode 100644
index 00000000000..1f36b0e217c
--- /dev/null
+++ b/spec/support/helpers/metrics_dashboard_helpers.rb
@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MetricsDashboardHelpers
+  def project_with_dashboard(dashboard_path, dashboard_yml = nil)
+    dashboard_yml ||= fixture_file('lib/gitlab/metrics/dashboard/sample_dashboard.yml')
+
+    create(:project, :custom_repo, files: { dashboard_path => dashboard_yml })
+  end
+
+  def delete_project_dashboard(project, user, dashboard_path)
+    project.repository.delete_file(
+      user,
+      dashboard_path,
+      branch_name: 'master',
+      message: 'Delete dashboard'
+    )
+
+    project.repository.refresh_method_caches([:metrics_dashboard])
+  end
+
+  shared_examples_for 'misconfigured dashboard service response' do |status_code|
+    it 'returns an appropriate message and status code' do
+      result = service_call
+
+      expect(result.keys).to contain_exactly(:message, :http_status, :status)
+      expect(result[:status]).to eq(:error)
+      expect(result[:http_status]).to eq(status_code)
+    end
+  end
+
+  shared_examples_for 'valid dashboard service response' do
+    let(:dashboard_schema) { JSON.parse(fixture_file('lib/gitlab/metrics/dashboard/schemas/dashboard.json')) }
+
+    it 'returns a json representation of the dashboard' do
+      result = service_call
+
+      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
+  end
+end
-- 
cgit v1.2.1