294 lines
8.9 KiB
Ruby
294 lines
8.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
RSpec.describe API::UsageData, feature_category: :service_ping do
|
|
let_it_be(:user) { create(:user) }
|
|
|
|
describe 'GET /usage_data/service_ping' do
|
|
let(:endpoint) { '/usage_data/service_ping' }
|
|
|
|
context 'without authentication' do
|
|
it 'returns 401 response' do
|
|
get api(endpoint)
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when authenticated as non-admin' do
|
|
let(:user) { create(:user) }
|
|
|
|
it 'returns 403' do
|
|
get api(endpoint, user)
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
end
|
|
end
|
|
|
|
context 'when authenticated as an admin using read_service_ping access token' do
|
|
let(:scopes) { [Gitlab::Auth::READ_SERVICE_PING_SCOPE] }
|
|
let(:personal_access_token) { create(:personal_access_token, user: user, scopes: scopes) }
|
|
|
|
before do
|
|
allow(Ability).to receive(:allowed?).and_return(true)
|
|
end
|
|
|
|
it 'returns 200' do
|
|
get api(endpoint, personal_access_token: personal_access_token)
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
it 'returns service ping payload' do
|
|
usage_data = { 'key' => 'value' }
|
|
allow(Rails.cache).to receive(:fetch).and_return(usage_data)
|
|
|
|
get api(endpoint, personal_access_token: personal_access_token)
|
|
|
|
expect(response.body).to eq(usage_data.to_json)
|
|
end
|
|
|
|
it 'tracks an internal event' do
|
|
expect(Gitlab::InternalEvents).to receive(:track_event)
|
|
.with('request_service_ping_via_rest', user: user)
|
|
|
|
get api(endpoint, personal_access_token: personal_access_token)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /usage_data/increment_counter' do
|
|
let(:endpoint) { '/usage_data/increment_counter' }
|
|
let(:known_event) { "diff_searches" }
|
|
let(:unknown_event) { 'unknown' }
|
|
|
|
context 'without CSRF token' do
|
|
it 'returns forbidden' do
|
|
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 '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_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
|
|
|
|
context 'with correct params' do
|
|
before do
|
|
stub_application_setting(usage_ping_enabled: true)
|
|
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(true)
|
|
end
|
|
|
|
it 'returns status :ok' do
|
|
expect(Gitlab::UsageDataCounters::BaseCounter).to receive(:count).with("searches")
|
|
|
|
post api(endpoint, user), params: { event: known_event }
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
end
|
|
|
|
context 'with unknown event' do
|
|
before do
|
|
skip_default_enabled_yaml_check
|
|
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
|
|
|
|
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' }
|
|
|
|
context 'without CSRF token' do
|
|
it 'returns forbidden' do
|
|
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 '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_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
|
|
|
|
context 'with correct params' do
|
|
it 'returns status ok' do
|
|
expect(Gitlab::UsageDataCounters::HLLRedisCounter).to receive(:track).with(anything, known_event, anything)
|
|
# allow other events to also get triggered
|
|
allow(Gitlab::UsageDataCounters::HLLRedisCounter).to receive(:track)
|
|
|
|
post api(endpoint, user), params: { event: known_event }
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
end
|
|
|
|
context 'with unknown event' do
|
|
it 'returns status ok' do
|
|
expect(Gitlab::Redis::HLL).not_to receive(:add).with(hash_including(key: unknown_event))
|
|
|
|
post api(endpoint, user), params: { event: unknown_event }
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /usage_data/track_event' do
|
|
let(:endpoint) { '/usage_data/track_event' }
|
|
let(:known_event) { 'i_compliance_dashboard' }
|
|
let(:unknown_event) { 'unknown' }
|
|
let(:namespace_id) { 123 }
|
|
let(:project_id) { 123 }
|
|
|
|
context 'without CSRF token' do
|
|
it 'returns forbidden' do
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(false)
|
|
|
|
post api(endpoint, user), params: { event: known_event, namespace_id: namespace_id, project_id: project_id }
|
|
|
|
expect(response).to have_gitlab_http_status(:forbidden)
|
|
end
|
|
end
|
|
|
|
context 'without authentication' do
|
|
it 'returns 401 response' do
|
|
post api(endpoint), params: { event: known_event, namespace_id: namespace_id, project_id: project_id }
|
|
|
|
expect(response).to have_gitlab_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'with authentication' do
|
|
let_it_be(:namespace) { create(:namespace) }
|
|
let_it_be(:project) { create(:project) }
|
|
let_it_be(:additional_properties) do
|
|
{
|
|
label: 'label3',
|
|
property: 'admin'
|
|
}
|
|
end
|
|
|
|
before do
|
|
stub_application_setting(usage_ping_enabled: true)
|
|
allow(Gitlab::RequestForgeryProtection).to receive(:verified?).and_return(true)
|
|
end
|
|
|
|
context 'with correct params' do
|
|
it 'returns status ok' do
|
|
expect(Gitlab::InternalEvents).to receive(:track_event)
|
|
.with(
|
|
known_event,
|
|
send_snowplow_event: false,
|
|
user: user,
|
|
namespace: namespace,
|
|
project: project,
|
|
additional_properties: additional_properties
|
|
)
|
|
|
|
params = {
|
|
event: known_event,
|
|
namespace_id: namespace.id,
|
|
project_id: project.id,
|
|
additional_properties: additional_properties
|
|
}
|
|
post api(endpoint, user), params: params
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
|
|
context 'with no additional_properties' do
|
|
it 'returns status ok' do
|
|
expect(Gitlab::InternalEvents).to receive(:track_event)
|
|
.with(
|
|
known_event,
|
|
send_snowplow_event: false,
|
|
user: user,
|
|
namespace: namespace,
|
|
project: project,
|
|
additional_properties: {}
|
|
)
|
|
|
|
post api(endpoint, user), params: { event: known_event, namespace_id: namespace.id, project_id: project.id }
|
|
|
|
expect(response).to have_gitlab_http_status(:ok)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
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
|
|
end
|