summaryrefslogtreecommitdiff
path: root/spec/lib/banzai/filter/inline_metrics_redactor_filter_spec.rb
blob: 9ccea1cc3e9622abaeeffade9484a66998c45376 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Banzai::Filter::InlineMetricsRedactorFilter do
  include FilterSpecHelper

  let_it_be(:project) { create(:project) }

  let(:url) { urls.metrics_dashboard_project_environment_url(project, 1, embedded: true) }
  let(:input) { %(<a href="#{url}">example</a>) }
  let(:doc) { filter(input) }

  context 'without a metrics charts placeholder' do
    it 'leaves regular non-metrics links unchanged' do
      expect(doc.to_s).to eq input
    end
  end

  context 'with a metrics charts placeholder' do
    let(:input) { %(<div class="js-render-metrics" data-dashboard-url="#{url}"></div>) }

    it_behaves_like 'redacts the embed placeholder'
    it_behaves_like 'retains the embed placeholder when applicable'

    context 'with /-/metrics?environment=:environment_id URL' do
      let(:url) { urls.project_metrics_dashboard_url(project, embedded: true, environment: 1) }

      it_behaves_like 'redacts the embed placeholder'
      it_behaves_like 'retains the embed placeholder when applicable'
    end

    context 'for a grafana dashboard' do
      let(:url) { urls.project_grafana_api_metrics_dashboard_url(project, embedded: true) }

      it_behaves_like 'redacts the embed placeholder'
      it_behaves_like 'retains the embed placeholder when applicable'
    end

    context 'for a cluster metric embed' do
      let_it_be(:cluster) { create(:cluster, :provided_by_gcp, :project, projects: [project]) }

      let(:params) { [project.namespace.path, project.path, cluster.id] }
      let(:query_params) { { group: 'Cluster Health', title: 'CPU Usage', y_label: 'CPU (cores)' } }
      let(:url) { urls.metrics_dashboard_namespace_project_cluster_url(*params, **query_params, format: :json) }

      context 'with user who can read cluster' do
        it_behaves_like 'redacts the embed placeholder'
        it_behaves_like 'retains the embed placeholder when applicable'
      end

      context 'without user who can read cluster' do
        let(:doc) { filter(input, current_user: create(:user)) }

        it 'redacts the embed placeholder' do
          expect(doc.to_s).to be_empty
        end
      end
    end

    context 'the user has requisite permissions' do
      let(:user) { create(:user) }
      let(:doc) { filter(input, current_user: user) }

      before do
        project.add_maintainer(user)
      end

      context 'for an internal non-dashboard url' do
        let(:url) { urls.project_url(project) }

        it 'leaves the placeholder' do
          expect(doc.to_s).to be_empty
        end
      end

      context 'with over 100 embeds' do
        let(:embed) { %(<div class="js-render-metrics" data-dashboard-url="#{url}"></div>) }
        let(:input) { embed * 150 }

        it 'redacts ill-advised embeds' do
          expect(doc.to_s.length).to eq(embed.length * 100)
        end
      end
    end

    context 'for an alert embed' do
      let_it_be(:alert) { create(:prometheus_alert, project: project) }

      let(:url) do
        urls.metrics_dashboard_project_prometheus_alert_url(
          project,
          alert.prometheus_metric_id,
          environment_id: alert.environment_id,
          embedded: true
        )
      end

      it_behaves_like 'redacts the embed placeholder'
      it_behaves_like 'retains the embed placeholder when applicable'
    end
  end
end