summaryrefslogtreecommitdiff
path: root/lib/gitlab/metrics/dashboard/stages/base_stage.rb
blob: 514ed50e58d9e6084624a8a19ad0955eb8ac7a7c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# frozen_string_literal: true

module Gitlab
  module Metrics
    module Dashboard
      module Stages
        class BaseStage
          include Gitlab::Metrics::Dashboard::Defaults

          DashboardProcessingError = Class.new(StandardError)
          LayoutError = Class.new(DashboardProcessingError)

          attr_reader :project, :environment, :dashboard

          def initialize(project, environment, dashboard)
            @project = project
            @environment = environment
            @dashboard = dashboard
          end

          # Entry-point to the stage
          def transform!
            raise NotImplementedError
          end

          protected

          def missing_panel_groups!
            raise LayoutError.new('Top-level key :panel_groups must be an array')
          end

          def missing_panels!
            raise LayoutError.new('Each "panel_group" must define an array :panels')
          end

          def missing_metrics!
            raise LayoutError.new('Each "panel" must define an array :metrics')
          end

          def for_metrics
            missing_panel_groups! unless dashboard[:panel_groups].is_a?(Array)

            dashboard[:panel_groups].each do |panel_group|
              missing_panels! unless panel_group[:panels].is_a?(Array)

              panel_group[:panels].each do |panel|
                missing_metrics! unless panel[:metrics].is_a?(Array)

                panel[:metrics].each do |metric|
                  yield metric
                end
              end
            end
          end
        end
      end
    end
  end
end