2020-09-10 12:08:54 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
require 'spec_helper'
|
|
|
|
|
|
|
|
RSpec.describe API::UsageData do
|
|
|
|
let_it_be(:user) { create(:user) }
|
|
|
|
|
2020-11-19 15:09:13 +00:00
|
|
|
describe 'POST /usage_data/increment_counter' do
|
|
|
|
let(:endpoint) { '/usage_data/increment_counter' }
|
|
|
|
let(:known_event) { "#{known_event_prefix}_#{known_event_postfix}" }
|
|
|
|
let(:known_event_prefix) { "static_site_editor" }
|
|
|
|
let(:known_event_postfix) { 'commits' }
|
|
|
|
let(:unknown_event) { 'unknown' }
|
|
|
|
|
|
|
|
context 'without CSRF token' do
|
|
|
|
it 'returns forbidden' do
|
|
|
|
stub_feature_flags(usage_data_api: true)
|
|
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(false)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: known_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'usage_data_api feature not enabled' do
|
|
|
|
it 'returns not_found' do
|
|
|
|
stub_feature_flags(usage_data_api: false)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: known_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'without authentication' do
|
|
|
|
it 'returns 401 response' do
|
|
|
|
post api(endpoint), params: { event: known_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'with authentication' do
|
|
|
|
before do
|
|
|
|
stub_feature_flags(usage_data_api: true)
|
|
|
|
stub_feature_flags("usage_data_#{known_event}" => true)
|
|
|
|
stub_application_setting(usage_ping_enabled: true)
|
|
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(true)
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'when event is missing from params' do
|
|
|
|
it 'returns bad request' do
|
|
|
|
post api(endpoint, user), params: {}
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2022-01-21 12:16:22 +00:00
|
|
|
context 'with correct params' do
|
|
|
|
using RSpec::Parameterized::TableSyntax
|
2020-11-19 15:09:13 +00:00
|
|
|
|
2022-01-21 12:16:22 +00:00
|
|
|
where(:prefix, :event) do
|
|
|
|
'static_site_editor' | 'merge_requests'
|
|
|
|
'static_site_editor' | 'commits'
|
|
|
|
end
|
|
|
|
|
|
|
|
before do
|
|
|
|
stub_application_setting(usage_ping_enabled: true)
|
|
|
|
stub_feature_flags(usage_data_api: true)
|
|
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(true)
|
|
|
|
stub_feature_flags("usage_data_#{prefix}_#{event}" => true)
|
|
|
|
end
|
|
|
|
|
|
|
|
with_them do
|
|
|
|
it 'returns status :ok' do
|
|
|
|
expect(Gitlab::UsageDataCounters::BaseCounter).to receive(:count).with(event)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: "#{prefix}_#{event}" }
|
2020-11-19 15:09:13 +00:00
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'with unknown event' do
|
|
|
|
before do
|
|
|
|
skip_feature_flags_yaml_validation
|
2022-01-26 15:12:36 +00:00
|
|
|
skip_default_enabled_yaml_check
|
2020-11-19 15:09:13 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
it 'returns status ok' do
|
|
|
|
expect(Gitlab::UsageDataCounters::BaseCounter).not_to receive(:count)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: unknown_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-09-10 12:08:54 +00:00
|
|
|
describe 'POST /usage_data/increment_unique_users' do
|
|
|
|
let(:endpoint) { '/usage_data/increment_unique_users' }
|
|
|
|
let(:known_event) { 'g_compliance_dashboard' }
|
|
|
|
let(:unknown_event) { 'unknown' }
|
|
|
|
|
2020-09-11 12:08:50 +00:00
|
|
|
context 'without CSRF token' do
|
|
|
|
it 'returns forbidden' do
|
|
|
|
stub_feature_flags(usage_data_api: true)
|
|
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(false)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: known_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-09-10 12:08:54 +00:00
|
|
|
context 'usage_data_api feature not enabled' do
|
|
|
|
it 'returns not_found' do
|
|
|
|
stub_feature_flags(usage_data_api: false)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: known_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:not_found)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'without authentication' do
|
|
|
|
it 'returns 401 response' do
|
|
|
|
post api(endpoint), params: { event: known_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'with authentication' do
|
|
|
|
before do
|
|
|
|
stub_feature_flags(usage_data_api: true)
|
|
|
|
stub_feature_flags("usage_data_#{known_event}" => true)
|
|
|
|
stub_application_setting(usage_ping_enabled: true)
|
2020-09-11 12:08:50 +00:00
|
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(true)
|
2020-09-10 12:08:54 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
context 'when event is missing from params' do
|
|
|
|
it 'returns bad request' do
|
|
|
|
post api(endpoint, user), params: {}
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:bad_request)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'with correct params' do
|
|
|
|
it 'returns status ok' do
|
|
|
|
expect(Gitlab::Redis::HLL).to receive(:add)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: known_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'with unknown event' do
|
2020-09-21 12:09:34 +00:00
|
|
|
before do
|
|
|
|
skip_feature_flags_yaml_validation
|
|
|
|
end
|
|
|
|
|
2020-09-10 12:08:54 +00:00
|
|
|
it 'returns status ok' do
|
|
|
|
expect(Gitlab::Redis::HLL).not_to receive(:add)
|
|
|
|
|
|
|
|
post api(endpoint, user), params: { event: unknown_event }
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2021-04-09 09:09:10 +00:00
|
|
|
|
|
|
|
describe 'GET /usage_data/metric_definitions' do
|
|
|
|
let(:endpoint) { '/usage_data/metric_definitions' }
|
|
|
|
let(:metric_yaml) do
|
|
|
|
{ 'key_path' => 'counter.category.event', 'description' => 'Metric description' }.to_yaml
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'without authentication' do
|
|
|
|
it 'returns a YAML file', :aggregate_failures do
|
|
|
|
allow(Gitlab::Usage::MetricDefinition).to receive(:dump_metrics_yaml).and_return(metric_yaml)
|
|
|
|
|
|
|
|
get api(endpoint)
|
|
|
|
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
|
|
expect(response.media_type).to eq('application/yaml')
|
|
|
|
expect(response.body).to eq(metric_yaml)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2020-09-10 12:08:54 +00:00
|
|
|
end
|