summaryrefslogtreecommitdiff
path: root/spec/support/shared_examples/controllers/metrics/dashboard/prometheus_api_proxy_shared_examples.rb
blob: 19b1cee44eeab9e055722b7f9198cd6f9574ee59 (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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# frozen_string_literal: true

RSpec.shared_examples_for 'metrics dashboard prometheus api proxy' do
  let(:service_params) { [proxyable, 'GET', 'query', expected_params] }
  let(:service_result) { { status: :success, body: prometheus_body } }
  let(:prometheus_proxy_service) { instance_double(Prometheus::ProxyService) }
  let(:proxyable_params) do
    {
      id: proxyable.id.to_s
    }
  end

  let(:expected_params) do
    ActionController::Parameters.new(
      prometheus_proxy_params(
        proxy_path: 'query',
        controller: described_class.controller_path,
        action: 'prometheus_proxy'
      )
    ).permit!
  end

  before do
    allow_next_instance_of(Prometheus::ProxyService, *service_params) do |proxy_service|
      allow(proxy_service).to receive(:execute).and_return(service_result)
    end
  end

  context 'with valid requests' do
    context 'with success result' do
      let(:prometheus_body) { '{"status":"success"}' }
      let(:prometheus_json_body) { Gitlab::Json.parse(prometheus_body) }

      it 'returns prometheus response' do
        get :prometheus_proxy, params: prometheus_proxy_params

        expect(Prometheus::ProxyService).to have_received(:new).with(*service_params)
        expect(response).to have_gitlab_http_status(:ok)
        expect(json_response).to eq(prometheus_json_body)
      end

      context 'with nil query' do
        let(:params_without_query) do
          prometheus_proxy_params.except(:query)
        end

        before do
          expected_params.delete(:query)
        end

        it 'does not raise error' do
          get :prometheus_proxy, params: params_without_query

          expect(Prometheus::ProxyService).to have_received(:new).with(*service_params)
        end
      end
    end

    context 'with nil result' do
      let(:service_result) { nil }

      it 'returns 204 no_content' do
        get :prometheus_proxy, params: prometheus_proxy_params

        expect(json_response['status']).to eq(_('processing'))
        expect(json_response['message']).to eq(_('Not ready yet. Try again later.'))
        expect(response).to have_gitlab_http_status(:no_content)
      end
    end

    context 'with 404 result' do
      let(:service_result) { { http_status: 404, status: :success, body: '{"body": "value"}' } }

      it 'returns body' do
        get :prometheus_proxy, params: prometheus_proxy_params

        expect(response).to have_gitlab_http_status(:not_found)
        expect(json_response['body']).to eq('value')
      end
    end

    context 'with error result' do
      context 'with http_status' do
        let(:service_result) do
          { http_status: :service_unavailable, status: :error, message: 'error message' }
        end

        it 'sets the http response status code' do
          get :prometheus_proxy, params: prometheus_proxy_params

          expect(response).to have_gitlab_http_status(:service_unavailable)
          expect(json_response['status']).to eq('error')
          expect(json_response['message']).to eq('error message')
        end
      end

      context 'without http_status' do
        let(:service_result) { { status: :error, message: 'error message' } }

        it 'returns bad_request' do
          get :prometheus_proxy, params: prometheus_proxy_params

          expect(response).to have_gitlab_http_status(:bad_request)
          expect(json_response['status']).to eq('error')
          expect(json_response['message']).to eq('error message')
        end
      end
    end
  end

  context 'with inappropriate requests' do
    let(:prometheus_body) { nil }

    context 'without correct permissions' do
      let(:user2) { create(:user) }

      before do
        sign_out(user)
        sign_in(user2)
      end

      it 'returns 404' do
        get :prometheus_proxy, params: prometheus_proxy_params

        expect(response).to have_gitlab_http_status(:not_found)
      end
    end
  end

  context 'with invalid proxyable id' do
    let(:prometheus_body) { nil }

    it 'returns 404' do
      get :prometheus_proxy, params: prometheus_proxy_params(id: proxyable.id + 1)

      expect(response).to have_gitlab_http_status(:not_found)
    end
  end

  private

  def prometheus_proxy_params(params = {})
    {
      proxy_path: 'query',
      query: '1'
    }.merge(proxyable_params).merge(params)
  end
end