/spec/lib/gitlab/prometheus_client_spec.rb

https://gitlab.com/espadav8/gitlab-ce · Ruby · 191 lines · 151 code · 37 blank · 3 comment · 0 complexity · 582741c3c1886704e68e2b8a85882a95 MD5 · raw file

  1. require 'spec_helper'
  2. describe Gitlab::PrometheusClient, lib: true do
  3. include PrometheusHelpers
  4. subject { described_class.new(api_url: 'https://prometheus.example.com') }
  5. describe '#ping' do
  6. it 'issues a "query" request to the API endpoint' do
  7. req_stub = stub_prometheus_request(prometheus_query_url('1'), body: prometheus_value_body('vector'))
  8. expect(subject.ping).to eq({ "resultType" => "vector", "result" => [{ "metric" => {}, "value" => [1488772511.004, "0.000041021495238095323"] }] })
  9. expect(req_stub).to have_been_requested
  10. end
  11. end
  12. # This shared examples expect:
  13. # - query_url: A query URL
  14. # - execute_query: A query call
  15. shared_examples 'failure response' do
  16. context 'when request returns 400 with an error message' do
  17. it 'raises a Gitlab::PrometheusError error' do
  18. req_stub = stub_prometheus_request(query_url, status: 400, body: { error: 'bar!' })
  19. expect { execute_query }
  20. .to raise_error(Gitlab::PrometheusError, 'bar!')
  21. expect(req_stub).to have_been_requested
  22. end
  23. end
  24. context 'when request returns 400 without an error message' do
  25. it 'raises a Gitlab::PrometheusError error' do
  26. req_stub = stub_prometheus_request(query_url, status: 400)
  27. expect { execute_query }
  28. .to raise_error(Gitlab::PrometheusError, 'Bad data received')
  29. expect(req_stub).to have_been_requested
  30. end
  31. end
  32. context 'when request returns 500' do
  33. it 'raises a Gitlab::PrometheusError error' do
  34. req_stub = stub_prometheus_request(query_url, status: 500, body: { message: 'FAIL!' })
  35. expect { execute_query }
  36. .to raise_error(Gitlab::PrometheusError, '500 - {"message":"FAIL!"}')
  37. expect(req_stub).to have_been_requested
  38. end
  39. end
  40. end
  41. describe 'failure to reach a provided prometheus url' do
  42. let(:prometheus_url) {"https://prometheus.invalid.example.com"}
  43. context 'exceptions are raised' do
  44. it 'raises a Gitlab::PrometheusError error when a SocketError is rescued' do
  45. req_stub = stub_prometheus_request_with_exception(prometheus_url, SocketError)
  46. expect { subject.send(:get, prometheus_url) }
  47. .to raise_error(Gitlab::PrometheusError, "Can't connect to #{prometheus_url}")
  48. expect(req_stub).to have_been_requested
  49. end
  50. it 'raises a Gitlab::PrometheusError error when a SSLError is rescued' do
  51. req_stub = stub_prometheus_request_with_exception(prometheus_url, OpenSSL::SSL::SSLError)
  52. expect { subject.send(:get, prometheus_url) }
  53. .to raise_error(Gitlab::PrometheusError, "#{prometheus_url} contains invalid SSL data")
  54. expect(req_stub).to have_been_requested
  55. end
  56. it 'raises a Gitlab::PrometheusError error when a HTTParty::Error is rescued' do
  57. req_stub = stub_prometheus_request_with_exception(prometheus_url, HTTParty::Error)
  58. expect { subject.send(:get, prometheus_url) }
  59. .to raise_error(Gitlab::PrometheusError, "Network connection error")
  60. expect(req_stub).to have_been_requested
  61. end
  62. end
  63. end
  64. describe '#query' do
  65. let(:prometheus_query) { prometheus_cpu_query('env-slug') }
  66. let(:query_url) { prometheus_query_with_time_url(prometheus_query, Time.now.utc) }
  67. around do |example|
  68. Timecop.freeze { example.run }
  69. end
  70. context 'when request returns vector results' do
  71. it 'returns data from the API call' do
  72. req_stub = stub_prometheus_request(query_url, body: prometheus_value_body('vector'))
  73. expect(subject.query(prometheus_query)).to eq [{ "metric" => {}, "value" => [1488772511.004, "0.000041021495238095323"] }]
  74. expect(req_stub).to have_been_requested
  75. end
  76. end
  77. context 'when request returns matrix results' do
  78. it 'returns nil' do
  79. req_stub = stub_prometheus_request(query_url, body: prometheus_value_body('matrix'))
  80. expect(subject.query(prometheus_query)).to be_nil
  81. expect(req_stub).to have_been_requested
  82. end
  83. end
  84. context 'when request returns no data' do
  85. it 'returns []' do
  86. req_stub = stub_prometheus_request(query_url, body: prometheus_empty_body('vector'))
  87. expect(subject.query(prometheus_query)).to be_empty
  88. expect(req_stub).to have_been_requested
  89. end
  90. end
  91. it_behaves_like 'failure response' do
  92. let(:execute_query) { subject.query(prometheus_query) }
  93. end
  94. end
  95. describe '#query_range' do
  96. let(:prometheus_query) { prometheus_memory_query('env-slug') }
  97. let(:query_url) { prometheus_query_range_url(prometheus_query) }
  98. around do |example|
  99. Timecop.freeze { example.run }
  100. end
  101. context 'when non utc time is passed' do
  102. let(:time_stop) { Time.now.in_time_zone("Warsaw") }
  103. let(:time_start) { time_stop - 8.hours }
  104. let(:query_url) { prometheus_query_range_url(prometheus_query, start: time_start.utc.to_f, stop: time_stop.utc.to_f) }
  105. it 'passed dates are properly converted to utc' do
  106. req_stub = stub_prometheus_request(query_url, body: prometheus_values_body('vector'))
  107. subject.query_range(prometheus_query, start: time_start, stop: time_stop)
  108. expect(req_stub).to have_been_requested
  109. end
  110. end
  111. context 'when a start time is passed' do
  112. let(:query_url) { prometheus_query_range_url(prometheus_query, start: 2.hours.ago) }
  113. it 'passed it in the requested URL' do
  114. req_stub = stub_prometheus_request(query_url, body: prometheus_values_body('vector'))
  115. subject.query_range(prometheus_query, start: 2.hours.ago)
  116. expect(req_stub).to have_been_requested
  117. end
  118. end
  119. context 'when request returns vector results' do
  120. it 'returns nil' do
  121. req_stub = stub_prometheus_request(query_url, body: prometheus_values_body('vector'))
  122. expect(subject.query_range(prometheus_query)).to be_nil
  123. expect(req_stub).to have_been_requested
  124. end
  125. end
  126. context 'when request returns matrix results' do
  127. it 'returns data from the API call' do
  128. req_stub = stub_prometheus_request(query_url, body: prometheus_values_body('matrix'))
  129. expect(subject.query_range(prometheus_query)).to eq([
  130. {
  131. "metric" => {},
  132. "values" => [[1488758662.506, "0.00002996364761904785"], [1488758722.506, "0.00003090239047619091"]]
  133. }
  134. ])
  135. expect(req_stub).to have_been_requested
  136. end
  137. end
  138. context 'when request returns no data' do
  139. it 'returns []' do
  140. req_stub = stub_prometheus_request(query_url, body: prometheus_empty_body('matrix'))
  141. expect(subject.query_range(prometheus_query)).to be_empty
  142. expect(req_stub).to have_been_requested
  143. end
  144. end
  145. it_behaves_like 'failure response' do
  146. let(:execute_query) { subject.query_range(prometheus_query) }
  147. end
  148. end
  149. end